CIP C++ documentation for class "uifcPushButton"

Class uifcPushButton

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

Description

Method Summary


`void`	`AddActionListener (uifcPushButtonListener_ptr listener)`


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


`void`	`DeletePopupMenu ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`uifcKey_ptr`	`GetKeyPressed ()`


`xint`	`GetMaximumWidth ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`uifcDimension_ptr`	`GetTextSize (xrstring str)`


`xint`	`GetWidth ()`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`void`	`PushAction (uifcPushButtonAction action)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetKeyPressed (uifcKey_ptr key)`


`void`	`SetMaximumWidth (xint value)`


`void`	`SetWidth (xint 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:

xint GetMaximumWidth ()

Returns:: The maximum width of the PushButton, in character widths.
A value of 0 indicates that the PushButton should size itself based upon its contents.

void SetMaximumWidth (xint value)

Sets the maximum width of the PushButton, in character widths.
A value of 0 indicates that the PushButton should size itself based upon its contents.

Parameters:

value

Returns:

xint GetWidth ()

Returns:: The width of the PushButton, in character widths.
A value of 0 indicates that the PushButton should size itself based upon its contents.

void SetWidth (xint value)

Sets the width of the PushButton, in character widths.
A value of 0 indicates that the PushButton should size itself based upon its contents.

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:

void AddActionListener (uifcPushButtonListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcPushButtonAction action)

Parameters:

action

Returns:

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