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