summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XScrollBar.idl
blob: 37f597cd0337cecaf9e73bbb153b6f53da21af94 (plain)
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
/*************************************************************************
 *
 * 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: XScrollBar.idl,v $
 * $Revision: 1.8 $
 *
 * 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_XScrollBar_idl__
#define __com_sun_star_awt_XScrollBar_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XAdjustmentListener_idl__
#include <com/sun/star/awt/XAdjustmentListener.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** gives access to the value and settings of a scroll bar and makes it possible
    to register adjustment event listeners.
 */
published interface XScrollBar: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** registers an adjustment event listener.
     */
    [oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );

    //-------------------------------------------------------------------------

    /** unregisters an adjustment event listener.
     */
    [oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );

    //-------------------------------------------------------------------------

    /** sets the scroll value of the scroll bar.
     */
    [oneway] void setValue( [in] long n );

    //-------------------------------------------------------------------------

    /** sets the scroll value, visible area and maximum scroll value
        of the scoll bar.
     */
    [oneway] void setValues( [in] long nValue,
             [in] long nVisible,
             [in] long nMax );

    //-------------------------------------------------------------------------

    /** returns the current scroll value of the scroll bar.
     */
    long getValue();

    //-------------------------------------------------------------------------

    /** sets the maximum scroll value of the scroll bar.
     */
    [oneway] void setMaximum( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set maximum scroll value of the scroll bar.
     */
    long getMaximum();

    //-------------------------------------------------------------------------

    /** sets the increment for a single line move.
     */
    [oneway] void setLineIncrement( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set increment for a single line move.
     */
    long getLineIncrement();

    //-------------------------------------------------------------------------

    /** sets the increment for a block move.
     */
    [oneway] void setBlockIncrement( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set increment for a block move.
     */
    long getBlockIncrement();

    //-------------------------------------------------------------------------

    /** sets the visible size of the scroll bar.
     */
    [oneway] void setVisibleSize( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently visible size of the scroll bar.
     */
    long getVisibleSize();

    //-------------------------------------------------------------------------

    /** sets the <type>ScrollBarOrientation</type> of the scroll bar.
     */
    [oneway] void setOrientation( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set <type>ScrollBarOrientation</type> of the
        scroll bar.
     */
    long getOrientation();

};

//=============================================================================

}; }; }; };

#endif