MGUI::DLG_XML Class Reference

#include <mgui/xmldlg.h>

Inheritance diagram for MGUI::DLG_XML:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 DLG_XML ()
bool GetCtrlByID (const UNICODE *id, MGUI::FORM_EDIT_RANGE *&ctrl) const
bool GetCtrlByID (const UNICODE *id, MGUI::CTRL_EDIT_NUMBER *&ctrl) const
bool GetCtrlByID (const UNICODE *id, MGUI::CTRL_EDIT_STRING *&ctrl) const
bool GetCtrlByID (const UNICODE *id, MGUI::CTRL_TOGGLEBUTTON *&ctrl) const
bool GetCtrlByID (const UNICODE *id, MGUI::CTRL_PUSHBUTTON *&ctrl) const
bool GetCtrlByID (const UNICODE *id, MGUI::CTRL_GROUPBOX *&ctrl) const
bool GetCtrlByID (const UNICODE *id, MGUI::CTRL_LABEL *&ctrl) const
MGUI::FORMGetCtrlByID (const UNICODE *id) const
MGUI::LAYOUT_PANE_BASEGetPaneByID (const UNICODE *id) const
ERRVALUE GetValues (MGUI::XMLFORM_DATA &values) const
ERRVALUE SetValues (const MGUI::XMLFORM_DATA &values)
ERRVALUE SetXMLNode (const XMLNODE *xmlnode, SMLCONTEXT *context=0)
virtual ~DLG_XML ()

Protected Member Functions

GUIXMLPRIVDATA * GetPriv () const
virtual void OnApply ()
virtual void OnCancel ()
virtual void OnClose ()
virtual void OnDestroy ()
virtual ERRVALUE OnInitDialog ()
virtual void OnOK ()
virtual void OnOpen ()

Constructor & Destructor Documentation

MGUI::DLG_XML::DLG_XML  ) 
 

virtual MGUI::DLG_XML::~DLG_XML  )  [virtual]
 


Member Function Documentation

bool MGUI::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetCtrlByID const UNICODE 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::DLG_XML::GetPaneByID const UNICODE id  )  const
 

Get a pane by it's XML id attribute.

Returns:
NULL if there was no such pane.

GUIXMLPRIVDATA* MGUI::DLG_XML::GetPriv  )  const [inline, protected]
 

Definition at line 291 of file xmldlg.h.

ERRVALUE MGUI::DLG_XML::GetValues MGUI::XMLFORM_DATA values  )  const
 

Get the current values of the controls.

Controls with no id attribute are ignored

virtual void MGUI::DLG_XML::OnApply  )  [protected, virtual]
 

Creates the body from the form contents.

Reimplemented from MGUI::DLG_BASE.

virtual void MGUI::DLG_XML::OnCancel  )  [protected, virtual]
 

Called when 'Cancel' button is pressed.

Derived class must call base class OnCancel() method AFTER performing its own processing to properly close the dialog. In some cases the user may be given an opportunity to verify that they intended to press the Cancel button. If they elect not to cancel then the base class OnCancel() method should not be called. This will cause the dialog to remain open and allow the user to retain the settings.

Reimplemented from MGUI::DLG_BASE.

virtual void MGUI::DLG_XML::OnClose  )  [protected, virtual]
 

Called when dialog is closed.

Derived class must call base class OnClose() method AFTER performing its own processing to properly close the dialog.

Reimplemented from MGUI::DLG_BASE.

virtual void MGUI::DLG_XML::OnDestroy  )  [protected, virtual]
 

Called when dialog is destroyed.

Reimplemented from MGUI::DLG_BASE.

virtual ERRVALUE MGUI::DLG_XML::OnInitDialog  )  [protected, virtual]
 

Create dialog contents.

Derived class MUST implement this. Function must return 0 for success or an error code. This will be called by the dialog creation code and thus should not be called directly. This is normally overridden only by the specific dialog implementation and not by the code that actually uses that dialog implementation. The implementation should call GetMainForm() or GetMainPane() to determine the form widget or pane to create the controls in.

Implements MGUI::DLG_BASE.

virtual void MGUI::DLG_XML::OnOK  )  [protected, virtual]
 

Called when 'OK' button is pressed.

Derived class must call base class OnOK() method AFTER performing its own processing to properly close the dialog. If the dialog settings do not pass their associated validation test then an appropriate message should be displayed for the user and the base class OnOK() method should not be called. This will cause the dialog to remain open and allow the user to correct the settings.

Reimplemented from MGUI::DLG_BASE.

virtual void MGUI::DLG_XML::OnOpen  )  [protected, virtual]
 

Called when dialog is opened after the dialog is actually "managed" and displayed.

Derived class must call base class OnOpen() method BEFORE performing its own processing.

Reimplemented from MGUI::DLG_BASE.

ERRVALUE MGUI::DLG_XML::SetValues const MGUI::XMLFORM_DATA values  ) 
 

Get the current values of the controls.

Controls with no id attribute are ignored

ERRVALUE MGUI::DLG_XML::SetXMLNode const XMLNODE xmlnode,
SMLCONTEXT context = 0
 

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

Parameters:
xmlnode  XML document node describing the dialog
context  Context to use if being created from SML


The documentation for this class was generated from the following file:
Generated on Tue Dec 14 13:20:49 2004 for TNTsdk by  doxygen 1.3.8-20040913