CIP C++ documentation for class "uifcRadioGroup"

Class uifcRadioGroup

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

Description

Method Summary


`void`	`AddActionListener (uifcRadioGroupListener_ptr listener)`


`xbool`	`CanResizeWhenNeeded ()`


`xbool`	`CanTruncateText ()`


`xbool`	`CanWrap ()`


`void`	`CreateTimer (uifcRadioGroupTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesAllowKeyboardInput ()`


`xbool`	`DoesItemSelectWhenSelected ()`


`uifcButtonStyle`	`GetButtonStyle ()`


`xint`	`GetColumns ()`


`xint`	`GetContentArrangement ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragItemName ()`


`xstring`	`GetDragNotValidCursorImage ()`


`xstring`	`GetDropItemName ()`


`xstringsequence_ptr`	`GetEnabledItemNameArray ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xstringsequence_ptr`	`GetItemHelpTextArray ()`


`xstringsequence_ptr`	`GetItemImageArray ()`


`xintsequence_ptr`	`GetItemImageBackgroundColorArray ()`


`xintsequence_ptr`	`GetItemImageColorArray ()`


`xstringsequence_ptr`	`GetItemNameArray ()`


`xstringsequence_ptr`	`GetItemTextArray ()`


`uifcColors_ptr`	`GetItemTextColorArray ()`


`xstring`	`GetMostRecentItemName ()`


`uifcOrientation`	`GetOrientation ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`xint`	`GetRows ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xstringsequence_ptr`	`GetSelectedItemNameArray ()`


`xstring`	`GetSetStateImage ()`


`uifcAlignment`	`GetTextAlignment ()`


`uifcDimension_ptr`	`GetTextSize (xrstring str)`


`xstring`	`GetUnsetStateImage ()`


`xstringsequence_ptr`	`GetVisibleItemNameArray ()`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsValidDragSite ()`


`void`	`PushAction (uifcRadioGroupAction action)`


`void`	`SetAllowKeyboardInput (xbool flag)`


`void`	`SetButtonStyle (uifcButtonStyle value)`


`void`	`SetCanResizeWhenNeeded (xbool flag)`


`void`	`SetCanTruncateText (xbool flag)`


`void`	`SetCanWrap (xbool flag)`


`void`	`SetColumns (xint value)`


`void`	`SetContentArrangement (xint value)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetEnabledItemNameArray (xstringsequence_ptr values)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetItemHelpTextArray (xstringsequence_ptr values)`


`void`	`SetItemImageArray (xstringsequence_ptr values)`


`void`	`SetItemImageBackgroundColorArray (xintsequence_ptr values)`


`void`	`SetItemImageColorArray (xintsequence_ptr values)`


`void`	`SetItemNameArray (xstringsequence_ptr values)`


`void`	`SetItemSelectWhenSelected (xbool flag)`


`void`	`SetItemTextArray (xstringsequence_ptr values)`


`void`	`SetItemTextColorArray (uifcColors_ptr colors)`


`void`	`SetOrientation (uifcOrientation value)`


`void`	`SetRows (xint value)`


`void`	`SetSelectedItemNameArray (xstringsequence_ptr values)`


`void`	`SetSetStateImage (xrstring value)`


`void`	`SetTextAlignment (uifcAlignment value)`


`void`	`SetUnsetStateImage (xrstring value)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetVisibleItemNameArray (xstringsequence_ptr values)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`

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

Methods Inherited from Class uifcSelection:: IsInMixedState, SetInMixedState, GetTextFormat, SetTextFormat, GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetFontStyle, SetFontStyle

Method Detail

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

xint InsertPopupMenu (uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

void SetFrameOrigin (uifcPoint_ptr value)

Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcDimension_ptr GetTextSize (xrstring str)

Get the size in pixels of the given text string.

Parameters:

str

Returns:

void SetFrameRectangle (uifcRectangle_ptr rect)

Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

rect

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void SetFrameSize (uifcDimension_ptr value)

Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcRectangle_ptr GetScreenRectangle ()

Determine the size and screen position of the component, in pixels.

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

uifcRectangle_ptr GetFrameRectangle ()

Determine the size and position of the component, in pixels.

Returns:

xstring GetDragItemName ()

Returns:: The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.

xint GetColumns ()

Returns:: The number of columns of buttons of the RadioGroup when the orientation is ORIENTATION_HORIZONTAL.

void SetColumns (xint value)

Sets the number of columns of buttons of the RadioGroup when the orientation is ORIENTATION_HORIZONTAL.

Parameters:

value

Returns:

xstringsequence_ptr GetSelectedItemNameArray ()

Returns:: The names of the selected items of the component.

void SetSelectedItemNameArray (xstringsequence_ptr values)

Sets the names of the selected items of the component.

Parameters:

values

Returns:

uifcOrientation GetOrientation ()

Returns:

The orientation of the RadioGroup.

ORIENTATION_HORIZONTAL	Horizontal, with the buttons being laid out from left to right
ORIENTATION_VERTICAL	Vertical, with the buttons being laid out from top to bottom

void SetOrientation (uifcOrientation value)

Sets the orientation of the RadioGroup.

ORIENTATION_HORIZONTAL	Horizontal, with the buttons being laid out from left to right
ORIENTATION_VERTICAL	Vertical, with the buttons being laid out from top to bottom

Parameters:

value

Returns:

xstring GetDragCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

void SetDragCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

Parameters:

value

Returns:

xintsequence_ptr GetItemImageBackgroundColorArray ()

Returns:: The background colors of the images of the items of the component, as either a uifcColor or a uifcColor.

void SetItemImageBackgroundColorArray (xintsequence_ptr values)

Sets the background colors of the images of the items of the component, as either a uifcColor or a uifcColor.

Parameters:

values

Returns:

uifcAlignment GetTextAlignment ()

Returns:

The justification of the labels of the buttons of the RadioGroup if the labels are multi-line.

ALIGNMENT_LEFT	Left justified
ALIGNMENT_CENTER	Center justified
ALIGNMENT_RIGHT	Right justified

void SetTextAlignment (uifcAlignment value)

Sets the justification of the labels of the buttons of the RadioGroup if the labels are multi-line.

ALIGNMENT_LEFT	Left justified
ALIGNMENT_CENTER	Center justified
ALIGNMENT_RIGHT	Right justified

Parameters:

value

Returns:

uifcButtonStyle GetButtonStyle ()

Returns:

The display style of the buttons of the RadioGroup.

BUTTON_STYLE_CHECK	The horizontal and vertical margins are equal, no shadow border is drawn and by default the RadioGroup accepts keyboard input
BUTTON_STYLE_TOGGLE	The horizontal margin is twice as wide as the vertical margin, the shadow border is always drawn and by default the RadioGroup accepts keyboard input
BUTTON_STYLE_TOOL	The horizontal and vertical margins are equal, the shadow border is always drawn and by default the RadioGroup does not accept keyboard input
BUTTON_STYLE_FLAT	The horizontal and vertical margins are equal, the shadow border is only drawn when the pointer is moved over the component and by default the RadioGroup does not accept keyboard input

void SetButtonStyle (uifcButtonStyle value)

Sets the display style of the buttons of the RadioGroup.

BUTTON_STYLE_CHECK	The horizontal and vertical margins are equal, no shadow border is drawn and by default the RadioGroup accepts keyboard input
BUTTON_STYLE_TOGGLE	The horizontal margin is twice as wide as the vertical margin, the shadow border is always drawn and by default the RadioGroup accepts keyboard input
BUTTON_STYLE_TOOL	The horizontal and vertical margins are equal, the shadow border is always drawn and by default the RadioGroup does not accept keyboard input
BUTTON_STYLE_FLAT	The horizontal and vertical margins are equal, the shadow border is only drawn when the pointer is moved over the component and by default the RadioGroup does not accept keyboard input

Parameters:

value

Returns:

xbool CanWrap ()

Returns:: Flag indicating whether the labels of the buttons of the RadioGroup should wrap within the available space granted to the component by its parent. Currently this flag is only supported for components which are the children of a MenuPane, where the MenuPane has been assigned a given size by the application code.

void SetCanWrap (xbool flag)

Sets flag indicating whether the labels of the buttons of the RadioGroup should wrap within the available space granted to the component by its parent. Currently this flag is only supported for components which are the children of a MenuPane, where the MenuPane has been assigned a given size by the application code.

Parameters:

flag

Returns:

xstringsequence_ptr GetVisibleItemNameArray ()

Returns:: The names of the visible items of the component. An empty array indicates that every item of the component is visible.

void SetVisibleItemNameArray (xstringsequence_ptr values)

Sets the names of the visible items of the component. An empty array indicates that every item of the component is visible.

Parameters:

values

Returns:

xstring GetDragNotValidCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.

void SetDragNotValidCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.

Parameters:

value

Returns:

uifcColors_ptr GetItemTextColorArray ()

Returns:: The foreground colors of the items of the component, as a uifcColor.

void SetItemTextColorArray (uifcColors_ptr colors)

Sets the foreground colors of the items of the component, as a uifcColor.

Parameters:

colors

Returns:

xint GetContentArrangement ()

Returns:

The alignment of the image and label of the buttons of the RadioGroup.
This is made up of between 1 and 4 digits which represent the relative locations of the image and label.
The first digit is the image alignment within the bounds of the button:

1	2	3
4	5	6
7	8	9

The second digit is optional and is the label alignment within the bounds of the button, using the same scheme as above. If no digit is specified then the label alignment is assumed to be the same as the image alignment.
The third digit is also optional and is the relative position of the image and the label if the first 2 digits are equal. If no digit is specified then the relative position is assumed to be 1.

1	The image to the left of the label
2	The image to the right of the label
3	The image above the label
4	The image below the label

The fourth digit is also optional and is a flag representing whether how the image and label should be displayed. If no digit is specified then then fourth digit is assumed to be 1.

1	Display both the image and label
2	Display only the image
3	Display only the label

void SetContentArrangement (xint value)

Sets the alignment of the image and label of the buttons of the RadioGroup.
This is made up of between 1 and 4 digits which represent the relative locations of the image and label.
The first digit is the image alignment within the bounds of the button:

1	2	3
4	5	6
7	8	9

1	The image to the left of the label
2	The image to the right of the label
3	The image above the label
4	The image below the label

The fourth digit is also optional and is a flag representing whether how the image and label should be displayed. If no digit is specified then then fourth digit is assumed to be 1.

1	Display both the image and label
2	Display only the image
3	Display only the label

Parameters:

value

Returns:

xbool DoesAllowKeyboardInput ()

Returns:: Flag indicating whether the component is capable of receiving keyboard input (xtrue), and hence is capable of receiving the keyboard input focus, or whether it responds only to mouse input (xfalse).
If this value is left unchanged (i.e. 2) then it is automatically set to xtrue or xfalse based upon the value of the ButtonStyle attribute.

void SetAllowKeyboardInput (xbool flag)

Sets flag indicating whether the component is capable of receiving keyboard input (xtrue), and hence is capable of receiving the keyboard input focus, or whether it responds only to mouse input (xfalse).
If this value is left unchanged (i.e. 2) then it is automatically set to xtrue or xfalse based upon the value of the ButtonStyle attribute.

Parameters:

flag

Returns:

xstring GetDropItemName ()

Returns:: The name of the item beneath the pointer whilst the pointer is over the component during a drag & drop operation.

xstringsequence_ptr GetItemImageArray ()

Returns:: The images of the items of the component.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetItemImageArray (xstringsequence_ptr values)

Sets the images of the items of the component.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

values

Returns:

xstringsequence_ptr GetItemHelpTextArray ()

Returns:: The popup help-text to be displayed for the items of the component whilst the pointer is over the component.

void SetItemHelpTextArray (xstringsequence_ptr values)

Sets the popup help-text to be displayed for the items of the component whilst the pointer is over the component.

Parameters:

values

Returns:

xbool IsValidDragSite ()

Returns:: Flag indicating whether the component can be dragged to start a drag & drop operation.

void SetValidDragSite (xbool flag)

Sets flag indicating whether the component can be dragged to start a drag & drop operation.

Parameters:

flag

Returns:

xbool CanTruncateText ()

Returns:: Flag indicating whether to truncate the labels of the buttons of the RadioGroup with ellipsis if there is insufficient space to display the entire text string.

void SetCanTruncateText (xbool flag)

Sets flag indicating whether to truncate the labels of the buttons of the RadioGroup with ellipsis if there is insufficient space to display the entire text string.

Parameters:

flag

Returns:

xintsequence_ptr GetItemImageColorArray ()

Returns:: The foreground colors of the images of the items of the component, as either a uifcColor or a uifcColor.

void SetItemImageColorArray (xintsequence_ptr values)

Sets the foreground colors of the images of the items of the component, as either a uifcColor or a uifcColor.

Parameters:

values

Returns:

xbool DoesItemSelectWhenSelected ()

Returns:: Flag indicating whether the RadioGroup should generate a OnItemSelect() callback when the currently selected item is re-selected (xtrue) or whether such a selection should be ignored as the state has not changed.

void SetItemSelectWhenSelected (xbool flag)

Sets flag indicating whether the RadioGroup should generate a OnItemSelect() callback when the currently selected item is re-selected (xtrue) or whether such a selection should be ignored as the state has not changed.

Parameters:

flag

Returns:

xstringsequence_ptr GetItemNameArray ()

Returns:: The names of the items of the component.

void SetItemNameArray (xstringsequence_ptr values)

Sets the names of the items of the component.

Parameters:

values

Returns:

xbool CanResizeWhenNeeded ()

Returns:: Flag indicating whether the RadioGroup should attempt to resize when its contents are changed.

void SetCanResizeWhenNeeded (xbool flag)

Sets flag indicating whether the RadioGroup should attempt to resize when its contents are changed.

Parameters:

flag

Returns:

xstring GetUnsetStateImage ()

Returns:: If the button style is BUTTON_STYLE_CHECK then this value is the name of the check mark image to be displayed next to the label of a button of the RadioGroup when the button is not the current selection.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetUnsetStateImage (xrstring value)

Sets if the button style is BUTTON_STYLE_CHECK then this value is the name of the check mark image to be displayed next to the label of a button of the RadioGroup when the button is not the current selection.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

value

Returns:

xstringsequence_ptr GetEnabledItemNameArray ()

Returns:: The names of the selectable items of the component. An empty array indicates that every item of the component may be selected.

void SetEnabledItemNameArray (xstringsequence_ptr values)

Sets the names of the selectable items of the component. An empty array indicates that every item of the component may be selected.

Parameters:

values

Returns:

xstring GetMostRecentItemName ()

Returns:: The item which was beneath the pointer the last time the pointer was over the component.

xstringsequence_ptr GetItemTextArray ()

Returns:: The labels of the items of the component.

void SetItemTextArray (xstringsequence_ptr values)

Sets the labels of the items of the component.

Parameters:

values

Returns:

xstring GetSetStateImage ()

Returns:: If the button style is BUTTON_STYLE_CHECK then this value is the name of the check mark image to be displayed next to the label of a button of the RadioGroup when the button is the current selection.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetSetStateImage (xrstring value)

Sets if the button style is BUTTON_STYLE_CHECK then this value is the name of the check mark image to be displayed next to the label of a button of the RadioGroup when the button is the current selection.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

value

Returns:

xint GetRows ()

Returns:: The number of rows of buttons of the RadioGroup when the orientation is ORIENTATION_VERTICAL.

void SetRows (xint value)

Sets the number of rows of buttons of the RadioGroup when the orientation is ORIENTATION_VERTICAL.

Parameters:

value

Returns:

void AddActionListener (uifcRadioGroupListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcRadioGroupAction action)

Parameters:

action

Returns:

void CreateTimer (uifcRadioGroupTimer_ptr timer, xrstring timerName, xbool writeInTrail)

Parameters:

timer
timerName
writeInTrail

Returns:

void StartTimer (xrstring timerName, xint duration)

Parameters:

timerName
duration

Returns:

void StopTimer (xrstring timerName)

Parameters:

timerName

Returns: