MGUI::LAYOUT_PANE_XMLFORM Class Reference

#include <mgui/xmldlg.h>

Inheritance diagram for MGUI::LAYOUT_PANE_XMLFORM:

[legend]

List of all members.

Public Member Functions
	LAYOUT_PANE_XMLFORM ()
virtual	~LAYOUT_PANE_XMLFORM ()
ERRVALUE	Create (MGUI::LAYOUT_PANE_BASE &ParentPane, const XMLNODE *xmlnode, SML::CONTEXT *context=0)
bool	GetCtrlByID (const MIUNICODE *id, MGUI::FORM_EDIT_RANGE *&ctrl) const
bool	GetCtrlByID (const MIUNICODE *id, MGUI::CTRL_EDIT_NUMBER *&ctrl) const
bool	GetCtrlByID (const MIUNICODE *id, MGUI::CTRL_EDIT_STRING *&ctrl) const
bool	GetCtrlByID (const MIUNICODE *id, MGUI::CTRL_TOGGLEBUTTON *&ctrl) const
bool	GetCtrlByID (const MIUNICODE *id, MGUI::CTRL_PUSHBUTTON *&ctrl) const
bool	GetCtrlByID (const MIUNICODE *id, MGUI::CTRL_GROUPBOX *&ctrl) const
bool	GetCtrlByID (const MIUNICODE *id, MGUI::CTRL_LABEL *&ctrl) const
MGUI::FORM *	GetCtrlByID (const MIUNICODE *id) const
MGUI::LAYOUT_PANE_BASE *	GetPaneByID (const MIUNICODE *id) const
ERRVALUE	GetValues (MGUI::XMLFORM_DATA &values) const
ERRVALUE	SetValues (const MGUI::XMLFORM_DATA &values)

---

Constructor & Destructor Documentation

MGUI::LAYOUT_PANE_XMLFORM::LAYOUT_PANE_XMLFORM

(

)

virtual MGUI::LAYOUT_PANE_XMLFORM::~LAYOUT_PANE_XMLFORM

(

)

[virtual]

---

Member Function Documentation

ERRVALUE MGUI::LAYOUT_PANE_XMLFORM::Create	(	MGUI::LAYOUT_PANE_BASE &	ParentPane,
		const XMLNODE *	xmlnode,
		SML::CONTEXT *	context = 0
	)

Create a layout from a <form> in an XML document.

Parameters:

	ParentPane	Parent pane
	xmlnode	XML document node describing the form
	context	Context to use if being created from SML

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::FORM_EDIT_RANGE *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::CTRL_EDIT_NUMBER *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::CTRL_EDIT_STRING *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::CTRL_TOGGLEBUTTON *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::CTRL_PUSHBUTTON *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::CTRL_GROUPBOX *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

bool MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID	(	const MIUNICODE *	id,
		MGUI::CTRL_LABEL *&	ctrl
	)			const

Get a control by it's XML id attribute.

Returns true if there was such a control, false if not. Also returns false if there was a control with the given id but was not of the requested type.

MGUI::FORM* MGUI::LAYOUT_PANE_XMLFORM::GetCtrlByID

(

const MIUNICODE *

id

)

const

Get a control by it's XML id attribute.

This version just returns a pointer to an MGUI::FORM. This should only be used in cases where you don't really care what the control type is. If you expect the control to be of a specific type, use the override that takes a referenct to a pointer.

Returns:

NULL if there was no such control.

MGUI::LAYOUT_PANE_BASE* MGUI::LAYOUT_PANE_XMLFORM::GetPaneByID

(

const MIUNICODE *

id

)

const

Get a pane by it's XML id attribute.

Returns:

NULL if there was no such pane.

ERRVALUE MGUI::LAYOUT_PANE_XMLFORM::GetValues

(

MGUI::XMLFORM_DATA &

values

)

const

Get the current values of the controls.

Controls with no id attribute are ignored

ERRVALUE MGUI::LAYOUT_PANE_XMLFORM::SetValues

(

const MGUI::XMLFORM_DATA &

values

)

Get the current values of the controls.

Controls with no id attribute are ignored

---

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

• mgui/xmldlg.h