CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

csStatic Class Reference
[Static control]

The Static component class represents a decorative control (widget) which usually does not have functionality, but serves as a decoration. More...

#include <csws/csstatic.h>

Inheritance diagram for csStatic:

csComponent csColorWheel List of all members.

Public Member Functions

 csStatic (csComponent *iParent, csComponent *iLink, const char *iText, csStaticStyle iStyle=csscsLabel)
 Create static component object (by default - a label) linked to another.
 csStatic (csComponent *iParent, csStaticStyle iStyle=csscsRectangle)
 Create static component object without text (by default - a rectangle).
 csStatic (csComponent *iParent, csPixmap *iBitmap)
 Create static bitmap object.
virtual ~csStatic ()
 Destroy the static object.
virtual void SetText (const char *iText)
 Set static component text.
virtual void Draw ()
 Draw the static component.
virtual bool HandleEvent (iEvent &Event)
 Handle input events.
virtual bool PostHandleEvent (iEvent &Event)
 Pre-handle input events.
virtual void SuggestSize (int &w, int &h)
 Return the recommended minimal size of static object.
void SetTextAlign (int iTextAlignment)
 Set text alignment (only for csscsText style).
void SetLink (csComponent *iLink)
 Set linked component.

Detailed Description

The Static component class represents a decorative control (widget) which usually does not have functionality, but serves as a decoration.

Static controls can be created of many different styles (see csStaticStyle definition above), and they can look completely different one from another. The only common 'function' of all static controls is that they can act as 'dialog labels', i.e. the text assigned to a static component can contain a 'hot' letter, and if you press 'Alt+letter' the first selectable component following the static one will be activated.

Definition at line 128 of file csstatic.h.


Constructor & Destructor Documentation

csStatic::csStatic csComponent iParent,
csComponent iLink,
const char *  iText,
csStaticStyle  iStyle = csscsLabel
 

Create static component object (by default - a label) linked to another.

csStatic::csStatic csComponent iParent,
csStaticStyle  iStyle = csscsRectangle
 

Create static component object without text (by default - a rectangle).

csStatic::csStatic csComponent iParent,
csPixmap iBitmap
 

Create static bitmap object.

virtual csStatic::~csStatic  )  [virtual]
 

Destroy the static object.


Member Function Documentation

virtual void csStatic::Draw  )  [virtual]
 

Draw the static component.

Reimplemented from csComponent.

Reimplemented in csColorWheel.

virtual bool csStatic::HandleEvent iEvent Event  )  [virtual]
 

Handle input events.

Reimplemented from csComponent.

Reimplemented in csColorWheel.

virtual bool csStatic::PostHandleEvent iEvent Event  )  [virtual]
 

Pre-handle input events.

Reimplemented from csComponent.

void csStatic::SetLink csComponent iLink  )  [inline]
 

Set linked component.

Definition at line 180 of file csstatic.h.

virtual void csStatic::SetText const char *  iText  )  [virtual]
 

Set static component text.

Reimplemented from csComponent.

void csStatic::SetTextAlign int  iTextAlignment  )  [inline]
 

Set text alignment (only for csscsText style).

Definition at line 176 of file csstatic.h.

virtual void csStatic::SuggestSize int &  w,
int &  h
[virtual]
 

Return the recommended minimal size of static object.

Reimplemented from csComponent.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1