offapi/com/sun/star/awt/UnoControlDialogModel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: UnoControlDialogModel.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_UnoControlDialogModel_idl__
  31 #define __com_sun_star_awt_UnoControlDialogModel_idl__
  32
  33 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  34 #include <com/sun/star/awt/FontDescriptor.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  38 #include <com/sun/star/awt/UnoControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_XContainer_idl__
  42 #include <com/sun/star/container/XContainer.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_XNameContainer_idl__
  46 #include <com/sun/star/container/XNameContainer.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  50 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_util_Color_idl__
  54 #include <com/sun/star/util/Color.idl>
  55 #endif
  56
  57 #ifndef com_sun_star_graphic_XGraphic_idl
  58 #include <com/sun/star/graphic/XGraphic.idl>
  59 #endif
  60
  61 //=============================================================================
  62
  63  module com {  module sun {  module star {  module awt {
  64
  65 //=============================================================================
  66
  67 /** specifies the standard model of an <type>UnoControlDialog</type>.
  68  */
  69 published service UnoControlDialogModel
  70 {
  71     service com::sun::star::awt::UnoControlModel;
  72
  73     /** allows to create control models, which support the
  74         <type>UnoControlDialogElement</type> service and can be inserted into
  75         this container.
  76      */
  77     interface com::sun::star::lang::XMultiServiceFactory;
  78
  79     interface com::sun::star::container::XContainer;
  80
  81     interface com::sun::star::container::XNameContainer;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** specifies the background color (RGB) of the dialog.
  86      */
  87     [property] com::sun::star::util::Color BackgroundColor;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** specifies if the dialog is closeable.
  92      */
  93     [property] boolean Closeable;
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** determines whether a dialog is enabled or disabled.
  98      */
  99     [property] boolean Enabled;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** specifies the font attributes of the text in the caption bar of the dialog.
 104      */
 105     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 110         value of the text in the caption bar of the dialog.
 111      */
 112     [property] short FontEmphasisMark;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 117         value of the text in the caption bar of the dialog.
 118      */
 119     [property] short FontRelief;
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** specifies the help text of the dialog.
 124      */
 125     [property] string HelpText;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** specifies the help URL of the dialog.
 130      */
 131     [property] string HelpURL;
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** specifies if the dialog is moveable.
 136      */
 137     [property] boolean Moveable;
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** specifies if the dialog is sizeable.
 142      */
 143     [property] boolean Sizeable;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** specifies the text color (RGB) of the dialog.
 148      */
 149     [property] com::sun::star::util::Color TextColor;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** specifies the text line color (RGB) of the dialog.
 154      */
 155     [property] com::sun::star::util::Color TextLineColor;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** specifies the text that is displayed in the caption bar of the dialog.
 160      */
 161     [property] string Title;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** If set to true the dialog will have the desktop as parent.
 166
 167         @since OOo 2.3.0
 168      */
 169     [optional, property] boolean DesktopAsParent;
 170
 171     /** specifies a URL that references a graphic that should be used as a
 172         background image.
 173             @see Graphic
 174
 175         @since OOo 2.4.0
 176     */
 177     [optional, property] string ImageURL;
 178
 179     /** specifies a graphic to be displayed as a background image
 180
 181         <p>If this property is present, it interacts with the <member>ImageURL</member>in the
 182         following way:
 183         <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
 184             to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
 185             does not point to a valid image file.</li>
 186             <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
 187             to an empty string.</li>
 188         </ul></p>
 189
 190         @since OOo 2.4.0
 191      */
 192     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 193
 194 };
 195
 196 //=============================================================================
 197
 198 }; }; }; };
 199
 200 #endif