FX::FXTriStateButton Class Reference

The tri-state button provides a three-state button, which toggles between the on and the off state each time it is pressed; programmatically, it may also be switched into the MAYBE state. More...

#include <FXTriStateButton.h>

Inheritance diagram for FX::FXTriStateButton:

List of all members.

Public Member Functions
	FXTriStateButton (FXComposite *p, const FXString &text1, const FXString &text2, const FXString &text3, FXIcon *icon1=NULL, FXIcon *icon2=NULL, FXIcon *icon3=NULL, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=TOGGLEBUTTON_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	create ()
virtual void	detach ()
virtual FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
void	setMaybeText (const FXString &text)
FXString	getMaybeText () const
void	setMaybeIcon (FXIcon *ic)
FXIcon *	getMaybeIcon () const
void	setMaybeHelpText (const FXString &text)
FXString	getMaybeHelpText () const
void	setMaybeTipText (const FXString &text)
FXString	getMaybeTipText () const
virtual void	save (FXStream &store) const
virtual void	load (FXStream &store)
virtual	~FXTriStateButton ()

---

Detailed Description

The tri-state button provides a three-state button, which toggles between the on and the off state each time it is pressed; programmatically, it may also be switched into the MAYBE state.

The MAYBE state is useful to signify an unknown state in the application data. Like the toggle button, it sends a SEL_COMMAND to its target, with the message data set to the current state of the toggle button, of the type FXbool.

---

Constructor & Destructor Documentation

FX::FXTriStateButton::FXTriStateButton	(	FXComposite *	p,
		const FXString &	text1,
		const FXString &	text2,
		const FXString &	text3,
		FXIcon *	icon1 = NULL,
		FXIcon *	icon2 = NULL,
		FXIcon *	icon3 = NULL,
		FXObject *	tgt = NULL,
		FXSelector	sel = 0,
		FXuint	opts = TOGGLEBUTTON_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 tri-state toggle button with three text labels, and three icons, one for each state.

virtual FX::FXTriStateButton::~FXTriStateButton

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void FX::FXTriStateButton::create

(

)

[virtual]

Create server-side resources.

Reimplemented from FX::FXToggleButton.

virtual void FX::FXTriStateButton::detach

(

)

[virtual]

Detach server-side resources.

Reimplemented from FX::FXToggleButton.

virtual FXint FX::FXTriStateButton::getDefaultWidth

(

)

[virtual]

Get default width.

Reimplemented from FX::FXToggleButton.

virtual FXint FX::FXTriStateButton::getDefaultHeight

(

)

[virtual]

Get default height.

Reimplemented from FX::FXToggleButton.

void FX::FXTriStateButton::setMaybeText

(

const FXString &

text

)

Change maybe text shown when toggled.

FXString FX::FXTriStateButton::getMaybeText

(

)

const [inline]

Return maybe text.

void FX::FXTriStateButton::setMaybeIcon

(

FXIcon *

ic

)

Change maybe icon shown when toggled.

FXIcon* FX::FXTriStateButton::getMaybeIcon

(

)

const [inline]

Return maybe icon.

void FX::FXTriStateButton::setMaybeHelpText

(

const FXString &

text

)

Change maybe help text shown when toggled.

FXString FX::FXTriStateButton::getMaybeHelpText

(

)

const [inline]

Return maybe help text.

void FX::FXTriStateButton::setMaybeTipText

(

const FXString &

text

)

Change maybe tip text shown when toggled.

FXString FX::FXTriStateButton::getMaybeTipText

(

)

const [inline]

Return maybe tip text.

virtual void FX::FXTriStateButton::save

(

FXStream &

store

)

const [virtual]

Save toggle button to a stream.

Reimplemented from FX::FXToggleButton.

virtual void FX::FXTriStateButton::load

(

FXStream &

store

)

[virtual]

Load toggle button from a stream.

Reimplemented from FX::FXToggleButton.