Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

csScrollBar Class Reference

The ScrollBar component class is used to scroll left/right or up/down windows whose content does not fit into their size. More...

#include <csscrbar.h>

Inheritance diagram for csScrollBar:

csComponent List of all members.

Public Methods

 csScrollBar (csComponent *iParent, csScrollBarFrameStyle iFrameStyle=cssfsThickRect)
 Create static component object (by default - a label) linked to another.

virtual ~csScrollBar ()
 Destroy the scroll bar.

virtual bool HandleEvent (iEvent &Event)
 Handle scroll button notifications.

virtual bool SetRect (int xmin, int ymin, int xmax, int ymax)
 Set scroll button positions on resize.

virtual void SetState (int mask, bool enable)
 Override SetState method to disable scroll buttons as well.

csScrollBarFrameStyle GetFrameStyle ()
 Get frame style.

int GetActiveButton ()
 Get active button.

bool GetIsHorizontal ()
 Returns true if scrollbar is horizontal.

csButtonGetScroller ()
 Get the scroller button.

csButtonGetTopLeft ()
 Get the top or left arrow button.

csButtonGetBotRight ()
 Get the bottom or right arrow button.

virtual char* GetSkinName ()
 Get the name of the skip slice for this component.


Protected Methods

void SetValue (int iValue)
 Set scroll bar value.


Detailed Description

The ScrollBar component class is used to scroll left/right or up/down windows whose content does not fit into their size.

If scroll bar's width is bigger than its height, it becomes a horizontal scroll bar, otherwise it is a vertical scroll bar. A scroll bar notifies its parent with a command event when user requests (using mouse) to scroll window contents. Parent can set scroll bar's position/range using command messages.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000