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