/////////////////////////////////////////////////////////////////////////////
-// Name: dragimag.h
+// Name: wx/msw/dragimag.h
// Purpose: wxDragImage class: a kind of a cursor, that can cope
// with more sophisticated images
// Author: Julian Smart
// Created: 08/04/99
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_DRAGIMAG_H_
#define _WX_DRAGIMAG_H_
-#ifdef __GNUG__
-#pragma interface "dragimag.h"
-#endif
-
#include "wx/bitmap.h"
#include "wx/icon.h"
#include "wx/cursor.h"
#include "wx/treectrl.h"
#include "wx/listctrl.h"
+// If 1, use a simple wxCursor instead of ImageList_SetDragCursorImage
+#define wxUSE_SIMPLER_DRAGIMAGE 0
+
/*
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();
class WXDLLEXPORT wxDragImage: public wxObject
{
- DECLARE_DYNAMIC_CLASS(wxDragImage)
public:
-
+
// Ctors & dtor
////////////////////////////////////////////////////////////////////////////
wxDragImage();
- wxDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+ wxDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor)
{
- m_hImageList = 0;
+ Init();
+
Create(image, cursor);
}
- wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+
+ // Deprecated form of the above
+ wxDragImage(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot)
{
- m_hImageList = 0;
+ Init();
+
+ Create(image, cursor, cursorHotspot);
+ }
+
+ wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor)
+ {
+ Init();
+
Create(image, cursor);
}
- wxDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+
+ // Deprecated form of the above
+ wxDragImage(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot)
{
- m_hImageList = 0;
+ Init();
+
+ Create(image, cursor, cursorHotspot);
+ }
+
+ wxDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor)
+ {
+ Init();
+
Create(str, cursor);
}
+
+ // Deprecated form of the above
+ wxDragImage(const wxString& str, const wxCursor& cursor, const wxPoint& cursorHotspot)
+ {
+ Init();
+
+ Create(str, cursor, cursorHotspot);
+ }
+
+#if wxUSE_TREECTRL
wxDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
{
- m_hImageList = 0;
+ Init();
+
Create(treeCtrl, id);
}
+#endif
+
+#if wxUSE_LISTCTRL
wxDragImage(const wxListCtrl& listCtrl, long id)
{
- m_hImageList = 0;
+ Init();
+
Create(listCtrl, id);
}
+#endif
+
~wxDragImage();
-
+
// Attributes
////////////////////////////////////////////////////////////////////////////
-
+
// Operations
////////////////////////////////////////////////////////////////////////////
-
+
// 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 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
+ // position of the window on the screen, to restrict the drag to.
+ bool BeginDrag(const wxPoint& hotspot, wxWindow* window, wxWindow* fullScreenRect);
+
// End drag
- bool EndDrag(wxWindow* window);
-
+ bool EndDrag();
+
// Move the image: call from OnMouseMove. Pt is in window client coordinates if window
// is non-NULL, or in screen coordinates if NULL.
- bool Move(const wxPoint& pt, wxWindow* window);
+ bool Move(const wxPoint& pt);
// Show the image
- bool Show(wxWindow* window);
+ bool Show();
// Hide the image
- bool Hide(wxWindow* window);
-
+ bool Hide();
+
// Implementation
////////////////////////////////////////////////////////////////////////////
-
+
+ // Initialize variables
+ void Init();
+
// Returns the native image list handle
- inline WXHIMAGELIST GetHIMAGELIST() const { return m_hImageList; }
-
+ WXHIMAGELIST GetHIMAGELIST() const { return m_hImageList; }
+
+#if !wxUSE_SIMPLER_DRAGIMAGE
+ // Returns the native image list handle for the cursor
+ WXHIMAGELIST GetCursorHIMAGELIST() const { return m_hCursorImageList; }
+#endif
+
protected:
WXHIMAGELIST m_hImageList;
+
+#if wxUSE_SIMPLER_DRAGIMAGE
+ wxCursor m_oldCursor;
+#else
+ WXHIMAGELIST m_hCursorImageList;
+#endif
+
wxCursor m_cursor;
- wxPoint m_hotspot;
+// wxPoint m_cursorHotspot; // Obsolete
wxPoint m_position;
+ wxWindow* m_window;
+ wxRect m_boundingRect;
+ bool m_fullScreen;
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxDragImage)
+ DECLARE_NO_COPY_CLASS(wxDragImage)
};
#endif
projects / wxWidgets.git / blobdiff