-/////////////////////////////////////////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////////////
// Name: wx/generic/dragimgg.h
// Purpose: wxDragImage class: a kind of a cursor, that can cope
// with more sophisticated images
#ifndef _WX_DRAGIMGG_H_
#define _WX_DRAGIMGG_H_
-#ifdef __GNUG__
-#pragma interface "dragimgg.h"
-#endif
-
#include "wx/bitmap.h"
#include "wx/icon.h"
#include "wx/cursor.h"
#include "wx/treectrl.h"
#include "wx/listctrl.h"
+#include "wx/log.h"
/*
To use this class, create a wxDragImage when you start dragging, for example:
void MyTreeCtrl::OnBeginDrag(wxTreeEvent& event)
{
#ifdef __WXMSW__
- ::UpdateWindow((HWND) GetHWND()); // We need to implement this in wxWindows
+ ::UpdateWindow((HWND) GetHWND()); // We need to implement this in wxWidgets
#endif
CaptureMouse();
// Ctors & dtor
////////////////////////////////////////////////////////////////////////////
- wxGenericDragImage();
- wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+ wxGenericDragImage(const wxCursor& cursor = wxNullCursor)
+ {
+ Init();
+ Create(cursor);
+ }
+
+ // Deprecated version of the above
+ wxGenericDragImage(const wxCursor& cursor, const wxPoint& cursorHotspot)
+ {
+ Init();
+ Create(cursor, cursorHotspot);
+ }
+
+ wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor)
+ {
+ Init();
+
+ Create(image, cursor);
+ }
+
+ // Deprecated version of the above
+ wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot)
+ {
+ Init();
+
+ Create(image, cursor, cursorHotspot);
+ }
+
+ wxGenericDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor)
{
Init();
- Create(image, cursor, hotspot);
+ Create(image, cursor);
}
- wxGenericDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+
+ // Deprecated version of the above
+ wxGenericDragImage(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot)
{
Init();
- Create(image, cursor, hotspot);
+ Create(image, cursor, cursorHotspot);
}
- wxGenericDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+
+ wxGenericDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor)
{
Init();
- Create(str, cursor, hotspot);
+ Create(str, cursor);
}
+
+ // Deprecated version of the above
+ wxGenericDragImage(const wxString& str, const wxCursor& cursor, const wxPoint& cursorHotspot)
+ {
+ Init();
+
+ Create(str, cursor, cursorHotspot);
+ }
+
+#if wxUSE_TREECTRL
wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
{
Init();
Create(treeCtrl, id);
}
+#endif
+
+#if wxUSE_LISTCTRL
wxGenericDragImage(const wxListCtrl& listCtrl, long id)
{
Init();
Create(listCtrl, id);
}
+#endif
+
~wxGenericDragImage();
// Attributes
////////////////////////////////////////////////////////////////////////////
+ // For efficiency, tell wxGenericDragImage to use a bitmap that's already
+ // created (e.g. from last drag)
+ void SetBackingBitmap(wxBitmap* bitmap) { m_pBackingBitmap = bitmap; }
+
// Operations
////////////////////////////////////////////////////////////////////////////
+ // Create a drag image with a virtual image (need to override DoDrawImage, GetImageRect)
+ bool Create(const wxCursor& cursor = wxNullCursor);
+ bool Create(const wxCursor& cursor, const wxPoint& WXUNUSED(cursorHotspot))
+ {
+ wxLogDebug(wxT("wxDragImage::Create: use of a cursor hotspot is now deprecated. Please omit this argument."));
+ return Create(cursor);
+ }
+
// Create a drag image from a bitmap and optional cursor
- bool Create(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0));
+ bool Create(const wxBitmap& image, const wxCursor& cursor = wxNullCursor);
+ bool Create(const wxBitmap& image, const wxCursor& cursor, const wxPoint& WXUNUSED(cursorHotspot))
+ {
+ wxLogDebug(wxT("wxDragImage::Create: use of a cursor hotspot is now deprecated. Please omit this argument."));
+ return Create(image, cursor);
+ }
// Create a drag image from an icon and optional cursor
- bool Create(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0));
+ bool Create(const wxIcon& image, const wxCursor& cursor = wxNullCursor);
+ bool Create(const wxIcon& image, const wxCursor& cursor, const wxPoint& WXUNUSED(cursorHotspot))
+ {
+ wxLogDebug(wxT("wxDragImage::Create: use of a cursor hotspot is now deprecated. Please omit this argument."));
+ return Create(image, cursor);
+ }
// Create a drag image from a string and optional cursor
- bool Create(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0));
+ bool Create(const wxString& str, const wxCursor& cursor = wxNullCursor);
+ bool Create(const wxString& str, const wxCursor& cursor, const wxPoint& WXUNUSED(cursorHotspot))
+ {
+ wxLogDebug(wxT("wxDragImage::Create: use of a cursor hotspot is now deprecated. Please omit this argument."));
+ return Create(str, cursor);
+ }
+#if wxUSE_TREECTRL
// Create a drag image for the given tree control item
bool Create(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
+#endif
+#if wxUSE_LISTCTRL
// Create a drag image for the given list control item
bool Create(const wxListCtrl& listCtrl, long id);
+#endif
// Begin drag. hotspot is the location of the drag position relative to the upper-left
// corner of the image.
- bool BeginDrag(const wxPoint& hotspot, wxWindow* window, bool fullScreen = FALSE, wxRect* rect = (wxRect*) NULL);
+ bool BeginDrag(const wxPoint& hotspot, wxWindow* window, bool fullScreen = false, wxRect* rect = (wxRect*) NULL);
// Begin drag. hotspot is the location of the drag position relative to the upper-left
// corner of the image. This is full screen only. fullScreenRect gives the
void Init();
- wxRect GetImageRect(const wxPoint& pos) const;
+ // Override this if you are using a virtual image (drawing your own image)
+ virtual wxRect GetImageRect(const wxPoint& pos) const;
+
+ // Override this if you are using a virtual image (drawing your own image)
+ virtual bool DoDrawImage(wxDC& dc, const wxPoint& pos) const;
+
+ // Override this if you wish to draw the window contents to the backing bitmap
+ // yourself. This can be desirable if you wish to avoid flicker by not having to
+ // redraw the window itself before dragging in order to be graphic-minus-dragged-objects.
+ // Instead, paint the drag image's backing bitmap to be correct, and leave the window
+ // to be updated only when dragging the objects away (thus giving a smoother appearance).
+ virtual bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
+ const wxRect& sourceRect, const wxRect& destRect) const;
// Erase and redraw simultaneously if possible
- bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos, bool eraseOld, bool drawNew);
+ virtual bool RedrawImage(const wxPoint& oldPos, const wxPoint& newPos, bool eraseOld, bool drawNew);
protected:
wxBitmap m_bitmap;
wxIcon m_icon;
wxCursor m_cursor;
wxCursor m_oldCursor;
- wxPoint m_hotspot;
+// wxPoint m_hotspot;
+ wxPoint m_offset; // The hostpot value passed to BeginDrag
wxPoint m_position;
bool m_isDirty;
bool m_isShown;
// Stores the window contents while we're dragging the image around
wxBitmap m_backingBitmap;
+ wxBitmap* m_pBackingBitmap; // Pointer to existing backing bitmap
+ // (pass to wxGenericDragImage as an efficiency measure)
// A temporary bitmap for repairing/redrawing
wxBitmap m_repairBitmap;
private:
DECLARE_DYNAMIC_CLASS(wxGenericDragImage)
+ DECLARE_NO_COPY_CLASS(wxGenericDragImage)
};
#endif
projects / wxWidgets.git / blobdiff