Class uifcCascadeButton

API Documentation > Interface Classes > Class uifcCascadeButton

# include <uifcCascadeButton.h>

class uifcCascadeButton
: public virtual uifcButtonBase
{
xaideclare(uifcCascadeButton)
...
};

Description

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 Summary

void	AddActionListener (uifcCascadeButtonListener_ptr listener)



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



xbool	DoesAutoClose ()



xbool	DoesReplayDismissEvent ()



uifcLabelAlignment	GetButtonPlacement ()



xstring	GetCascadeHelpText ()



uifcCheckState	GetCheckedState ()



xstring	GetChildMenuName ()



xstring	GetDefaultHelpText ()



uifcDimension_ptr	GetFrameMinimumSize ()



uifcPoint_ptr	GetFrameOrigin ()



uifcRectangle_ptr	GetFrameRectangle ()



uifcDimension_ptr	GetFrameSize ()



uifcKey_ptr	GetKeyPressed ()



uifcOrientation	GetOrientation ()



xstring	GetPendingActionComponentName ()



xstring	GetPendingActionDialogName ()



uifcRectangle_ptr	GetRectangleOfMonitor ()



uifcPoint_ptr	GetScreenOrigin ()



uifcRectangle_ptr	GetScreenRectangle ()



uifcDimension_ptr	GetTextSize (xrstring str)



xint	IsMenuEnabled ()



xbool	IsSplitButton ()



xbool	IsSplitCheckButton ()



void	PushAction (uifcCascadeButtonAction action)



void	SetAutoClose (xbool flag)



void	SetButtonPlacement (uifcLabelAlignment value)



void	SetCascadeHelpText (xrstring value)



void	SetCheckedState (uifcCheckState value)



void	SetChildMenuName (xrstring value)



void	SetDefaultHelpText (xrstring value)



void	SetFrameOrigin (uifcPoint_ptr value)



void	SetFrameRectangle (uifcRectangle_ptr rect)



void	SetFrameSize (uifcDimension_ptr value)



void	SetKeyPressed (uifcKey_ptr key)



void	SetMenuEnabled (xint value)



void	SetOrientation (uifcOrientation value)



void	SetReplayDismissEvent (xbool flag)



void	SetSplitButton (xbool flag)



void	SetSplitCheckButton (xbool flag)



void	StartTimer (xrstring timerName, xint duration)



void	StopTimer (xrstring timerName)

Method Detail

xstring

GetPendingActionDialogName

()

Returns:

xstring

GetPendingActionComponentName

()

Returns:

uifcPoint_ptr

GetScreenOrigin

()

Determine the screen position of the component, in pixels.

Returns:

uifcRectangle_ptr

GetScreenRectangle

()

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

Returns:

uifcDimension_ptr

GetFrameMinimumSize

()

Determine the minimum size of the component, in pixels.

Returns:

uifcPoint_ptr

GetFrameOrigin

()

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

Returns:

uifcRectangle_ptr

GetFrameRectangle

()

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

Returns:

uifcDimension_ptr

GetFrameSize

()

Determine the size 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

GetTextSize

(xrstring str)

Get the size in pixels of the given text string.

Parameters:

str

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:

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

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:

xstring

GetDefaultHelpText

()

Returns:

The popup help-text to be displayed over the button part of a split CascadeButton.

void

SetDefaultHelpText

(xrstring value)

Sets the popup help-text to be displayed over the button part of a split CascadeButton.

Parameters:

value

Returns:

xstring

GetChildMenuName

()

Returns:

The name of the MenuPane to be displayed when the CascadeButton is activated.

If this value is "" then the value of the PopupMenuName attribute is used instead.

void

SetChildMenuName

(xrstring value)

Sets the name of the MenuPane to be displayed when the CascadeButton is activated.

If this value is "" then the value of the PopupMenuName attribute is used instead.

Parameters:

value

Returns:

uifcOrientation

GetOrientation

()

Returns:

The orientation of the CascadeButton.

ORIENTATION_HORIZONTAL	The child menu opens in a horizontal direction, with the arrow pointing to the right
ORIENTATION_VERTICAL	The child menu opens in a vertical direction, with the arrow pointing downwards

void

SetOrientation

(uifcOrientation value)

Sets the orientation of the CascadeButton.

ORIENTATION_HORIZONTAL	The child menu opens in a horizontal direction, with the arrow pointing to the right
ORIENTATION_VERTICAL	The child menu opens in a vertical direction, with the arrow pointing downwards

Parameters:

value

Returns:

xint

IsMenuEnabled

()

Returns:

When SplitButton attribute is xtrue, this attribute controls the sensitivity of the arrow part of the control.

If the value is set to 2 then the sensitivity is instead taken from the value of Enabled attribute to provide backwards compatibility with previous versions.

void

SetMenuEnabled

(xint value)

Sets when SplitButton attribute is xtrue, this attribute controls the sensitivity of the arrow part of the control.

If the value is set to 2 then the sensitivity is instead taken from the value of Enabled attribute to provide backwards compatibility with previous versions.

Parameters:

value

Returns:

uifcKey_ptr

GetKeyPressed

()

Returns:

The key pressed which generated a OnKeyDown(). To indicate to the component that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.

void

SetKeyPressed

(uifcKey_ptr key)

Sets the key pressed which generated a OnKeyDown(). To indicate to the component that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.

Parameters:

key

Returns:

xbool

DoesReplayDismissEvent

()

Returns:

Flag indicating whether the CascadeButton should replay a mouse event which occured outside the MenuPane of the CascadeButton, causing the MenuPane to be dismissed and the CascadeButton to close. The mouse event is replayed to the component beneath the cursor, where it would otherwise have been sent, originally.

void

SetReplayDismissEvent

(xbool flag)

Sets flag indicating whether the CascadeButton should replay a mouse event which occured outside the MenuPane of the CascadeButton, causing the MenuPane to be dismissed and the CascadeButton to close. The mouse event is replayed to the component beneath the cursor, where it would otherwise have been sent, originally.

Parameters:

flag

Returns:

uifcLabelAlignment

GetButtonPlacement

()

Returns:

The justification of the label of the CascadeButton

LABEL_ALIGNMENT_LEFT	To the left of the split / to the left of the arrow
LABEL_ALIGNMENT_RIGHT	To the right of the split
LABEL_ALIGNMENT_TOP	Above the split / above the arrow
LABEL_ALIGNMENT_BOTTOM	Below the split

void

SetButtonPlacement

(uifcLabelAlignment value)

Sets the justification of the label of the CascadeButton

LABEL_ALIGNMENT_LEFT	To the left of the split / to the left of the arrow
LABEL_ALIGNMENT_RIGHT	To the right of the split
LABEL_ALIGNMENT_TOP	Above the split / above the arrow
LABEL_ALIGNMENT_BOTTOM	Below the split

Parameters:

value

Returns:

xbool

IsSplitButton

()

Returns:

Flag indicating whether to allow OnActivate() callbacks for the CascadeButton. When this flag is set to xtrue the CascadeButton is drawn as a split-button, with the arrow region being used to open the child MenuPane and the remainder of the button generating this callback.

void

SetSplitButton

(xbool flag)

Sets flag indicating whether to allow OnActivate() callbacks for the CascadeButton. When this flag is set to xtrue the CascadeButton is drawn as a split-button, with the arrow region being used to open the child MenuPane and the remainder of the button generating this callback.

Parameters:

flag

Returns:

xstring

GetCascadeHelpText

()

Returns:

The popup help-text to be displayed for the arrow part of a split CascadeButton.

void

SetCascadeHelpText

(xrstring value)

Sets the popup help-text to be displayed for the arrow part of a split CascadeButton.

Parameters:

value

Returns:

xbool

IsSplitCheckButton

()

Returns:

Flag indicating whether to treat OnActivate() callbacks for the CascadeButton as if the button were a CheckButton. When this flag is set to xtrue the CascadeButton toggles the value of CheckedState attribute when the button is pressed.

void

SetSplitCheckButton

(xbool flag)

Sets flag indicating whether to treat OnActivate() callbacks for the CascadeButton as if the button were a CheckButton. When this flag is set to xtrue the CascadeButton toggles the value of CheckedState attribute when the button is pressed.

Parameters:

flag

Returns:

xbool

DoesAutoClose

()

Returns:

Flag indicating whether the CascadeButton is in the process of closing.

void

SetAutoClose

(xbool flag)

Sets flag indicating whether the CascadeButton is in the process of closing.

Parameters:

flag

Returns:

uifcCheckState

GetCheckedState

()

Returns:

The state of the CascadeButton when SplitCheckButton attribute is set to CHECK_STATE_SET.

void

SetCheckedState

(uifcCheckState value)

Sets the state of the CascadeButton when SplitCheckButton attribute is set to CHECK_STATE_SET.

Parameters:

value

Returns:

void

AddActionListener

(uifcCascadeButtonListener_ptr listener)

Parameters:

listener

Returns:

void

PushAction

(uifcCascadeButtonAction action)

Parameters:

action

Returns:

void

CreateTimer

(uifcCascadeButtonTimer_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:

Was this helpful?