formnrgl.h

Go to the documentation of this file.

/**
 * \file migui/formnrgl.h 
 * \brief FORM_NAMEDREGION_LIST class definitions.
 *
 * \if NODOC
 * $Id: formnrgl.h_v 1.6 2004/05/25 15:09:36 mju Exp $
 *
 * $Log: formnrgl.h_v $
 * Revision 1.6  2004/05/25 15:09:36  mju
 * OnEndLabelEdit now uses non-const string.
 *
 * Revision 1.5  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.4  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/04/09 20:50:17  dwilliss
 * Don't use _T in templates. Mac's ctype.h defines a global _T
 *
 * Revision 1.2  2002/10/09 17:04:56  mju
 * Moved to 'mgui' folder.
 *
 * Revision 1.1  2002/08/13 20:25:25  mju
 * Initial revision
 *
 * 
 * 11    6/25/02 12:06p Mju
 * Update list when region saved.
 * 
 * 9     2/08/02 5:27p Dwilliss
 * Changed to use new CTRL_GRID
 * 
 * 8     12/13/01 10:55a Mju
 * MGUI unificiation with X.
 * 
 * 7     12/03/01 11:05a Mju
 * Remove references to old deprecated MGUI names.
 * Include miwin/CtrlList where needed.
 * 
 * 6     10/29/01 2:31p Mju
 * Use OnItemSelect instead of Activate
 * 
 * 1     1/24/01 8:47a Mju
 * \endif
**/

#ifndef  INC_MGUI_FORMNRGL_H
#define  INC_MGUI_FORMNRGL_H
#ifndef GENERATING_DOXYGEN_OUTPUT
#define  INC_MGUI_FORMNRGL_H
#endif // GENERATING_DOXYGEN_OUTPUT

#ifndef  INC_MI32_NAMEDRGN_H
#include <mi32/namedrgn.h>
#endif

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

#ifndef  INC_MGUI_GRID_H
#include <mgui/grid.h>
#endif


class FORM_NAMEDREGION_LIST {
   public:

      //! Constructor.
      FORM_NAMEDREGION_LIST (
         NAMEDREGION_LIST& RegionList
         );

      //! Destructor.
      virtual ~FORM_NAMEDREGION_LIST (
         );

      //! Create the form.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,
         MGUI::LAYOUT_SIZEALIGN sizing = MGUI::LAYOUT_SIZEALIGN_Expand
         );

      //! Get reference to currently selected region.
      //! Make sure a region is selected using IsRegionSelected().
      const NAMEDREGION& GetSelectedRegion (
         ) const { return (GetSelRegion()); }

      //! Determine if a region is currently selected in the list.
      bool IsRegionSelected (
         ) const { return (m_ListCtrl.GetSelectedCount() > 0); }

   protected:

      //! Called when a region gets selected or all regions become unselected.
      virtual void OnChangeSelection (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      class LISTOBSERVER : public NAMEDREGION_LIST::OBSERVER {
         public:
            LISTOBSERVER (
               FORM_NAMEDREGION_LIST& form
               );
            virtual void OnChanged (const NAMEDREGION& item);
            virtual void OnClear ();
            virtual void OnInsert (const NAMEDREGION& item);
            virtual void OnRemove (const NAMEDREGION& item);
         private:
            FORM_NAMEDREGION_LIST& m_form;
         };

      NAMEDREGION_LIST& m_RegionList;
      LISTOBSERVER m_ListObserver;
      MGUI::CTRL_GRID_T<FORM_NAMEDREGION_LIST> m_ListCtrl;
      MGUI::CTRL_PUSHBUTTON_T<FORM_NAMEDREGION_LIST> m_AddPB;
      MGUI::CTRL_PUSHBUTTON_T<FORM_NAMEDREGION_LIST> m_SaveAsPB;
      MGUI::CTRL_PUSHBUTTON_T<FORM_NAMEDREGION_LIST> m_RemovePB;
      MGUI::CTRL_PUSHBUTTON_T<FORM_NAMEDREGION_LIST> m_CombinePB;
      MDLGPARENT m_DlgParent;

      void AddListCtrlItem (const NAMEDREGION&);
      NAMEDREGION& GetSelRegion () const;
      void OnAdd ();
      void OnCombine ();
      bool OnListCtrlBeginLabelEdit (int, int);
      void OnListCtrlItemSelect (int itemnum, int subitem);
      bool OnListCtrlEndLabelEdit (int, int, MISTRING&);
      void OnRemove ();
      void OnSaveAs ();

      // UNIMPLEMENTED / UNSUPPORTED
      FORM_NAMEDREGION_LIST (const FORM_NAMEDREGION_LIST&);
      FORM_NAMEDREGION_LIST& operator= (const FORM_NAMEDREGION_LIST&);

      friend class LISTOBSERVER;
      friend class LISTCTRL;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


template <class _CT> class FORM_NAMEDREGION_LIST_T : public FORM_NAMEDREGION_LIST {
   public:

      //! Constructor.
      FORM_NAMEDREGION_LIST_T (
         NAMEDREGION_LIST& RegionList
         ): FORM_NAMEDREGION_LIST(RegionList), m_container(0), m_funcptr(0)
         { }

      //! Destructor.
      virtual ~FORM_NAMEDREGION_LIST_T (
         ) { }

      //! Create the form.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,
         _CT *cbcontainer,                      //!< Pointer to callback container class
         void (_CT::*cbfuncptr)(),              //! Callback function pointer
         MGUI::LAYOUT_SIZEALIGN sizing = MGUI::LAYOUT_SIZEALIGN_Expand
         ) {
         m_container = cbcontainer;
         m_funcptr = cbfuncptr;
         FORM_NAMEDREGION_LIST::Create(ParentPane,sizing);
         return;
         }

   protected:

      //! Called when a region gets selected or all regions become unselected.
      virtual void OnChangeSelection (
         ) { (m_container->*m_funcptr)(); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_container;
      void (_CT::*m_funcptr)();
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

#endif   // INC_MGUI_FORMNRGL_H

---