include/wx/generic/dragimgg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/dragimgg.h
   3 // Purpose:     wxDragImage class: a kind of a cursor, that can cope
   4 //              with more sophisticated images
   5 // Author:      Julian Smart
   6 // Modified by:
   7 // Created:     29/2/2000
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) Julian Smart
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_DRAGIMGG_H_
  14 #define _WX_DRAGIMGG_H_
  15
  16 #ifdef __GNUG__
  17 #pragma interface "dragimgg.h"
  18 #endif
  19
  20 #include "wx/bitmap.h"
  21 #include "wx/icon.h"
  22 #include "wx/cursor.h"
  23 #include "wx/treectrl.h"
  24 #include "wx/listctrl.h"
  25
  26 /*
  27   To use this class, create a wxDragImage when you start dragging, for example:
  28
  29   void MyTreeCtrl::OnBeginDrag(wxTreeEvent& event)
  30   {
  31 #ifdef __WXMSW__
  32     ::UpdateWindow((HWND) GetHWND()); // We need to implement this in wxWindows
  33 #endif
  34
  35     CaptureMouse();
  36
  37     m_dragImage = new wxDragImage(* this, itemId);
  38     m_dragImage->BeginDrag(wxPoint(0, 0), this);
  39     m_dragImage->Move(pt, this);
  40     m_dragImage->Show(this);
  41     ...
  42   }
  43
  44   In your OnMouseMove function, hide the image, do any display updating required,
  45   then move and show the image again:
  46
  47   void MyTreeCtrl::OnMouseMove(wxMouseEvent& event)
  48   {
  49     if (m_dragMode == MY_TREE_DRAG_NONE)
  50     {
  51         event.Skip();
  52         return;
  53     }
  54
  55     // Prevent screen corruption by hiding the image
  56     if (m_dragImage)
  57         m_dragImage->Hide(this);
  58
  59     // Do some updating of the window, such as highlighting the drop target
  60     ...
  61
  62 #ifdef __WXMSW__
  63     if (updateWindow)
  64         ::UpdateWindow((HWND) GetHWND());
  65 #endif
  66
  67     // Move and show the image again
  68     m_dragImage->Move(event.GetPosition(), this);
  69     m_dragImage->Show(this);
  70  }
  71
  72  Eventually we end the drag and delete the drag image.
  73
  74  void MyTreeCtrl::OnLeftUp(wxMouseEvent& event)
  75  {
  76     ...
  77
  78     // End the drag and delete the drag image
  79     if (m_dragImage)
  80     {
  81         m_dragImage->EndDrag(this);
  82         delete m_dragImage;
  83         m_dragImage = NULL;
  84     }
  85     ReleaseMouse();
  86  }
  87 */
  88
  89 /*
  90  * wxGenericDragImage
  91  */
  92
  93 class WXDLLEXPORT wxGenericDragImage: public wxObject
  94 {
  95 public:
  96
  97     // Ctors & dtor
  98     ////////////////////////////////////////////////////////////////////////////
  99
 100     wxGenericDragImage();
 101     wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
 102     {
 103         Init();
 104
 105         Create(image, cursor, hotspot);
 106     }
 107     wxGenericDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
 108     {
 109         Init();
 110
 111         Create(image, cursor, hotspot);
 112     }
 113     wxGenericDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
 114     {
 115         Init();
 116
 117         Create(str, cursor, hotspot);
 118     }
 119     wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
 120     {
 121         Init();
 122
 123         Create(treeCtrl, id);
 124     }
 125     wxGenericDragImage(const wxListCtrl& listCtrl, long id)
 126     {
 127         Init();
 128
 129         Create(listCtrl, id);
 130     }
 131     ~wxGenericDragImage();
 132
 133     // Attributes
 134     ////////////////////////////////////////////////////////////////////////////
 135
 136     // Operations
 137     ////////////////////////////////////////////////////////////////////////////
 138
 139     // Create a drag image from a bitmap and optional cursor
 140     bool Create(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0));
 141
 142     // Create a drag image from an icon and optional cursor
 143     bool Create(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0));
 144
 145     // Create a drag image from a string and optional cursor
 146     bool Create(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0));
 147
 148     // Create a drag image for the given tree control item
 149     bool Create(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
 150
 151     // Create a drag image for the given list control item
 152     bool Create(const wxListCtrl& listCtrl, long id);
 153
 154     // Begin drag. hotspot is the location of the drag position relative to the upper-left
 155     // corner of the image.
 156     bool BeginDrag(const wxPoint& hotspot, wxWindow* window, bool fullScreen = FALSE, wxRect* rect = (wxRect*) NULL);
 157
 158     // Begin drag. hotspot is the location of the drag position relative to the upper-left
 159     // corner of the image. This is full screen only. fullScreenRect gives the
 160     // position of the window on the screen, to restrict the drag to.
 161     bool BeginDrag(const wxPoint& hotspot, wxWindow* window, wxWindow* fullScreenRect);
 162
 163     // End drag
 164     bool EndDrag();
 165
 166     // Move the image: call from OnMouseMove. Pt is in window client coordinates if window
 167     // is non-NULL, or in screen coordinates if NULL.
 168     bool Move(const wxPoint& pt);
 169
 170     // Show the image
 171     bool Show();
 172
 173     // Hide the image
 174     bool Hide();
 175
 176     // Implementation
 177     ////////////////////////////////////////////////////////////////////////////
 178
 179     void Init();
 180
 181     wxRect GetImageRect(const wxPoint& pos) const;
 182
 183     // Erase and redraw simultaneously if possible
 184     bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos, bool eraseOld, bool drawNew);
 185
 186 protected:
 187     wxBitmap        m_bitmap;
 188     wxIcon          m_icon;
 189     wxCursor        m_cursor;
 190     wxCursor        m_oldCursor;
 191     wxPoint         m_hotspot;
 192     wxPoint         m_position;
 193     bool            m_isDirty;
 194     bool            m_isShown;
 195     wxWindow*       m_window;
 196     wxDC*           m_windowDC;
 197
 198     // Stores the window contents while we're dragging the image around
 199     wxBitmap        m_backingBitmap;
 200     // A temporary bitmap for repairing/redrawing
 201     wxBitmap        m_repairBitmap;
 202
 203     wxRect          m_boundingRect;
 204     bool            m_fullScreen;
 205
 206 private:
 207     DECLARE_DYNAMIC_CLASS(wxGenericDragImage)
 208 };
 209
 210 #endif
 211     // _WX_DRAGIMGG_H_