]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/dragimgg.h
Updated translations manual page with latest status given by the website translations...
[wxWidgets.git] / include / wx / generic / dragimgg.h
CommitLineData
2b5f62a0 1//////////////////////////////////////////////////////////////////////////////
68be9f09
JS
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
65571936 10// Licence: wxWindows licence
68be9f09
JS
11/////////////////////////////////////////////////////////////////////////////
12
13#ifndef _WX_DRAGIMGG_H_
14#define _WX_DRAGIMGG_H_
15
68be9f09
JS
16#include "wx/bitmap.h"
17#include "wx/icon.h"
18#include "wx/cursor.h"
19#include "wx/treectrl.h"
20#include "wx/listctrl.h"
2b5f62a0 21#include "wx/log.h"
30c841c8 22#include "wx/overlay.h"
e412f892 23
68be9f09
JS
24/*
25 To use this class, create a wxDragImage when you start dragging, for example:
26
27 void MyTreeCtrl::OnBeginDrag(wxTreeEvent& event)
28 {
29#ifdef __WXMSW__
77ffb593 30 ::UpdateWindow((HWND) GetHWND()); // We need to implement this in wxWidgets
68be9f09
JS
31#endif
32
33 CaptureMouse();
34
35 m_dragImage = new wxDragImage(* this, itemId);
36 m_dragImage->BeginDrag(wxPoint(0, 0), this);
37 m_dragImage->Move(pt, this);
38 m_dragImage->Show(this);
39 ...
40 }
41
42 In your OnMouseMove function, hide the image, do any display updating required,
43 then move and show the image again:
44
45 void MyTreeCtrl::OnMouseMove(wxMouseEvent& event)
46 {
47 if (m_dragMode == MY_TREE_DRAG_NONE)
48 {
49 event.Skip();
50 return;
51 }
52
53 // Prevent screen corruption by hiding the image
54 if (m_dragImage)
55 m_dragImage->Hide(this);
56
57 // Do some updating of the window, such as highlighting the drop target
58 ...
59
60#ifdef __WXMSW__
61 if (updateWindow)
62 ::UpdateWindow((HWND) GetHWND());
63#endif
64
65 // Move and show the image again
66 m_dragImage->Move(event.GetPosition(), this);
67 m_dragImage->Show(this);
68 }
69
70 Eventually we end the drag and delete the drag image.
71
72 void MyTreeCtrl::OnLeftUp(wxMouseEvent& event)
73 {
74 ...
75
76 // End the drag and delete the drag image
77 if (m_dragImage)
78 {
79 m_dragImage->EndDrag(this);
80 delete m_dragImage;
81 m_dragImage = NULL;
82 }
83 ReleaseMouse();
84 }
85*/
86
87/*
88 * wxGenericDragImage
89 */
90
53a2db12 91class WXDLLIMPEXP_CORE wxGenericDragImage: public wxObject
68be9f09
JS
92{
93public:
94
95 // Ctors & dtor
96 ////////////////////////////////////////////////////////////////////////////
97
aa2d25a5 98 wxGenericDragImage(const wxCursor& cursor = wxNullCursor)
f6bcfd97
BP
99 {
100 Init();
aa2d25a5 101 Create(cursor);
f6bcfd97 102 }
aa2d25a5 103
aa2d25a5
JS
104 wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor)
105 {
106 Init();
107
108 Create(image, cursor);
109 }
110
aa2d25a5
JS
111 wxGenericDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor)
112 {
113 Init();
114
115 Create(image, cursor);
116 }
117
aa2d25a5 118 wxGenericDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor)
68be9f09
JS
119 {
120 Init();
121
aa2d25a5 122 Create(str, cursor);
68be9f09 123 }
aa2d25a5 124
ca3e85cf
WS
125#if WXWIN_COMPATIBILITY_2_6
126 // don't use in new code, use versions without hot spot parameter
127 wxDEPRECATED( wxGenericDragImage(const wxCursor& cursor, const wxPoint& cursorHotspot) );
128 wxDEPRECATED( wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
129 wxDEPRECATED( wxGenericDragImage(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
130 wxDEPRECATED( wxGenericDragImage(const wxString& str, const wxCursor& cursor, const wxPoint& cursorHotspot) );
131 wxDEPRECATED( bool Create(const wxCursor& cursor, const wxPoint& cursorHotspot) );
132 wxDEPRECATED( bool Create(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
133 wxDEPRECATED( bool Create(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
134 wxDEPRECATED( bool Create(const wxString& str, const wxCursor& cursor, const wxPoint& cursorHotspot) );
135#endif // WXWIN_COMPATIBILITY_2_6
aa2d25a5 136
3080bf59 137#if wxUSE_TREECTRL
68be9f09
JS
138 wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
139 {
140 Init();
141
142 Create(treeCtrl, id);
143 }
3080bf59 144#endif
aa2d25a5 145
3080bf59 146#if wxUSE_LISTCTRL
68be9f09
JS
147 wxGenericDragImage(const wxListCtrl& listCtrl, long id)
148 {
149 Init();
150
151 Create(listCtrl, id);
152 }
3080bf59
VZ
153#endif
154
d3c7fc99 155 virtual ~wxGenericDragImage();
68be9f09
JS
156
157 // Attributes
158 ////////////////////////////////////////////////////////////////////////////
159
996173c4
VZ
160#ifdef wxHAS_NATIVE_OVERLAY
161 // backing store is not used when native overlays are
162 void SetBackingBitmap(wxBitmap* WXUNUSED(bitmap)) { }
163#else
f6bcfd97
BP
164 // For efficiency, tell wxGenericDragImage to use a bitmap that's already
165 // created (e.g. from last drag)
996173c4
VZ
166 void SetBackingBitmap(wxBitmap* bitmap) { m_pBackingBitmap = bitmap; }
167#endif // wxHAS_NATIVE_OVERLAY/!wxHAS_NATIVE_OVERLAY
f6bcfd97 168
68be9f09
JS
169 // Operations
170 ////////////////////////////////////////////////////////////////////////////
171
f6bcfd97 172 // Create a drag image with a virtual image (need to override DoDrawImage, GetImageRect)
aa2d25a5 173 bool Create(const wxCursor& cursor = wxNullCursor);
f6bcfd97 174
68be9f09 175 // Create a drag image from a bitmap and optional cursor
aa2d25a5 176 bool Create(const wxBitmap& image, const wxCursor& cursor = wxNullCursor);
68be9f09
JS
177
178 // Create a drag image from an icon and optional cursor
aa2d25a5 179 bool Create(const wxIcon& image, const wxCursor& cursor = wxNullCursor);
68be9f09
JS
180
181 // Create a drag image from a string and optional cursor
aa2d25a5 182 bool Create(const wxString& str, const wxCursor& cursor = wxNullCursor);
68be9f09 183
3080bf59 184#if wxUSE_TREECTRL
68be9f09
JS
185 // Create a drag image for the given tree control item
186 bool Create(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
3080bf59 187#endif
68be9f09 188
3080bf59 189#if wxUSE_LISTCTRL
68be9f09
JS
190 // Create a drag image for the given list control item
191 bool Create(const wxListCtrl& listCtrl, long id);
3080bf59 192#endif
68be9f09
JS
193
194 // Begin drag. hotspot is the location of the drag position relative to the upper-left
195 // corner of the image.
ca65c044 196 bool BeginDrag(const wxPoint& hotspot, wxWindow* window, bool fullScreen = false, wxRect* rect = (wxRect*) NULL);
68be9f09
JS
197
198 // Begin drag. hotspot is the location of the drag position relative to the upper-left
199 // corner of the image. This is full screen only. fullScreenRect gives the
200 // position of the window on the screen, to restrict the drag to.
201 bool BeginDrag(const wxPoint& hotspot, wxWindow* window, wxWindow* fullScreenRect);
202
203 // End drag
204 bool EndDrag();
205
206 // Move the image: call from OnMouseMove. Pt is in window client coordinates if window
207 // is non-NULL, or in screen coordinates if NULL.
208 bool Move(const wxPoint& pt);
209
210 // Show the image
211 bool Show();
212
213 // Hide the image
214 bool Hide();
215
216 // Implementation
217 ////////////////////////////////////////////////////////////////////////////
218
219 void Init();
220
f6bcfd97
BP
221 // Override this if you are using a virtual image (drawing your own image)
222 virtual wxRect GetImageRect(const wxPoint& pos) const;
223
224 // Override this if you are using a virtual image (drawing your own image)
225 virtual bool DoDrawImage(wxDC& dc, const wxPoint& pos) const;
226
227 // Override this if you wish to draw the window contents to the backing bitmap
228 // yourself. This can be desirable if you wish to avoid flicker by not having to
229 // redraw the window itself before dragging in order to be graphic-minus-dragged-objects.
230 // Instead, paint the drag image's backing bitmap to be correct, and leave the window
231 // to be updated only when dragging the objects away (thus giving a smoother appearance).
232 virtual bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
ca3e85cf 233 const wxRect& sourceRect, const wxRect& destRect) const;
68be9f09
JS
234
235 // Erase and redraw simultaneously if possible
f6bcfd97 236 virtual bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos, bool eraseOld, bool drawNew);
68be9f09
JS
237
238protected:
239 wxBitmap m_bitmap;
240 wxIcon m_icon;
241 wxCursor m_cursor;
242 wxCursor m_oldCursor;
aa2d25a5 243// wxPoint m_hotspot;
f6bcfd97 244 wxPoint m_offset; // The hostpot value passed to BeginDrag
68be9f09
JS
245 wxPoint m_position;
246 bool m_isDirty;
247 bool m_isShown;
248 wxWindow* m_window;
249 wxDC* m_windowDC;
250
69a5bc23 251#ifdef wxHAS_NATIVE_OVERLAY
e412f892
SC
252 wxOverlay m_overlay;
253 wxDCOverlay* m_dcOverlay;
254#else
68be9f09
JS
255 // Stores the window contents while we're dragging the image around
256 wxBitmap m_backingBitmap;
f6bcfd97
BP
257 wxBitmap* m_pBackingBitmap; // Pointer to existing backing bitmap
258 // (pass to wxGenericDragImage as an efficiency measure)
68be9f09
JS
259 // A temporary bitmap for repairing/redrawing
260 wxBitmap m_repairBitmap;
30c841c8 261#endif // !wxHAS_NATIVE_OVERLAY
68be9f09
JS
262
263 wxRect m_boundingRect;
264 bool m_fullScreen;
265
266private:
267 DECLARE_DYNAMIC_CLASS(wxGenericDragImage)
22f3361e 268 DECLARE_NO_COPY_CLASS(wxGenericDragImage)
68be9f09
JS
269};
270
271#endif
272 // _WX_DRAGIMGG_H_