1998-04-14 00:24:54 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Netscape Public License
|
|
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
|
|
* http://www.mozilla.org/NPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* NPL.
|
|
|
|
*
|
|
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
|
|
* Communications Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
|
|
* Reserved.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef nsIScrollbar_h__
|
|
|
|
#define nsIScrollbar_h__
|
|
|
|
|
|
|
|
#include "nsIWidget.h"
|
|
|
|
|
|
|
|
// {18032AD2-B265-11d1-AA2A-000000000000}
|
|
|
|
#define NS_ISCROLLBAR_IID \
|
|
|
|
{ 0x18032ad2, 0xb265, 0x11d1, \
|
|
|
|
{ 0xaa, 0x2a, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }
|
|
|
|
|
1998-04-14 04:31:59 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
*
|
1998-04-15 01:33:43 +04:00
|
|
|
* Scrollbar, converts mouse input into values that can be used
|
|
|
|
* to shift the contents of a window.
|
1998-04-14 04:31:59 +04:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
class nsIScrollbar : public nsIWidget
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the scrollbar range
|
|
|
|
* @param aEndRange set range for scrollbar from 0 to aEndRange
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
virtual void SetMaxRange(PRUint32 aEndRange) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the scrollbar range
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return the upper end of the scrollbar range
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
|
|
|
virtual PRUint32 GetMaxRange() = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the thumb position.
|
|
|
|
* @param aPos a value between (startRange) and (endRange - thumbSize)
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
virtual void SetPosition(PRUint32 aPos) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the thumb position.
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return a value between (startRange) and (endRange - thumbSize)
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
virtual PRUint32 GetPosition() = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the thumb size.
|
|
|
|
* @param aSize size of the thumb. Must be a value between
|
|
|
|
* startRange and endRange
|
|
|
|
*/
|
|
|
|
virtual void SetThumbSize(PRUint32 aSize) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the thumb size.
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return size of the thumb. The value is between
|
1998-04-14 00:24:54 +04:00
|
|
|
* startRange and endRange
|
|
|
|
*/
|
|
|
|
virtual PRUint32 GetThumbSize() = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the line increment.
|
|
|
|
* @param aSize size of the line increment. The value must
|
|
|
|
* be between startRange and endRange
|
|
|
|
*/
|
|
|
|
virtual void SetLineIncrement(PRUint32 aSize) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the line increment.
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return size of the line increment. The value is
|
1998-04-14 00:24:54 +04:00
|
|
|
* between startRange and endRange
|
|
|
|
*/
|
|
|
|
virtual PRUint32 GetLineIncrement() = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set all scrollbar parameters at once
|
|
|
|
* @param aMaxRange set range for scrollbar from 0 to aMaxRange
|
|
|
|
* @param aThumbSize size of the thumb. Must be a value between
|
|
|
|
* startRange and endRange
|
|
|
|
* @param aPosition a value between (startRange) and (endRange - thumbSize)
|
|
|
|
* @param aLineIncrement size of the line increment. The value must
|
|
|
|
* be between startRange and endRange
|
|
|
|
*/
|
|
|
|
virtual void SetParameters(PRUint32 aMaxRange, PRUint32 aThumbSize,
|
|
|
|
PRUint32 aPosition, PRUint32 aLineIncrement) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // nsIScrollbar_h__
|