Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

service UnoControlTimeFieldModel
Description
specifies the standard model of an UnoControlTimeField.

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
specifies the background color (RGB) of the control.  
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.  
FontDescriptor
FontDescriptor
specifies the font attributes of the text in the control.  
short
FontEmphasisMark
specifies the ::com::sun::star::text::FontEmphasis value of the text in the control.  
short
FontRelief
specifies the ::com::sun::star::text::FontRelief value of the text in the control.  
string
HelpText
specifies the help text of the control.  
string
HelpURL
specifies the help URL of the control.  
boolean
HideInactiveSelection
[ OPTIONAL ]
specifies whether the selection in the control should be hidden when the control is not active (focused).  
boolean
Printable
specifies that the control will be printed with the document.  
boolean
ReadOnly
specifies that the content of the control cannot be modified by the user.  
boolean
Repeat
[ OPTIONAL ]
specifies whether the mouse should show repeating behaviour, i.e. repeatedly trigger an action when keeping pressed.  
long
RepeatDelay
[ OPTIONAL ]
specifies the mouse repeat delay, in milliseconds.  
boolean
Spin
specifies that the control has a spin button.  
boolean
StrictFormat
specifies that the date is checked during the user input.  
boolean
Tabstop
specifies that the control can be reached with the TAB key.  
string
Text
[ OPTIONAL ]
specifies the text displayed in the control.  
::com::sun::star::util::Color
TextColor
specifies the text color (RGB) of the control.  
::com::sun::star::util::Color
TextLineColor
specifies the text line color (RGB) of the control.  
long
Time
specifies the time displayed in the control.  
short
TimeFormat
specifies the format of the displayed time.  
long
TimeMax
specifies the maximum time that can be entered.  
long
TimeMin
specifies the minimum time that can be entered.  
short
WritingMode
[ OPTIONAL ]
denotes the writing mode used in the control, as specified in the ::com::sun::star::text::WritingMode2 constants group.  
short
MouseWheelBehavior
[ OPTIONAL ]
defines how the mouse wheel can be used to scroll through the control's content.  
::com::sun::star::style::VerticalAlignment
VerticalAlign
[ OPTIONAL ]
specifies the vertical alignment of the text in the control.  
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;
Description
specifies the background color (RGB) of the control.
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.
FontDescriptor
FontDescriptor FontDescriptor;
Description
specifies the font attributes of the text in the control.
FontEmphasisMark
short FontEmphasisMark;
Description
specifies the ::com::sun::star::text::FontEmphasis value of the text in the control.
FontRelief
short FontRelief;
Description
specifies the ::com::sun::star::text::FontRelief value of the text in the control.
HelpText
string HelpText;
Description
specifies the help text of the control.
HelpURL
string HelpURL;
Description
specifies the help URL of the control.
HideInactiveSelection
boolean HideInactiveSelection;
Usage Restrictions
optional
Description
specifies whether the selection in the control should be hidden when the control is not active (focused).
Since
OOo 2.0
Printable
boolean Printable;
Description
specifies that the control will be printed with the document.
ReadOnly
boolean ReadOnly;
Description
specifies that the content of the control cannot be modified by the user.
Repeat
boolean Repeat;
Usage Restrictions
optional
Description
specifies whether the mouse should show repeating behaviour, i.e. repeatedly trigger an action when keeping pressed.
Since
OOo 2.0
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 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.

Since
OOo 2.0
Spin
boolean Spin;
Description
specifies that the control has a spin button.
StrictFormat
boolean StrictFormat;
Description
specifies that the date is checked during the user input.
Tabstop
boolean Tabstop;
Description
specifies that the control can be reached with the TAB key.
Text
string Text;
Usage Restrictions
optional
Description
specifies the text displayed in the control.
Since
OOo 2.0
TextColor
::com::sun::star::util::Color TextColor;
Description
specifies the text color (RGB) of the control.
TextLineColor
::com::sun::star::util::Color TextLineColor;
Description
specifies the text line color (RGB) of the control.
Time
long Time;
Description
specifies the time displayed in the control.
TimeFormat
short TimeFormat;
Description
specifies the format of the displayed time.
 0: 24h short
 1: 24h long
 2: 12h short
 3: 12h long
 4: Duration short
 5: Duration long
 
TimeMax
long TimeMax;
Description
specifies the maximum time that can be entered.
TimeMin
long TimeMin;
Description
specifies the minimum time that can be entered.
WritingMode
short WritingMode;
Usage Restrictions
optional
Description
denotes the writing mode used in the control, as specified in the ::com::sun::star::text::WritingMode2 constants group.

Only ::com::sun::star::text::WritingMode2::LR_TB and ::com::sun::star::text::WritingMode2::RL_TB are supported at the moment.

Since
OOo 3.1
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.

VerticalAlign
::com::sun::star::style::VerticalAlignment VerticalAlign;
Usage Restrictions
optional
Description
specifies the vertical alignment of the text in the control.
Since
OOo 3.3

 
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.