mfctreeview.h

Go to the documentation of this file.

/**
 * \file mfctreeview.h <gre/mfctreeview.h>
 * \brief GRE MFC_TREEVIEW class
 *
 * \if NODOC
 * $Id: mfctreeview.h_v 1.5 2005/03/31 16:57:06 fileserver!dwilliss Exp $
 *
 * $Log: mfctreeview.h_v $
 * Revision 1.5  2005/03/31 16:57:06  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.4  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/07/30 15:36:35  mju
 * Ignore entire header as for legacy only.
 *
 * Revision 1.2  2003/06/18 13:56:59  mju
 * Include stuff for MFC.
 *
 * Revision 1.1  2003/06/17 13:40:07  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_MFCTREEVIEW_H
#define  INC_GRE_MFCTREEVIEW_H

#ifndef  INC_GRE_BASE_H
   #include <gre/base.h>
#endif

#ifndef  INC_GRE_ELEMSAMPLEDC_H
   #include <gre/elemsampledc.h>
#endif

#if !defined(_OXTOOLTIPCTRL_H__) && defined(WIN32_MFC)
   #include <mgui/oxttctrl.h>
#endif

#if !defined(__TREECTRLEX_H) && defined(WIN32_MFC)
   #include <mgui/treectex.h>
#endif

#if !defined(INC_MGUI_SIZINGCB_H) && defined(WIN32_MFC)
   #include <mgui/sizingcb.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
//===================================================================================================================

#ifdef WIN32_MFC

class GRE_MFC_TREEVIEW {
   public:

      enum IMAGEIDX {
         IMAGEIDX_Blank = 0,
         IMAGEIDX_Layout,
         IMAGEIDX_Group2D,
         IMAGEIDX_Group3D,
         IMAGEIDX_LayerRaster,
         IMAGEIDX_LayerVector,
         IMAGEIDX_LayerCAD,
         IMAGEIDX_LayerDBPinmap,
         IMAGEIDX_LayerMapGrid,
         IMAGEIDX_LayerScaleBar,
         IMAGEIDX_LayerText,
         IMAGEIDX_LayerLegend,
         IMAGEIDX_LayerTIN,
         IMAGEIDX_LayerSketch,
         IMAGEIDX_LayerRegion,
         IMAGEIDX_LayerSurface,
         IMAGEIDX_LayerSML,
         IMAGEIDX_LayerFormula,
         IMAGEIDX_Legend,
         IMAGEIDX_Tables,
         IMAGEIDX_ComponentNode,
         IMAGEIDX_ComponentPoint,
         IMAGEIDX_ComponentLine,
         IMAGEIDX_ComponentPolygon,
         IMAGEIDX_ComponentEdge,
         IMAGEIDX_ComponentTriangle,
         IMAGEIDX_ComponentText,
         IMAGEIDX_ComponentRed,
         IMAGEIDX_ComponentGreen,
         IMAGEIDX_ComponentBlue,
         IMAGEIDX_ComponentGray,
         IMAGEIDX_ComponentCyan,
         IMAGEIDX_ComponentMagenta,
         IMAGEIDX_ComponentYellow,
         IMAGEIDX_ComponentHue,
         IMAGEIDX_ComponentSaturation,
         IMAGEIDX_TableGeneric,
         IMAGEIDX_TableForm,
         IMAGEIDX_TableLinked,
         IMAGEIDX_TableStdAttrib,
         IMAGEIDX_TableStyle,
         IMAGEIDX_TableInternal,
         IMAGEIDX_COUNT
         };

      enum ITEMTYPE {
         ITEMTYPE_NotUsed = 0,
         ITEMTYPE_Layout,
         ITEMTYPE_Group,
         ITEMTYPE_Layer,
         ITEMTYPE_ElementsParent,
         ITEMTYPE_LegendParent,
         ITEMTYPE_TableParent,
         ITEMTYPE_Component,
         ITEMTYPE_LegendItem,
         ITEMTYPE_Table,
         ITEMTYPE_Custom
         };

      enum STATEIDX {
         STATEIDX_None = 0,
         STATEIDX_Hidden,
         STATEIDX_Visible,
         STATEIDX_NotVisibleAtScale,
         STATEIDX_ComponentNotSelectable,
         STATEIDX_ComponentSelectable,
         //! Maximum of 15 state images!
         STATEIDX_COUNT
         };

      enum VIEWMODE {
         VIEWMODE_Controls =     0x01,
         VIEWMODE_Legend =       0x02,
         VIEWMODE_Mixed =        0x03
         };

      class ITEMINFO;

      typedef void (*ITEMDRAWFUNC)(GRE_MFC_TREEVIEW& TreeView, const ITEMINFO& info, bool bFocus, const CRect& rcItem, HDC hdc);

      class ITEMINFO {
         public:
            ITEMTYPE GetType (
               ) const { return (m_itemtype); }
            void *GetPtr (
               ) const { return (m_itemptr); }
            UINT32 GetValue (
               ) const { return (m_itemvalue); }
            ITEMDRAWFUNC GetDrawFunc (
               ) const { return (m_ItemDrawFunc); }
         private:
            ITEMTYPE m_itemtype;
            void *m_itemptr;
            UINT32 m_itemvalue;
            ITEMDRAWFUNC m_ItemDrawFunc;
         friend class GRE_MFC_TREEVIEW;
         };

      //! Constructor.
      GRE_MFC_TREEVIEW (
         GRE_VIEWABLE *viewable = 0,
         GRE_MFC_VIEW *mfcview = 0
         );

      //! Destructor.
      ~GRE_MFC_TREEVIEW (
         );

      //! Compute item height multiplier for desired height in pixels.
      int ComputeHeightMult (
         int height                          //!< Desired item height in pixels
         ) const;

      //! Compute string of specified width.
      //! This is used by custom-draw for a base label where the legend sample goes.
      void ComputeStringForWidth (
         int width,                          //!< Width in pixels
         MISTRING& string                    //!< String returned
         );

      //! Create the control.
      //! Returns 'false' if failed or 'true' if succeeded.
      bool Create (
         CWnd *pParentWnd,
         UINT nID
         );

      //! Get DLGPARENT using TreeView.
      MDLGPARENT GetDlgParent (
         ) { return (&m_TreeCtrl); }

      //! Get GRE_VIEW pointer.
      GRE_VIEW* GetView (
         ) const { return (m_view); }

      //! Get current viewing mode.
      VIEWMODE GetViewMode (
         ) const { return (m_viewmode); }

      //! Insert item into TreeView with label from resource lookup.
      HTREEITEM InsertItem (
         const char *label,
         HTREEITEM hParent,
         HTREEITEM hInsertAfter,
         IMAGEIDX ImageIdx,
         ITEMTYPE ItemType,
         void *ItemPtr,
         UINT32 itemvalue = 0,
         STATEIDX stateidx = STATEIDX_None,
         int HeightMult = 1
         );

      //! Insert item into TreeView with MIUNICODE label.
      HTREEITEM InsertItem (
         const MIUNICODE *label,
         HTREEITEM hParent,
         HTREEITEM hInsertAfter,
         IMAGEIDX ImageIdx,
         ITEMTYPE ItemType,
         void *ItemPtr,
         UINT32 itemvalue = 0,
         STATEIDX stateidx = STATEIDX_None,
         int HeightMult = 1
         );

      //! Insert custom-drawn item.
      HTREEITEM InsertItem (
         const MIUNICODE *label,
         HTREEITEM hParent,
         HTREEITEM hInsertAfter,
         void *ItemPtr,
         UINT32 itemvalue,
         ITEMDRAWFUNC itemdrawfunc,
         ITEMTYPE ItemType = ITEMTYPE_Custom,
         int HeightMult = 1
         );

      //! Redraw view, uses 50 millisecond delay to avoid flashing.
      void RedrawView (
         );

      //! Set "state image" for item.
      void SetItemStateImage (
         HTREEITEM hItem,
         STATEIDX stateidx
         );

      //! Set root item label prefix.
      void SetRootPrefix (
         const MIUNICODE *string
         );

      //! Set associated view.
      void SetView (
         GRE_MFC_VIEW *mfcview
         );

      //! Set viewable object.
      void SetViewable (
         GRE_VIEWABLE *viewable
         );

      //! Set viewing mode.
      void SetViewMode (
         VIEWMODE viewmode
         );

      //! Track popup menu on right mouse button.
      //! @return Command ID of menu item chosen or 0 if none/error.
      int TrackPopupMenu (
         CMenu& menu,
         const CPoint& mpoint
         );

   private:

      class MYTREECTRL : public CTreeCtrlEx {
         public:
            MYTREECTRL (
               GRE_MFC_TREEVIEW& TreeView
               );
            HTREEITEM FindItemByPtr (
               HTREEITEM hParent,
               void *itemptr,
               ITEMTYPE itemtype = ITEMTYPE_NotUsed
               );
            bool IsCreated (
               ) const { return (m_hWnd != 0); }
         protected:
            afx_msg void OnBeginDrag (NM_TREEVIEW* pNM, LRESULT* pResult);
            afx_msg BOOL OnCustomDraw (NMTVCUSTOMDRAW* pNM, LRESULT* pResult);
            afx_msg void OnDeleteItem (NM_TREEVIEW* pNM, LRESULT* pResult);
            afx_msg void OnLButtonDown (UINT nFlags, CPoint point);
            afx_msg void OnRButtonDown (UINT nFlags, CPoint point);
            afx_msg void OnSelChanged (NM_TREEVIEW* pNM, LRESULT* pResult);
            afx_msg void OnSelChanging (NM_TREEVIEW* pNM, LRESULT* pResult);
            DECLARE_MESSAGE_MAP()
         private:
            GRE_MFC_TREEVIEW& m_TreeView;
            MYTREECTRL (const MYTREECTRL&);
            MYTREECTRL& operator= (const MYTREECTRL&);
         };
      friend class GRE_MFC_TREEVIEW::MYTREECTRL;

      MYTREECTRL m_TreeCtrl;
      SIMPLE_ARRAY<ITEMINFO> m_ItemInfo;
      GRE_VIEWABLE *m_viewable;
      GRE_MFC_VIEW *m_mfcview;
      GRE_VIEW *m_view;
      VIEWMODE m_viewmode;
      double m_LastViewScale;
      GRE_ELEMSAMPLE_DC m_LegendDC;
      MISTRING m_RootPrefix;
      CMenu m_PopupMenuLayout;
      CMenu m_PopupMenuGroup;
      HTREEITEM m_hPopupItem;

      static CImageList& GetImageList (int ImageListType);
      static void GRECB_Viewable (GRE_CALLBACK_MSG*, GRE_MFC_TREEVIEW*);

      void AddGroupItem (HTREEITEM, HTREEITEM, GRE_GROUP*);
      void AddGroupSubItems (GRE_GROUP*, HTREEITEM hGroupItem = 0);
      HTREEITEM AddLayerItem (HTREEITEM, HTREEITEM, GRE_LAYER*);
      int AllocItem (ITEMTYPE, void*, UINT32 itemvalue = 0, ITEMDRAWFUNC itemdrawfunc = 0);
      HTREEITEM GetGroupItem (GRE_GROUP*);
      HTREEITEM GetLayerItem (GRE_LAYER*);
      const GRE_ELEMSAMPLE_DC& GetLegendDC (GRE_LEGEND*);
      void GetRootLabel (MISTRING&) const;
      void HandleMsgViewable (const GRE_CALLBACK_MSG&);
      void Init ();
      void OnCmdCollapseAll ();
      void OnCmdExpandAll ();
      void OnCmdSetBackgroundColor ();
      void OnPopupMenuGroup (const CPoint&, GRE_GROUP*);
      void OnPopupMenuLayout (const CPoint&, GRE_LAYOUT*);
      void SetGroupStateImage (GRE_GROUP*, HTREEITEM hGroupItem = 0);
      void SetLayerStateImage (GRE_LAYER*, HTREEITEM hLayerITem = 0);
      bool UpdateGroupLegend (GRE_GROUP*, HTREEITEM hGroupItem = 0, bool forceupdate = false);
      void UpdateRootLabel ();
      void UpdateVisibilityStates ();
      void UpdateVisibilityStatesGroup (HTREEITEM);

      // UNIMPLEMENTED
      GRE_MFC_TREEVIEW (const GRE_MFC_TREEVIEW&);
      GRE_MFC_TREEVIEW& operator= (const GRE_MFC_TREEVIEW&);
   };

#endif

//===================================================================================================================

#ifdef WIN32_MFC

class GRE_MFC_TREEVIEWBAR : public CSizingControlBarG {
   public:

      //! Constructor.
      GRE_MFC_TREEVIEWBAR (
         );

      //! Destructor.
      virtual ~GRE_MFC_TREEVIEWBAR (
         );

      //! Create with default options.
      BOOL CreateDft (
         CWnd* pParentWnd,
         UINT nID
         );

      //! Get current viewing mode.
      GRE_MFC_TREEVIEW::VIEWMODE GetViewMode (
         ) const { return (m_TreeView.GetViewMode()); }

      //! Set title prefix for when undocked.
      void SetTitle (
         const MIUNICODE *string
         );

      //! Set view to associate with TreeView.
      void SetView (
         GRE_MFC_VIEW *mfcview
         ) { m_TreeView.SetView(mfcview); return; }

      //! Set viewable object.
      void SetViewable (
         GRE_VIEWABLE *viewable
         ) { m_TreeView.SetViewable(viewable); return; }

      //! Set viewing mode.
      void SetViewMode (
         GRE_MFC_TREEVIEW::VIEWMODE viewmode
         ) { m_TreeView.SetViewMode(viewmode); return; }

   protected:
      afx_msg int OnCreate (LPCREATESTRUCT lpCreateStruct);
      DECLARE_MESSAGE_MAP()

   private:
      GRE_MFC_TREEVIEW m_TreeView;
   };

#endif

//===================================================================================================================
#endif //!< GENERATING_DOXYGEN_OUTPUT

#endif   //!< INC_GRE_MFCTREEVIEW_H

---