summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XSpinValue.idl
blob: d2bc7450d51eacccd7cd9b135bcabfa5cafa03b5 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_awt_XSpinValue_idl__
#define __com_sun_star_awt_XSpinValue_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/awt/XAdjustmentListener.idl>
#include <com/sun/star/lang/NoSupportException.idl>

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

 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */