In file include/csws/csscrbar.h:

## class csScrollBar : public csComponent

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

## Inheritance:

### Public Methods

csScrollBar(csComponent *iParent, csScrollBarFrameStyle iFrameStyle = cssfsThickRect)
  Create static component object (by default - a label) linked to another
virtual void Draw()
  Draw the scrollbar
virtual bool HandleEvent(csEvent &Event)
  Handle scroll button notifications
virtual bool SetRect(int xmin, int ymin, int xmax, int ymax)
  Set scroll button positions on resize
~csScrollBar()
  Destroy the scroll bar

### Protected Methods

void SetValue(int iValue)
  Set scroll bar value

### Private Fields

int active_button
  Active button ID
int activepixlen
  Length of active portion of scrollbar
csScrollBarFrameStyle FrameStyle
  Scroll bar frame style
bool IsHorizontal
  true if scroll bar is horizontal
int scrollerdx
  Scroller tracking initial position
static csSprite2D* sprarrows[12]
  Images of arrows
static csSprite2D* sprscroller[2]
  Image of scroller
csScrollBarStatus status
  Current scroll bar status
csTimer* timer
  The repeat timer
csButton* topleft
  The scroll buttons and the scroller
bool TrackScroller
  true if tracking scroller

### Inherited from csComponent:

### Public Fields

csApp* app
csRect bound
csVector clipchildren
csComponent* focused
unsigned int id
csComponent* next
csComponent* parent
csComponent* top

### Public Methods

void Box(int xmin, int ymin, int xmax, int ymax, int colindx)
void Center(bool iHoriz = true, bool iVert = true)
virtual void Close()
virtual void Delete(csComponent *comp)
void DeleteAll()
void DeleteClipChild(csComponent *clipchild)
void Drag(int x, int y, int DragMode)
void FindMaxFreeRect(csRect &area)
virtual void FixPosition(int &newX, int &newY)
virtual void FixSize(int &newW, int &newH)
csComponent* ForEach(bool (*func) (csComponent *child, void *param), void *param = NULL, bool Zorder = false)
csComponent* GetChild(int find_id)
csComponent* GetClipParent()
int GetColor(int Index)
csComponent* GetDefault()
int GetDragStyle()
csComponent* GetFocused()
int GetFont()
int GetState(int mask)
virtual char* GetText()
virtual void GetText(char *oText, int iTextSize)
csComponent* GetTop()
void GlobalToLocal(int &x, int &y)
bool HandleDragEvent(csEvent &Event, int BorderW, int BorderH)
virtual void Hide()
virtual void Insert(csComponent *comp)
void InsertClipChild(csComponent *clipchild)
void Invalidate(csRect &area, bool IncludeChildren = false)
void Invalidate(bool IncludeChildren = false)
void Invalidate(int xmin, int ymin, int xmax, int ymax, bool IncludeChildren = false)
void Line(float x1, float y1, float x2, float y2, int colindx)
void LocalToGlobal(int &x, int &y)
virtual bool Maximize()
virtual csComponent* NextChild(csComponent *start = NULL, bool disabled = false)
virtual csComponent* NextControl(csComponent *start = NULL)
virtual csComponent* NextGroup(csComponent *start = NULL)
void ObliqueRect3D(int xmin, int ymin, int xmax, int ymax, int cornersize, int darkindx, int lightindx)
void Pixel(int x, int y, int colindx)
virtual bool PostHandleEvent(csEvent &Event)
virtual bool PreHandleEvent(csEvent &Event)
virtual csComponent* PrevChild(csComponent *start = NULL, bool disabled = false)
virtual csComponent* PrevControl(csComponent *start = NULL)
virtual csComponent* PrevGroup(csComponent *start = NULL)
void Rect3D(int xmin, int ymin, int xmax, int ymax, int darkindx, int lightindx)
void Redraw()
virtual bool Restore()
bool Select()
void* SendCommand(int CommandCode, void *Info = NULL)
void SetApp(csApp *newapp)
void SetClipRect()
void SetClipRect(int xmin, int ymin, int xmax, int ymax)
void SetColor(int Index, int Color)
bool SetDragRect(int xmin, int ymin, int xmax, int ymax)
void SetDragStyle(int iDragStyle)
bool SetFocused(csComponent *comp)
void SetFont(int iFont, bool IncludeChildren = false)
void SetMouse(csMouseCursorID Cursor)
void SetPalette(int *iPalette, int iPaletteSize)
void SetPalette(int iPaletteID)
void SetPos(int x, int y)
void SetSize(int w, int h)
void SetSizingCursor(int dragtype)
virtual void SetState(int mask, bool enable)
virtual void SetSuggestedSize(int dw, int dh)
virtual void SetText(char *iText)
bool SetZorder(csComponent *comp, csComponent *below)
virtual void Show(bool focused = false)
void Sprite2D(csSprite2D *s2d, int x, int y)
void Sprite2D(csSprite2D *s2d, int x, int y, int w, int h)
virtual void SuggestSize(int &w, int &h)
void Text(int x, int y, int fgindx, int bgindx, char *s)
int TextHeight()
int TextWidth(char *text)

### Public

### Protected Fields

csRect clip
csComponent* clipparent
csRect dirty
static csRect dragBound
int DragStyle
static int dragX
int Font
bool Maximized
csRect OrgBound
bool originalpalette
int* palette
int state
char* text

### Protected Methods

void Clip(csObjVector &rect, csComponent *last)
void ClipAlienChildren(csObjVector &rect, csComponent *child)
void DrawUnderline(int iX, int iY, char *iText, int iUnderlinePos, int iColor)
static void PrepareLabel(char *iLabel, char * &oLabel, int &oUnderlinePos)
static int WordLeft(char *iText, int StartPos)
static int WordRight(char *iText, int StartPos)

### Inherited from csBase:

## Documentation

> 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.

`csScrollBarFrameStyle FrameStyle`
  Scroll bar frame style

`csButton* topleft`
  The scroll buttons and the scroller

`csTimer* timer`
  The repeat timer

`int active_button`
  Active button ID

`bool IsHorizontal`
  true if scroll bar is horizontal

`bool TrackScroller`
  true if tracking scroller

`int scrollerdx`
  Scroller tracking initial position

`int activepixlen`
  Length of active portion of scrollbar

`static csSprite2D* sprarrows[12]`
  Images of arrows

`static csSprite2D* sprscroller[2]`
  Image of scroller

`csScrollBarStatus status`
  Current scroll bar status

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

`~csScrollBar()`
  Destroy the scroll bar

`virtual void Draw()`
  Draw the scrollbar

`virtual bool HandleEvent(csEvent &Event)`
  Handle scroll button notifications

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

`void SetValue(int iValue)`
  Set scroll bar value

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de