formeditobjname.h

Go to the documentation of this file.

/** 
 * \file mgui/formeditobjname.h 
 * \brief Definitions for MGUI::FORM_EDIT_OBJECTNAME classes.
 *
 * \if NODOC
 * $Id: formeditobjname.h_v 1.4 2005/03/31 16:57:08 fileserver!dwilliss Exp $
 *
 * $Log: formeditobjname.h_v $
 * Revision 1.4  2005/03/31 16:57:08  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.3  2003/12/11 15:07:06  mju
 * Remove unnecessary base virtual call for onchangevalue.
 *
 * Revision 1.2  2003/10/01 22:32:25  dwilliss
 * doxygen
 *
 * Revision 1.1  2003/09/29 22:59:26  scowan
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_FORM_EDIT_OBJNAME_H
#define  INC_MGUI_FORM_EDIT_OBJNAME_H

#ifndef INC_MGUI_FORM_H
#include <mgui/form.h>
#endif

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

#ifndef  INC_RVCDEFNS_H
#include <mi32/rvcdefns.h>
#endif

namespace MGUI {

//! String 'edit' control.
class CTRL_EDIT_OBJECTNAME : public MGUI::CTRL_EDIT_BASE {
   public:

      //! Constructor.
      CTRL_EDIT_OBJECTNAME (
         );

      //! Destructor.
      virtual ~CTRL_EDIT_OBJECTNAME (
         );

      //! Clear to empty string.
      void ClearValue (
         bool notify = true                     //!< Call OnChangeValue() if control has already been created
         );

      //! Create control.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
         );

      //! Get current string value.
      const RVC::OBJECTNAME& GetValue (
         ) const { return (m_value); }

      //! Read value from INI file.
      //! If Create() has already been performed the control's state will be updated.
      void IniRead (
         INIHANDLE IniHandle,                //!< Handle to INI file to read from, 0 for default
         const char *IniGroup,               //!< INI group to read from
         const char *IniField,               //!< INI field to read from
         bool notify = true                  //!< Call OnChangeValue() if control has already been created
         );

      //! Write current value to INI file.
      void IniWrite (
         INIHANDLE IniHandle,                //!< Handle to INI file to read from, 0 for default
         const char *IniGroup,               //!< INI group to read from
         const char *IniField                //!< INI field to read from
         ) const { ::IniWrite(IniHandle,IniGroup,IniField,m_value); }

      //! Select range of characters in string.
      void SetSelection (
         int StartChar = 0,                  //!< Starting character position in string, 0 for beginning
         int EndChar = -1,                   //!< Ending character position, -1 for end of string
         bool NoScroll = true                //!< Indicates whether to scroll caret into view
         )
      #ifdef WIN32_MFC
         { m_ctrl.SetSel(StartChar,EndChar,NoScroll); }
      #endif
         ;

      //! Set current string value with validation.
      //! OnValidate() will be called and if valid, the string will be updated.
      //! No comparison is made with the current string value.
      void SetValue (
         const RVC::OBJECTNAME& name,        //!< New string to set
         bool notify = true                  //!< Call OnChangeValue() if string actually updated
         );

   protected:

      //! Validate the string and alter if possible/necessary.
      //! Derived class must call corresponding base class method BEFORE performing its own processing.
      //!   @return 'true' if string could be validated, 'false' if not
      virtual bool OnValidate (
         MISTRING& string                    //!< String to be validated
         );

   private:

      RVC::OBJECTNAME m_value;

      //! Called internally to update control-specific data from edit control.
      virtual void OnUserEdit ();
      virtual void UpdateValue (bool notify = true);

      CTRL_EDIT_OBJECTNAME (const CTRL_EDIT_OBJECTNAME&);
      CTRL_EDIT_OBJECTNAME& operator= (const CTRL_EDIT_OBJECTNAME&);
   };



//-------------------------------------------------------------------------------------------------------------------
//! Convenience template for String 'edit' control to allow method in container class to be called.
template <class _CT> class CTRL_EDIT_OBJECTNAME_T : public MGUI::CTRL_EDIT_OBJECTNAME {
   public:

      //! Constructor.
      explicit CTRL_EDIT_OBJECTNAME_T (
         ): m_pContainer(0), m_pfOnChangeValue(0), m_pfOnValidate(0)
         { }

      //! Create control.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         _CT *pContainer,                       //!< Pointer to container
         void (_CT::*pfOnChangeValue)(),              //!< Function to call when value changed, NULL for none
         bool (_CT::*pfOnValidate)(MISTRING& string), //!< Function to call for validation, NULL for none
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
         ) {
         m_pContainer = pContainer;
         m_pfOnChangeValue = pfOnChangeValue;
         m_pfOnValidate = pfOnValidate;
         CTRL_EDIT_OBJECTNAME::Create(ParentPane, sizealign);
         }

   private:
      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeValue)();
      bool (_CT::*m_pfOnValidate)(MISTRING&);

      virtual void OnChangeValue (
         ) {
         if (m_pContainer != 0) (m_pContainer->*m_pfOnChangeValue)();
         }

      virtual bool OnValidate (
         MISTRING& str
         ) {
         if (m_pContainer != 0 && m_pfOnValidate != 0) return((m_pContainer->*m_pfOnValidate)(str));
         return (CTRL_EDIT_OBJECTNAME::OnValidate(str));
         }
   };


//===================================================================================================================
//! Form consisting of label and string edit field.
class FORM_EDIT_OBJECTNAME : public MGUI::FORM_COMPOSITE {
   public:
      //! Constructor.
      FORM_EDIT_OBJECTNAME (
         );

      //! Destructor.
      virtual ~FORM_EDIT_OBJECTNAME (
         );

      //! Clear to empty string.
      void ClearValue (
         bool notify = true                     //!< Call OnChangeValue() if control has already been created
         ) { m_editctrl.ClearValue(notify); }

      //! Create form with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MISTRING& label,                 //!< Label
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         MGUI::CTRL_LABEL::STYLE labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap
         );

      //! Retrieve string "edit" control for form.
      MGUI::CTRL_EDIT_OBJECTNAME& GetEditCtrl (
         ) { return (m_editctrl); }

      //! Retrieve label control for form.
      //! Usually the label control is only retrieved for alignment purposes.
      MGUI::CTRL_LABEL& GetLabel (
         ) { return (m_label); }

      //! Get current string value.
      const RVC::OBJECTNAME& GetValue (
         ) const { return (m_editctrl.GetValue()); }

      //! Read value from INI file.
      //! If Create() has already been performed the control's state will be updated.
      void IniRead (
         INIHANDLE IniHandle,                //!< Handle to INI file to read from, 0 for default
         const char *IniGroup,               //!< INI group to read from
         const char *IniField,               //!< INI field to read from
         bool notify = true                  //!< Call OnChangeValue() if control has already been created
         ) { m_editctrl.IniRead(IniHandle,IniGroup,IniField,notify); }

      //! Write current value to INI file.
      void IniWrite (
         INIHANDLE IniHandle,                //!< Handle to INI file to write to, 0 for default
         const char *IniGroup,               //!< INI group to write to
         const char *IniField                //!< INI field to write to
         ) const { m_editctrl.IniWrite(IniHandle,IniGroup,IniField); }

      //! Set label text using string from resource lookup.
      void SetLabel (
         const MISTRING& label               //!< New label text
         ) { m_label.SetLabel(label); }

      //! Select range of characters in string.
      void SetSelection (
         int StartChar = 0,                  //!< Starting character position in string, 0 for beginning
         int EndChar = -1,                   //!< Ending character position, -1 for end of string
         bool NoScroll = true                //!< Indicates whether to scroll caret into view
         ) { m_editctrl.SetSelection(StartChar,EndChar,NoScroll); }

      //! Set set of 'valid' or 'invalid' characters.
      //! This does not alter the current contents, if any.
      void SetValidChars (
         const MIUNICODE* string,               //!< Characters valid or invalid to enter
         bool invert = false                 //!< Allow all but specified characters
         ) { m_editctrl.SetValidChars(string,invert); }

      //! Set current string value with validation.
      //! OnValidate() will be called and if valid, the string will be updated.
      //! No comparison is made with the current string value.
      void SetValue (
         const RVC::OBJECTNAME& name,        //!< New string to set
         bool notify = true                  //!< Call OnChangeValue() if string actually updated
         ) { m_editctrl.SetValue(name, notify); }

   protected:

      //! Called when value is changed after validation.
      //! Derived class must call corresponding base class method BEFORE performing its own processing.
      //! If the user modifies the text in the edit control this will not be called until the control loses "focus".
      virtual void OnChangeValue ();

      //! Validate the string and alter if possible/necessary.
      //! Derived class must call corresponding base class method BEFORE performing its own processing.
      //!   @return 'true' if string could be validated, 'false' if not
      virtual bool OnValidate (
         MISTRING& string                    //!< String to be validated
         );

   private:
      CTRL_LABEL m_label;
      CTRL_EDIT_OBJECTNAME_T<FORM_EDIT_OBJECTNAME> m_editctrl;
   };


//:>-------------------------------------------------------------------------------------------------------------------
//!   Convenience template for FORM_EDIT_OBJECTNAME to allow method in container class to be called.
template <class _CT> class FORM_EDIT_OBJECTNAME_T : public MGUI::FORM_EDIT_OBJECTNAME {
   public:

      //! Constructor.
      explicit FORM_EDIT_OBJECTNAME_T (
         ): m_pContainer(0), m_pfOnChangeValue(0), m_pfOnValidate(0)
         { }

      //! Create form with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MISTRING& label,                 //!< Label
         _CT *pContainer,                       //!< Pointer to container
         void (_CT::*pfOnChangeValue)(),              //!< Function to call when value changed, NULL for none
         bool (_CT::*pfOnValidate)(MISTRING& string), //!< Function to call for validation, NULL for none
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize,
         MGUI::CTRL_LABEL::STYLE labelstyle = MGUI::CTRL_LABEL::STYLE_LeftNoWrap
         ) {
         m_pContainer = pContainer;
         m_pfOnChangeValue = pfOnChangeValue;
         m_pfOnValidate = pfOnValidate;
         FORM_EDIT_OBJECTNAME::Create(ParentPane,label,sizealign,labelstyle);
         }

   private:

      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeValue)();
      bool (_CT::*m_pfOnValidate)(MISTRING&);

      virtual void OnChangeValue (
         ) { if (m_pfOnChangeValue != 0) (m_pContainer->*m_pfOnChangeValue)(); }
      virtual bool OnValidate (
         MISTRING& string
         ) { return ((m_pfOnValidate != 0) ? (m_pContainer->*m_pfOnValidate)(string) : true); }
   };

}  // End of MGUI namespace

#endif      // INC_MGUI_FORM_EDIT_OBJNAME_H

---