CIP C++ documentation for class "uifcSpinBox"

Class uifcSpinBox

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

Description

Method Summary


`void`	`AddActionListener (uifcSpinBoxListener_ptr listener)`


`xbool`	`CanWrap ()`


`void`	`ChangeDoubleValue (xreal change)`


`void`	`ChangeIntegerValue (xint change)`


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


`void`	`DeletePopupMenu ()`


`xbool`	`DoesAlwaysShowValueSign ()`


`xbool`	`DoesDynamicUpdate ()`


`uifcAlignment`	`GetButtonPlacement ()`


`xint`	`GetDigits ()`


`xstring`	`GetDoubleFormat ()`


`xreal`	`GetDoubleValue ()`


`xint`	`GetFastSpinDelay ()`


`xreal`	`GetFastSpinDoubleDelta ()`


`xint`	`GetFastSpinIntegerDelta ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xreal`	`GetMaximumDoubleValue ()`


`xreal`	`GetMinimumDoubleValue ()`


`xint`	`GetMinimumWidth ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xreal`	`GetSlowSpinDoubleDelta ()`


`xint`	`GetSlowSpinIntegerDelta ()`


`xint`	`GetSpinRate ()`


`uifcInputType`	`GetValueType ()`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsEnabled ()`


`xbool`	`IsInMixedState ()`


`void`	`PushAction (uifcSpinBoxAction action)`


`void`	`SetAlwaysShowValueSign (xbool flag)`


`void`	`SetButtonPlacement (uifcAlignment value)`


`void`	`SetCanWrap (xbool flag)`


`void`	`SetDigits (xint value)`


`void`	`SetDoubleFormat (xrstring value)`


`void`	`SetDoubleValue (xreal value)`


`void`	`SetDynamicUpdate (xbool flag)`


`void`	`SetEnabled (xbool flag)`


`void`	`SetFastSpinDelay (xint value)`


`void`	`SetFastSpinDoubleDelta (xreal value)`


`void`	`SetFastSpinIntegerDelta (xint value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetInMixedState (xbool flag)`


`void`	`SetMaximumDoubleValue (xreal value)`


`void`	`SetMinimumDoubleValue (xreal value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetSlowSpinDoubleDelta (xreal value)`


`void`	`SetSlowSpinIntegerDelta (xint value)`


`void`	`SetSpinRate (xint value)`


`void`	`SetValueType (uifcInputType 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 uifcRange_Controls:: GetMaximumIntegerValue, SetMaximumIntegerValue, GetIntegerValue, SetIntegerValue, GetMinimumIntegerValue, SetMinimumIntegerValue, GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, GetHelpText, SetHelpText, GetFontStyle, SetFontStyle

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 GetScreenOrigin ()

Determine the screen position of the component, in pixels.

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:

void ChangeDoubleValue (xreal change)

Increment the DoubleValue attribute of the SpinBox by the given amount.

Parameters:

change

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

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

void ChangeIntegerValue (xint change)

Increment the IntegerValue attribute of the component by the given amount.

Parameters:

change

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 DoesDynamicUpdate ()

Returns:: Flag indicating whether the SpinBox generates a OnChange() each time the value changes whilst the value is updating (xtrue) or whether only one OnChange() is generated when the updating is complete (xfalse).

void SetDynamicUpdate (xbool flag)

Sets flag indicating whether the SpinBox generates a OnChange() each time the value changes whilst the value is updating (xtrue) or whether only one OnChange() is generated when the updating is complete (xfalse).

Parameters:

flag

Returns:

xreal GetMaximumDoubleValue ()

Returns:: The maximum double value of the SpinBox.

void SetMaximumDoubleValue (xreal value)

Sets the maximum double value of the SpinBox.

Parameters:

value

Returns:

xint GetMinimumWidth ()

Returns:: The minimum width of the SpinBox, in character widths.

void SetMinimumWidth (xint value)

Sets the minimum width of the SpinBox, in character widths.

Parameters:

value

Returns:

xreal GetDoubleValue ()

Returns:: The double value of the SpinBox.

void SetDoubleValue (xreal value)

Sets the double value of the SpinBox.

Parameters:

value

Returns:

xint GetSpinRate ()

Returns:: The number of increments per second when the SpinBox value is repeatedly updating.

void SetSpinRate (xint value)

Sets the number of increments per second when the SpinBox value is repeatedly updating.

Parameters:

value

Returns:

xint GetSlowSpinIntegerDelta ()

Returns:: The slow increment to be used when the SpinBox value is a integer.

void SetSlowSpinIntegerDelta (xint value)

Sets the slow increment to be used when the SpinBox value is a integer.

Parameters:

value

Returns:

xint GetFastSpinDelay ()

Returns:: The delay time in milliseconds during which the SpinBox uses the slow increment, before it then uses the fast increment to update the value.

void SetFastSpinDelay (xint value)

Sets the delay time in milliseconds during which the SpinBox uses the slow increment, before it then uses the fast increment to update the value.

Parameters:

value

Returns:

xbool IsInMixedState ()

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

void SetInMixedState (xbool flag)

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

Parameters:

flag

Returns:

uifcAlignment GetButtonPlacement ()

Returns:

The alignment of the buttons of the SpinBox.

ALIGNMENT_LEFT	Left aligned
ALIGNMENT_RIGHT	Right aligned

void SetButtonPlacement (uifcAlignment value)

Sets the alignment of the buttons of the SpinBox.

ALIGNMENT_LEFT	Left aligned
ALIGNMENT_RIGHT	Right aligned

Parameters:

value

Returns:

xbool CanWrap ()

Returns:: Flag indicating whether the SpinBox value should wrap when it reaches an extreme of the range.

void SetCanWrap (xbool flag)

Sets flag indicating whether the SpinBox value should wrap when it reaches an extreme of the range.

Parameters:

flag

Returns:

uifcInputType GetValueType ()

Returns:

The data-type of the SpinBox.

INPUT_TYPE_INTEGER	An integer
INPUT_TYPE_DOUBLE	A double

void SetValueType (uifcInputType value)

Sets the data-type of the SpinBox.

INPUT_TYPE_INTEGER	An integer
INPUT_TYPE_DOUBLE	A double

Parameters:

value

Returns:

xint GetFastSpinIntegerDelta ()

Returns:: The fast increment to be used when the SpinBox value is a integer.

void SetFastSpinIntegerDelta (xint value)

Sets the fast increment to be used when the SpinBox value is a integer.

Parameters:

value

Returns:

xbool DoesAlwaysShowValueSign ()

Returns:: Flag indicating whether to display the signum of numerical values in the SpinBox.

void SetAlwaysShowValueSign (xbool flag)

Sets flag indicating whether to display the signum of numerical values in the SpinBox.

Parameters:

flag

Returns:

xint GetDigits ()

Returns:: The number of digits with which to display the value of the SpinBox.
A value of 0 indicates that this attribute should be ignored when formatting the value.

void SetDigits (xint value)

Sets the number of digits with which to display the value of the SpinBox.
A value of 0 indicates that this attribute should be ignored when formatting the value.

Parameters:

value

Returns:

xstring GetDoubleFormat ()

Returns:: The format of the contents of the SpinBox if they are being treated as a double.
The value of this attribute is a C formatting string which can handle the precision and value of the SpinBox.

void SetDoubleFormat (xrstring value)

Sets the format of the contents of the SpinBox if they are being treated as a double.
The value of this attribute is a C formatting string which can handle the precision and value of the SpinBox.

Parameters:

value

Returns:

xreal GetSlowSpinDoubleDelta ()

Returns:: The slow increment to be used when the SpinBox value is a double.

void SetSlowSpinDoubleDelta (xreal value)

Sets the slow increment to be used when the SpinBox value is a double.

Parameters:

value

Returns:

xreal GetFastSpinDoubleDelta ()

Returns:: The fast increment to be used when the SpinBox value is a double.

void SetFastSpinDoubleDelta (xreal value)

Sets the fast increment to be used when the SpinBox value is a double.

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:

xreal GetMinimumDoubleValue ()

Returns:: The minimum double value of the SpinBox.

void SetMinimumDoubleValue (xreal value)

Sets the minimum double value of the SpinBox.

Parameters:

value

Returns:

xint GetWidth ()

Returns:: The width of the SpinBox, in character widths.

void SetWidth (xint value)

Sets the width of the SpinBox, in character widths.

Parameters:

value

Returns:

xbool HasBorder ()

Returns:: Flag indicating whether the SpinBox has a decorated shadow border.

void SetHasBorder (xbool flag)

Sets flag indicating whether the SpinBox has a decorated shadow border.

Parameters:

flag

Returns:

void AddActionListener (uifcSpinBoxListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcSpinBoxAction action)

Parameters:

action

Returns:

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