commdlg.lib is not in evc3

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

diff --git a/include/wx/msw/dragimag.h b/include/wx/msw/dragimag.h
index a7a1fd0988214e720315a734d3c42bdcbe732e7c..88192d97f2383fc0f1609bad1d4b5e163b466efa 100644 (file)
--- a/include/wx/msw/dragimag.h
+++ b/include/wx/msw/dragimag.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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
 // Purpose:     wxDragImage class: a kind of a cursor, that can cope
 //              with more sophisticated images
 // Author:      Julian Smart


@@ -7,13 +7,13 @@
 // Created:     08/04/99
 // RCS-ID:      $Id$
 // Copyright:   (c) 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_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DRAGIMAG_H_
 #define _WX_DRAGIMAG_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "dragimag.h"
 #endif
 
 #pragma interface "dragimag.h"
 #endif
 


@@ -23,6 +23,9 @@
 #include "wx/treectrl.h"
 #include "wx/listctrl.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:
 
 /*
   To use this class, create a wxDragImage when you start dragging, for example:
 


@@ -100,89 +103,172 @@
 
 class WXDLLEXPORT wxDragImage: public wxObject
 {
 
 class WXDLLEXPORT wxDragImage: public wxObject
 {

-    DECLARE_DYNAMIC_CLASS(wxDragImage)

 public:
 public:

-    
+

     // Ctors & dtor
     ////////////////////////////////////////////////////////////////////////////
 
     wxDragImage();
     // 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);
     }
         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)
+    {
+        Init();
+
+        Create(image, cursor, cursorHotspot);
+    }
+
+    wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor)

     {
     {

-        m_hImageList = 0;
+        Init();
+

         Create(image, cursor);
     }
         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)
+    {
+        Init();
+
+        Create(image, cursor, cursorHotspot);
+    }
+
+    wxDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor)

     {
     {

-        m_hImageList = 0;
+        Init();
+

         Create(str, cursor);
     }
         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)
     {
     wxDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
     {

-        m_hImageList = 0;
+        Init();
+

         Create(treeCtrl, id);
     }
         Create(treeCtrl, id);
     }

+#endif
+
+#if wxUSE_LISTCTRL

     wxDragImage(const wxListCtrl& listCtrl, long id)
     {
     wxDragImage(const wxListCtrl& listCtrl, long id)
     {

-        m_hImageList = 0;
+        Init();
+

         Create(listCtrl, id);
     }
         Create(listCtrl, id);
     }

+#endif
+

     ~wxDragImage();
     ~wxDragImage();

-    
+

     // Attributes
     ////////////////////////////////////////////////////////////////////////////
     // Attributes
     ////////////////////////////////////////////////////////////////////////////

-    
+

     // Operations
     ////////////////////////////////////////////////////////////////////////////
     // Operations
     ////////////////////////////////////////////////////////////////////////////

-    
+

     // Create a drag image from a bitmap and optional 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
     // 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
     // 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);
     // 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);
     // 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.
 
     // 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
     // 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.
     // 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
 
     // Show the image

-    bool Show(wxWindow* window);
+    bool Show();

 
     // Hide the image
 
     // Hide the image

-    bool Hide(wxWindow* window);
-    
+    bool Hide();
+

     // Implementation
     ////////////////////////////////////////////////////////////////////////////
     // Implementation
     ////////////////////////////////////////////////////////////////////////////

-    
+
+    // Initialize variables
+    void Init();
+

     // Returns the native image list handle
     // 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;
 protected:
     WXHIMAGELIST    m_hImageList;

+
+#if wxUSE_SIMPLER_DRAGIMAGE
+    wxCursor        m_oldCursor;
+#else
+    WXHIMAGELIST    m_hCursorImageList;
+#endif
+

     wxCursor        m_cursor;
     wxCursor        m_cursor;

-    wxPoint         m_hotspot;
+//    wxPoint         m_cursorHotspot; // Obsolete

     wxPoint         m_position;
     wxPoint         m_position;

+    wxWindow*       m_window;
+    wxRect          m_boundingRect;
+    bool            m_fullScreen;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxDragImage)
+    DECLARE_NO_COPY_CLASS(wxDragImage)

 };
 
 #endif
 };
 
 #endif