canvas.h

Go to the documentation of this file.

/**
 * \file mgui/canvas.h
 * \brief MGUI "canvas" control definitions.
 *
 * \if NODOC
 * $Id: canvas.h_v 1.10 2005/03/31 16:57:07 fileserver!dwilliss Exp $
 *
 * $Log: canvas.h_v $
 * Revision 1.10  2005/03/31 16:57:07  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.9  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.8  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/04/09 20:48:40  dwilliss
 * never mind
 *
 * Revision 1.6  2003/04/09 20:46:28  dwilliss
 * Don't use _T in templates. Mac ctype.h defines a global _T
 *
 * Revision 1.5  2003/01/10 23:07:20  mju
 * Now working for tools.
 *
 * Revision 1.4  2003/01/07 18:25:31  mju
 * Add GetDlgParent.
 * Add v_OnKey.
 *
 * Revision 1.3  2003/01/07 15:03:23  mju
 * Use v_ for virtual methods.
 *
 * Revision 1.2  2002/10/14 13:46:38  mju
 * Rename ctrl_canvas as canvas.
 *
 * Revision 1.1  2002/10/11 20:32:18  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MGUI_CANVAS_H
#define  INC_MGUI_CANVAS_H

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

#ifndef INC_MGUI_KEYCODE_H
#include <mgui/keycode.h>
#endif

#ifndef INC_MGUI_CURSORID_H
#include <mgui/cursorid.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
namespace MGD {
   class DEVICE_X;
   class DEVICE_MEM24;
   class DEVICE_MEM32;
   class CONTEXT;
   }
#endif // GENERATING_DOXYGEN_OUTPUT


namespace MGUI {

#ifndef GENERATING_DOXYGEN_OUTPUT
//! Window derived from CWnd for MFC.
//! Not nested because MFC macros have problems with nested classes.
#ifdef WIN32_MFC
class WNDCANVAS;
#endif
#endif // GENERATING_DOXYGEN_OUTPUT

//===================================================================================================================
//!   Generic 'canvas' control supporting drawing and simple user input.
//! To avoid unnecessary overhead there is at present no 'template' (_CT) version of this class
//! due to the large number of virtual methods.
class CANVAS : public CTRL {
   public:

      enum DCTYPE {
         DCTYPE_Buffer,
         DCTYPE_Screen
         };

      enum STYLE {
         STYLE_Default =         0x00,
         STYLE_EnableOverlay =   0x01,
         STYLE_NoBuffer =        0x02
         };

      //! Constructor.
      CANVAS (
         STYLE style = STYLE_Default
         );

      //! Destructor.
      virtual ~CANVAS (
         );

      //! Create canvas control
      void Create (
         LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         int width,                       //!< Desired width in pixels
         int height,                      //!< Desired height in pixels
         LAYOUT_SIZEALIGN sizealign,      //!< Sizing and alignment options
         CANVAS::STYLE style = STYLE_Default
         );

      //! Get suitable parent for dialog launched from canvas.
      MDLGPARENT GetDlgParent (
         ) const;

      //! Get drawing context for buffer or direct display.
      //! Do not delete the returned CONTEXT as it is internal to the CANVAS.
      MGD::CONTEXT* GetDrawingContext (
         DCTYPE dctype = DCTYPE_Buffer    //!< Drawing context type
         );

      //! Get dimensions of canvas.
      void GetSize (
         INT16& width,                    //!< Width in pixels returned
         INT16& height                    //!< Height in pixels returned
         );

      //! Invalidate entire canvas.
      //! This will restore from off-screen buffer (if available) and/or
      //! generate OnPaint notification depending on canvas style.
      void Invalidate (
         bool UpdateNow = false           //!< Perform immediate update before returning
         );

      //! Invalidate specified portion of canvas.
      //! This will restore from off-screen buffer (if available) and/or
      //! generate OnPaint notification depending on canvas style.
      void Invalidate (
         const LRECT2D& rect,
         bool UpdateNow = false           //!< Perform immediate update before returning
         );

      //! Determine if mouse is "captured" by this canvas.
      bool IsMouseCaptured (
         ) const;

      //! Determine if canvas set for delayed redraw.
//!      bool IsRedrawDelayed (
//!         ) const { return (m_RedrawTimerID != 0); }

      //! Schedule redraw of canvas after specified delay.
      void RedrawDelayed (
         int delay = 1000                 //!< Delay in milliseconds
         );

      //! Set mouse cursor to show while in canvas.
      void SetCursor (
         CURSORID cursorid
         );

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT
   #ifdef WIN32_MFC
      WNDCANVAS *m_pctrl;
      friend class WNDCANVAS;
      class BUFDEVICE;
      BUFDEVICE *m_BufDev;
   #endif

   #ifdef X_NATIVE
      MGD::DEVICE_MEM24 *m_BufDev;
      MGD::DEVICE_X *m_DispDev;
      bool m_MouseCaptured;
      static void CB_Expose (Widget, CANVAS*, void*);
      static void CB_Resize (Widget, CANVAS*, void*);
      static void EH_Input (Widget, CANVAS*, XEvent*, Boolean*);
      void RestoreRect (const LRECT2D& rect);
   #endif

      MGD::CONTEXT *m_BufDC;
      MGD::CONTEXT *m_DispDC;
      CANVAS::STYLE m_style;

      void CreateBufDev ();
      CANVAS (const CANVAS&);
      CANVAS& operator= (const CANVAS&);
      #endif // GENERATING_DOXYGEN_OUTPUT

      // New overridables.

      //! Called when cursor "capture" is changed (lost).
      virtual void v_OnCaptureChanged (
         );

      //! Called when key "pressed".
      //! @return 'true' if key handled, 'false' if not.
      virtual bool v_OnKey (
         MGUI::POINT point,               //!< Point in canvas coordinates where button event occurred
         MGUI::KEYCODE keycode,           //!< Processed key code, equivalent to MIUNICODE for alphanumeric keys.
         MGUI::KEYSTATE keystate          //!< Modifier key state
         );

      //! Called when left mouse button pressed.
      virtual void v_OnLeftDown (
         MGUI::POINT point,               //!< Point in canvas coordinates where button event occurred
         KEYSTATE keystate                //!< Modifier key state at time of event
         );

      //! Called when left mouse button released.
      virtual void v_OnLeftUp (
         MGUI::POINT point,               //!< Point in canvas coordinates where button event occurred
         KEYSTATE keystate                //!< Modifier key state at time of event
         );

      //! Called when mouse cursor is moved.
      virtual void v_OnMouseMove (
         MGUI::POINT point,               //!< Point in canvas coordinates where button event occurred
         KEYSTATE keystate                //!< Modifier key state at time of event
         );

      //! Called when canvas needs to be redrawn, do not call directly.
      //! This is called after the buffer is updated to the screen.  If no overlay and not unbuffered
      //! then this method does not need to be overridden.
      virtual void v_OnPaint (
         MGD::CONTEXT *gc                 //!< Drawing context for unbuffered/overlay.
         );

      //! Called when right mouse button pressed.
      virtual void v_OnRightDown (
         MGUI::POINT point,               //!< Point in canvas coordinates where button event occurred
         KEYSTATE keystate                //!< Modifier key state at time of event
         );

      //! Called when right mouse button released.
      virtual void v_OnRightUp (
         MGUI::POINT point,               //!< Point in canvas coordinates where button event occurred
         KEYSTATE keystate                //!< Modifier key state at time of event
         );

      //! Called when canvas size changes.
      //! Note, this is NOT called repeatedly while the user resizes the window, but instead will be
      //! called after the user releases the mouse or pauses for a nominal period of time (.5 second).
      virtual void v_OnSize (
         int width,                       //!< New canvas width in pixels
         int height                       //!< New canvas height in pixels
         );

   };

DEFINE_ENUM_OP_BITWISE(CANVAS::STYLE);

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

}  // End namespace MGUI


#endif   // INC_MGUI_CANVAS_H

---