CIP C++ documentation for class "uifcSelection"

Class uifcSelection

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

Description

Direct Known Subclasses:: uifcList, uifcOptionMenu, uifcRadioGroup, uifcTable, uifcTree

Method Summary


`uifcFontClass`	`GetFontClass ()`


`xstring`	`GetFontName ()`


`xreal`	`GetFontSize ()`


`uifcFontStyle`	`GetFontStyle ()`


`xstring`	`GetHelpText ()`


`uifcRichText`	`GetTextFormat ()`


`xbool`	`IsEnabled ()`


`xbool`	`IsInMixedState ()`


`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`	`SetInMixedState (xbool flag)`


`void`	`SetTextFormat (uifcRichText 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

xbool IsInMixedState ()

Returns:: Flag indicating whether the Tree has no selection at this time and is therefore in an indeterminate "mixed" state.
If this attribute is set to xtrue then when the user makes a selection in the Tree it will automatically be reset to xfalse.

void SetInMixedState (xbool flag)

Sets flag indicating whether the Tree has no selection at this time and is therefore in an indeterminate "mixed" state.
If this attribute is set to xtrue then when the user makes a selection in the Tree it will automatically be reset to xfalse.

Parameters:

flag

Returns:

uifcRichText GetTextFormat ()

Returns:

The format of the display text of the component.

RICHTEXT_OFF	Plain text
RICHTEXT_ON	A very restricted subset of HTML
RICHTEXT_ON + <HTML>	HTML as supported by the HTMLWindow

The UI RichText format supports the following styles, controlled by their corresponding tokens:

Style	Switch on	Switch off
Bold	\b	\b0
Italic	\i	\i0
Underlined	\ul	\ulnone
~~Strike-through~~	\strike	\strike0
^Superscript	\super	\nosupersub
_Subscript	\sub	\nosupersub
Foreground Color	\cfRRGGBB	\cf0
Background Color	\cbRRGGBB	\cb0
Picture	\pictNAME	n/a

N.B. Each token must be followed immediately by another token or a whitespace character (e.g. space, newline).
The very restricted subset of HTML supports the following styles, controlled by their corresponding tokens:

Style	Switch on	Switch off
Bold	<b>	</b>
Italic	<i>	</i>
Underlined	<u>	</u>
~~Strike-through~~	<strike>	</strike>
^Superscript	<sup>	</sup>
_Subscript	<sub>	</sub>
Foreground Color	<font color=#RRGGBB>	</font>
Background Color	<span style="background:#RRGGBB">	</span>
Picture	<img src="NAME">	n/a

void SetTextFormat (uifcRichText value)

Sets the format of the display text of the component.

RICHTEXT_OFF	Plain text
RICHTEXT_ON	A very restricted subset of HTML
RICHTEXT_ON + <HTML>	HTML as supported by the HTMLWindow

The UI RichText format supports the following styles, controlled by their corresponding tokens:

Style	Switch on	Switch off
Bold	\b	\b0
Italic	\i	\i0
Underlined	\ul	\ulnone
~~Strike-through~~	\strike	\strike0
^Superscript	\super	\nosupersub
_Subscript	\sub	\nosupersub
Foreground Color	\cfRRGGBB	\cf0
Background Color	\cbRRGGBB	\cb0
Picture	\pictNAME	n/a

Style	Switch on	Switch off
Bold	<b>	</b>
Italic	<i>	</i>
Underlined	<u>	</u>
~~Strike-through~~	<strike>	</strike>
^Superscript	<sup>	</sup>
_Subscript	<sub>	</sub>
Foreground Color	<font color=#RRGGBB>	</font>
Background Color	<span style="background:#RRGGBB">	</span>
Picture	<img src="NAME">	n/a

Parameters:

value

Returns:

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:

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: