Documentation | InterfaceKit | StatusBar

SYNOPSIS

Perl

use HaikuR1::StatusBar;

HaikuR1::StatusBar->new(
    frame => $frame,
    name => $name,
    label => [ $label, $trailingLabel ],
);

Python

from HaikuR1.InterfaceKit import HaikuR1.StatusBar

StatusBar(
    frame = frame,
    name = name,
    label = [ label, trailingLabel  ],
)

DESCRIPTION

Exposes the BStatusBar object.

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

METHODS

Constructor

Creates a StatusBar.

Perl

HaikuR1::StatusBar->new(
    frame => $frame,
    name => $name,
    label => [ $label, $trailingLabel ],
);
HaikuR1::StatusBar->new(
    name => $name,
    label => [ $label, $trailingLabel ],
);
HaikuR1::StatusBar->new($archive);

Python

StatusBar(
    frame = frame,
    name = name,
    label => [ $label, $trailingLabel ],
)
StatusBar(
    name = name,
    label => [ $label, $trailingLabel ],
)
StatusBar(archive)

frame

A Rect that indicates where on the parent Window the View should be. You should not specify a frame on a View that will be added to a parent which uses a Layout.
name

A string, the Button's internal name.
label

A string containing a label, or a two-item native list containing a starting label and trailing label.
archive

A Message, contains an archived version of the StatusBar.

CurrentValue

Returns the current value of the StatusBar

Perl

$statusbar->CurrentValue();

Python

statusbar.CurrentValue()

BarColor

SetBarColor

Gets or sets the bar color. (The default value when the object is created is 50, 150, 255.)

SetBarColor can also be called as a hook.

Perl

$statusbar->BarColor();
$statusbar->SetBarColor($color);

Python

statusbar.BarColor()
statusbar.SetBarColor(color)

color

An rgb_color object, the new color.

BarHeight

SetBarHeight

Gtes or sets the bar height. (The default value when the object is created is calculated from the font.)

SetBarHeight can also be called as a hook.

Perl

$statusbar->BarHeight();
$statusbar->SetBarHeight($height);

Python

statusbar.BarHeight()
statusbar.SetBarHeight(height)

height

A floating point number, the new height.

Label

TrailingLabel

Reset

Gets or sets the label(s) for the object.

Reset can also be called as a hook.

Perl

$statusbar->Label();
$statusbar->TrailingLabel();
$statusbar->Reset($label, $trailingLabel);

Python

statusbar.Label()
statusbar.TrailingLabel()
statusbar.Reset(label, trailingLabel)

label, trailingLabel

Strings, the new values.

MaxValue

SetMaxValue

Gets or sets the maximum value for the StatusBar. (The default value when the object is created is 100.)

SetMaxValue can also be called as a hook.

Perl

$statusbar->MaxValue();
$statusbar->SetMaxValue($max);

Python

statusbar.MaxValue()
statusbar.SetMaxValue(max)

max

A floating point number, the new maximum value.

Text

TrailingText

SetText

SetTrailingText

Gets or sets the specified text string. (Defaults to an empty string when the object is created.)

SetText and SetTrailingText can also be called as hooks.

Perl

$statusbar->Text();
$statusbar->TrailingText();
$statusbar->SetText($string);
$statusbar->SetTrailingText($string);

Python

statusbar.Text()
statusbar.TrailingText()
statusbar.SetText(string)
statusbar.SetTrailingText(string)

string

A string, the new value.

Update

SetTo

Change the StatusBar's value and text strings. Update will increase the current value by the given amount; SetTo will replace the current value

Perl

$statusbar->Update($delta, $text, $trailingText);
$statusbar->SetTo($value, $text, $trailingText);

Python

statusbar.Update(delta, text, trailingText)
statusbar.SetTo(value, text, trailingText)

delta, value

Floating point numbers.
text, trailingText

Strings, the new values.

SCRIPTING SUITE

Box inherits the following suites: