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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XSpinValue_idl__
  20 #define __com_sun_star_awt_XSpinValue_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/awt/XAdjustmentListener.idl>
  24 #include <com/sun/star/lang/NoSupportException.idl>
  25
  26
  27  module com {  module sun {  module star {  module awt {
  28
  29
  30 /** gives access to the value and settings of a control which is associated with
  31     a spinnable value.
  32  */
  33 interface XSpinValue : com::sun::star::uno::XInterface
  34 {
  35
  36     /** registers an adjustment event listener.
  37      */
  38     void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
  39
  40
  41     /** unregisters an adjustment event listener.
  42      */
  43     void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
  44
  45
  46     /** sets the current value of the control
  47      */
  48     void setValue( [in] long value );
  49
  50
  51     /** sets the value and value range of the control
  52
  53         @see setValue
  54         @see setMinimum
  55         @see setMaximum
  56      */
  57     void setValues( [in] long minValue, [in] long maxValue, [in] long currentValue );
  58
  59
  60     /** returns the current value of the control.
  61      */
  62     long getValue();
  63
  64
  65     /** sets the  minimum value which can be set on the control
  66      */
  67     void setMinimum( [in] long minValue );
  68
  69
  70     /** sets the  maximum value which can be set on the control
  71      */
  72     void setMaximum( [in] long maxValue );
  73
  74
  75     /** returns the currently set minimum value of the control
  76      */
  77     long getMinimum();
  78
  79
  80     /** returns the currently set maximum value of the control
  81      */
  82     long getMaximum();
  83
  84
  85     /** sets the value by which the current value of the control
  86         should be incremented or decremented upon spinning.
  87      */
  88     void setSpinIncrement( [in] long spinIncrement );
  89
  90
  91     /** returns the value by which the current value of the control
  92         should be incremented or decremented upon spinning.
  93      */
  94     long getSpinIncrement();
  95
  96
  97     /** controls the orientation of the control
  98         @param orientation
  99             one of the ScrollBarOrientation values specifying the orientation
 100         @throws com::sun::star::lang::NoSupportException
 101             in case the given orientation is not supported
 102      */
 103     void setOrientation( [in] long orientation )
 104             raises( com::sun::star::lang::NoSupportException );
 105
 106
 107     /** returns the current orientation of the control
 108      */
 109     long getOrientation();
 110
 111 };
 112
 113
 114 }; }; }; };
 115
 116 #endif
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */