formrastervalue.h

Go to the documentation of this file.

/** 
 * \file mgui/formrastervalue.h 
 * \brief Definitions for MGUI::FORM_EDIT_RASTER_VALUE classes.
 *
 * \if NODOC
 * $Id: formrastervalue.h_v 1.6 2005/08/31 21:27:49 mju Exp $
 *
 * $Log: formrastervalue.h_v $
 * Revision 1.6  2005/08/31 21:27:49  mju
 * Use ctrl instead of form for edit fields as label is separate.
 *
 * Revision 1.5  2005/08/31 17:16:55  mju
 * Add clearValue and hasValue.
 *
 * Revision 1.4  2003/11/04 13:20:30  mju
 * GetValue can't be const.
 *
 * Revision 1.3  2003/10/01 22:32:27  dwilliss
 * doxygen
 *
 * Revision 1.2  2003/09/30 15:31:32  scowan
 * Fixed virtual method override.
 *
 * Revision 1.1  2003/09/29 22:59:06  scowan
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_FORM_EDIT_RASTER_VALUE_H
#define  INC_MGUI_FORM_EDIT_RASTER_VALUE_H

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

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

#ifndef  INC_RVC_IMAGE_H
#include <rvc/image.h>
#endif

namespace MGUI {

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

      //! Destructor.
      virtual ~FORM_EDIT_RASTER_VALUE (
         );

      //! Clear current value.
      void ClearValue (
         bool notify = true                     //!< Call v_OnChangeValue() if control has already been created
         );

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

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

      //! Get current raster value.
      void GetValue (
         ANYRASTVALUE& value
         );

      //! Determine if value has been set.
      bool HasValue (
         );
         
      void SetCellType (
         RVC::IMAGE::CELLTYPE CellType
         );

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

      //! 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 ANYRASTVALUE& value,          //!< New value to set
         bool notify = true                  //!< Call OnChangeValue() if string actually updated
         );

   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 v_OnChangeValue ();

   private:
      RVC::IMAGE::CELLTYPE m_CellType;
      CTRL_LABEL m_label;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_RASTER_VALUE> m_Value1;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_RASTER_VALUE> m_Value2;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_RASTER_VALUE> m_Value3;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_RASTER_VALUE> m_Value4;
      
      void OnValueChanged ();
   };


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

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

      //! Create form with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         const MISTRING& label,                 //!< Label
         RVC::IMAGE::CELLTYPE CellType,
         _CT *pContainer,                       //!< Pointer to container
         void (_CT::*pfOnChangeValue)(),              //!< Function to call when value changed, 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;
         FORM_EDIT_RASTER_VALUE::Create(ParentPane,label,CellType,sizealign,labelstyle);
         }

   private:

      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeValue)();

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

}  // End of MGUI namespace

#endif      // INC_MGUI_FORM_EDIT_RASTER_VALUE_H

---