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