xref: /aoo4110/main/offapi/com/sun/star/awt/XScrollBar.idl (revision b1cdbd2c)
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_XScrollBar_idl__
24#define __com_sun_star_awt_XScrollBar_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
35//=============================================================================
36
37 module com {  module sun {  module star {  module awt {
38
39//=============================================================================
40
41/** gives access to the value and settings of a scroll bar and makes it possible
42	to register adjustment event listeners.
43 */
44published interface XScrollBar: com::sun::star::uno::XInterface
45{
46	//-------------------------------------------------------------------------
47
48	/** registers an adjustment event listener.
49	 */
50	[oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );
51
52	//-------------------------------------------------------------------------
53
54	/** unregisters an adjustment event listener.
55	 */
56	[oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );
57
58	//-------------------------------------------------------------------------
59
60	/** sets the scroll value of the scroll bar.
61	 */
62	[oneway] void setValue( [in] long n );
63
64	//-------------------------------------------------------------------------
65
66	/** sets the scroll value, visible area and maximum scroll value
67        of the scoll bar.
68	 */
69	[oneway] void setValues( [in] long nValue,
70			 [in] long nVisible,
71			 [in] long nMax );
72
73	//-------------------------------------------------------------------------
74
75	/** returns the current scroll value of the scroll bar.
76	 */
77	long getValue();
78
79	//-------------------------------------------------------------------------
80
81	/** sets the maximum scroll value of the scroll bar.
82	 */
83	[oneway] void setMaximum( [in] long n );
84
85	//-------------------------------------------------------------------------
86
87	/** returns the currently set maximum scroll value of the scroll bar.
88	 */
89	long getMaximum();
90
91	//-------------------------------------------------------------------------
92
93	/** sets the increment for a single line move.
94	 */
95	[oneway] void setLineIncrement( [in] long n );
96
97	//-------------------------------------------------------------------------
98
99	/** returns the currently set increment for a single line move.
100	 */
101	long getLineIncrement();
102
103	//-------------------------------------------------------------------------
104
105	/** sets the increment for a block move.
106	 */
107	[oneway] void setBlockIncrement( [in] long n );
108
109	//-------------------------------------------------------------------------
110
111	/** returns the currently set increment for a block move.
112	 */
113	long getBlockIncrement();
114
115	//-------------------------------------------------------------------------
116
117	/** sets the visible size of the scroll bar.
118	 */
119	[oneway] void setVisibleSize( [in] long n );
120
121	//-------------------------------------------------------------------------
122
123	/** returns the currently visible size of the scroll bar.
124	 */
125	long getVisibleSize();
126
127	//-------------------------------------------------------------------------
128
129	/** sets the <type>ScrollBarOrientation</type> of the scroll bar.
130	 */
131	[oneway] void setOrientation( [in] long n );
132
133	//-------------------------------------------------------------------------
134
135	/** returns the currently set <type>ScrollBarOrientation</type> of the
136        scroll bar.
137	 */
138	long getOrientation();
139
140};
141
142//=============================================================================
143
144}; }; }; };
145
146#endif
147