Document wxKill(wxSIGTERM) reliance on having an open window in wxMSW.

[wxWidgets.git] / include / wx / generic / dragimgg.h

diff --git a/include/wx/generic/dragimgg.h b/include/wx/generic/dragimgg.h
index f35a28cc6f0507819875bad62e60eb347ff42e46..f37a9abcc16370596661c872ea174ca834b7c9f6 100644 (file)
--- a/include/wx/generic/dragimgg.h
+++ b/include/wx/generic/dragimgg.h
@@ -1,4 +1,4 @@
-/////////////////////////////////////////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////////////

 // Name:        wx/generic/dragimgg.h
 // Purpose:     wxDragImage class: a kind of a cursor, that can cope
 //              with more sophisticated images
 // Name:        wx/generic/dragimgg.h
 // Purpose:     wxDragImage class: a kind of a cursor, that can cope
 //              with more sophisticated images


@@ -13,15 +13,13 @@
 #ifndef _WX_DRAGIMGG_H_
 #define _WX_DRAGIMGG_H_
 
 #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/bitmap.h"
 #include "wx/icon.h"
 #include "wx/cursor.h"
 #include "wx/treectrl.h"
 #include "wx/listctrl.h"

+#include "wx/log.h"
+#include "wx/overlay.h"

 
 /*
   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:


@@ -29,7 +27,7 @@
   void MyTreeCtrl::OnBeginDrag(wxTreeEvent& event)
   {
 #ifdef __WXMSW__
   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();
 #endif
 
     CaptureMouse();


@@ -90,70 +88,112 @@
  * wxGenericDragImage
  */
 
  * wxGenericDragImage
  */
 

-class WXDLLEXPORT wxGenericDragImage: public wxObject
+class WXDLLIMPEXP_CORE wxGenericDragImage: public wxObject

 {
 public:
 
     // Ctors & dtor
     ////////////////////////////////////////////////////////////////////////////
 
 {
 public:
 
     // 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);
+    }
+
+    wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor)

     {
         Init();
 
     {
         Init();
 

-        Create(image, cursor, hotspot);
+        Create(image, cursor);

     }
     }

-    wxGenericDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+
+    wxGenericDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor)

     {
         Init();
 
     {
         Init();
 

-        Create(image, cursor, hotspot);
+        Create(image, cursor);

     }
     }

-    wxGenericDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor, const wxPoint& hotspot = wxPoint(0, 0))
+
+    wxGenericDragImage(const wxString& str, const wxCursor& cursor = wxNullCursor)

     {
         Init();
 
     {
         Init();
 

-        Create(str, cursor, hotspot);
+        Create(str, cursor);

     }
     }

+
+#if WXWIN_COMPATIBILITY_2_6
+    // don't use in new code, use versions without hot spot parameter
+    wxDEPRECATED( wxGenericDragImage(const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( wxGenericDragImage(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( wxGenericDragImage(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( wxGenericDragImage(const wxString& str, const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( bool Create(const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( bool Create(const wxBitmap& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( bool Create(const wxIcon& image, const wxCursor& cursor, const wxPoint& cursorHotspot) );
+    wxDEPRECATED( bool Create(const wxString& str, const wxCursor& cursor, const wxPoint& cursorHotspot) );
+#endif // WXWIN_COMPATIBILITY_2_6
+
+#if wxUSE_TREECTRL

     wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
     {
         Init();
 
         Create(treeCtrl, id);
     }
     wxGenericDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id)
     {
         Init();
 
         Create(treeCtrl, id);
     }

+#endif
+
+#if wxUSE_LISTCTRL

     wxGenericDragImage(const wxListCtrl& listCtrl, long id)
     {
         Init();
 
         Create(listCtrl, id);
     }
     wxGenericDragImage(const wxListCtrl& listCtrl, long id)
     {
         Init();
 
         Create(listCtrl, id);
     }

-    ~wxGenericDragImage();
+#endif
+
+    virtual ~wxGenericDragImage();

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

+#ifdef wxHAS_NATIVE_OVERLAY
+    // backing store is not used when native overlays are
+    void SetBackingBitmap(wxBitmap* WXUNUSED(bitmap)) { }
+#else
+    // For efficiency, tell wxGenericDragImage to use a bitmap that's already
+    // created (e.g. from last drag)
+    void SetBackingBitmap(wxBitmap* bitmap) { m_pBackingBitmap = bitmap; }
+#endif // wxHAS_NATIVE_OVERLAY/!wxHAS_NATIVE_OVERLAY
+

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

+    // Create a drag image with a virtual image (need to override DoDrawImage, GetImageRect)
+    bool Create(const wxCursor& cursor = wxNullCursor);
+

     // 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);

 
     // 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);

 
     // 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);

 
 

+#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 fullScreen = FALSE, wxRect* rect = (wxRect*) NULL);
+    bool BeginDrag(const wxPoint& hotspot, wxWindow* window, bool fullScreen = false, wxRect* rect = 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
 
     // 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


@@ -178,33 +218,54 @@ public:
 
     void Init();
 
 
     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
 
     // 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;
 
 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;
     wxWindow*       m_window;
     wxDC*           m_windowDC;
 
     wxPoint         m_position;
     bool            m_isDirty;
     bool            m_isShown;
     wxWindow*       m_window;
     wxDC*           m_windowDC;
 

+#ifdef wxHAS_NATIVE_OVERLAY
+    wxOverlay       m_overlay;
+    wxDCOverlay*     m_dcOverlay;
+#else

     // Stores the window contents while we're dragging the image around
     wxBitmap        m_backingBitmap;
     // 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;
     // A temporary bitmap for repairing/redrawing
     wxBitmap        m_repairBitmap;

+#endif // !wxHAS_NATIVE_OVERLAY

 
     wxRect          m_boundingRect;
     bool            m_fullScreen;
 
 private:
     DECLARE_DYNAMIC_CLASS(wxGenericDragImage)
 
     wxRect          m_boundingRect;
     bool            m_fullScreen;
 
 private:
     DECLARE_DYNAMIC_CLASS(wxGenericDragImage)

+    wxDECLARE_NO_COPY_CLASS(wxGenericDragImage);

 };
 
 #endif
 };
 
 #endif