class MASKING_DLL_DECLSPEC SpinBox

A compound widget made of an EditBox and two spinner Buttons.

Inheritance:

SpinBox - CompoundWidget - Dialog - Widget - Rect

SpinBox - ScrollObject

Public Fields

EditBox editBox

The underlaying edit box

SpinButton bUp

The underlaying up arrow button

SpinButton bDown

The underlaying down arrow button

Public Methods

void Setup(int x, int y, int w, int h, int key, int flags, double min, double max, double pos, double inc)

Shortcut for Widget::Setup() and ScrollObject::Setup().

void Setup(int x, int y, int w, int h, int key, int flags, int min, int max, int pos, int inc)

Shortcut for Widget::Setup() and ScrollObject::Setup().

void HandleEvent(Widget& obj, int msg, int arg1=0, int arg2=0)

Handles events such as spinner button clicks so that the box is updated whenever a button is clicked

void SetPosition(double pos)

Sets the position (the value) of the SpinBox's contents

void Increment()

Increments the box's value

void Decrement()

Increments the box's value

Protected Fields

bool integerMode

The current mode of operation.

Protected Methods

void MsgInitSkin()

Initializes the SpinBox and it's widgets with the default bitmaps, fonts and colours as defined by the skin

void UpdateSize()

Places and resizes the editbox and the buttons according to the geometry of the SpinBox

Documentation

A compound widget made of an EditBox and two spinner Buttons. Functionally a SpinBox is very similar to a Slider except that it presents the data differently. While a slider's position can be adjusted by dragging it's button, a SpinBox's position can be changed by pressing the two buttons or by directly entering the value into the text edit area. A SpinBox can operate in two modes: integer mode and double mode. In integer mode the number value it holds can only be an integer while in double mode it can only be a double.

EditBox editBox

The underlaying edit box

SpinButton bUp

The underlaying up arrow button

SpinButton bDown

The underlaying down arrow button

bool integerMode

The current mode of operation. True if the spinbox is in integer mode, false otherwise.

void MsgInitSkin()

Initializes the SpinBox and it's widgets with the default bitmaps, fonts and colours as defined by the skin

void UpdateSize()

Places and resizes the editbox and the buttons according to the geometry of the SpinBox

void Setup(int x, int y, int w, int h, int key, int flags, double min, double max, double pos, double inc)

Shortcut for Widget::Setup() and ScrollObject::Setup(). Double version.

void Setup(int x, int y, int w, int h, int key, int flags, int min, int max, int pos, int inc)

Shortcut for Widget::Setup() and ScrollObject::Setup(). Integer version.

void HandleEvent(Widget& obj, int msg, int arg1=0, int arg2=0)

Handles events such as spinner button clicks so that the box is updated whenever a button is clicked

void SetPosition(double pos)

Sets the position (the value) of the SpinBox's contents

void Increment()

Increments the box's value

void Decrement()

Increments the box's value

This class has no child classes.

Alphabetic index Hierarchy of classes