Documentation | InterfaceKit | TextControl

SYNOPSIS

use HaikuR1::TextControl;

my $textcontrol = HaikuR1::TextControl->new(
    frame => $frame,
    name => $name,
    label => $label,
    text => $text,
    message => $message,
    resizingMode => $resizingMode,
    flags => $flags,
);
$window->AddChild($textcontrol);

import HaikuR1.TextControl []

textcontrol = TextControl(
    frame = frame,
    name = name,
    label = label,
    text = text,
    message = message,
    resizingMode = resizingMode,
    flags = flags,
)
window.AddChild(textcontrol)

DESCRIPTION

Exposes the BTextControl object.

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

METHODS

Constructor

Creates a TextControl.

HaikuR1::TextControl->new(
    frame => $frame,
    name => $name,
    label => $label,
    text => $text,
    message => $message,
    resizingMode => $resizingMode,
    flags => $flags,
);
HaikuR1::TextControl->newFromArchive($archive);

TextControl(
    frame = frame,
    name = name,
    label = label,
    text = text,
    message = message,
    resizingMode = resizingMode,
    flags = flags,
)
TextControl.FromArchive(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 TextControl's internal name.

• label

  A string, the label that will be displayed to the left of the TextControl's input field.

• text

  A string, the initial text in the TextControl's input field; if you pass the empty value, there will be no label.

• message

  A Message that will be sent when the TextControl is Invoked.

• resizingMode

  An integer, the resizing mode. (See the resizing mode constants.) Should only be specified when there is a frame. Defaults to B_FOLLOW_NONE.

• flags

  An integer, view flags. (See the view flag constants.)

• archive

  A Message, contains an archived version of the TextControl.

Text

SetText

TextLength

Gets or sets the text in the input field. SetText can also be called as a hook.

$textcontrol->Text();
$textcontrol->SetText($text);
$textcontrol->TextLength();

textcontrol.Text()
textcontrol.SetText(text)
textcontrol.TextLength()

• text

  A string, the new value for the input field.

MarkAsInvalid

Marks the control as invalid; this changes its appearance.

$textcontrol->MarkAsInvalid($invalid);

textcontrol.MarkAsInvalid(invalid)

• invalid

  A boolean; if true, the control will be marked invalid.

TextView

Returns the TextView input field.

$textcontrol->TextView();

textcontrol.TextView()

ModificationMessage

SetModificationMessage

Gets or sets the message sent when the content changes. SetModificationMessage can also be called as a hook.

$textcontrol->ModificationMessage();
$textcontrol->SetModificationMessage($message);

textcontrol.ModificationMessage()
textcontrol.SetModificationMessage(message)

• message

  The new modification Message.

Alignment

GetAlignment

SetAlignment

Gets or sets the alignment for the TextControl's input field and label. SetAlignment can also be called as a hook. GetAlignment returns two values.

$textcontrol->GetAlignment();
$textcontrol->SetAlignment($forLabel, $forText);

textcontrol.GetAlignment()
textcontrol.SetAlignment(forLabel, forText)

• forLabel

• forText

  Integers, one of the alignment constants.

Divider

SetDivider

Gets or sets the divider point between the label and the TextView; this is the x-coordinate where the label stops and the input field begins.

$textcontrol->Divider();
$textcontrol->SetDivider($xCoordinate);

textcontrol.Divider()
textcontrol.SetDivider(xCoordinate)

• xCoordinate

  A floating point number, the new divider point.

Layout items

CreateLabelLayoutItem

CreateTextViewLayoutItem

Creates LayoutItems for the internal Views.

$textcontrol->CreateLabelLayoutItem();
$textcontrol->CreateTextViewLayoutItem();

textcontrol.CreateLabelLayoutItem()
textcontrol.CreateTextViewLayoutItem()

ARCHIVABLE INTERFACE

TextControl inherits the methods and hooks of Archivable.

HANDLER INTERFACE

TextControl inherits the methods and hooks of Handler.

VIEW INTERFACE

TextControl inherits the methods and hooks of View.

CONTROL INTERFACE

TextControl inherits the methods and hooks of Control.

SCRIPTING SUITE

TextControl inherits the following suites:

• suite/vnd.Be-handler
• suite/vnd.Be-view
• suite/vnd.Be-control

However, TextControl overrides the Control suite so that the Value property is a string instead of an integer.