xref: /aoo42x/main/offapi/com/sun/star/awt/XSpinValue.idl (revision d5bd2f9e)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XSpinValue_idl__
24#define __com_sun_star_awt_XSpinValue_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_awt_XAdjustmentListener_idl__
31#include <com/sun/star/awt/XAdjustmentListener.idl>
32#endif
33
34#ifndef __com_sun_star_lang_NoSupportException_idl__
35#include <com/sun/star/lang/NoSupportException.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module awt {
41
42//=============================================================================
43
44/** gives access to the value and settings of a control which is associated with
45    a spinnable value.
46 */
47interface XSpinValue : com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50
51	/** registers an adjustment event listener.
52	 */
53	[oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
54
55	//-------------------------------------------------------------------------
56
57	/** unregisters an adjustment event listener.
58	 */
59	[oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
60
61	//-------------------------------------------------------------------------
62
63	/** sets the current value of the control
64	 */
65	[oneway] void setValue( [in] long value );
66
67	//-------------------------------------------------------------------------
68
69	/** sets the value and value range of the control
70
71        @see setValue
72        @see setMinimum
73        @see setMaximum
74	 */
75	[oneway] void setValues( [in] long minValue, [in] long maxValue, [in] long currentValue );
76
77	//-------------------------------------------------------------------------
78
79	/** returns the current value of the control.
80	 */
81	long getValue();
82
83	//-------------------------------------------------------------------------
84
85	/** sets the  minimum value which can be set on the control
86	 */
87	[oneway] void setMinimum( [in] long minValue );
88
89	//-------------------------------------------------------------------------
90
91	/** sets the  maximum value which can be set on the control
92	 */
93	[oneway] void setMaximum( [in] long maxValue );
94
95	//-------------------------------------------------------------------------
96
97	/** returns the currently set minimum value of the control
98	 */
99	long getMinimum();
100
101	//-------------------------------------------------------------------------
102
103	/** returns the currently set maximum value of the control
104	 */
105	long getMaximum();
106
107	//-------------------------------------------------------------------------
108
109	/** sets the value by which the current value of the control
110        should be incremented or decremented upon spinning.
111	 */
112	[oneway] void setSpinIncrement( [in] long spinIncrement );
113
114	//-------------------------------------------------------------------------
115
116	/** returns the value by which the current value of the control
117        should be incremented or decremented upon spinning.
118	 */
119	long getSpinIncrement();
120
121	//-------------------------------------------------------------------------
122
123	/** controls the orientation of the control
124        @param orientation
125            one of the <type>ScrollBarOrientation</type> values specifying the orientation
126        @throws com::sun::star::lang::NoSupportException
127            in case the given orientation is not supported
128	 */
129	void setOrientation( [in] long orientation )
130			raises( com::sun::star::lang::NoSupportException );
131
132	//-------------------------------------------------------------------------
133
134	/** returns the current orientation of the control
135	 */
136	long getOrientation();
137
138};
139
140//=============================================================================
141
142}; }; }; };
143
144#endif
145