mgui/xmldlg.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * \file mgui/xmldlg.h
 * \brief XML Dialog
 * 
 * \if NODOC
 * $Log: xmldlg.h_v $
 * Revision 1.5  2003/10/01 22:34:17  dwilliss
 * doxygen
 *
 * Revision 1.4  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/07/08 18:01:24  dwilliss
 * Moved XMLFORM_DATA to its own include file
 *
 * Revision 1.2  2002/10/09 22:41:00  dwilliss
 * Moved to mgui subdirectory
 *
 * Revision 1.1  2002/10/09 22:38:13  dwilliss
 * Initial revision
 *
 * Revision 1.2  2002/09/19 22:34:09  dwilliss
 * Major update.  Almost complete
 *
 * Revision 1.1  2002/09/03 22:38:57  dwilliss
 * Initial revision
 *
 *
 * \endif
 ****************************************************************************/

#ifndef INC_MGUI_XMLDLG_H
#define INC_MGUI_XMLDLG_H


#ifndef INC_MGUI_LAYOUT_H
#include <mgui/layout.h>
#endif

#ifndef INC_MGUI_DLGBASE_H
#include <mgui/dlgbase.h>
#endif

#ifndef INC_MI32_XML_H
#include <mi32/xml.h>
#endif

#ifndef INC_MGUI_XMLDATA_H
#include <mgui/xmldata.h>
#endif


struct SMLCONTEXT;

namespace MGUI {

class GUIXMLPRIVDATA;      // Actually defined in smlctrl.c


class LAYOUT_PANE_XMLFORM : public MGUI::LAYOUT_PANE {
   public:
      LAYOUT_PANE_XMLFORM();
      virtual ~LAYOUT_PANE_XMLFORM();

      //! Create a layout from a <form> in an XML document

      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const XMLNODE* xmlnode,                //!< XML document node describing the form
         SMLCONTEXT* context = 0                //!< Context to use if being created from SML
         );

      //! 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.
      //! @return NULL if there was no such control.
      MGUI::FORM* GetCtrlByID (
         const UNICODE* id
         ) 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 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.
      bool 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 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 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 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 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 GetCtrlByID (
         const UNICODE* id,
         MGUI::FORM_EDIT_RANGE*& ctrl
         ) const;


      //! Get the current values of the controls.
      //! Controls with no id attribute are ignored
      ERRVALUE GetValues (
         MGUI::XMLFORM_DATA& values
         ) const;

      //! Get the current values of the controls.
      //! Controls with no id attribute are ignored
      ERRVALUE SetValues (
         const MGUI::XMLFORM_DATA& values
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      GUIXMLPRIVDATA* m_priv;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class DLG_XML : public MGUI::DLG_BASE {
   public:
      DLG_XML();
      virtual ~DLG_XML();

      //! 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.
      //! @return NULL if there was no such control.
      MGUI::FORM* GetCtrlByID (
         const UNICODE* id
         ) 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 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.
      bool 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 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 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 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 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 GetCtrlByID (
         const UNICODE* id,
         MGUI::FORM_EDIT_RANGE*& ctrl
         ) const;


      //! Get the current values of the controls.
      //! Controls with no id attribute are ignored
      ERRVALUE GetValues (
         MGUI::XMLFORM_DATA& values
         ) const;

      //! Get the current values of the controls.
      //! Controls with no id attribute are ignored
      ERRVALUE SetValues (
         const MGUI::XMLFORM_DATA& values
         );


      //! Create a layout from a <form> in an XML document
      ERRVALUE SetXMLNode (
         const XMLNODE* xmlnode,                //!< XML document node describing the dialog
         SMLCONTEXT* context = 0                //!< Context to use if being created from SML
         );


   protected:

      virtual ERRVALUE OnInitDialog ();         //! Creates the body from the form contents
      virtual void OnApply ();
      virtual void OnOK ();
      virtual void OnCancel ();
      virtual void OnOpen ();
      virtual void OnClose ();
      virtual void OnDestroy ();

      GUIXMLPRIVDATA* GetPriv() const { return (m_priv); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual const char* GetDialogHelpID () const;         
      virtual const char* GetDialogName () const;        

      GUIXMLPRIVDATA* m_priv;
      mutable char *m_helpid; //!< GetDialogHelpID() may set it so we'll free it in the dtor
      #endif // GENERATING_DOXYGEN_OUTPUT
   };




}     // End of MGUI namespace

#endif

---