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