/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XScrollBar.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:53:01 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XScrollBar_idl__
#define __com_sun_star_awt_XScrollBar_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XAdjustmentListener_idl__
#include <com/sun/star/awt/XAdjustmentListener.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** gives access to the value and settings of a scroll bar and makes it possible
    to register adjustment event listeners.
 */
published interface XScrollBar: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** registers an adjustment event listener.
     */
    [oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );

    //-------------------------------------------------------------------------

    /** unregisters an adjustment event listener.
     */
    [oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l );

    //-------------------------------------------------------------------------

    /** sets the scroll value of the scroll bar.
     */
    [oneway] void setValue( [in] long n );

    //-------------------------------------------------------------------------

    /** sets the scroll value, visible area and maximum scroll value
        of the scoll bar.
     */
    [oneway] void setValues( [in] long nValue,
             [in] long nVisible,
             [in] long nMax );

    //-------------------------------------------------------------------------

    /** returns the current scroll value of the scroll bar.
     */
    long getValue();

    //-------------------------------------------------------------------------

    /** sets the maximum scroll value of the scroll bar.
     */
    [oneway] void setMaximum( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set maximum scroll value of the scroll bar.
     */
    long getMaximum();

    //-------------------------------------------------------------------------

    /** sets the increment for a single line move.
     */
    [oneway] void setLineIncrement( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set increment for a single line move.
     */
    long getLineIncrement();

    //-------------------------------------------------------------------------

    /** sets the increment for a block move.
     */
    [oneway] void setBlockIncrement( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set increment for a block move.
     */
    long getBlockIncrement();

    //-------------------------------------------------------------------------

    /** sets the visible size of the scroll bar.
     */
    [oneway] void setVisibleSize( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently visible size of the scroll bar.
     */
    long getVisibleSize();

    //-------------------------------------------------------------------------

    /** sets the <type>ScrollBarOrientation</type> of the scroll bar.
     */
    [oneway] void setOrientation( [in] long n );

    //-------------------------------------------------------------------------

    /** returns the currently set <type>ScrollBarOrientation</type> of the
        scroll bar.
     */
    long getOrientation();

};

//=============================================================================

}; }; }; };

#endif
