FX::FXSpinner Class Reference

#include <FXSpinner.h>

Inheritance diagram for FX::FXSpinner:

List of all members.

Public Types
enum	{   ID_INCREMENT = FXPacker::ID_LAST,   ID_DECREMENT,   ID_ENTRY,   ID_LAST }
Public Member Functions
	FXSpinner (FXComposite *p, FXint cols, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=SPIN_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)
virtual void	layout ()
virtual void	disable ()
virtual void	enable ()
virtual FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
void	increment (FXbool notify=FALSE)
void	incrementByAmount (FXint amount, FXbool notify=FALSE)
void	decrement (FXbool notify=FALSE)
void	decrementByAmount (FXint amount, FXbool notify=FALSE)
FXbool	isCyclic () const
void	setCyclic (FXbool cyclic)
FXbool	isTextVisible () const
void	setTextVisible (FXbool shown)
virtual void	setValue (FXint value, FXbool notify=FALSE)
FXint	getValue () const
void	setRange (FXint lo, FXint hi, FXbool notify=FALSE)
void	getRange (FXint &lo, FXint &hi) const
void	setIncrement (FXint increment)
FXint	getIncrement () const
void	setFont (FXFont *fnt)
FXFont *	getFont () const
void	setHelpText (const FXString &text)
const FXString &	getHelpText () const
void	setTipText (const FXString &text)
const FXString &	getTipText () const
void	setSpinnerStyle (FXuint style)
FXuint	getSpinnerStyle () const
void	setEditable (FXbool edit=TRUE)
FXbool	isEditable () const
void	setUpArrowColor (FXColor clr)
FXColor	getUpArrowColor () const
void	setDownArrowColor (FXColor clr)
FXColor	getDownArrowColor () const
void	setTextColor (FXColor clr)
FXColor	getTextColor () const
void	setSelBackColor (FXColor clr)
FXColor	getSelBackColor () const
void	setSelTextColor (FXColor clr)
FXColor	getSelTextColor () const
void	setCursorColor (FXColor clr)
FXColor	getCursorColor () const
void	setNumColumns (FXint cols)
FXint	getNumColumns () const
virtual void	save (FXStream &store) const
virtual void	load (FXStream &store)
virtual	~FXSpinner ()

---

Detailed Description

Spinner control.

See also:

• Spinner Options.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

ID_INCREMENT
ID_DECREMENT
ID_ENTRY
ID_LAST

---

Constructor & Destructor Documentation

FX::FXSpinner::FXSpinner	(	FXComposite *	p,
		FXint	cols,
		FXObject *	tgt = NULL,
		FXSelector	sel = 0,
		FXuint	opts = SPIN_NORMAL,
		FXint	x = 0,
		FXint	y = 0,
		FXint	w = 0,
		FXint	h = 0,
		FXint	pl = DEFAULT_PAD,
		FXint	pr = DEFAULT_PAD,
		FXint	pt = DEFAULT_PAD,
		FXint	pb = DEFAULT_PAD
	)

Construct a spinner.

virtual FX::FXSpinner::~FXSpinner

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void FX::FXSpinner::layout

(

)

[virtual]

Perform layout.

Reimplemented from FX::FXPacker.

virtual void FX::FXSpinner::disable

(

)

[virtual]

Disable spinner.

Reimplemented from FX::FXWindow.

virtual void FX::FXSpinner::enable

(

)

[virtual]

Enable spinner.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXSpinner::getDefaultWidth

(

)

[virtual]

Return default width.

Reimplemented from FX::FXPacker.

virtual FXint FX::FXSpinner::getDefaultHeight

(

)

[virtual]

Return default height.

Reimplemented from FX::FXPacker.

void FX::FXSpinner::increment

(

FXbool

notify = FALSE

)

Increment spinner.

void FX::FXSpinner::incrementByAmount	(	FXint	amount,
		FXbool	notify = FALSE
	)

Increment spinner by certain amount.

void FX::FXSpinner::decrement

(

FXbool

notify = FALSE

)

Decrement spinner.

void FX::FXSpinner::decrementByAmount	(	FXint	amount,
		FXbool	notify = FALSE
	)

Decrement spinner by certain amount.

FXbool FX::FXSpinner::isCyclic

(

)

const

Return TRUE if in cyclic mode.

void FX::FXSpinner::setCyclic

(

FXbool

cyclic

)

Set to cyclic mode, i.e. wrap around at maximum/minimum.

FXbool FX::FXSpinner::isTextVisible

(

)

const

Return TRUE if text is visible.

void FX::FXSpinner::setTextVisible

(

FXbool

shown

)

Set text visible flag.

virtual void FX::FXSpinner::setValue	(	FXint	value,
		FXbool	notify = FALSE
	)		[virtual]

Change current value.

FXint FX::FXSpinner::getValue

(

)

const [inline]

Return current value.

void FX::FXSpinner::setRange	(	FXint	lo,
		FXint	hi,
		FXbool	notify = FALSE
	)

Change the spinner's range.

void FX::FXSpinner::getRange	(	FXint &	lo,
		FXint &	hi
	)		const [inline]

Get the spinner's current range.

void FX::FXSpinner::setIncrement

(

FXint

increment

)

Change spinner increment.

FXint FX::FXSpinner::getIncrement

(

)

const [inline]

Return spinner increment.

void FX::FXSpinner::setFont

(

FXFont *

fnt

)

Set the text font.

FXFont* FX::FXSpinner::getFont

(

)

const

Get the text font.

void FX::FXSpinner::setHelpText

(

const FXString &

text

)

Set the status line help text for this spinner.

const FXString& FX::FXSpinner::getHelpText

(

)

const

Get the status line help text for this spinner.

void FX::FXSpinner::setTipText

(

const FXString &

text

)

Set the tool tip message for this spinner.

const FXString& FX::FXSpinner::getTipText

(

)

const

Get the tool tip message for this spinner.

void FX::FXSpinner::setSpinnerStyle

(

FXuint

style

)

Change spinner style.

FXuint FX::FXSpinner::getSpinnerStyle

(

)

const

Return current spinner style.

void FX::FXSpinner::setEditable

(

FXbool

edit = TRUE

)

Allow editing of the text field.

FXbool FX::FXSpinner::isEditable

(

)

const

Return TRUE if text field is editable.

void FX::FXSpinner::setUpArrowColor

(

FXColor

clr

)

Change color of the up arrow.

FXColor FX::FXSpinner::getUpArrowColor

(

)

const

Return color of the up arrow.

void FX::FXSpinner::setDownArrowColor

(

FXColor

clr

)

Change color of the down arrow.

FXColor FX::FXSpinner::getDownArrowColor

(

)

const

Return color of the the down arrow.

void FX::FXSpinner::setTextColor

(

FXColor

clr

)

Change text color.

FXColor FX::FXSpinner::getTextColor

(

)

const

Return text color.

void FX::FXSpinner::setSelBackColor

(

FXColor

clr

)

Change selected background color.

FXColor FX::FXSpinner::getSelBackColor

(

)

const

Return selected background color.

void FX::FXSpinner::setSelTextColor

(

FXColor

clr

)

Change selected text color.

FXColor FX::FXSpinner::getSelTextColor

(

)

const

Return selected text color.

void FX::FXSpinner::setCursorColor

(

FXColor

clr

)

Changes the cursor color.

FXColor FX::FXSpinner::getCursorColor

(

)

const

Return the cursor color.

void FX::FXSpinner::setNumColumns

(

FXint

cols

)

Change width of text field in terms of number of columns * `m'.

FXint FX::FXSpinner::getNumColumns

(

)

const

Return number of columns.

virtual void FX::FXSpinner::save

(

FXStream &

store

)

const [virtual]

Save spinner to a stream.

Reimplemented from FX::FXPacker.

virtual void FX::FXSpinner::load

(

FXStream &

store

)

[virtual]

Load spinner from a stream.

Reimplemented from FX::FXPacker.