offapi/com/sun/star/awt/XScrollBar.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_XScrollBar_idl__
  20 #define __com_sun_star_awt_XScrollBar_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XAdjustmentListener.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** gives access to the value and settings of a scroll bar and makes it possible
  32     to register adjustment event listeners.
  33  */
  34 published interface XScrollBar: com::sun::star::uno::XInterface
  35 {
  36
  37     /** registers an adjustment event listener.
  38      */
  39     void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );
  40
  41
  42     /** unregisters an adjustment event listener.
  43      */
  44     void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );
  45
  46
  47     /** sets the scroll value of the scroll bar.
  48      */
  49     void setValue( [in] long n );
  50
  51
  52     /** sets the scroll value, visible area and maximum scroll value
  53         of the scroll bar.
  54      */
  55     void setValues( [in] long nValue,
  56              [in] long nVisible,
  57              [in] long nMax );
  58
  59
  60     /** returns the current scroll value of the scroll bar.
  61      */
  62     long getValue();
  63
  64
  65     /** sets the maximum scroll value of the scroll bar.
  66      */
  67     void setMaximum( [in] long n );
  68
  69
  70     /** returns the currently set maximum scroll value of the scroll bar.
  71      */
  72     long getMaximum();
  73
  74
  75     /** sets the increment for a single line move.
  76      */
  77     void setLineIncrement( [in] long n );
  78
  79
  80     /** returns the currently set increment for a single line move.
  81      */
  82     long getLineIncrement();
  83
  84
  85     /** sets the increment for a block move.
  86      */
  87     void setBlockIncrement( [in] long n );
  88
  89
  90     /** returns the currently set increment for a block move.
  91      */
  92     long getBlockIncrement();
  93
  94
  95     /** sets the visible size of the scroll bar.
  96      */
  97     void setVisibleSize( [in] long n );
  98
  99
 100     /** returns the currently visible size of the scroll bar.
 101      */
 102     long getVisibleSize();
 103
 104
 105     /** sets the ScrollBarOrientation of the scroll bar.
 106      */
 107     void setOrientation( [in] long n );
 108
 109
 110     /** returns the currently set ScrollBarOrientation of the
 111         scroll bar.
 112      */
 113     long getOrientation();
 114
 115 };
 116
 117
 118 }; }; }; };
 119
 120 #endif
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */