API Documentation > Interface Classes > Class uifcSpinBox
Class uifcSpinBox

# include <uifcSpinBox.h>

class uifcSpinBox
: public virtual uifcRange_Controls
{
xaideclare(uifcSpinBox)
...
};


Description
Method Summary
void
void
void
void
CreateTimer (uifcSpinBoxTimer_ptr timer, xrstring timerName, xbool writeInTrail)
void
void
void
void
void
void
SetDigits (xint value)
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
SetWidth (xint value)
void
StartTimer (xrstring timerName, xint duration)
void
StopTimer (xrstring timerName)
Methods Inherited from Class uifcComponent::
Methods Inherited from Class uifcRange_Controls::
Method Detail
void
SetFrameRectangle
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:
GetScreenOrigin
()
Determine the screen position of the component, in pixels.
Returns:
GetFrameOrigin
()
Determine the position of the component, in pixels, relative to its parent.
Returns:
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:
GetFrameMinimumSize
()
Determine the minimum size of the component, in pixels.
Returns:
void
SetFrameSize
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:
GetScreenRectangle
()
Determine the size and screen position of the component, in pixels.
Returns:
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:
GetFrameSize
()
Determine the size of the component, in pixels.
Returns:
GetFrameRectangle
()
Determine the size and position of the component, in pixels.
Returns:
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:
GetMaximumDoubleValue
()
Returns:
The maximum double value of the SpinBox.
void
SetMaximumDoubleValue
(xreal value)
Sets the maximum double value of the SpinBox.
Parameters:
value
Returns:
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:
GetDoubleValue
()
Returns:
The double value of the SpinBox.
void
SetDoubleValue
(xreal value)
Sets the double value of the SpinBox.
Parameters:
value
Returns:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
GetMinimumDoubleValue
()
Returns:
The minimum double value of the SpinBox.
void
SetMinimumDoubleValue
(xreal value)
Sets the minimum double value of the SpinBox.
Parameters:
value
Returns:
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:
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
Parameters:
listener
Returns:
void
PushAction
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:
Was this helpful?