gre/uitreeview.h

Go to the documentation of this file.

#ifndef  INC_GRE_UITREEVIEW_H
#define  INC_GRE_UITREEVIEW_H

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

#ifndef  INC_MGUI_TREE_H
   #include <mgui/tree.h>
#endif

#ifndef  INC_MGUI_IMAGELST_H
   #include <mgui/imagelst.h>
#endif

#ifndef  INC_MAP
   #include <map>
#endif

namespace GRE {
//===================================================================================================================

class CTRL_TREEVIEW : public MGUI::CTRL_TREE {
   public:

      enum IMAGEIDX {
         IMAGEIDX_Blank = 0,
         IMAGEIDX_Layout,
         IMAGEIDX_Group2D,
         IMAGEIDX_Group3D,
         IMAGEIDX_Legend,
         IMAGEIDX_Component_Node,
         IMAGEIDX_Component_Point,
         IMAGEIDX_Component_Line,
         IMAGEIDX_Component_Polygon,
         IMAGEIDX_Component_Edge,
         IMAGEIDX_Component_Triangle,
         IMAGEIDX_Component_Text,
         IMAGEIDX_Component_Element,
         IMAGEIDX_Table_Generic,
         IMAGEIDX_Table_Form,
         IMAGEIDX_Table_Linked,
         IMAGEIDX_Table_StdAttrib,
         IMAGEIDX_Table_Style,
         IMAGEIDX_Table_Internal,
         IMAGEIDX_Table_LinkedMissing,
         };

      enum STATEIDX {
         STATEIDX_None =                     0,
         STATEIDX_Hidden =                   1,
         STATEIDX_Visible =                  2,
         STATEIDX_VisibleNotAll =            3,
         STATEIDX_ComponentNotSelectable =   4,
         STATEIDX_ComponentSelectable =      5,
         STATEIDX_Blank =                    6,
         // Maximum allowed index is 15
         };

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

      class SHARED {
         public:
            MGUI::IMAGELIST& GetImageListPrimary (
               ) { return (m_ImageListPrimary); }
            MGUI::IMAGELIST& GetImageListState (
               ) { return (m_ImageListState); }
         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            MGUI::IMAGELIST m_ImageListPrimary;
            MGUI::IMAGELIST m_ImageListState;
            SHARED ();
            SHARED (const SHARED&);
            SHARED& operator= (const SHARED&);
            friend class CTRL_TREEVIEW;
            #endif
         };

      typedef FastDelegate<bool(CTRL_TREEVIEW&,ITEMHND,HITRESULT,const LPOINT2D&,MGUI::POINTERBUTTON,MGUI::KEYSTATE)> DELEGATE_BUTTON;

      typedef FastDelegate<MGUI::CUSTOMDRAW::RETVALUE(CTRL_TREEVIEW&,MGUI::CUSTOMDRAW_TREE&)> DELEGATE_CUSTOMDRAW;

      typedef FastDelegate<void(CTRL_TREEVIEW&,ITEMHND)> DELEGATE_ITEM;

      typedef FastDelegate<void(CTRL_TREEVIEW&,ITEMVALUES,ITEMINFO&)> DELEGATE_GETITEMINFO;

      typedef FastDelegate<void(CTRL_TREEVIEW&,ITEMHND,CHILDVISIBILITY)> DELEGATE_VISIBILITYCHANGED;

      typedef FastDelegate<bool(CTRL_TREEVIEW&,ITEMHND,CHILDVISIBILITY)> DELEGATE_VISIBILITYCHANGING;

      typedef FastDelegate<bool(CTRL_TREEVIEW&,ITEMHND,HITRESULT,const LPOINT2D&,MGUI::CTRL_TOOLTIP&)> DELEGATE_TOOLTIP;

      static SHARED& GetShared (
         );

      CTRL_TREEVIEW ();

      virtual ~CTRL_TREEVIEW ();

      void Attach (
         VIEWABLE *viewable            
         );

      void Attach (
         VIEWABLE *viewable,           
         bool ShowTopObject            
         );

      void Attach (
         GRE::VIEW *view                  
         );

      void AttachAll (
         );

      void Detach (
         );

      ITEMHND GetItemFromPtr (
         const void *ptr
         ) const;

      ITEMHND GetItemFromObject (
         const GRE::OBJECT *object
         ) const;

      const ELEMSAMPLE_DC& GetLegendDC (
         GRE::LEGEND& legend,                
         MGD::CONTEXT *pgc
         );

      void* GetPtr (
         ITEMHND hndItem
         ) const;

      GRE::VIEW* GetView (
         ) const { return (m_view); }

      GRE::VIEWABLE* GetViewable (
         ) const { return (m_viewable); }

      VIEWMODE GetViewMode (
         ) const { return (m_viewmode); }

      ITEMHND Insert (
         const MISTRING& name,
         ITEMHND hndParent,
         ITEMHND hndInsertAfter,
         int ImageIdx,
         void *object,
         STATEIDX StateIdx = STATEIDX_None
         );

      bool IsAllBold (
         ITEMHND hndItem
         ) const;

      void SetAutoExpandWhenAddFirstChild (
         bool AutoExpand
         ) { m_AutoExpandWhenAddFirstChild = AutoExpand; }

      void SetDelegateOnChildVisibilityChanged (
         ITEMHND hndItem,
         DELEGATE_VISIBILITYCHANGED delegate
         );

      void SetDelegateOnChildVisibilityChanging (
         ITEMHND hndItem,
         DELEGATE_VISIBILITYCHANGING delegate
         );

      void SetDelegateOnCustomDraw (
         ITEMHND hndItem,
         DELEGATE_CUSTOMDRAW delegate
         );

      void SetDelegateOnGetItemInfo (
         ITEMHND hndItem,
         DELEGATE_GETITEMINFO delegate
         );

      void SetDelegateOnItemChangePosition (
         ITEMHND hndItem,
         DELEGATE_ITEM delegate
         );

      void SetDelegateOnPointerButtonDown (
         ITEMHND hndItem,
         DELEGATE_BUTTON delegate
         );

      void SetDelegateOnToolTipRequest (
         ITEMHND hndItem,
         DELEGATE_TOOLTIP delegate
         );

      void SetPtr (
         ITEMHND hndItem,
         void *ptr
         );

      void SetViewMode (
         VIEWMODE viewmode
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      class ITEM;
      typedef std::map<void*,ITEMHND> PTRHNDMAP;

      VIEWMODE m_viewmode;
      VIEWABLE *m_viewable;
      GRE::VIEW *m_view;
      bool m_IncludeTopObject;
      bool m_AutoExpandWhenAddFirstChild;
      PTRHNDMAP m_PtrHndMap;
      ELEMSAMPLE_DC m_LegendDC;

      static void GRECB_Object (
         const GRE::MSG *msg,
         void *vpTree
         );

      void Attach (VIEWABLE *viewable, GRE::VIEW *view, bool ShowTopObject);
      unsigned int ComputeGroupStateIdx (GRE::GROUP *group, bool skiplocator = false) const;

      ITEM* GetItem (
         ITEMHND hndItem
         ) const { return (static_cast<ITEM*>(reinterpret_cast<void*>(GetItemID(hndItem)))); }

      ITEM* GetItem (ITEMHND hndItem, bool create);
      ITEMHND InsertGroupItem (GRE::GROUP *group, ITEMHND hndParent, ITEMHND hndInsertAfter);
      ITEMHND InsertGroupSubItems (GRE::GROUP *group, ITEMHND hndParent, ITEMHND hndInsertAfter);
      ITEMHND InsertLayoutItem (GRE::LAYOUT *layout, ITEMHND hndParent, ITEMHND hndInsertAfter);
      void InsertLayoutSubItems (GRE::LAYOUT *layout, ITEMHND hndParent);

      void OnGreMsg (const GRE::MSG& msg);
      void OnGroupChangePosition (CTRL_TREEVIEW&, ITEMHND);
      void OnGroupChildVisibilityChanged (CTRL_TREEVIEW&, ITEMHND, CHILDVISIBILITY);
      bool OnGroupPointerButton (CTRL_TREEVIEW&, ITEMHND, HITRESULT, const LPOINT2D&, MGUI::POINTERBUTTON, MGUI::KEYSTATE);
      bool OnGroupToolTipRequest (CTRL_TREEVIEW&, ITEMHND, HITRESULT, const LPOINT2D&, MGUI::CTRL_TOOLTIP&);
      bool OnLayoutPointerButton (CTRL_TREEVIEW&, ITEMHND, HITRESULT, const LPOINT2D&, MGUI::POINTERBUTTON, MGUI::KEYSTATE);
      bool OnLayoutToolTipRequest (CTRL_TREEVIEW&, ITEMHND, HITRESULT, const LPOINT2D&, MGUI::CTRL_TOOLTIP&);
      void PopupMenuGroup(GRE::GROUP*, const LPOINT2D&);
      void PopupMenuLayout(GRE::LAYOUT*, const LPOINT2D&);
      void RemoveGreMsgHandler ();
      void SetAllStateImages ();
      void SetAllStateImages (GRE::LAYOUT*);
      void SetAllStateImages (GRE::GROUP*);
      void SetGroupStateImage (GRE::GROUP*, ITEMHND hndGroupItem = ITEMHND_None);
      bool UpdateGroupLegend (GRE::GROUP*, bool forceupdate = false);

      // MGUI::CTRL_TREE overrides.
      virtual void v_OnChildVisibilityChanged (ITEMHND hndItem, CHILDVISIBILITY visibility);
      virtual bool v_OnChildVisibilityChanging (ITEMHND hndItem, CHILDVISIBILITY visibility);
      virtual MGUI::CUSTOMDRAW::RETVALUE v_OnCustomDraw (MGUI::CUSTOMDRAW_TREE& CustomDraw);
      virtual void v_OnDestroyItem (ITEMHND hndItem);
      virtual void v_OnGetItemInfo (ITEMVALUES RequestedValue, ITEMINFO& ItemInfo);
      virtual void v_OnItemChangePosition (ITEMHND hndItem);
      virtual void v_OnPointerButtonDown (ITEMHND hndItem, HITRESULT HitResult, const LPOINT2D& point, MGUI::POINTERBUTTON button, MGUI::KEYSTATE keystate);
      virtual void v_OnPreInsertItem (ITEMINFO& ItemInfo);
      virtual bool v_OnToolTipRequest (ITEMHND hndItem, HITRESULT HitResult, const LPOINT2D& point, MGUI::CTRL_TOOLTIP& ToolTipCtrl);

      CTRL_TREEVIEW (const CTRL_TREEVIEW&);
      CTRL_TREEVIEW& operator= (const CTRL_TREEVIEW&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================
}  // End namespace GRE

#endif   // INC_GRE_UITREEVIEW_H

---