1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_UnoControlPatternFieldModel_idl__
24#define __com_sun_star_awt_UnoControlPatternFieldModel_idl__
25
26#ifndef __com_sun_star_awt_FontDescriptor_idl__
27#include <com/sun/star/awt/FontDescriptor.idl>
28#endif
29
30#ifndef __com_sun_star_awt_UnoControlModel_idl__
31#include <com/sun/star/awt/UnoControlModel.idl>
32#endif
33
34#ifndef __com_sun_star_util_Color_idl__
35#include <com/sun/star/util/Color.idl>
36#endif
37
38#ifndef __com_sun_star_style_VerticalAlignment_idl__
39#include <com/sun/star/style/VerticalAlignment.idl>
40#endif
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module awt {
45
46//=============================================================================
47
48/** specifies the standard model of an <type>UnoControlPatternField</type>.
49 */
50published service UnoControlPatternFieldModel
51{
52	service com::sun::star::awt::UnoControlModel;
53
54	//-------------------------------------------------------------------------
55
56	/** specifies the background color (RGB) of the control.
57	 */
58	[property] com::sun::star::util::Color BackgroundColor;
59
60	//-------------------------------------------------------------------------
61
62	/** specifies the border style of the control.
63
64		<pre>
65		0: No border
66		1: 3D border
67		2: simple border
68		</pre>
69	 */
70	[property] short Border;
71
72	//-------------------------------------------------------------------------
73
74	/** specifies the color of the border, if present
75
76        <p>Not every border style (see <member>Border</member>) may support coloring.
77        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
78
79        @since OpenOffice 2.0
80	 */
81	[optional, property] long BorderColor;
82
83	//-------------------------------------------------------------------------
84
85	/** specifies the edit mask.
86	 */
87	[property] string EditMask;
88
89	//-------------------------------------------------------------------------
90
91	/** determines whether the control is enabled or disabled.
92	 */
93	[property] boolean Enabled;
94
95	//-------------------------------------------------------------------------
96
97	/** specifies the font attributes of the text in the control.
98	 */
99	[property] com::sun::star::awt::FontDescriptor FontDescriptor;
100
101	//-------------------------------------------------------------------------
102
103	/** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
104        value of the text in the control.
105	 */
106	[property] short FontEmphasisMark;
107
108	//-------------------------------------------------------------------------
109
110	/** specifies the <type scope="com::sun::star::text">FontRelief</type>
111        value of the text in the control.
112	 */
113	[property] short FontRelief;
114
115	//-------------------------------------------------------------------------
116
117	/** specifies the help text of the control.
118	 */
119	[property] string HelpText;
120
121	//-------------------------------------------------------------------------
122
123	/** specifies the help URL of the control.
124	 */
125	[property] string HelpURL;
126
127	//-------------------------------------------------------------------------
128
129    /** specifies whether the selection in the control should be hidden when
130        the control is not active (focused).
131
132        @since OpenOffice 2.0
133     */
134    [optional, property] boolean HideInactiveSelection;
135
136	//-------------------------------------------------------------------------
137
138	/** specifies the literal mask.
139	 */
140	[property] string LiteralMask;
141
142	//-------------------------------------------------------------------------
143
144	/** specifies the maximum character count.
145     */
146	[property] short MaxTextLen;
147
148	//-------------------------------------------------------------------------
149
150	/** specifies that the control will be printed with the document.
151	 */
152	[property] boolean Printable;
153
154	//-------------------------------------------------------------------------
155
156	/** specifies that the content of the control cannot be modified by the
157        user.
158	 */
159	[property] boolean ReadOnly;
160
161	//-------------------------------------------------------------------------
162
163	/** specifies that the text is checked during the user input.
164	 */
165	[property] boolean StrictFormat;
166
167	//-------------------------------------------------------------------------
168
169	/** specifies that the control can be reached with the TAB key.
170	 */
171	[property] boolean Tabstop;
172
173	//-------------------------------------------------------------------------
174
175	/** specifies the text displayed in the control.
176	 */
177	[property] string Text;
178
179	//-------------------------------------------------------------------------
180
181	/** specifies the text color (RGB) of the control.
182	 */
183	[property] com::sun::star::util::Color TextColor;
184
185	//-------------------------------------------------------------------------
186
187	/** specifies the text line color (RGB) of the control.
188	 */
189	[property] com::sun::star::util::Color TextLineColor;
190
191    /** denotes the writing mode used in the control, as specified in the
192        <type scope="com::sun::star::text">WritingMode2</type> constants group.
193
194        <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
195        <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
196
197        @since OpenOffice 3.1
198    */
199    [optional, property] short WritingMode;
200
201    /** defines how the mouse wheel can be used to scroll through the control's content.
202
203        <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
204        and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
205        this is possible.</p>
206    */
207    [optional, property] short MouseWheelBehavior;
208
209    //-------------------------------------------------------------------------
210
211    /** specifies the vertical alignment of the text in the control.
212
213        @since OpenOffice 3.3
214	 */
215    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
216};
217
218//=============================================================================
219
220}; }; }; };
221
222#endif
223