offapi/com/sun/star/awt/UnoControlImageControlModel.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: UnoControlImageControlModel.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_UnoControlImageControlModel_idl__
  31 #define __com_sun_star_awt_UnoControlImageControlModel_idl__
  32
  33 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  34 #include <com/sun/star/awt/UnoControlModel.idl>
  35 #endif
  36 #ifndef __com_sun_star_util_Color_idl__
  37 #include <com/sun/star/util/Color.idl>
  38 #endif
  39 #ifndef com_sun_star_graphic_XGraphic_idl
  40 #include <com/sun/star/graphic/XGraphic.idl>
  41 #endif
  42
  43
  44 //=============================================================================
  45
  46  module com {  module sun {  module star {  module awt {
  47
  48 //=============================================================================
  49
  50 /** specifies the standard model of an <type>UnoControlImageControl</type>.
  51  */
  52 published service UnoControlImageControlModel
  53 {
  54     service com::sun::star::awt::UnoControlModel;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** specifies the background color (RGB) of the control.
  59      */
  60     [property] com::sun::star::util::Color BackgroundColor;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies the border style of the control.
  65
  66         <pre>
  67         0: No border
  68         1: 3D border
  69         2: simple border
  70         </pre>
  71      */
  72     [property] short Border;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** specifies the color of the border, if present
  77
  78         <p>Not every border style (see <member>Border</member>) may support coloring.
  79         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  80
  81         @since OOo 2.0.0
  82      */
  83     [optional, property] long BorderColor;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** determines whether the control is enabled or disabled.
  88      */
  89     [property] boolean Enabled;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** specifies the help text of the control.
  94      */
  95     [property] string HelpText;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** specifies the help URL of the control.
 100      */
 101     [property] string HelpURL;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** specifies an URL to an image to use for the control.
 106         @see Graphic
 107      */
 108     [property] string ImageURL;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** specifies a graphic to be displayed on the control
 113
 114         <p>If this property is present, it interacts with the <member>ImageURL</member>in the
 115         following way:
 116         <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
 117             to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
 118             does not point to a valid image file.</li>
 119             <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
 120             to an empty string.</li>
 121         </ul></p>
 122
 123         @since OOo 2.1
 124      */
 125     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** specifies that the control will be printed with the document.
 130      */
 131     [property] boolean Printable;
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** specifies if the image is automatically scaled to the size of the
 136         control.
 137      */
 138     [property] boolean ScaleImage;
 139
 140     /** defines how to scale the image
 141
 142         <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p>
 143
 144         <p>The value of this property is one of the <type>ImageScaleMode</type> constants.</p>
 145
 146         @since OOo 3.1
 147     */
 148     [property, optional] short ScaleMode;
 149
 150     //-------------------------------------------------------------------------
 151
 152     /** specifies that the control can be reached with the TAB key.
 153
 154         @since OOo 1.1.2
 155      */
 156     [optional, property] boolean Tabstop;
 157
 158 };
 159
 160 //=============================================================================
 161
 162 }; }; }; };
 163
 164 #endif