SYNOPSIS

Perl

Python

use HaikuR1::Alert qw(B_EMPTY_ALERT B_INFO_ALERT B_IDEA_ALERT B_WARNING_ALERT B_STOP_ALERT B_EVEN_SPACING B_OFFSET_SPACING);

my $alert = HaikuR1::Alert->new(
    title => $title,
    text => $text,
    buttons => $buttons,
    width => $width,
    type => $type,
);
$alert->Go();

fromm HaikuR1.InterfaceKit import Alert, B_EMPTY_ALERT, B_INFO_ALERT, B_IDEA_ALERT, B_WARNING_ALERT, B_STOP_ALERT, B_EVEN_SPACING, B_OFFSET_SPACING

alert = Alert(
    title = title,
    text = text,
    buttons = buttons,
    width = width,
    type = type,
)
$alert->Go()

DESCRIPTION

Exposes the BAlert object.

For more information on Alert, see the Be Book class description, the Be Book overview, and the Haiku Book class description.

METHODS

Constructor

Creates an Alert.

Perl

Python

HaikuR1::Alert->new(
    title => $title,
    text => $text,
    buttons => $buttons,
    width => $width,
    type => $type,
);

Alert(
    title = title,
    text = text,
    buttons = buttons,
    width = width,
    type = type,
)

title

A string, the title. It will not appear on screen, but will appear in the name of the thread.
text

A string, the text to be displayed.
buttons

A native list of strings, the button labels. The constructor will accept up to three labels; if you need more buttons, use AddButton.
width

An integer, one of the button width constants.
type

An integer, one of the alert type constants.

AlertPosition

Computes the frame given the width and height and returns the upper left Point.

Unless you are creating your own custom Alert subclass, you should not need this method; the constructor calls it automatically.

Perl

Python

$alert->AlertPosition($width, $height);

alert.AlertPosition(width, height)

width, height

Floating point numbers.

Appearance

SetIcon

SetText

SetButtonSpacing

SetButtonWidth

Changes elements of the Alert's appearance.

Perl

Python

$alert->SetIcon($bitmap);
$alert->SetText($text);
$alert->SetButtonSpacing($spacing);
$alert->SetButtonWidth($width);

alert.SetIcon(bitmap)
alert.SetText(text)
alert.SetButtonSpacing(spacing)
alert.SetButtonWidth(width)

bitmap

A Bitmap, the new bitmap.
text

A string, the text to be displayed.
spacing

An integer, one of the button spacing constants.
width

An integer, one of the button width constants.

Buttons

AddButton

CountButtons

ButtonAt

These buttons do what you expect.

Perl

Python

$alert->AddButton($label, $key);
$alert->CountButtons();
$alert->ButtonAt($index);

alert.AddButton(label, key)
alert.CountButtons()
alert.ButtonAt(index)

label

A string, the label for the new button.
key

An optional single character string, the shortcut key for the new button.
index

An integer, 0-based index of the button to find.

Go

Displays the Alert.

If an Invoker is provided, the call will be asynchronous: it will return 0 immediately and a message will be sent to the Invoker's target. The 0-based index of the selected button will be in the int32 "which" field of the message.

If no Invoker is provided, the call will be synchronous: it will not return until the user has selected a button, and the return value will be the index of the selected button.

Perl

Python

$alert->Go($invoker);

alert.Go(invoker)

invoker

An Invoker to which a message will be sent when a button is selected. If you pass the empty value, the call will be asynchronous, but the selected index will not be sent.

Shortcut

SetShortcut

Gets or sets a shortcut character for a button.

Perl

Python

$alert->Shortcut($index);
$alert->SetShortcut($index, $shortcut);

alert.SetShortcut(index, shortcut)
alert.Shortcut(index)

index

An integer, the index of a button.
shortcut

A single character string, the shortcut key.

TextView

Returns the TextView object for the Alert's text.

Perl

Python

$alert->TextView();

alert.TextView()

Type

SetType

Gets or sets the alert type.

Perl

Python

$alert->Type();
$alert->SetType($type);

alert.Type()
alert.SetType(type)

ARCHIVABLE INTERFACE

Alert inherits the methods and hooks of Archivable.

HANDLER INTERFACE

Alert inherits the methods and hooks of Handler.

LOOPER INTERFACE

Alert inherits the methods and hooks of Looper.

WINDOW INTERFACE

Alert inherits the methods and hooks of Window.

CONSTANTS

Alert types

Perl

Python

use HaikuR1::Alert qw(:alert_type)

Python does not support export tags.

B_EMPTY_ALERT

No icon

B_INFO_ALERT

Info icon

B_IDEA_ALERT

Idea icon

B_WARNING_ALERT

Warning icon

B_STOP_ALERT

Stop icon

Button spacing

Perl

Python

use HaikuR1::Alert qw(:button_spacing)

Python does not support export tags.

B_EVEN_SPACING

Buttons are evenly spaced

B_OFFSET_SPACING

Leftmost button is offset

Alert inherits the following suites: