mgui/xmldata.h

Go to the documentation of this file.

/*****************************************************************************
 * \file mgui/xmldata.h
 * \brief XMLFORM_DATA definition
 * 
 * \if NODOC
 * $Log: xmldata.h_v $
 * Revision 1.7  2008/09/10 13:58:39  mju
 * Fix doxygen warnings.
 *
 * Revision 1.6  2003/11/14 18:33:11  dwilliss
 * Added a private enum which is passed to a private method.
 *
 * Revision 1.1  2002/09/03 22:38:57  dwilliss
 * Initial revision
 * \endif
 ****************************************************************************/

#ifndef INC_MGUI_XMLDATA_H
#define INC_MGUI_XMLDATA_H


#ifndef INC_MI32_COLOR_H
#include <mi32/color.h>
#endif

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

namespace MGUI {


class XMLFORM_DATA : public XMLDOC {
   public:

      enum PROPERTY {
         PROPERTY_Value = 0,           
         PROPERTY_Min,
         PROPERTY_Max,
         };

      XMLFORM_DATA (
         );

      XMLFORM_DATA (
         const XMLNODE* InitialValues
         );

      XMLFORM_DATA (
         const XMLFORM_DATA&
         );

      //======================= Get Methods ============================
      
      bool GetValue (
         const char* id,         
         MISTRING& value         
         ) const;

      bool GetValue (
         const char* id,         
         double& value,          
         XMLFORM_DATA::PROPERTY property = PROPERTY_Value
         ) const;

      bool GetValue (
         const char* id,         
         INT32& value,           
         XMLFORM_DATA::PROPERTY property = PROPERTY_Value
         ) const;

      bool GetValue (
         const char* id,         
         bool& value             
         ) const;


      bool GetValue (
         const char* id,         
         COLOR& value            
         ) const;


      XMLNODE* GetRecordNode (
         ) const {
         return m_root;
         }

      //======================= Set Methods ============================

      void SetValue (
         const char* id,         
         const MISTRING& value         
         );

      void SetValue (
         const char* id,         
         double value,           
         XMLFORM_DATA::PROPERTY property = PROPERTY_Value
         );

      void SetValue (
         const char* id,         
         bool value              
         );

      void SetValue (
         const char* id,         
         const COLOR& value      
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      enum TYPE {
         TYPE_Int,
         TYPE_Double,
         TYPE_String,
         TYPE_Bool,
         TYPE_Color
         };

      XMLNODE* m_root;  

      XMLNODE* FindNode (
         const char* id,
         bool create = false
         ) const;

      void OnDocReplaced();
      
      void InternalSetValue (
         const char* id,               
         const MISTRING& value,        
         PROPERTY property,
         TYPE type
         );
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

}     // End of MGUI namespace

#endif

---