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
  20
  21  module com {  module sun {  module star {  module awt {
  22
  23
  24 /** gives access to the value and settings of a control which is associated with
  25     a spinnable value.
  26  */
  27 interface XSpinValue : com::sun::star::uno::XInterface
  28 {
  29
  30     /** registers an adjustment event listener.
  31      */
  32     void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
  33
  34
  35     /** unregisters an adjustment event listener.
  36      */
  37     void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener listener );
  38
  39
  40     /** sets the current value of the control
  41      */
  42     void setValue( [in] long value );
  43
  44
  45     /** sets the value and value range of the control
  46
  47         @see setValue
  48         @see setMinimum
  49         @see setMaximum
  50      */
  51     void setValues( [in] long minValue, [in] long maxValue, [in] long currentValue );
  52
  53
  54     /** returns the current value of the control.
  55      */
  56     long getValue();
  57
  58
  59     /** sets the  minimum value which can be set on the control
  60      */
  61     void setMinimum( [in] long minValue );
  62
  63
  64     /** sets the  maximum value which can be set on the control
  65      */
  66     void setMaximum( [in] long maxValue );
  67
  68
  69     /** returns the currently set minimum value of the control
  70      */
  71     long getMinimum();
  72
  73
  74     /** returns the currently set maximum value of the control
  75      */
  76     long getMaximum();
  77
  78
  79     /** sets the value by which the current value of the control
  80         should be incremented or decremented upon spinning.
  81      */
  82     void setSpinIncrement( [in] long spinIncrement );
  83
  84
  85     /** returns the value by which the current value of the control
  86         should be incremented or decremented upon spinning.
  87      */
  88     long getSpinIncrement();
  89
  90
  91     /** controls the orientation of the control
  92         @param orientation
  93             one of the ScrollBarOrientation values specifying the orientation
  94         @throws com::sun::star::lang::NoSupportException
  95             in case the given orientation is not supported
  96      */
  97     void setOrientation( [in] long orientation )
  98             raises( com::sun::star::lang::NoSupportException );
  99
 100
 101     /** returns the current orientation of the control
 102      */
 103     long getOrientation();
 104
 105 };
 106
 107
 108 }; }; }; };
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */