TextWidget

The text widget base class.

abstract

class TextWidget : Widget {

string _textVariable;

Image _image;

this(UiElement parent);

auto setText(string text);

string getText();

auto setImage(Image image, string imagePosition);

auto setImagePosition(string imagePosition);

auto setTextCharacterWidth(int characterWidth);

void destroy();

mixin Underline ;

}

Constructors

this this(UiElement parent): Construct the widget.

Members

Functions

destroy void destroy(): Destroy this widget.
getText string getText(): Get the widget text.
setImage auto setImage(Image image, string imagePosition): Set the image for this widget.
setImagePosition auto setImagePosition(string imagePosition): Change the position of the image in relation to the text.
setText auto setText(string text): Set the widget text.
setTextCharacterWidth auto setTextCharacterWidth(int characterWidth): Set the text character width.

Mixins

__anonymous mixin Underline: Mixin common commands.

Variables

_image Image _image;: Undocumented in source.
_textVariable string _textVariable;: Undocumented in source.

Mixed In Members

From `mixin Underline`

underlineChar auto underlineChar(int index): Underline one of the characters in the widget text.

Inherited Members

setState auto setState(string[] state): Set the widget's state.
getState string[] getState(): Get the widget's state.
inState bool inState(string[] state): Test if a widget is in a particular state.
removeState auto removeState(string[] state): Remove the widget's state.
resetState auto resetState(): Reset the widget's state to default.
setStyle auto setStyle(string style): Set the widget's style.
getStyle string getStyle(): Get the widget's style.
setKeyboardFocus auto setKeyboardFocus(string focus): Set if the widget can recieve focus during keyboard traversal.
getKeyboardFocus string getKeyboardFocus(): Get if the widget can recieve focus during keyboard traversal.
pack auto pack(int outerPadding, int innerPadding, string side, string fill, string anchor, bool expand): Geometry method for loosely placing this widget inside its parent using a web browser model. Widgets flow around each other in the available space.
grid auto grid(int column, int row, int outerPadding, int innerPadding, int columnSpan, int rowSpan, string sticky): Geometry method for placing this widget inside its parent using an imaginary grid. Somewhat more direct and intuitive than pack. Choose grid for tabular layouts, and when there's no good reason to choose something else.
place auto place(int xPos, int yPos, int width, int height, string anchor, string borderMode): Geometry method for placing this widget inside its parent using absolute positioning.
place auto place(double relativeXPos, double relativeYPos, double relativeWidth, double relativeHeight, string anchor, string borderMode): Geometry method for placing this widget inside its parent using relative positioning. In this case the position and size is specified as a floating-point number between 0.0 and 1.0 relative to the height of the parent. 0.5 means the widget will be half as high as the parent and 1.0 means the widget will have the same height as the parent, and so on.

Detailed Description

Common Commands

These are injected common commands that can also be used with this widget.

See Also

tkd.widget.widget

Meta

Source

See Implementation

tkd widget textwidget classes

TextWidget