mgui/canvas.h

Go to the documentation of this file.

#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 INC_MGUI_POINTERBUTTON_H
   #include <mgui/pointerbutton.h>
#endif

#ifndef  INC_MI32_STEREOVIEW_H
   #include <mi32/stereoview.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
class STEREODEVICE;
namespace MGD {
   class DEVICE;
   class CONTEXT;
   }
#endif


namespace MGUI {

//===================================================================================================================
class CANVAS : public CTRL {
   public:

      enum DEVICETYPE {
         DEVICETYPE_Screen,         
         DEVICETYPE_Pixmap,         
         DEVICETYPE_Memory,         
         DEVICETYPE_Stereo,         
         };

      enum STYLE {
         STYLE_Default =                  0x00,
         STYLE_UsePixmap =                0x01,    
         STYLE_UseMemory =                0x02,    
         STYLE_NoBuffer =                 0x04,    
         STYLE_NoDelayResize =            0x08,    
         STYLE_NotifyExpose =             0x10,    
         STYLE_TraverseToOnPointerEnter = 0x20,    
         };

      typedef fastdelegate::FastDelegate<bool(MGUI::POINT,MGUI::KEYCODE,MGUI::KEYSTATE)> DELEGATE_ONKEY;
      typedef fastdelegate::FastDelegate<bool(MGUI::POINT,MGUI::POINTERBUTTON,MGUI::KEYSTATE)> DELEGATE_ONPOINTER;
      typedef fastdelegate::FastDelegate<bool(MGUI::POINT,MGUI::POINTERBUTTON,MGUI::KEYSTATE,bool)> DELEGATE_ONPOINTERMOVE;
      typedef fastdelegate::FastDelegate<void(MGD::CONTEXT*)> DELEGATE_ONPAINT;
      typedef fastdelegate::FastDelegate<void(const LRECT2D&)> DELEGATE_ONUPDATERECT;
      typedef fastdelegate::FastDelegate<void(INT32)> DELEGATE_ONWHEEL;

      CANVAS (
         STYLE style = STYLE_Default
         );

      virtual ~CANVAS ();

      void AddDelegateOnPointerButtonDown (
         POINTERBUTTON buttons,           
         DELEGATE_ONPOINTER delegate      
         );

      void AddDelegateOnPointerButtonUp (
         POINTERBUTTON buttons,           
         DELEGATE_ONPOINTER delegate      
         );

      void Create (
         LAYOUT_PANE_BASE& ParentPane,    
         int width,                       
         int height,                      
         LAYOUT_SIZEALIGN sizealign,      
         CANVAS::STYLE style = STYLE_Default
         );

      void CursorSetVisible (
         bool visible                     
         );

      void Erase (
         const COLOR& color               
         );

      CURSORID GetCursor () const;

      MDLGPARENT GetDlgParent () const;

      MGD::CONTEXT* GetDrawingContext (
         DEVICETYPE DeviceType,
         STEREOVIEW StereoView = STEREOVIEW_None   
         ) const;

      MGD::DEVICE* GetDrawingDevice (
         DEVICETYPE DeviceType = DEVICETYPE_Memory    
         );

      MGD::DEVICE* GetDrawingDevice (
         DEVICETYPE DeviceType,                       
         bool AllowStereo                             
         );

      INT16 GetHeight () const;

      bool GetPointerLocation (
         MGUI::POINT& ptCanvas            
         ) const;

      void GetSize (
         INT16& width,                    
         INT16& height                    
         ) const;

      STYLE GetStyle () const;

      INT16 GetWidth () const;

      bool IsPointerCaptured () const;

      void PanFromBuffer (
         INT32 dx,                        
         INT32 dy,                        
         const COLOR *pColorBG            
         );

      void ReleaseCapture ();

      void Resize (
         INT16 width,                     
         INT16 height                     
         );

      void RestoreFromBuffer (
         DEVICETYPE devtype,              
         bool UpdateNow = false           
         );

      void RestoreFromBuffer (
         DEVICETYPE devtype,              
         const LRECT2D& rect,             
         bool UpdateNow = false           
         );

      void SetCursor (
         CURSORID cursorid
         );

      void SetDelegateOnKey (
         DELEGATE_ONKEY delegate
         );

      void SetDelegateOnPaint (
         DELEGATE_ONPAINT delegate
         );

      void SetDelegateOnPointerDoubleClick (
         DELEGATE_ONPOINTER delegate
         );

      void SetDelegateOnPointerEnter (
         DELEGATE_VOID_NOPARMS delegate
         );

      void SetDelegateOnPointerLeave (
         DELEGATE_VOID_NOPARMS delegate
         );

      void SetDelegateOnPointerMove (
         DELEGATE_ONPOINTERMOVE delegate
         );

      void SetDelegateOnPointerWheel (
         DELEGATE_ONWHEEL delegate
         );

      void SetDelegateOnSize (
         DELEGATE_ONSIZE delegate
         );

      void SetDelegateOnUpdatePixmap (
         DELEGATE_ONUPDATERECT delegate
         );

      void StereoDisable ();

      void StereoDrawCursor (
         MGUI::POINT ptCanvasL,                 
         MGUI::POINT ptCanvasR,                 
         LRECT2D& CursorRectL,                  
         LRECT2D& CursorRectR                   
         );

      void StereoEnable (
         const STEREODEVICE& StereoDevice       
         );

      const STEREODEVICE* StereoGetDeviceHW () const;

      bool StereoIsEnabled () const;

      void StereoUpdateFromBuffer ();

      void UpdateFromBuffer (
         DEVICETYPE DevTarget,                  
         DEVICETYPE DevSource,                  
         const LRECT2D *pRectSource = 0         
         );

   protected:

      virtual void v_OnCaptureChanged ();

      virtual bool v_OnKey (
         MGUI::POINT point,               
         MGUI::KEYCODE keycode,           
         MGUI::KEYSTATE keystate          
         );

      virtual void v_OnPaint (
         MGD::CONTEXT *gc                 
         );

      virtual void v_OnPointerButtonDown (
         MGUI::POINT point,               
         POINTERBUTTON button,            
         KEYSTATE keystate                
         );

      virtual void v_OnPointerButtonUp (
         MGUI::POINT point,               
         POINTERBUTTON button,            
         KEYSTATE keystate                
         );

      virtual void v_OnPointerEnter ();

      virtual void v_OnPointerLeave ();

      virtual void v_OnPointerMove (
         MGUI::POINT point,               
         POINTERBUTTON button,            
         KEYSTATE keystate,               
         bool hasmore                     
         );

      virtual void v_OnPointerWheel (
         INT32 direction                  
         );

      virtual void v_OnSize (
         int width,                       
         int height                       
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV *m_pPriv;

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

      virtual void v_OnUpdatePixmap (
         const LRECT2D& rect              
         );

   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(CANVAS::STYLE)
#endif

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

}  // End namespace MGUI


#endif   // INC_MGUI_CANVAS_H

---