1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_UnoControlTimeFieldModel_idl__
28#define __com_sun_star_awt_UnoControlTimeFieldModel_idl__
29
30#ifndef __com_sun_star_awt_FontDescriptor_idl__
31#include <com/sun/star/awt/FontDescriptor.idl>
32#endif
33
34#ifndef __com_sun_star_awt_UnoControlModel_idl__
35#include <com/sun/star/awt/UnoControlModel.idl>
36#endif
37
38#ifndef __com_sun_star_util_Color_idl__
39#include <com/sun/star/util/Color.idl>
40#endif
41
42#ifndef __com_sun_star_style_VerticalAlignment_idl__
43#include <com/sun/star/style/VerticalAlignment.idl>
44#endif
45
46//=============================================================================
47
48 module com {  module sun {  module star {  module awt {
49
50//=============================================================================
51
52/** specifies the standard model of an <type>UnoControlTimeField</type>.
53 */
54published service UnoControlTimeFieldModel
55{
56	service com::sun::star::awt::UnoControlModel;
57
58	//-------------------------------------------------------------------------
59
60	/** specifies the background color (RGB) of the control.
61	 */
62	[property] com::sun::star::util::Color BackgroundColor;
63
64	//-------------------------------------------------------------------------
65
66	/** specifies the border style of the control.
67
68		<pre>
69		0: No border
70		1: 3D border
71		2: simple border
72		</pre>
73	 */
74	[property] short Border;
75
76	//-------------------------------------------------------------------------
77
78	/** specifies the color of the border, if present
79
80        <p>Not every border style (see <member>Border</member>) may support coloring.
81        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
82
83        @since OOo 2.0
84	 */
85	[optional, property] long BorderColor;
86
87	//-------------------------------------------------------------------------
88
89	/** determines whether the control is enabled or disabled.
90	 */
91	[property] boolean Enabled;
92
93	//-------------------------------------------------------------------------
94
95	/** specifies the font attributes of the text in the control.
96	 */
97	[property] com::sun::star::awt::FontDescriptor FontDescriptor;
98
99	//-------------------------------------------------------------------------
100
101	/** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
102        value of the text in the control.
103	 */
104	[property] short FontEmphasisMark;
105
106	//-------------------------------------------------------------------------
107
108	/** specifies the <type scope="com::sun::star::text">FontRelief</type>
109        value of the text in the control.
110	 */
111	[property] short FontRelief;
112
113	//-------------------------------------------------------------------------
114
115	/** specifies the help text of the control.
116	 */
117	[property] string HelpText;
118
119	//-------------------------------------------------------------------------
120
121	/** specifies the help URL of the control.
122	 */
123	[property] string HelpURL;
124
125	//-------------------------------------------------------------------------
126
127    /** specifies whether the selection in the control should be hidden when
128        the control is not active (focused).
129
130        @since OOo 2.0
131     */
132    [optional, property] boolean HideInactiveSelection;
133
134	//-------------------------------------------------------------------------
135
136	/** specifies that the control will be printed with the document.
137	 */
138	[property] boolean Printable;
139
140	//-------------------------------------------------------------------------
141
142	/** specifies that the content of the control cannot be modified by the user.
143	 */
144	[property] boolean ReadOnly;
145
146	//-------------------------------------------------------------------------
147
148	/** specifies whether the mouse should show repeating behaviour, i.e.
149        repeatedly trigger an action when keeping pressed.
150
151        @since OOo 2.0
152     */
153    [optional, property] boolean Repeat;
154
155	//-------------------------------------------------------------------------
156
157	/** specifies the mouse repeat delay, in milliseconds.
158
159        <p>When the user presses a mouse in a control area where this triggers
160        an action (such as spinning the value), then usual control implementations
161        allow to repeatedly trigger this action, without the need to release the
162        mouse button and to press it again. The delay between two such triggers
163        is specified with this property.</p>
164
165        @since OOo 2.0
166     */
167	[optional, property] long RepeatDelay;
168
169	//-------------------------------------------------------------------------
170
171	/** specifies that the control has a spin button.
172	 */
173	[property] boolean Spin;
174
175	//-------------------------------------------------------------------------
176
177	/** specifies that the date is checked during the user input.
178	 */
179	[property] boolean StrictFormat;
180
181	//-------------------------------------------------------------------------
182
183	/** specifies that the control can be reached with the TAB key.
184	 */
185	[property] boolean Tabstop;
186
187	//-------------------------------------------------------------------------
188
189	/** specifies the text displayed in the control.
190
191        @since OOo 2.0
192     */
193	[optional, property] string Text;
194
195	//-------------------------------------------------------------------------
196
197	/** specifies the text color (RGB) of the control.
198	 */
199	[property] com::sun::star::util::Color TextColor;
200
201	//-------------------------------------------------------------------------
202
203	/** specifies the text line color (RGB) of the control.
204	 */
205	[property] com::sun::star::util::Color TextLineColor;
206
207	//-------------------------------------------------------------------------
208
209	/** specifies the time displayed in the control.
210	 */
211	[property] long Time;
212
213	//-------------------------------------------------------------------------
214
215	/** specifies the format of the displayed time.
216
217		<pre>
218		0:  24h short
219		1:  24h long
220		2:  12h short
221		3:  12h long
222		4:  Duration short
223		5:  Duration long
224		</pre>
225	 */
226	[property] short TimeFormat;
227
228	//-------------------------------------------------------------------------
229
230	/** specifies the maximum time that can be entered.
231	 */
232	[property] long TimeMax;
233
234	//-------------------------------------------------------------------------
235
236	/** specifies the minimum time that can be entered.
237	 */
238	[property] long TimeMin;
239
240    /** denotes the writing mode used in the control, as specified in the
241        <type scope="com::sun::star::text">WritingMode2</type> constants group.
242
243        <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
244        <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
245
246        @since OOo 3.1
247    */
248    [optional, property] short WritingMode;
249
250    /** defines how the mouse wheel can be used to scroll through the control's content.
251
252        <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
253        and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
254        this is possible.</p>
255    */
256    [optional, property] short MouseWheelBehavior;
257
258    //-------------------------------------------------------------------------
259
260    /** specifies the vertical alignment of the text in the control.
261
262        @since OOo 3.3
263	 */
264    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
265};
266
267//=============================================================================
268
269}; }; }; };
270
271#endif
272