CIP C++ documentation for class "uifcCheckButton"

Class uifcCheckButton

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

Description

Method Summary


`void`	`AddActionListener (uifcCheckButtonListener_ptr listener)`


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


`void`	`DeletePopupMenu ()`


`uifcCheckState`	`GetCheckedState ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xstring`	`GetMixedStateImage ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xstring`	`GetSetStateImage ()`


`uifcDimension_ptr`	`GetTextSize (xrstring str)`


`xstring`	`GetUnsetStateImage ()`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`Is3State ()`


`xbool`	`IsInMixedState ()`


`void`	`PushAction (uifcCheckButtonAction action)`


`void`	`Set3State (xbool flag)`


`void`	`SetCheckedState (uifcCheckState value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetInMixedState (xbool flag)`


`void`	`SetMixedStateImage (xrstring value)`


`void`	`SetSetStateImage (xrstring value)`


`void`	`SetUnsetStateImage (xrstring value)`


`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 uifcButtonBase:: GetImageColor, SetImageColor, GetAcceleratorKey, SetAcceleratorKey, GetDragCursorImage, SetDragCursorImage, GetImage, SetImage, GetTextAlignment, SetTextAlignment, GetButtonStyle, SetButtonStyle, CanWrap, SetCanWrap, GetTextFormat, SetTextFormat, GetDragNotValidCursorImage, SetDragNotValidCursorImage, GetContentArrangement, SetContentArrangement, DoesAllowKeyboardInput, SetAllowKeyboardInput, GetFontName, SetFontName, GetFontClass, SetFontClass, IsValidDragSite, SetValidDragSite, CanTruncateText, SetCanTruncateText, CanResizeWhenNeeded, SetCanResizeWhenNeeded, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetText, SetText, GetFontStyle, SetFontStyle, GetImageBackgroundColor, SetImageBackgroundColor, GetAcceleratorText

Method Detail

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:

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:

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:

xbool Is3State ()

Returns:: Flag indicating whether the CheckButton has 2 (xfalse) or 3 (xtrue) states which can be cycled by the user.

void Set3State (xbool flag)

Sets flag indicating whether the CheckButton has 2 (xfalse) or 3 (xtrue) states which can be cycled by the user.

Parameters:

flag

Returns:

xstring GetMixedStateImage ()

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 when the CheckButton is in a mixed state.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetMixedStateImage (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 when the CheckButton is in a mixed state.
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:

xbool IsInMixedState ()

Returns:: Flag indicating whether the CheckButton is neither set nor unset at this time and is therefore in an indeterminate "mixed" state.
If this attribute is set to xtrue then when the user activates the CheckButton it will automatically be reset to xfalse.

void SetInMixedState (xbool flag)

Sets flag indicating whether the CheckButton is neither set nor unset at this time and is therefore in an indeterminate "mixed" state.
If this attribute is set to xtrue then when the user activates the CheckButton it will automatically be reset to xfalse.

Parameters:

flag

Returns:

uifcCheckState GetCheckedState ()

Returns:: The state of the CheckButton.

void SetCheckedState (uifcCheckState value)

Sets the state of the CheckButton.

Parameters:

value

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 when the state of the CheckButton is False.
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 when the state of the CheckButton is False.
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:

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 when the state of the CheckButton is True.
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 when the state of the CheckButton is True.
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:

void AddActionListener (uifcCheckButtonListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcCheckButtonAction action)

Parameters:

action

Returns:

void CreateTimer (uifcCheckButtonTimer_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: