add an assert indicating that old code overriding OnExecute() must be updated with 2.9

[wxWidgets.git] / include / wx / msw / dragimag.h

diff --git a/include/wx/msw/dragimag.h b/include/wx/msw/dragimag.h
index f4a469088ed45a140bb35915a4c1d7b2d2772c6c..fbe7b402f13b496dea67cc7abc45f1476e91cc2c 100644 (file)
--- a/include/wx/msw/dragimag.h
+++ b/include/wx/msw/dragimag.h
@@ -13,9 +13,7 @@
 #ifndef _WX_DRAGIMAG_H_
 #define _WX_DRAGIMAG_H_
 
-#ifdef __GNUG__
-#pragma interface "dragimag.h"
-#endif
+#if wxUSE_DRAGIMAGE
 
 #include "wx/bitmap.h"
 #include "wx/icon.h"
@@ -23,9 +21,8 @@
 #include "wx/treectrl.h"
 #include "wx/listctrl.h"
 
-// If 1, use a simple wxCursor instead of ImageList_SetDragCursorImage,
-// and some other simplifications
-#define wxUSE_SIMPLER_DRAGIMAGE 1
+// 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:
@@ -33,7 +30,7 @@
   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();
@@ -102,7 +99,7 @@
  * wxDragImage
  */
 
-class WXDLLEXPORT wxDragImage: public wxObject
+class WXDLLIMPEXP_CORE wxDragImage: public wxObject
 {
 public:
 
@@ -110,37 +107,70 @@ public:
     ////////////////////////////////////////////////////////////////////////////
 
     wxDragImage();
-    wxDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& cursorHotspot = wxPoint(0, 0))
+    wxDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor)
+    {
+        Init();
+
+        Create(image, cursor);
+    }
+
+    // Deprecated form of the above
+    wxDragImage(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot)
     {
         Init();
 
         Create(image, cursor, cursorHotspot);
     }
-    wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& cursorHotspot = wxPoint(0, 0))
+
+    wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor)
+    {
+        Init();
+
+        Create(image, cursor);
+    }
+
+    // Deprecated form of the above
+    wxDragImage(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot)
     {
         Init();
 
         Create(image, cursor, cursorHotspot);
     }
-    wxDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& cursorHotspot = wxPoint(0, 0))
+
+    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)
     {
         Init();
 
         Create(treeCtrl, id);
     }
+#endif
+
+#if wxUSE_LISTCTRL
     wxDragImage(const wxListCtrl& listCtrl, long id)
     {
         Init();
 
         Create(listCtrl, id);
     }
-    ~wxDragImage();
+#endif
+
+    virtual ~wxDragImage();
 
     // Attributes
     ////////////////////////////////////////////////////////////////////////////
@@ -149,23 +179,42 @@ public:
     ////////////////////////////////////////////////////////////////////////////
 
     // Create a drag image from a bitmap and optional cursor
-    bool Create(const wxBitmap& image, const wxCursor& cursor = wxNullCursor, const wxPoint& cursorHotspot = 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& cursorHotspot = 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& cursorHotspot = 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
@@ -209,7 +258,7 @@ protected:
 #endif
 
     wxCursor        m_cursor;
-    wxPoint         m_cursorHotspot;
+//    wxPoint         m_cursorHotspot; // Obsolete
     wxPoint         m_position;
     wxWindow*       m_window;
     wxRect          m_boundingRect;
@@ -217,7 +266,9 @@ protected:
 
 private:
     DECLARE_DYNAMIC_CLASS(wxDragImage)
+    DECLARE_NO_COPY_CLASS(wxDragImage)
 };
 
+#endif // wxUSE_DRAGIMAGE
 #endif
     // _WX_DRAGIMAG_H_