1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_UnoControlSpinButtonModel_idl__
28#define __com_sun_star_awt_UnoControlSpinButtonModel_idl__
29
30#ifndef __com_sun_star_awt_UnoControlModel_idl__
31#include <com/sun/star/awt/UnoControlModel.idl>
32#endif
33
34#ifndef __com_sun_star_util_Color_idl__
35#include <com/sun/star/util/Color.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module awt {
42
43//=============================================================================
44
45/** specifies the standard model of an <type>UnoControlSpinButton</type>.
46
47    <p>A spin button is a control which has a numeric value associated with it,
48    and allows to change this value using two spin buttons.</p>
49
50    <p>A spin button is similar to a scroll bar, but it usually has no
51    (own) visual representation of the associated value, but is used to propagate
52    it's value to other controls.</p>
53
54    @see UnoControlScrollBarModel
55 */
56service UnoControlSpinButtonModel
57{
58	service com::sun::star::awt::UnoControlModel;
59
60	//-------------------------------------------------------------------------
61
62	/** specifies the border style of the control.
63
64		<pre>
65		0: No border
66		1: 3D border
67		2: simple border
68		</pre>
69	 */
70	[property] short Border;
71
72	//-------------------------------------------------------------------------
73
74	/** specifies the color of the border, if present
75
76        <p>Not every border style (see <member>Border</member>) may support coloring.
77        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
78
79        @since OOo 2.0
80	 */
81	[optional, property] long BorderColor;
82
83	//-------------------------------------------------------------------------
84
85	/** determines whether the control is enabled or disabled.
86	 */
87	[property] boolean Enabled;
88
89	//-------------------------------------------------------------------------
90
91	/** specifies the help text of the control.
92	 */
93	[property] string HelpText;
94
95	//-------------------------------------------------------------------------
96
97	/** specifies the help URL of the control.
98	 */
99	[property] string HelpURL;
100
101	//-------------------------------------------------------------------------
102
103	/** specifies the increment by which the value is changed when using operating
104        the spin button.
105	 */
106	[property] long SpinIncrement;
107
108	//-------------------------------------------------------------------------
109
110	/** specifies the <type>ScrollBarOrientation</type> of the control.
111	 */
112	[property] long Orientation;
113
114	//-------------------------------------------------------------------------
115
116	/** specifies whether the control will be printed with the document.
117	 */
118	[property] boolean Printable;
119
120	//-------------------------------------------------------------------------
121
122	/** specifies the current value of the control.
123	 */
124	[property] long SpinValue;
125
126	//-------------------------------------------------------------------------
127
128    /** specifies the minimum value of the control.
129    */
130	[property] long SpinValueMin;
131
132	//-------------------------------------------------------------------------
133
134	/** specifies the maximum value of the control.
135	 */
136	[property] long SpinValueMax;
137
138	//-------------------------------------------------------------------------
139
140	/** specifies the RGB color to be used for the control
141    */
142	[property] com::sun::star::util::Color BackgroundColor;
143
144    //-------------------------------------------------------------------------
145
146	/** specifies the RGB color to be used when painting symbols which are
147        part of the control's appearance, such as the arrow buttons.
148    */
149	[property] com::sun::star::util::Color SymbolColor;
150
151    //-------------------------------------------------------------------------
152
153	/** specifies whether the mouse should show repeating behaviour, i.e.
154        repeatedly trigger an action when keeping pressed.
155    */
156    [property] boolean Repeat;
157
158    //-------------------------------------------------------------------------
159
160	/** specifies the mouse repeat delay, in milliseconds.
161
162        <p>When the user presses a mouse in a control area where this triggers
163        an action (such as spinning the value), then usual control implementations
164        allow to repeatedly trigger this action, without the need to release the
165        mouse button and to press it again. The delay between two such triggers
166        is specified with this property.</p>
167    */
168	[property] long RepeatDelay;
169
170    /** defines how the mouse wheel can be used to scroll through the control's content.
171
172        <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
173        and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
174        this is possible.</p>
175    */
176    [optional, property] short MouseWheelBehavior;
177};
178
179//=============================================================================
180
181}; }; }; };
182
183#endif
184