mgui/gadget.h

Go to the documentation of this file.

#ifndef  INC_MGUI_GADGET_H
#define  INC_MGUI_GADGET_H

#ifndef  INC_MGUI_TOOLCANVAS_H
   #include <mgui/toolcanvas.h>
#endif


namespace MGUI {

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

class GADGET {
   public:

      enum PLACEMENT {
         PLACEMENT_Center =         0x001,
         PLACEMENT_CenterLeft =     0x002,
         PLACEMENT_CenterRight =    0x004,
         PLACEMENT_BottomCenter =   0x008,
         PLACEMENT_BottomLeft =     0x010,
         PLACEMENT_BottomRight =    0x020,
         PLACEMENT_TopCenter =      0x040,
         PLACEMENT_TopLeft =        0x080,
         PLACEMENT_TopRight =       0x100,

         PLACEMENT_AnyLeft =        PLACEMENT_CenterLeft | PLACEMENT_BottomLeft | PLACEMENT_TopLeft,
         PLACEMENT_AnyRight =       PLACEMENT_CenterRight | PLACEMENT_BottomRight | PLACEMENT_TopRight,
         PLACEMENT_AnyBottom =      PLACEMENT_BottomCenter | PLACEMENT_BottomLeft | PLACEMENT_BottomRight,
         PLACEMENT_AnyTop =         PLACEMENT_TopCenter | PLACEMENT_TopLeft | PLACEMENT_TopRight,
         PLACEMENT_AnyCorner =      PLACEMENT_BottomLeft | PLACEMENT_BottomRight | PLACEMENT_TopLeft | PLACEMENT_TopRight,
         PLACEMENT_Any =            0x1FF
         };

      enum CANVASDEVICES {
         CANVASDEVICE_Memory =         0x01,    
         CANVASDEVICE_Pixmap =         0x02,    
         CANVASDEVICE_ScreenIfActive = 0x04,    
         CANVASDEVICE_ScreenAlways =   0x08,    
         CANVASDEVICE_Stereo =         0x10,    
         };

      enum FLAGS {
         FLAG_None =             0,
         FLAG_AllowUserHide =    0x01,    
         FLAG_HasDlgSettings =   0x02,    
         };

      virtual ~GADGET () = 0;

      bool operator< (const GADGET& rhs) const
         { return (m_priority < rhs.m_priority); }

      bool CanDrawOnDeviceType (
         CANVAS::DEVICETYPE DeviceType
         ) const;

      bool DlgEditSettings (
         MDLGPARENT dlgparent
         );

      void Draw (
         CANVAS::DEVICETYPE DeviceType
         );

      PLACEMENT GetPlacement () const
         { return (m_Placement); }

      const MGUI::POINT& GetPosition () const
         { return (m_pos); }

      INT16 GetPriority () const
         { return (m_priority); }

      const MGUI::POINT& GetSize () const
         { return (m_size); }

      bool HasPosition () const
         { return (m_hasposition); }

      bool IsVisible () const
         { return (m_visible); }

      bool OnToolTipRequest (CTRL_TOOLTIP& tooltip, MGUI::POINT ptCanvas)
         { return (v_OnToolTipRequest(tooltip,ptCanvas)); }

      void SetDelegateOnChangePlacement (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnChangePlacement = delegate; }

      void SetDelegateOnChangeSettings (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnChangeSettings = delegate; }

      void SetDelegateOnChangeVisible (
         DELEGATE_VOID_NOPARMS delegate
         ) { m_DelegateOnChangeVisible = delegate; }

      void SetPlacement (
         PLACEMENT Placement,       
         bool notify = true
         );

      void SetPlacementsAllowed (
         PLACEMENT PlacementsAllowed
         ) { m_PlacementsAllowed = PlacementsAllowed; }

      void SetPriority (
         INT16 priority
         ) { m_priority = priority; }

      void SetVisible (
         bool visible,
         bool notify = true
         );

   protected:

      explicit GADGET (
         TOOLCANVAS *pCanvas,
         PLACEMENT PlacementsAllowed,
         FLAGS flags = FLAG_None,
         CANVASDEVICES CanvasDevices = CANVASDEVICE_Memory
         );

      void Draw (MGD::CONTEXT *gc, CANVAS::DEVICETYPE DeviceType);

      TOOLCANVAS* GetCanvas () const
         { return (m_pCanvas); }

      bool IsPointerCaptured () const;

      void SetCursor (
         CURSORID cursorid
         ) const { m_pCanvas->SetCursor(cursorid); }

      MGUI::POINT TransCanvasToGadget (
         MGUI::POINT ptCanvas
         ) const { return (MGUI::POINT(ptCanvas.m_x-m_pos.m_x,ptCanvas.m_y-m_pos.m_y)); }

      MGUI::POINT TransGadgetToCanvas (
         MGUI::POINT ptGadget
         ) const { return (MGUI::POINT(ptGadget.m_x+m_pos.m_x,ptGadget.m_y+m_pos.m_y)); }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      TOOLCANVAS *m_pCanvas;
      FLAGS m_flags;
      CANVASDEVICES m_CanvasDevices;
      PLACEMENT m_PlacementsAllowed;
      PLACEMENT m_Placement;
      bool m_visible;
      bool m_hasposition;
      INT16 m_priority;
      MGUI::POINT m_pos;
      MGUI::POINT m_size;
      DELEGATE_VOID_NOPARMS m_DelegateOnChangePlacement;
      DELEGATE_VOID_NOPARMS m_DelegateOnChangeSettings;
      DELEGATE_VOID_NOPARMS m_DelegateOnChangeVisible;

      void ClearPosition ()
         { m_hasposition = false; }
      void ComputeSize ()
         { m_size = v_ComputeSize(); }
      bool ContainsPoint (MGUI::POINT ptCanvas) const
         { return (m_hasposition && ptCanvas.m_x >= m_pos.m_x && ptCanvas.m_y >= m_pos.m_y && ptCanvas.m_x < m_pos.m_x + m_size.m_x && ptCanvas.m_y < m_pos.m_y + m_size.m_y); }
      void DetachCanvas ()
         { m_pCanvas = 0; }
      bool OnKey (MGUI::POINT ptCanvas, MGUI::KEYCODE keycode, KEYSTATE keystate)
         { return (v_OnKey(ptCanvas,keycode,keystate)); }
      bool OnPointerButtonDown (MGUI::POINT ptCanvas, POINTERBUTTON button, KEYSTATE keystate);
      bool OnPointerButtonUp (MGUI::POINT ptCanvas, POINTERBUTTON button, KEYSTATE keystate);
      void OnPointerEnter ()
         { v_OnPointerEnter(); }
      void OnPointerLeave ()
         { v_OnPointerLeave(); }
      void OnPointerMove (MGUI::POINT ptCanvas, POINTERBUTTON button, KEYSTATE keystate)
         { v_OnPointerMove(ptCanvas,button,keystate); }
      void SetPosition (MGUI::POINT topleft)
         { m_pos = topleft; m_hasposition = m_visible; }
      void SetPosition (INT16 x, INT16 y)
         { m_pos.Set(x,y); m_hasposition = m_visible; }
      void ValidatePlacement ();

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      virtual MGUI::POINT v_ComputeSize () = 0;

      virtual int v_DlgEditSettings (MDLGPARENT dlgparent);

      virtual void v_Draw (MGD::CONTEXT *gc, CANVAS::DEVICETYPE DeviceType) = 0;

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

      virtual bool v_OnPointerButtonDown (MGUI::POINT ptCanvas, POINTERBUTTON button, KEYSTATE keystate);

      virtual bool v_OnPointerButtonUp (MGUI::POINT ptCanvas, POINTERBUTTON button, KEYSTATE keystate);

      virtual void v_OnPointerEnter ();

      virtual void v_OnPointerLeave ();

      virtual void v_OnPointerMove (MGUI::POINT ptCanvas, POINTERBUTTON button, KEYSTATE keystate);

      virtual bool v_OnToolTipRequest (CTRL_TOOLTIP& tooltip, MGUI::POINT& ptCanvas);

      friend class TOOLCANVAS;
      friend class TOOLCANVAS::PRIV;
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(GADGET::CANVASDEVICES)
DEFINE_ENUM_OP_BITWISE(GADGET::FLAGS)
DEFINE_ENUM_OP_BITWISE(GADGET::PLACEMENT)
#endif

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

}  // End namespace MGUI

#endif   // INC_MGUI_GADGET_H

---