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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_UnoControlDialogModel_idl__
  20 #define __com_sun_star_awt_UnoControlDialogModel_idl__
  21
  22 #include <com/sun/star/awt/FontDescriptor.idl>
  23 #include <com/sun/star/awt/UnoControlModel.idl>
  24 #include <com/sun/star/container/XContainer.idl>
  25 #include <com/sun/star/container/XNameContainer.idl>
  26
  27 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  28 #include <com/sun/star/util/Color.idl>
  29 #include <com/sun/star/graphic/XGraphic.idl>
  30
  31
  32  module com {  module sun {  module star {  module awt {
  33
  34
  35 /** specifies the standard model of an UnoControlDialog.
  36  */
  37 published service UnoControlDialogModel
  38 {
  39     service com::sun::star::awt::UnoControlModel;
  40
  41     /** allows to create control models, which support the
  42         UnoControlDialogElement service and can be inserted into
  43         this container.
  44      */
  45     interface com::sun::star::lang::XMultiServiceFactory;
  46
  47     interface com::sun::star::container::XContainer;
  48
  49     interface com::sun::star::container::XNameContainer;
  50
  51
  52     /** specifies the background color (RGB) of the dialog.
  53      */
  54     [property] com::sun::star::util::Color BackgroundColor;
  55
  56
  57     /** specifies if the dialog is closeable.
  58      */
  59     [property] boolean Closeable;
  60
  61
  62     /** determines whether a dialog is enabled or disabled.
  63      */
  64     [property] boolean Enabled;
  65
  66
  67     /** specifies the font attributes of the text in the caption bar of the dialog.
  68      */
  69     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  70
  71
  72     /** specifies the com::sun::star::text::FontEmphasis
  73         value of the text in the caption bar of the dialog.
  74      */
  75     [property] short FontEmphasisMark;
  76
  77
  78     /** specifies the com::sun::star::text::FontRelief
  79         value of the text in the caption bar of the dialog.
  80      */
  81     [property] short FontRelief;
  82
  83
  84     /** specifies the help text of the dialog.
  85      */
  86     [property] string HelpText;
  87
  88
  89     /** specifies the help URL of the dialog.
  90      */
  91     [property] string HelpURL;
  92
  93
  94     /** specifies if the dialog is moveable.
  95      */
  96     [property] boolean Moveable;
  97
  98
  99     /** specifies if the dialog is sizeable.
 100      */
 101     [property] boolean Sizeable;
 102
 103
 104     /** specifies the text color (RGB) of the dialog.
 105      */
 106     [property] com::sun::star::util::Color TextColor;
 107
 108
 109     /** specifies the text line color (RGB) of the dialog.
 110      */
 111     [property] com::sun::star::util::Color TextLineColor;
 112
 113
 114     /** specifies the text that is displayed in the caption bar of the dialog.
 115      */
 116     [property] string Title;
 117
 118
 119     /** If set to true the dialog will have the desktop as parent.
 120
 121         @since OOo 2.3
 122      */
 123     [optional, property] boolean DesktopAsParent;
 124
 125     /** specifies a URL that references a graphic that should be used as a
 126         background image.
 127             @see Graphic
 128
 129         @since OOo 2.4
 130     */
 131     [optional, property] string ImageURL;
 132
 133     /** specifies a graphic to be displayed as a background image
 134
 135         <p>If this property is present, it interacts with the #ImageURL in the
 136         following way:
 137         <ul><li>If #ImageURL is set, #Graphic will be reset
 138             to an object as loaded from the given image URL, or `NULL` if #ImageURL
 139             does not point to a valid image file.</li>
 140             <li>If #Graphic is set, #ImageURL will be reset
 141             to an empty string.</li>
 142         </ul></p>
 143
 144         @since OOo 2.4
 145      */
 146     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 147
 148 };
 149
 150
 151 }; }; }; };
 152
 153 #endif
 154
 155 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */