CrystalSpace

Public API Reference

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

csSpinBox Class Reference
[Spin box]

The spinbox class is a combination of an input line and a bi-directional arrow button which can be used to switch input line contents back and forth between a set of predefined values. More...

#include <csspinbx.h>

Inheritance diagram for csSpinBox:

csInputLine csComponent List of all members.

Public Methods

 csSpinBox (csComponent *iParent, csInputLineFrameStyle iFrameStyle=csifsThickRect)
 Create spin box object.

virtual ~csSpinBox ()
 Destructor.

virtual void Draw ()
 Draw the spin box.

virtual bool HandleEvent (iEvent &Event)
 Handle external events.

void SetLimits (int iMin, int iMax, char *iFormat="%d")
 Set spin box type to numerical and set spin limits.

void SetValue (int iValue)
 Set spin box content.

int InsertItem (char *iValue, int iPosition)
 Insert a item into spinbox (same as csSpinBoxInsertItem message).

virtual void SetText (const char *iText)
 Set spinbox text.


Detailed Description

The spinbox class is a combination of an input line and a bi-directional arrow button which can be used to switch input line contents back and forth between a set of predefined values.

Definition at line 109 of file csspinbx.h.


Constructor & Destructor Documentation

csSpinBox::csSpinBox csComponent   iParent,
csInputLineFrameStyle    iFrameStyle = csifsThickRect
 

Create spin box object.

virtual csSpinBox::~csSpinBox   [virtual]
 

Destructor.


Member Function Documentation

virtual void csSpinBox::Draw   [virtual]
 

Draw the spin box.

Reimplemented from csInputLine.

virtual bool csSpinBox::HandleEvent iEvent   Event [virtual]
 

Handle external events.

Reimplemented from csInputLine.

int csSpinBox::InsertItem char *    iValue,
int    iPosition
 

Insert a item into spinbox (same as csSpinBoxInsertItem message).

void csSpinBox::SetLimits int    iMin,
int    iMax,
char *    iFormat = "%d"
 

Set spin box type to numerical and set spin limits.

virtual void csSpinBox::SetText const char *    iText [virtual]
 

Set spinbox text.

Reimplemented from csInputLine.

void csSpinBox::SetValue int    iValue
 

Set spin box content.

If spin box type is numerical, the iValue parameter is the number that will be set in entry field (after it will be clipped to Min..Max), if spin box type is enumerated, iValue is the ordinal of value to be set.


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