offapi/com/sun/star/awt/XSpinValue.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSpinValue.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XSpinValue_idl__
  31 #define __com_sun_star_awt_XSpinValue_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XAdjustmentListener_idl__
  38 #include <com/sun/star/awt/XAdjustmentListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_NoSupportException_idl__
  42 #include <com/sun/star/lang/NoSupportException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module awt {
  48
  49 //=============================================================================
  50
  51 /** gives access to the value and settings of a control which is associated with
  52     a spinnable value.
  53  */
  54 interface XSpinValue : com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** registers an adjustment event listener.
  59      */
  60     [oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** unregisters an adjustment event listener.
  65      */
  66     [oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** sets the current value of the control
  71      */
  72     [oneway] void setValue( [in] long value );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** sets the value and value range of the control
  77
  78         @see setValue
  79         @see setMinimum
  80         @see setMaximum
  81      */
  82     [oneway] void setValues( [in] long minValue, [in] long maxValue, [in] long currentValue );
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** returns the current value of the control.
  87      */
  88     long getValue();
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** sets the  minimum value which can be set on the control
  93      */
  94     [oneway] void setMinimum( [in] long minValue );
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** sets the  maximum value which can be set on the control
  99      */
 100     [oneway] void setMaximum( [in] long maxValue );
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** returns the currently set minimum value of the control
 105      */
 106     long getMinimum();
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** returns the currently set maximum value of the control
 111      */
 112     long getMaximum();
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** sets the value by which the current value of the control
 117         should be incremented or decremented upon spinning.
 118      */
 119     [oneway] void setSpinIncrement( [in] long spinIncrement );
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** returns the value by which the current value of the control
 124         should be incremented or decremented upon spinning.
 125      */
 126     long getSpinIncrement();
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** controls the orientation of the control
 131         @param orientation
 132             one of the <type>ScrollBarOrientation</type> values specifying the orientation
 133         @throws com::sun::star::lang::NoSupportException
 134             in case the given orientation is not supported
 135      */
 136     void setOrientation( [in] long orientation )
 137             raises( com::sun::star::lang::NoSupportException );
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** returns the current orientation of the control
 142      */
 143     long getOrientation();
 144
 145 };
 146
 147 //=============================================================================
 148
 149 }; }; }; };
 150
 151 #endif