Class TGUIEditBox

DescriptionHierarchyFieldsMethodsProperties

Unit

Irrlicht

Declaration

type TGUIEditBox = class(TGUIElement)

Description

Single line edit box for editing simple text.

Hierarchy

Overview

Methods

Public function GetTextDimension: TSize; inline;
Public procedure EnabledOverrideColor(Enable: Boolean=True); inline;
Public procedure SetOverrideColor(Color: TARGBColor); inline;
Public procedure SetOverrideFont(Font: TGUIFont); inline;
Public procedure SetPasswordChar(PWC: WideChar); inline;
Public procedure SetTextAlignment(Horizontal, Vertical: TGUIAlignment); inline;

Properties

Public property AutoScroll: Boolean read IsAutoScrollEnabled write EnableAutoScroll;
Public property DrawBorder: Boolean write SetDrawBorder;
Public property IsPasswordBox: Boolean read GetIsPasswordBox write SetIsPasswordBox;
Public property Maximum: LongWord read GetMax write SetMax;
Public property MultiLine: Boolean read IsMultiLineEnabled write SetMultiLine;
Public property WordWrap: Boolean read IsWordWrapEnabled write SetWordWrap;

Description

Methods

Public function GetTextDimension: TSize; inline;

Gets the size area of the text in the edit box in pixels.

Public procedure EnabledOverrideColor(Enable: Boolean=True); inline;

Sets if the text should use the override color or the color in the gui skin.

Parameters
Enable
f set to true, the override color, which can be set with SetOverrideColor is used, otherwise the dcButtonText color of the skin.
Public procedure SetOverrideColor(Color: TARGBColor); inline;

Sets another color for the text.
If set, the edit box does not use the dcButtonText color defined in the skin, but the set color instead. You don't need to call EnableOverrrideColor(true) after this, this is done by this function. If you set a color, and you want the text displayed with the color of the skin again, call EnableOverrideColor(false).

Parameters
Color
The new text color.
Public procedure SetOverrideFont(Font: TGUIFont); inline;
 
Public procedure SetPasswordChar(PWC: WideChar); inline;

Switches to password box mode and sets a custom mask character.

Public procedure SetTextAlignment(Horizontal, Vertical: TGUIAlignment); inline;

Sets text justification mode.

Parameters
Horizontal
alUpperLeft for left justified (default), alLowerRight for right justified, alCenter for centered text.
Vertical
alUpperLeft to align with top edge, alLowerRight for the bottom edge, alCenter for centered text (default)

Properties

Public property AutoScroll: Boolean read IsAutoScrollEnabled write EnableAutoScroll;

If set to true, the output scrolls automatically if the cursor outruns the screen.

Public property DrawBorder: Boolean write SetDrawBorder;

Shows or hides the border around the edit box.

Public property IsPasswordBox: Boolean read GetIsPasswordBox write SetIsPasswordBox;

If set to true, all characters will be masked with '*'; additionally, MultiLine, WordWrap and Ctrl-C / Ctrl-V will be disabled.

Public property Maximum: LongWord read GetMax write SetMax;

The maximum amount of characters.

Public property MultiLine: Boolean read IsMultiLineEnabled write SetMultiLine;

If set to true, multi-line editing is enabled.
In multi-line mode, pressing <Return> will not fire a geEditBoxEnter event, instead, a newline character will be inserted.

Public property WordWrap: Boolean read IsWordWrapEnabled write SetWordWrap;

If set to true, lines exceeding the control width will be automatically wrapped around.

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22