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

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