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

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