Wrapper for a LWXPanel. More...

#include <xpanel.h>

Inheritance diagram for lwpp::XPanel:

Collaboration diagram for lwpp::XPanel:

Public Member Functions
	XPanel (LWXPanelID panID=0, bool auto_close=false)
	Initialize the class from a created panel.
	XPanel (int type, LWXPanelControl *ctrlDesc, bool auto_close=true)
	Initialize the class by creating a panel.
	~XPanel ()
void	Create (int type, LWXPanelControl *ctrlDesc=NULL, bool auto_close=true)
void	Describe (LWXPanelDataDesc ddesc, LWXPanelGetFunc getf=0, LWXPanelSetFunc *setf=0)
void	Destroy ()
void	DestroyOnExit (bool doIt)
void	getForm (unsigned int id, void *&d)
void	getForm (unsigned int id, char *&d)
void	getForm (unsigned int id, std::string &d)
void	getForm (unsigned int id, int &d)
void	getForm (unsigned int id, unsigned int &d)
void	getForm (unsigned int id, bool &d)
void	getForm (unsigned int id, float &d)
void	getForm (unsigned int id, double &d)
LWXPanelID	getID () const
void *	getUserData (unsigned int id=0)
template<typename T >
T	getUserData (unsigned int id=0)
void	Hint (LWXPanelHint *hint, unsigned int ctl=0)
bool	isValid ()
int	Open ()
int	Post ()
void	setAutoDestroy (bool close)
void	setForm (unsigned long id, void *data)
void	setForm (unsigned long id, bool data)
void	setForm (unsigned long id, int data)
void	setForm (unsigned long id, unsigned int data)
void	setForm (unsigned long id, float data)
void	setForm (unsigned long id, double data)
void	setForm (unsigned long id, char *data)
void	setForm (unsigned long id, const char *data)
void	setForm (unsigned long id, std::string data)
void	setID (LWXPanelID id)
void	setUserData (void *data, unsigned int id=0)
void	ViewInst (void *inst)
void	ViewRefresh ()

Static Public Member Functions
static LWXPDrawFuncs *	getDrawFuncs ()
static int	getVersion ()
static void	ViewRefresh (LWXPanelID panel)

Protected Member Functions
bool	_acquireGlobal ()
virtual bool	available () const
	Check if the global is available.
void	Destroy (LWXPanelID lwxpanel)
void *	formGet (unsigned int id)
void	formSet (unsigned int id, void *data)
virtual LWXPanelFuncs *	getGlobal ()
	Get the pointer to the global.
LWXPanelFuncs *	operator-> ()
	Get the pointer to the global.

Static Protected Member Functions
static LWXPanelID	Create (int type, LWXPanelControl *ctrlDesc=0)
static void	Describe (LWXPanelID lwxpanel, LWXPanelDataDesc ddesc, LWXPanelGetFunc getf=0, LWXPanelSetFunc *setf=0)
static void *	formGet (LWXPanelID lwxpanel, unsigned long id)
static void	formSet (LWXPanelID lwxpanel, unsigned long id, void *data)
static float	getFormFloat (LWXPanelID lwxpanel, unsigned long id)
static int	getFormInt (LWXPanelID lwxpanel, unsigned long id)
static char *	getFormString (LWXPanelID lwxpanel, unsigned long id)
static void *	getUserData (LWXPanelID lwxpanel, unsigned long id=0)
	Get user data.
static void	Hint (LWXPanelID lwxpanel, LWXPanelHint *hint, unsigned long ctl=0)
static int	Open (LWXPanelID lwxpanel)
static int	Post (LWXPanelID lwxpanel)
static void	setForm (LWXPanelID lwxpanel, unsigned long id, long data)
static void	setForm (LWXPanelID lwxpanel, unsigned long id, float data)
static void	setForm (LWXPanelID lwxpanel, unsigned long id, char *data)
static void	setForm (LWXPanelID lwxpanel, unsigned long id, const char *data)
static void	setUserData (LWXPanelID lwxpanel, void *data, unsigned long id=0)
	Set user data.
static void	ViewInst (LWXPanelID lwxpanel, void *inst)

Static Protected Attributes
static LWXPanelFuncs *	globPtr
	Pointer to the global functions.

Detailed Description

Wrapper for a LWXPanel.

Constructor & Destructor Documentation

lwpp::XPanel::XPanel	(	LWXPanelID	panID = `0`,
		bool	auto_close = `false`
	)

inline

Initialize the class from a created panel.

Note:: This will not destroy the panel if the class is destroyed by default

lwpp::XPanel::XPanel	(	int	type,
		LWXPanelControl *	ctrlDesc,
		bool	auto_close = `true`
	)

inline

Initialize the class by creating a panel.

Note:: This will destroy the panel if the class is destroyed by default

lwpp::XPanel::~XPanel ( )

inline

Member Function Documentation

bool lwpp::GlobalBase< LWXPanelFuncs >::_acquireGlobal ( )

inlineprotectedinherited

virtual bool lwpp::GlobalBase< LWXPanelFuncs >::available ( ) const

inlinevirtualinherited

Check if the global is available.

static LWXPanelID lwpp::XPanelFuncs::Create	(	int	type,
		LWXPanelControl *	ctrlDesc = `0`
	)

inlinestaticinherited

void lwpp::XPanel::Create	(	int	type,
		LWXPanelControl *	ctrlDesc = `NULL`,
		bool	auto_close = `true`
	)

inline

static void lwpp::XPanelFuncs::Describe	(	LWXPanelID	lwxpanel,
		LWXPanelDataDesc *	ddesc,
		LWXPanelGetFunc *	getf = `0`,
		LWXPanelSetFunc *	setf = `0`
	)

inlinestaticinherited

void lwpp::XPanel::Describe	(	LWXPanelDataDesc *	ddesc,
		LWXPanelGetFunc *	getf = `0`,
		LWXPanelSetFunc *	setf = `0`
	)

inline

void lwpp::XPanelFuncs::Destroy ( LWXPanelID lwxpanel )

inlineinherited

void lwpp::XPanel::Destroy ( )

inline

void lwpp::XPanel::DestroyOnExit ( bool doIt )

inline

static void* lwpp::XPanelFuncs::formGet	(	LWXPanelID	lwxpanel,
		unsigned long	id
	)

inlinestaticinherited

void* lwpp::XPanel::formGet ( unsigned int id )

inlineprotected

static void lwpp::XPanelFuncs::formSet	(	LWXPanelID	lwxpanel,
		unsigned long	id,
		void *	data
	)

inlinestaticinherited

void lwpp::XPanel::formSet	(	unsigned int	id,
		void *	data
	)

inlineprotected

static LWXPDrawFuncs* lwpp::XPanel::getDrawFuncs ( )

inlinestatic

Reimplemented from lwpp::XPanelFuncs.

void lwpp::XPanel::getForm	(	unsigned int	id,
		void *&	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		char *&	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		std::string &	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		int &	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		unsigned int &	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		bool &	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		float &	d
	)

inline

void lwpp::XPanel::getForm	(	unsigned int	id,
		double &	d
	)

inline

static float lwpp::XPanelFuncs::getFormFloat	(	LWXPanelID	lwxpanel,
		unsigned long	id
	)

inlinestaticinherited

static int lwpp::XPanelFuncs::getFormInt	(	LWXPanelID	lwxpanel,
		unsigned long	id
	)

inlinestaticinherited

static char* lwpp::XPanelFuncs::getFormString	(	LWXPanelID	lwxpanel,
		unsigned long	id
	)

inlinestaticinherited

virtual LWXPanelFuncs * lwpp::GlobalBase< LWXPanelFuncs >::getGlobal ( )

inlinevirtualinherited

Get the pointer to the global.

LWXPanelID lwpp::XPanel::getID ( void ) const

inline

static void* lwpp::XPanelFuncs::getUserData	(	LWXPanelID	lwxpanel,
		unsigned long	id = `0`
	)

inlinestaticinherited

Get user data.

Parameters:

lwxpanel	LWXPanelID
id	ID of the control or 0 for the panel

Returns:: The user data

void* lwpp::XPanel::getUserData ( unsigned int id = 0 )

inline

template<typename T >

T lwpp::XPanel::getUserData ( unsigned int id = 0 )

inline

static int lwpp::XPanel::getVersion ( )

inlinestatic

Reimplemented from lwpp::XPanelFuncs.

static void lwpp::XPanelFuncs::Hint	(	LWXPanelID	lwxpanel,
		LWXPanelHint *	hint,
		unsigned long	ctl = `0`
	)

inlinestaticinherited

void lwpp::XPanel::Hint	(	LWXPanelHint *	hint,
		unsigned int	ctl = `0`
	)

inline

bool lwpp::XPanel::isValid ( void )

inline

static int lwpp::XPanelFuncs::Open ( LWXPanelID lwxpanel )

inlinestaticinherited

int lwpp::XPanel::Open ( )

inline

LWXPanelFuncs * lwpp::GlobalBase< LWXPanelFuncs >::operator-> ( )

inlineinherited

Get the pointer to the global.

static int lwpp::XPanelFuncs::Post ( LWXPanelID lwxpanel )

inlinestaticinherited

int lwpp::XPanel::Post ( void )

inline

void lwpp::XPanel::setAutoDestroy ( bool close )

inline

static void lwpp::XPanelFuncs::setForm	(	LWXPanelID	lwxpanel,
		unsigned long	id,
		long	data
	)

inlinestaticinherited

static void lwpp::XPanelFuncs::setForm	(	LWXPanelID	lwxpanel,
		unsigned long	id,
		float	data
	)

inlinestaticinherited

static void lwpp::XPanelFuncs::setForm	(	LWXPanelID	lwxpanel,
		unsigned long	id,
		char *	data
	)

inlinestaticinherited

static void lwpp::XPanelFuncs::setForm	(	LWXPanelID	lwxpanel,
		unsigned long	id,
		const char *	data
	)

inlinestaticinherited

void lwpp::XPanel::setForm	(	unsigned long	id,
		void *	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		bool	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		int	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		unsigned int	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		float	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		double	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		char *	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		const char *	data
	)

inline

void lwpp::XPanel::setForm	(	unsigned long	id,
		std::string	data
	)

inline

void lwpp::XPanel::setID ( LWXPanelID id )

inline

static void lwpp::XPanelFuncs::setUserData	(	LWXPanelID	lwxpanel,
		void *	data,
		unsigned long	id = `0`
	)

inlinestaticinherited

Set user data.

Parameters:

lwxpanel	LWXPanelID
*data	The user data
id	ID of the control or 0 for the panel

void lwpp::XPanel::setUserData	(	void *	data,
		unsigned int	id = `0`
	)

inline

static void lwpp::XPanelFuncs::ViewInst	(	LWXPanelID	lwxpanel,
		void *	inst
	)

inlinestaticinherited

void lwpp::XPanel::ViewInst ( void * inst )

inline

void lwpp::XPanel::ViewRefresh ( )

inline

static void lwpp::XPanel::ViewRefresh ( LWXPanelID panel )

inlinestatic

Reimplemented from lwpp::XPanelFuncs.

Member Data Documentation

LWXPanelFuncs * lwpp::GlobalBase< LWXPanelFuncs >::globPtr

staticprotectedinherited

Pointer to the global functions.

The documentation for this class was generated from the following file:

xpanel.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation