xref: /AOO41X/main/offapi/com/sun/star/awt/UnoControlDialogModel.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_UnoControlDialogModel_idl__
24#define __com_sun_star_awt_UnoControlDialogModel_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_container_XContainer_idl__
35#include <com/sun/star/container/XContainer.idl>
36#endif
37
38#ifndef __com_sun_star_container_XNameContainer_idl__
39#include <com/sun/star/container/XNameContainer.idl>
40#endif
41
42#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
43#include <com/sun/star/lang/XMultiServiceFactory.idl>
44#endif
45
46#ifndef __com_sun_star_util_Color_idl__
47#include <com/sun/star/util/Color.idl>
48#endif
49
50#ifndef com_sun_star_graphic_XGraphic_idl
51#include <com/sun/star/graphic/XGraphic.idl>
52#endif
53
54//=============================================================================
55
56 module com {  module sun {  module star {  module awt {
57
58//=============================================================================
59
60/** specifies the standard model of an <type>UnoControlDialog</type>.
61 */
62published service UnoControlDialogModel
63{
64    service com::sun::star::awt::UnoControlModel;
65
66    /** allows to create control models, which support the
67        <type>UnoControlDialogElement</type> service and can be inserted into
68        this container.
69     */
70    interface com::sun::star::lang::XMultiServiceFactory;
71
72    interface com::sun::star::container::XContainer;
73
74    interface com::sun::star::container::XNameContainer;
75
76    //-------------------------------------------------------------------------
77
78    /** specifies the background color (RGB) of the dialog.
79     */
80    [property] com::sun::star::util::Color BackgroundColor;
81
82    //-------------------------------------------------------------------------
83
84    /** specifies if the dialog is closeable.
85     */
86    [property] boolean Closeable;
87
88    //-------------------------------------------------------------------------
89
90    /** determines whether a dialog is enabled or disabled.
91     */
92    [property] boolean Enabled;
93
94    //-------------------------------------------------------------------------
95
96    /** specifies the font attributes of the text in the caption bar of the dialog.
97     */
98    [property] com::sun::star::awt::FontDescriptor FontDescriptor;
99
100    //-------------------------------------------------------------------------
101
102    /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
103        value of the text in the caption bar of the dialog.
104     */
105    [property] short FontEmphasisMark;
106
107    //-------------------------------------------------------------------------
108
109    /** specifies the <type scope="com::sun::star::text">FontRelief</type>
110        value of the text in the caption bar of the dialog.
111     */
112    [property] short FontRelief;
113
114    //-------------------------------------------------------------------------
115
116    /** specifies the help text of the dialog.
117     */
118    [property] string HelpText;
119
120    //-------------------------------------------------------------------------
121
122    /** specifies the help URL of the dialog.
123     */
124    [property] string HelpURL;
125
126    //-------------------------------------------------------------------------
127
128    /** specifies if the dialog is moveable.
129     */
130    [property] boolean Moveable;
131
132    //-------------------------------------------------------------------------
133
134    /** specifies if the dialog is sizeable.
135     */
136    [property] boolean Sizeable;
137
138    //-------------------------------------------------------------------------
139
140    /** specifies the text color (RGB) of the dialog.
141     */
142    [property] com::sun::star::util::Color TextColor;
143
144    //-------------------------------------------------------------------------
145
146    /** specifies the text line color (RGB) of the dialog.
147     */
148    [property] com::sun::star::util::Color TextLineColor;
149
150    //-------------------------------------------------------------------------
151
152    /** specifies the text that is displayed in the caption bar of the dialog.
153     */
154    [property] string Title;
155
156    //-------------------------------------------------------------------------
157
158    /** If set to true the dialog will have the desktop as parent.
159
160        @since OpenOffice 2.3
161     */
162    [optional, property] boolean DesktopAsParent;
163
164    /** specifies a URL that references a graphic that should be used as a
165        background image.
166            @see Graphic
167
168        @since OpenOffice 2.4
169    */
170    [optional, property] string ImageURL;
171
172    /** specifies a graphic to be displayed as a background image
173
174        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
175        following way:
176        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
177            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
178            does not point to a valid image file.</li>
179            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
180            to an empty string.</li>
181        </ul></p>
182
183        @since OpenOffice 2.4
184     */
185    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
186
187};
188
189//=============================================================================
190
191}; }; }; };
192
193#endif
194