offapi/com/sun/star/awt/UnoControlButtonModel.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 UnoControlButton.
  26  */
  27 published service UnoControlButtonModel
  28 {
  29     service com::sun::star::awt::UnoControlModel;
  30
  31
  32     /** specifies the horizontal alignment of the text in the control.
  33
  34         <pre>
  35         0: left
  36         1: center
  37         2: right
  38         </pre>
  39      */
  40     [optional, property] short Align;
  41
  42
  43     /** specifies the background color (RGB) of the control.
  44      */
  45     [property] com::sun::star::util::Color BackgroundColor;
  46
  47
  48     /** specifies that the button is the default button on the document.
  49      */
  50     [property] boolean DefaultButton;
  51
  52
  53     /** determines whether the control is enabled or disabled.
  54      */
  55     [property] boolean Enabled;
  56
  57
  58     /** specifies whether the button control should grab the focus when clicked.
  59
  60         <p>If set to `TRUE` (which is the default), the button control automatically grabs the
  61         focus when the user clicks onto it with the mouse.<br/>
  62         If set to `FALSE`, the focus is preserved when the user operates the button control with
  63         the mouse.</p>
  64
  65         @since OOo 2.0
  66      */
  67     [optional, property] boolean FocusOnClick;
  68
  69
  70     /** specifies the font attributes of the text in the control.
  71      */
  72     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  73
  74
  75     /** specifies the com::sun::star::text::FontEmphasis
  76         value of the text in the control.
  77      */
  78     [property] short FontEmphasisMark;
  79
  80
  81     /** specifies the com::sun::star::text::FontRelief
  82         value of the text in the control.
  83      */
  84     [property] short FontRelief;
  85
  86
  87     /** specifies the help text of the control.
  88      */
  89     [property] string HelpText;
  90
  91
  92     /** specifies the help URL of the control.
  93      */
  94     [property] string HelpURL;
  95
  96
  97     /** specifies the alignment of the image inside the button as
  98         ImageAlign value.
  99      */
 100     [property] short ImageAlign;
 101
 102
 103     /** specifies the position of the image, if any, relative to the text, if any
 104
 105         <p>Valid values of this property are specified with ImagePosition.</p>
 106
 107         <p>If this property is present, it supersedes the #ImageAlign property - setting
 108         one of both properties sets the other one to the best possible match.</p>
 109      */
 110     [optional, property] short ImagePosition;
 111
 112
 113     /** specifies a URL to an image to use for the button.
 114         @see Graphic
 115      */
 116     [property] string ImageURL;
 117
 118
 119     /** specifies a graphic to be displayed at the button
 120
 121         <p>If this property is present, it interacts with the #ImageURL in the
 122         following way:
 123         <ul><li>If #ImageURL is set, #Graphic will be reset
 124             to an object as loaded from the given image URL, or `NULL` if #ImageURL
 125             does not point to a valid image file.</li>
 126             <li>If #Graphic is set, #ImageURL will be reset
 127             to an empty string.</li>
 128         </ul></p>
 129
 130         @since OOo 2.1
 131      */
 132     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 133
 134
 135     /** specifies the label of the control.
 136      */
 137     [property] string Label;
 138
 139
 140     /** specifies that the text may be displayed on more than one line.
 141
 142         @since OOo 2.0
 143      */
 144     [optional, property] boolean MultiLine;
 145
 146
 147     /** specifies that the control will be printed with the document.
 148      */
 149     [property] boolean Printable;
 150
 151
 152     /** specifies the default action of the button as PushButtonType value.
 153      */
 154     [property] short PushButtonType;
 155
 156
 157     /** specifies whether the control should show repeating behavior.
 158
 159         <p>Normally, when you click a button with the mouse, you need to
 160         release the mouse button, and press it again. With this property
 161         set to `TRUE`, the button is repeatedly pressed while you hold
 162         down the mouse button.</p>
 163
 164         @since OOo 2.0
 165      */
 166     [optional, property] boolean Repeat;
 167
 168
 169     /** specifies the mouse repeat delay, in milliseconds.
 170
 171         <p>When the user presses a mouse in a control area where this triggers
 172         an action (such as pressing the button), then usual control implementations
 173         allow to repeatedly trigger this action, without the need to release the
 174         mouse button and to press it again. The delay between two such triggers
 175         is specified with this property.</p>
 176
 177         @since OOo 2.0
 178      */
 179     [optional, property] long RepeatDelay;
 180
 181
 182     /** specifies the state of the control.
 183
 184         If #Toggle property is set to `TRUE`, the pressed state
 185         is enabled and its pressed state can be obtained with this property.
 186
 187         <pre>
 188         0: not pressed
 189         1: pressed
 190         2: don't know
 191         </pre>
 192         @see #Toggle
 193      */
 194     [property] short State;
 195
 196
 197     /** specifies that the control can be reached with the TAB key.
 198      */
 199     [property] boolean Tabstop;
 200
 201
 202     /** specifies the text color (RGB) of the control.
 203      */
 204     [property] com::sun::star::util::Color TextColor;
 205
 206
 207     /** specifies the text line color (RGB) of the control.
 208      */
 209     [property] com::sun::star::util::Color TextLineColor;
 210
 211
 212     /** specifies whether the button should toggle on a single operation.
 213
 214         <p>If this property is set to `TRUE`, a single operation of the button control (pressing space
 215         while it is focused, or clicking onto it) toggles it between a <em>pressed</em> and a <em>not
 216         pressed</em> state.</p>
 217
 218         <p>The default for this property is `FALSE`, which means the button behaves like a usual
 219         push button.</p>
 220
 221         @since OOo 2.0
 222      */
 223     [optional, property] boolean Toggle;
 224
 225
 226     /** specifies the vertical alignment of the text in the control.
 227
 228         @since OOo 2.0
 229      */
 230     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 231
 232 };
 233
 234
 235 }; }; }; };
 236
 237 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */