Class TGUIStaticText

Fields

Unit

type TGUIStaticText = class(TGUIElement)

Multi or single line text label.

	`function GetOverrideFont: TGUIFont; inline;`
	`procedure SetOverrideFont(NFont: TGUIFont); inline;`
	`procedure SetTextAlignmet(Horizontal, Vertical: TGUIAlignment); inline;`

	`property BackgroundColor: TARGBColor write SetBackgroundColor;`
	`property DrawBackground: Boolean write SetDrawBackground;`
	`property DrawBorder: Boolean write SetDrawBorder;`
	`property OverrideColor: TARGBColor read GetOverrideColor write SetOverrideColor;`
	`property TextHeight: LongInt read GetTextHeight;`
	`property TextWidth: LongInt read GetTextWidth;`
	`property UseOverrideColor: Boolean read IsOverrideColorEnabled write EnableOverrideColor;`
	`property WordWrap: Boolean read IsWordWrapEnabled write SetWordWrap;`

function GetOverrideFont: TGUIFont; inline;

Returns the override font.

The override font, if any, else nil.

procedure SetOverrideFont(NFont: TGUIFont); inline;

Overrides the default font used by the static text or disables overriding.

procedure SetTextAlignmet(Horizontal, Vertical: TGUIAlignment); inline;

Sets the text justification mode.

Horizontal: gaUpperLeft for left justification, gaLowerRight for right justification, gaCenter for centered text.
Vertical: gaUpperLeft for alignment with the top edge, gaLowerRight for the bottom edge, gaCenter for vertically centered text.

	`property BackgroundColor: TARGBColor write SetBackgroundColor;`
Sets the background color. If you want the background to be drawn, set DrawBackground to True.

	`property DrawBackground: Boolean write SetDrawBackground;`
Specifies if the static text should draw a background.

	`property DrawBorder: Boolean write SetDrawBorder;`
Specifies if the static text should draw a border.

	`property OverrideColor: TARGBColor read GetOverrideColor write SetOverrideColor;`
The override text color. To use it, set UseOverrideColor to True.

	`property TextHeight: LongInt read GetTextHeight;`
The height of the text in pixels when it is drawn. This is useful for adjusting the layout of gui elements based on the height of the multiline text in this element.

	`property TextWidth: LongInt read GetTextWidth;`
Returns the width of the current text, in the current font. If the text is broken, this returns the width of the widest line.

	`property UseOverrideColor: Boolean read IsOverrideColorEnabled write EnableOverrideColor;`
Specifies if the static text should use its OverrideColor rather than the default skin color for static texts.

	`property WordWrap: Boolean read IsWordWrapEnabled write SetWordWrap;`
Enables or disables automatic wrap-around for oversized lines.

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