formextents.h

Go to the documentation of this file.

/** 
 * \file mgui/formextents.h 
 * \brief Definitions for MGUI::FORM_EDIT_EXTENTS class.
 *
 * \if NODOC
 * $Id: formextents.h_v 1.6 2004/11/24 17:15:05 mju Exp $
 *
 * $Log: formextents.h_v $
 * Revision 1.6  2004/11/24 17:15:05  mju
 * Change flag names to clarify purpose.
 *
 * Revision 1.5  2004/07/08 13:24:19  mju
 * Add ClearExtents.
 *
 * Revision 1.4  2004/06/30 13:54:41  mju
 * Add HasAllRangeValues.
 *
 * Revision 1.3  2004/06/22 19:41:48  scowan
 * Updated to use coord ref system.
 *
 * Revision 1.2  2004/06/11 17:30:11  scowan
 * Added doxygen wrappers.
 *
 * Revision 1.1  2004/06/10 21:28:09  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_FORM_EDIT_EXTENTS_H
#define  INC_MGUI_FORM_EDIT_EXTENTS_H

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

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

#ifndef  INC_MGUI_FORMBTXT_H
#include <mgui/formbtxt.h>
#endif

#ifndef  INC_MGUI_COMBOBOX_H
#include <mgui/combobox.h>
#endif

#ifndef  INC_MI32_SPATREF_H
#include <mi32/spatref.h>
#endif

namespace MGUI {

//:>===================================================================================================================
//! Form consisting of label and string edit field.
class FORM_EDIT_EXTENTS : public MGUI::FORM_COMPOSITE {
   public:

      enum FLAGS {
         FLAG_None =                      0x00,
         FLAG_AllowAllGeorefDatumTypes =  0x01,    //!< Allow all georeference-supported datum types
         FLAG_NoChangeCoordRefSys =       0x02     //!< Disallow changing of coordinate reference system
         };
   
      //! Constructor.
      FORM_EDIT_EXTENTS (
         );

      //! Destructor.
      virtual ~FORM_EDIT_EXTENTS (
         );

      //! Clear range edit controls.
      void ClearExtents (
         bool notify = true
         );

      //! Create form with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         bool IsRangeEditable = true,
         FLAGS flags = FLAG_None,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
         );

      //! Get the extents of the form
      const DRECT2D& GetExtents (
         ) const { return (m_Extents); }
         
      //! Get the projection to use for extents selection.
      const SPATREF::COORDREFSYS& GetCoordRefSys (
         ) const { return (m_CoordRefSys); }

      //! Determine if user has entered values for all range fields.
      bool HasAllRangeValues (
         );

      //! Set the extents of the form
      //! Do this after the call to SetProjection() or the call to the method will alter the extents
      void SetExtents (
         const DRECT2D& Extents,
         bool notify = true
         );

      //! Set the projection to use for extents selection.
      //! If a projection and value coordinates exists, the coordinates will be converted to the new projection
      void SetCoordRefSys (
         const SPATREF::COORDREFSYS& CoordRefSys,
         bool notify = true
         );

      //! Set the extents section to be editable
      void SetRangeEditable (
         bool IsRangeEditable
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      SPATREF::COORDREFSYS m_CoordRefSys;
      DRECT2D m_Extents;
      bool m_IsRangeEditable;
      FLAGS m_flags;
      
      FORM_BUTTONTEXT_T<FORM_EDIT_EXTENTS> m_Projection;

      LAYOUT_PANE m_YPane;
      CTRL_LABEL m_YLabel;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_EXTENTS> m_YInit;
      CTRL_LABEL m_YTo;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_EXTENTS> m_YLast;
      
      LAYOUT_PANE m_XPane;
      CTRL_LABEL m_XLabel;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_EXTENTS> m_XInit;
      CTRL_LABEL m_XTo;
      CTRL_EDIT_NUMBER_T<FORM_EDIT_EXTENTS> m_XLast;
      
      virtual void v_OnChangeExtents ();
      virtual void v_OnChangeProjection ();

      void OnExtentsChanged ();
      void OnProjectionPressed ();
      
      void UpdateProjection ();
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

DEFINE_ENUM_OP_BITWISE(FORM_EDIT_EXTENTS::FLAGS);

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

      //! Constructor.
      explicit FORM_EDIT_EXTENTS_T (
         _CT *pContainer
         ): m_pContainer(pContainer), m_pfOnChangeExtents(0), m_pfOnChangeCoordRefSys(0) 
         { }

      //! Set container pointer.
      //! Container may also be specified in constructor.
      void SetContainer (
         _CT *pContainer
         ) { m_pContainer = pContainer; }

      //! Set container method to call for OnChangeExtents().
      void SetFuncChangeExtents (
         void (_CT::*pfOnChangeExtents)()
         ) { m_pfOnChangeExtents = pfOnChangeExtents; };

      //! Set container method to call for OnChangeProjection()
      void SetFuncChangeCoordRefSys (
         void (_CT::*pfOnChangeCoordRefSys)()
         ) { m_pfOnChangeCoordRefSys = pfOnChangeCoordRefSys; };

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_pContainer;
      void (_CT::*m_pfOnChangeExtents)();
      void (_CT::*m_pfOnChangeCoordRefSys)();

      virtual void v_OnChangeExtents (
         ) { if (m_pfOnChangeExtents != 0) (m_pContainer->*m_pfOnChangeExtents)(); }

      virtual void v_OnChangeCoordRefSys (
         ) { if (m_pfOnChangeCoordRefSys != 0) (m_pContainer->*m_pfOnChangeCoordRefSys)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}  // End of MGUI namespace

#endif      // INC_MGUI_FORM_EXTENTS_H

---