gre/uiviewtool.h

Go to the documentation of this file.

#ifndef  INC_GRE_UIVIEWTOOL_H
#define  INC_GRE_UIVIEWTOOL_H

#ifndef  INC_GRE_UIVIEWCANVAS_H
#include <gre/uiviewcanvas.h>
#endif

#ifndef  INC_MGUI_MENU_H
#include <mgui/menu.h>
#endif

namespace GRE {
namespace UI {

class VIEWTOOL;

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

class VIEWTOOLMGR {
   public:

      explicit VIEWTOOLMGR (
         GRE::UI::VIEW_CANVAS *view
         );

      ~VIEWTOOLMGR ();

      bool ActivateByHotKey (
         MGUI::KEYCODE keycode
         );

      void Add (
         VIEWTOOL *tool
         );

      void AddMenuItems (
         MGUI::MENU& Menu
         );

      void AddToolBarItems (
         MGUI::CTRL_TOOLBAR& ToolBar
         );

      void DeleteAllScripts (
         bool RemoveUI                 
         );

      VIEWTOOL* Find (
         VIEWTOOLID ViewToolID
         ) const;

      VIEWTOOL* FindByName (
         const MISTRING& name
         ) const;

      VIEWTOOL* GetActive (
         ) const { return (m_ActiveTool); }

      VIEWTOOL* GetDefault (
         ) const;

      VIEW_CANVAS* GetView (
         ) const { return (m_view); }

      bool IsActive (
         const VIEWTOOL* tool
         ) const { return (tool != 0 && tool == m_ActiveTool); }

      void Resume (
         );

      void SetActive (
         VIEWTOOL *tool
         ) { m_ActiveTool = tool; }

      void Suspend (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      friend class VIEWTOOL;
      typedef MILIST<VIEWTOOL*> TOOLLIST;
      VIEW_CANVAS *m_view;
      TOOLLIST m_ToolList;                      // List of tools
      VIEWTOOL *m_ActiveTool;                   // Tool currently in use

      // Unimplemented.
      VIEWTOOLMGR (const VIEWTOOLMGR&);
      VIEWTOOLMGR& operator= (const VIEWTOOLMGR&);
      #endif
   };

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

class VIEWTOOL {
   public:

      virtual ~VIEWTOOL ();

      void Activate (
         );

      void AddMenuItem (
         MGUI::MENU& Menu
         );

      void AddToolBarItem (
         MGUI::CTRL_TOOLBAR& ToolBar
         );

      void Deactivate (
         );

      MGUI::KEYCODE GetHotKeyCode (
         ) const { return (m_HotKeyCode); }

      ICONID GetIconID (
         ) const { return (m_iconid); }

      const MISTRING& GetName (
         ) const { return (m_name); }

      MDLGPARENT GetDlgParent (
         ) const { return (GetView()->GetDlgParent()); }

      GRE::UI::VIEW_CANVAS* GetView (
         ) const { return (m_pMgr->GetView()); }

      VIEWABLE* GetViewable (
         ) const { return (GetView()->GetViewable()); }

      const VIEWTOOLID GetViewToolID (
         ) const { return (m_id); }

      bool IsActive (
         ) const;

      bool IsDisabled (
         ) const { return (m_IsDisabled); }

      bool IsScript (
         ) const { return (m_IsScript); }

      bool IsSuspended (
         ) const { return (m_SuspendCount > 0); }

      void RemoveUI (
         );

      void Resume (
         );

      void SetEnabled (
         bool enable
         );

      void Suspend (
         );

   protected:

      enum TOOLSTATE {
         STATE_NotInitialized = 0,
         STATE_Inactive,
         STATE_Active,
         STATE_NoLayers,
         STATE_Suspended
         };

      VIEWTOOL (
         GRE::UI::VIEW_CANVAS& view,
         const MISTRING& name,
         ICONID iconid,
         ICID icidMenu,
         ICID icidToolBar,
         VIEWTOOLID toolid = VIEWTOOLID_Unspecified,
         char HotKey = 0
         );

      VIEWTOOL (
         GRE::UI::VIEW_CANVAS& view,
         const MISTRING& name,
         ICONID iconid,
         VIEWTOOLID toolid = VIEWTOOLID_Unspecified,
         char HotKey = 0
         );

      TOOLSTATE GetState (
         ) const { return (m_state); }

      void SetIsScript (
         ) { m_IsScript = true; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      typedef VIEWTOOL THISCLASS;

      GRE::UI::VIEWTOOLMGR *m_pMgr;
      GRE::UI::VIEWTOOLID m_id;
      MISTRING m_name;
      ICONID m_iconid;
      TOOLSTATE m_state;
      bool m_IsDisabled;
      bool m_IsScript;
      ICID m_icidMenu;                       // ID for tool menu item
      ICID m_icidToolBar;                    // ID for toolbar item
      MGUI::KEYCODE m_HotKeyCode;
      MGUI::MENU m_Menu;
      MGUI::MENU::ITEMHND m_ItemHndMenu;
      MGUI::CTRL_TOOLBAR *m_pToolBar;
      UINT32 m_ItemHndToolBar;
      UINT32 m_SuspendCount;

      bool CanActivate () const;
      void OnToggle (MGUI::ID, bool ToggleOn);

      // Unimplemented.
      VIEWTOOL (const VIEWTOOL&);
      VIEWTOOL& operator= (const VIEWTOOL&);
      #endif


      virtual bool v_Activate () = 0;
      virtual void v_Deactivate () = 0;
      virtual bool v_Initialize ();
      virtual void v_Resume ();
      virtual void v_Suspend ();

   };

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

}  // End namespace UI
}  // End namespace GRE

#endif   // INC_GRE_UIVIEWTOOL_H

---