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