offapi/com/sun/star/awt/XScrollBar.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: XScrollBar.idl,v $
  10  * $Revision: 1.8 $
  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_XScrollBar_idl__
  31 #define __com_sun_star_awt_XScrollBar_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
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** gives access to the value and settings of a scroll bar and makes it possible
  49     to register adjustment event listeners.
  50  */
  51 published interface XScrollBar: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** registers an adjustment event listener.
  56      */
  57     [oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** unregisters an adjustment event listener.
  62      */
  63     [oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** sets the scroll value of the scroll bar.
  68      */
  69     [oneway] void setValue( [in] long n );
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** sets the scroll value, visible area and maximum scroll value
  74         of the scoll bar.
  75      */
  76     [oneway] void setValues( [in] long nValue,
  77              [in] long nVisible,
  78              [in] long nMax );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns the current scroll value of the scroll bar.
  83      */
  84     long getValue();
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** sets the maximum scroll value of the scroll bar.
  89      */
  90     [oneway] void setMaximum( [in] long n );
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** returns the currently set maximum scroll value of the scroll bar.
  95      */
  96     long getMaximum();
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** sets the increment for a single line move.
 101      */
 102     [oneway] void setLineIncrement( [in] long n );
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** returns the currently set increment for a single line move.
 107      */
 108     long getLineIncrement();
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** sets the increment for a block move.
 113      */
 114     [oneway] void setBlockIncrement( [in] long n );
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** returns the currently set increment for a block move.
 119      */
 120     long getBlockIncrement();
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** sets the visible size of the scroll bar.
 125      */
 126     [oneway] void setVisibleSize( [in] long n );
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** returns the currently visible size of the scroll bar.
 131      */
 132     long getVisibleSize();
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** sets the <type>ScrollBarOrientation</type> of the scroll bar.
 137      */
 138     [oneway] void setOrientation( [in] long n );
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** returns the currently set <type>ScrollBarOrientation</type> of the
 143         scroll bar.
 144      */
 145     long getOrientation();
 146
 147 };
 148
 149 //=============================================================================
 150
 151 }; }; }; };
 152
 153 #endif