offapi/com/sun/star/awt/UnoControlSpinButtonModel.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 UnoControlSpinButton.
  26
  27     <p>A spin button is a control which has a numeric value associated with it,
  28     and allows to change this value using two spin buttons.</p>
  29
  30     <p>A spin button is similar to a scroll bar, but it usually has no
  31     (own) visual representation of the associated value, but is used to propagate
  32     its value to other controls.</p>
  33
  34     @see UnoControlScrollBarModel
  35  */
  36 service UnoControlSpinButtonModel
  37 {
  38     service com::sun::star::awt::UnoControlModel;
  39
  40
  41     /** specifies the border style of the control.
  42
  43         <pre>
  44         0: No border
  45         1: 3D border
  46         2: simple border
  47         </pre>
  48      */
  49     [property] short Border;
  50
  51
  52     /** specifies the color of the border, if present
  53
  54         <p>Not every border style (see #Border) may support coloring.
  55         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  56
  57         @since OOo 2.0
  58      */
  59     [optional, property] long BorderColor;
  60
  61
  62     /** determines whether the control is enabled or disabled.
  63      */
  64     [property] boolean Enabled;
  65
  66
  67     /** specifies the help text of the control.
  68      */
  69     [property] string HelpText;
  70
  71
  72     /** specifies the help URL of the control.
  73      */
  74     [property] string HelpURL;
  75
  76
  77     /** specifies the increment by which the value is changed when using operating
  78         the spin button.
  79      */
  80     [property] long SpinIncrement;
  81
  82
  83     /** specifies the ScrollBarOrientation of the control.
  84      */
  85     [property] long Orientation;
  86
  87
  88     /** specifies whether the control will be printed with the document.
  89      */
  90     [property] boolean Printable;
  91
  92
  93     /** specifies the current value of the control.
  94      */
  95     [property] long SpinValue;
  96
  97
  98     /** specifies the minimum value of the control.
  99     */
 100     [property] long SpinValueMin;
 101
 102
 103     /** specifies the maximum value of the control.
 104      */
 105     [property] long SpinValueMax;
 106
 107
 108     /** specifies the RGB color to be used for the control
 109     */
 110     [property] com::sun::star::util::Color BackgroundColor;
 111
 112
 113     /** specifies the RGB color to be used when painting symbols which are
 114         part of the control's appearance, such as the arrow buttons.
 115     */
 116     [property] com::sun::star::util::Color SymbolColor;
 117
 118
 119     /** specifies whether the mouse should show repeating behavior, i.e.
 120         repeatedly trigger an action when keeping pressed.
 121     */
 122     [property] boolean Repeat;
 123
 124
 125     /** specifies the mouse repeat delay, in milliseconds.
 126
 127         <p>When the user presses a mouse in a control area where this triggers
 128         an action (such as spinning the value), then usual control implementations
 129         allow to repeatedly trigger this action, without the need to release the
 130         mouse button and to press it again. The delay between two such triggers
 131         is specified with this property.</p>
 132     */
 133     [property] long RepeatDelay;
 134
 135     /** defines how the mouse wheel can be used to scroll through the control's content.
 136
 137         <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
 138         and one of the MouseWheelBehavior constants, you can control under which circumstances
 139         this is possible.</p>
 140     */
 141     [optional, property] short MouseWheelBehavior;
 142 };
 143
 144
 145 }; }; }; };
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */