CIP C++ documentation for class "uifcText"

Class uifcText

# include <uifcText.h> class uifcText : public virtual uifcComponent { xaideclare(uifcText) ... };

Description

Direct Known Subclasses:: uifcInputPanel, uifcLabel, uifcTextArea

Method Summary


`uifcFontClass`	`GetFontClass ()`


`xstring`	`GetFontName ()`


`xreal`	`GetFontSize ()`


`uifcFontStyle`	`GetFontStyle ()`


`xstring`	`GetHelpText ()`


`xint`	`GetWidth ()`


`xbool`	`IsEnabled ()`


`void`	`SetEnabled (xbool flag)`


`void`	`SetFontClass (uifcFontClass value)`


`void`	`SetFontName (xrstring value)`


`void`	`SetFontSize (xreal value)`


`void`	`SetFontStyle (uifcFontStyle value)`


`void`	`SetHelpText (xrstring value)`


`void`	`SetWidth (xint value)`

Methods Inherited from Class uifcComponent:: GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Method Detail

xstring GetFontName ()

Returns:: The name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.

void SetFontName (xrstring value)

Sets the name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.

Parameters:

value

Returns:

uifcFontClass GetFontClass ()

Returns:

The base font class to be used to draw text in the component.

FONT_CLASS_DEFAULT	The default font
FONT_CLASS_DESKTOP	The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU	The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP	The font used by the popup helptext
FONT_CLASS_MESSAGE	The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR	The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED	A system-specific fixed width font for the locale

void SetFontClass (uifcFontClass value)

Sets the base font class to be used to draw text in the component.

FONT_CLASS_DEFAULT	The default font
FONT_CLASS_DESKTOP	The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU	The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP	The font used by the popup helptext
FONT_CLASS_MESSAGE	The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR	The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED	A system-specific fixed width font for the locale

Parameters:

value

Returns:

xreal GetFontSize ()

Returns:: The point-size of the font used to draw text in the component.

void SetFontSize (xreal value)

Sets the point-size of the font used to draw text in the component.

Parameters:

value

Returns:

xbool IsEnabled ()

Returns:: Flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

void SetEnabled (xbool flag)

Sets flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

Parameters:

flag

Returns:

xstring GetHelpText ()

Returns:: The popup help-text to be displayed whilst the pointer is over the component.
If the value begins with <HTML> then the help-text is treated as HTML, and rendered accordingly. It is often wise to use HTML help-text in conjunction with HelpTextWidth attribute, to define the maximum width of the popup help-text window.

void SetHelpText (xrstring value)

Sets the popup help-text to be displayed whilst the pointer is over the component.
If the value begins with <HTML> then the help-text is treated as HTML, and rendered accordingly. It is often wise to use HTML help-text in conjunction with HelpTextWidth attribute, to define the maximum width of the popup help-text window.

Parameters:

value

Returns:

xint GetWidth ()

Returns:: The width of the TextArea, in character widths.

void SetWidth (xint value)

Sets the width of the TextArea, in character widths.

Parameters:

value

Returns:

uifcFontStyle GetFontStyle ()

Returns:

A bitwise OR of the styles of the font used to draw text in the component.

FONT_STYLE_REGULAR	The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED	The font is condensed
FONT_STYLE_ITALIC	The font is italicised
FONT_STYLE_BOLD	The font is emboldened

void SetFontStyle (uifcFontStyle value)

Sets a bitwise OR of the styles of the font used to draw text in the component.

FONT_STYLE_REGULAR	The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED	The font is condensed
FONT_STYLE_ITALIC	The font is italicised
FONT_STYLE_BOLD	The font is emboldened

Parameters:

value

Returns: