xref: /AOO41X/main/offapi/com/sun/star/awt/UnoControlFileControlModel.idl (revision d1e7efc3a14909e0a68c915b160c0a3adcc02b1f)
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_UnoControlFileControlModel_idl__
24#define __com_sun_star_awt_UnoControlFileControlModel_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>UnoControlFileControl</type>.
49 */
50published service UnoControlFileControlModel
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    /** determines whether a control is enabled or disabled.
86     */
87    [property] boolean Enabled;
88
89    //-------------------------------------------------------------------------
90
91    /** specifies the font attributes of the text in the control.
92     */
93    [property] com::sun::star::awt::FontDescriptor FontDescriptor;
94
95    //-------------------------------------------------------------------------
96
97    /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
98        value of the text in the control.
99     */
100    [property] short FontEmphasisMark;
101
102    //-------------------------------------------------------------------------
103
104    /** specifies the <type scope="com::sun::star::text">FontRelief</type>
105        value of the text in the control.
106     */
107    [property] short FontRelief;
108
109    //-------------------------------------------------------------------------
110
111    /** specifies the help text of the control.
112     */
113    [property] string HelpText;
114
115    //-------------------------------------------------------------------------
116
117    /** specifies the help URL of the control.
118     */
119    [property] string HelpURL;
120
121    //-------------------------------------------------------------------------
122
123    /** specifies whether the selection in the control should be hidden when
124        the control is not active (focused).
125
126        @since OpenOffice 2.0
127    */
128    [optional, property] boolean HideInactiveSelection;
129
130    //-------------------------------------------------------------------------
131
132    /** specifies that the control will be printed with the document.
133     */
134    [property] boolean Printable;
135
136    //-------------------------------------------------------------------------
137
138    /** specifies that the content of the control cannot be modified by the user.
139
140        @since OpenOffice 1.1.2
141     */
142    [optional, property] boolean ReadOnly;
143
144    //-------------------------------------------------------------------------
145
146    /** specifies that the control can be reached with the TAB key.
147     */
148    [property] boolean Tabstop;
149
150    //-------------------------------------------------------------------------
151
152    /** specifies the text displayed in the control.
153     */
154    [property] string Text;
155
156    //-------------------------------------------------------------------------
157
158    /** specifies the text color (RGB) of the control.
159     */
160    [property] com::sun::star::util::Color TextColor;
161
162    //-------------------------------------------------------------------------
163
164    /** specifies the text line color (RGB) of the control.
165     */
166    [property] com::sun::star::util::Color TextLineColor;
167
168    //-------------------------------------------------------------------------
169
170    /** specifies the vertical alignment of the text in the control.
171
172        @since OpenOffice 3.3
173     */
174    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
175};
176
177//=============================================================================
178
179}; }; }; };
180
181#endif
182