summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XSpinValue.idl
blob: 155b036d9beeb2a71c814f740da81ae5a40048d2 (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
/*************************************************************************
 *
 * 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: XSpinValue.idl,v $
 * $Revision: 1.4 $
 *
 * 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_XSpinValue_idl__
#define __com_sun_star_awt_XSpinValue_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

#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif

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

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

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

/** gives access to the value and settings of a control which is associated with
    a spinnable value.
 */
interface XSpinValue : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

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

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

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

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

    /** sets the current value of the control
     */
    [oneway] void setValue( [in] long value );

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

    /** sets the value and value range of the control

        @see setValue
        @see setMinimum
        @see setMaximum
     */
    [oneway] void setValues( [in] long minValue, [in] long maxValue, [in] long currentValue );

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

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

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

    /** sets the  minimum value which can be set on the control
     */
    [oneway] void setMinimum( [in] long minValue );

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

    /** sets the  maximum value which can be set on the control
     */
    [oneway] void setMaximum( [in] long maxValue );

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

    /** returns the currently set minimum value of the control
     */
    long getMinimum();

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

    /** returns the currently set maximum value of the control
     */
    long getMaximum();

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

    /** sets the value by which the current value of the control
        should be incremented or decremented upon spinning.
     */
    [oneway] void setSpinIncrement( [in] long spinIncrement );

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

    /** returns the value by which the current value of the control
        should be incremented or decremented upon spinning.
     */
    long getSpinIncrement();

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

    /** controls the orientation of the control
        @param orientation
            one of the <type>ScrollBarOrientation</type> values specifying the orientation
        @throws com::sun::star::lang::NoSupportException
            in case the given orientation is not supported
     */
    void setOrientation( [in] long orientation )
            raises( com::sun::star::lang::NoSupportException );

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

    /** returns the current orientation of the control
     */
    long getOrientation();

};

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

}; }; }; };

#endif