Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

service UnoControlScrollBarModel
Description
specifies the standard model of an UnoControlScrollBar.

Included Services - Summary
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Summary
::com::sun::star::util::Color
BackgroundColor
[ OPTIONAL ]
specifies the RGB color to be used for the control.  
long
BlockIncrement
specifies the increment for a block move.  
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
LineIncrement
specifies the increment for a single line move.  
boolean
LiveScroll
[ OPTIONAL ]
specifies the scrolling behaviour of the control.  
long
Orientation
specifies the ScrollBarOrientation of the control.  
boolean
Printable
specifies that the control will be printed with the document.  
long
RepeatDelay
[ OPTIONAL ]
specifies the mouse repeat delay, in milliseconds.  
long
ScrollValue
specifies the scroll value of the control.  
long
ScrollValueMin
[ OPTIONAL ]
specifies the minimum scroll value of the control.  
long
ScrollValueMax
specifies the maximum scroll value of the control.  
::com::sun::star::util::Color
SymbolColor
[ OPTIONAL ]
specifies the RGB color to be used when painting symbols which are part of the control's appearance, such as the arrow buttons.  
boolean
Tabstop
[ OPTIONAL ]
specifies that the control can be reached with the TAB key.  
long
VisibleSize
specifies the visible size of the scroll bar.  
Included Services - Details
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Details
BackgroundColor
::com::sun::star::util::Color BackgroundColor;
Usage Restrictions
optional
Description
specifies the RGB color to be used for the control.
Since
OOo 2.0
BlockIncrement
long BlockIncrement;
Description
specifies the increment for a block move.
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.
LineIncrement
long LineIncrement;
Description
specifies the increment for a single line move.
LiveScroll
boolean LiveScroll;
Usage Restrictions
optional
Description
specifies the scrolling behaviour of the control.

true means, that when the user moves the slider in the scroll bar, the content of the window is updated immediately. false means, that the window is only updated after the user has released the mouse button.

Since
OOo 2.0
Orientation
long Orientation;
Description
specifies the ScrollBarOrientation of the control.
Printable
boolean Printable;
Description
specifies that the control will be printed with the document.
RepeatDelay
long RepeatDelay;
Usage Restrictions
optional
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 scrolling the scrollbar), 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.

Since
OOo 2.0
ScrollValue
long ScrollValue;
Description
specifies the scroll value of the control.
ScrollValueMin
long ScrollValueMin;
Usage Restrictions
optional
Description
specifies the minimum scroll value of the control.

If this optional property is not present, clients of the component should assume a minimal scroll value of 0.

ScrollValueMax
long ScrollValueMax;
Description
specifies the maximum scroll value of the control.
SymbolColor
::com::sun::star::util::Color SymbolColor;
Usage Restrictions
optional
Description
specifies the RGB color to be used when painting symbols which are part of the control's appearance, such as the arrow buttons.
Since
OOo 2.0
Tabstop
boolean Tabstop;
Usage Restrictions
optional
Description
specifies that the control can be reached with the TAB key.
Since
OOo 2.0
VisibleSize
long VisibleSize;
Description
specifies the visible size of the scroll bar.

 
Top of Page

Apache Software Foundation

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

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