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