wxAutoExcel::wxXlTribool Class Reference

Tri-state boolean. More...

#include <wxAutoExcel_tribool.h>

Public Types
enum	States { tb_false = 0 , tb_true = 1 , tb_default }
	Possible states of wxXlTribool. More...

Public Member Functions
	wxXlTribool (States state=tb_default)
	Creates a wxXlTribool in a default state.
	wxXlTribool (bool b)
	Creates a wxXlTribool containing a bool.
States	GetState () const
	Returns the current state.
bool	IsDefault () const
	Returns true if the tribool is in the default state.
bool	IsTrue () const
	Returns true if the tribool contains true.
bool	IsFalse () const
	Returns true if the tribool contains false.
wxXlTribool &	operator= (bool b)
	Assigns the bool value.
wxXlTribool &	operator= (const wxVariant &v)
	If the variant contains a bool, assigns the bool value else sets the state to tb_default.

Detailed Description

Tri-state boolean.

Member Enumeration Documentation

States

enum wxAutoExcel::wxXlTribool::States

Possible states of wxXlTribool.

Enumerator
tb_false	false
tb_true	true
tb_default	default / undetermined

Constructor & Destructor Documentation

wxXlTribool() [1/2]

wxAutoExcel::wxXlTribool::wxXlTribool ( States  state = tb_default )

inline

Creates a wxXlTribool in a default state.

wxXlTribool() [2/2]

wxAutoExcel::wxXlTribool::wxXlTribool ( bool  b )

inline

Creates a wxXlTribool containing a bool.

Member Function Documentation

GetState()

States wxAutoExcel::wxXlTribool::GetState ( ) const

inline

Returns the current state.

IsDefault()

bool wxAutoExcel::wxXlTribool::IsDefault ( ) const

inline

Returns true if the tribool is in the default state.

IsTrue()

bool wxAutoExcel::wxXlTribool::IsTrue ( ) const

inline

Returns true if the tribool contains true.

IsFalse()

bool wxAutoExcel::wxXlTribool::IsFalse ( ) const

inline

Returns true if the tribool contains false.

operator=() [1/2]

wxXlTribool & wxAutoExcel::wxXlTribool::operator= ( bool  b )

inline

Assigns the bool value.

operator=() [2/2]

wxXlTribool & wxAutoExcel::wxXlTribool::operator= ( const wxVariant &  v )

inline

If the variant contains a bool, assigns the bool value else sets the state to tb_default.