csScrollBar Class Reference
[Scroll bar]
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:

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. | |
csButton * | GetScroller () |
Get the scroller button. | |
csButton * | GetTopLeft () |
Get the top or left arrow button. | |
csButton * | GetBotRight () |
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.
Definition at line 110 of file csscrbar.h.
Constructor & Destructor Documentation
|
Create static component object (by default - a label) linked to another.
|
|
Destroy the scroll bar.
|
Member Function Documentation
|
Get active button.
Definition at line 160 of file csscrbar.h. |
|
Get the bottom or right arrow button.
Definition at line 176 of file csscrbar.h. |
|
Get frame style.
Definition at line 156 of file csscrbar.h. References csScrollBarFrameStyle. |
|
Returns true if scrollbar is horizontal.
Definition at line 164 of file csscrbar.h. |
|
Get the scroller button.
Definition at line 168 of file csscrbar.h. |
|
Get the name of the skip slice for this component.
Reimplemented from csComponent. Definition at line 180 of file csscrbar.h. |
|
Get the top or left arrow button.
Definition at line 172 of file csscrbar.h. |
|
Handle scroll button notifications.
Reimplemented from csComponent. |
|
Set scroll button positions on resize.
Reimplemented from csComponent. |
|
Override SetState method to disable scroll buttons as well.
Reimplemented from csComponent. |
|
Set scroll bar value.
|
The documentation for this class was generated from the following file:
- csws/csscrbar.h
Generated for Crystal Space by doxygen 1.2.18