mgui/toolcanv.h

Go to the documentation of this file.

/**
 * \file mgui/toolcanv.h
 * \brief MGUI::TOOL_CANVAS definitions.
 *
 * \if NODOC
 * $Id: toolcanv.h_v 1.4 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: toolcanv.h_v $
 * Revision 1.4  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.3  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/01/10 23:07:57  mju
 * Add GetCanvasExtents.
 *
 * Revision 1.1  2003/01/08 22:56:58  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_TOOLCANV_H
#define  INC_MGUI_TOOLCANV_H

#ifndef  INC_MGUI_CANVAS_H
   #include <mgui/canvas.h>
#endif

#ifndef  INC_MI32_MILIST_H
   #include <mi32/milist.h>
#endif

namespace MGUI {

#ifndef GENERATING_DOXYGEN_OUTPUT
class TOOL_BASE;
#endif // GENERATING_DOXYGEN_OUTPUT

//=====================================================================================================================
//!   TOOLCANVAS - Container canvas for graphic tools

class TOOLCANVAS : public CANVAS {

   public:

      //! Default constructor.
      TOOLCANVAS ();
      
      //! Destructor.               
      virtual ~TOOLCANVAS ();

      //! Get pointer to currently active graphic tool.
      TOOL_BASE *GetActiveTool (
         ) const { return (m_ActiveTool); }

      //! Resume active graphic tool.
      void GraphicToolResume (
         ) const;

      //! Suspend active graphic tool.
      void GraphicToolSuspend (
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      TOOL_BASE *m_ActiveTool;
      MILIST<TOOL_BASE*> m_ToolList;

      void AddTool (TOOL_BASE *const tool);
      void RemoveTool (TOOL_BASE *const tool);
      void SetActiveTool (TOOL_BASE* tool) { m_ActiveTool = tool; }

      //! MGUI::CANVAS overrides.
      virtual void v_OnCaptureChanged ();
      virtual bool v_OnKey (MGUI::POINT point, MGUI::KEYCODE keycode, MGUI::KEYSTATE keystate);
      virtual void v_OnLeftDown (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnLeftUp (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnMouseMove (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnPaint (MGD::CONTEXT *gc);
      virtual void v_OnRightDown (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnRightUp (MGUI::POINT point, KEYSTATE keystate);
      virtual void v_OnSize (int width, int height);
      #endif // GENERATING_DOXYGEN_OUTPUT

   friend class TOOL_BASE;
   };



}  // End namspace MGUI

#endif   // INC_MGUI_TOOLCANV_H

---