Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

unpublished service UnoControlSpinButtonModel
Usage Restrictions
not published
Description
specifies the standard model of an UnoControlSpinButton.

A spin button is a control which has a numeric value associated with it, and allows to change this value using two spin buttons.

A spin button is similar to a scroll bar, but it usually has no (own) visual representation of the associated value, but is used to propagate it's value to other controls.

See also
UnoControlScrollBarModel

Included Services - Summary
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Summary
short
Border
specifies the border style of the control.  
long
BorderColor
[ OPTIONAL ]
specifies the color of the border, if present  
boolean
Enabled
determines whether the control is enabled or disabled.  
string
HelpText
specifies the help text of the control.  
string
HelpURL
specifies the help URL of the control.  
long
SpinIncrement
specifies the increment by which the value is changed when using operating the spin button.  
long
Orientation
specifies the ScrollBarOrientation of the control.  
boolean
Printable
specifies whether the control will be printed with the document.  
long
SpinValue
specifies the current value of the control.  
long
SpinValueMin
specifies the minimum value of the control.  
long
SpinValueMax
specifies the maximum value of the control.  
::com::sun::star::util::Color
BackgroundColor
specifies the RGB color to be used for the control  
::com::sun::star::util::Color
SymbolColor
specifies the RGB color to be used when painting symbols which are part of the control's appearance, such as the arrow buttons.  
boolean
Repeat
specifies whether the mouse should show repeating behaviour, i.e. repeatedly trigger an action when keeping pressed.  
long
RepeatDelay
specifies the mouse repeat delay, in milliseconds.  
short
MouseWheelBehavior
[ OPTIONAL ]
defines how the mouse wheel can be used to scroll through the control's content.  
Included Services - Details
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Details
Border
short Border;
Description
specifies the border style of the control.
 0: No border
 1: 3D border
 2: simple border
 
BorderColor
long BorderColor;
Usage Restrictions
optional
Description
specifies the color of the border, if present

Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the BorderColor setting.

Since
OOo 2.0
Enabled
boolean Enabled;
Description
determines whether the control is enabled or disabled.
HelpText
string HelpText;
Description
specifies the help text of the control.
HelpURL
string HelpURL;
Description
specifies the help URL of the control.
SpinIncrement
long SpinIncrement;
Description
specifies the increment by which the value is changed when using operating the spin button.
Orientation
long Orientation;
Description
specifies the ScrollBarOrientation of the control.
Printable
boolean Printable;
Description
specifies whether the control will be printed with the document.
SpinValue
long SpinValue;
Description
specifies the current value of the control.
SpinValueMin
long SpinValueMin;
Description
specifies the minimum value of the control.
SpinValueMax
long SpinValueMax;
Description
specifies the maximum value of the control.
BackgroundColor
::com::sun::star::util::Color BackgroundColor;
Description
specifies the RGB color to be used for the control
SymbolColor
::com::sun::star::util::Color SymbolColor;
Description
specifies the RGB color to be used when painting symbols which are part of the control's appearance, such as the arrow buttons.
Repeat
boolean Repeat;
Description
specifies whether the mouse should show repeating behaviour, i.e. repeatedly trigger an action when keeping pressed.
RepeatDelay
long RepeatDelay;
Description
specifies the mouse repeat delay, in milliseconds.

When the user presses a mouse in a control area where this triggers an action (such as spinning the value), then usual control implementations allow to repeatedly trigger this action, without the need to release the mouse button and to press it again. The delay between two such triggers is specified with this property.

MouseWheelBehavior
short MouseWheelBehavior;
Usage Restrictions
optional
Description
defines how the mouse wheel can be used to scroll through the control's content.

Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.