Add wxTimer::StartOnce().

[wxWidgets.git] / interface / wx / dragimag.h

diff --git a/interface/wx/dragimag.h b/interface/wx/dragimag.h
index 9de1317021b53f1d57d2885a5348bba6cc4d3a33..f0dc5f206223bf8249c4fb3c4729b23dd02c1edf 100644 (file)
--- a/interface/wx/dragimag.h
+++ b/interface/wx/dragimag.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxDragImage
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxDragImage
-    @wxheader{dragimag.h}
 
     This class is used when you wish to drag an object on the screen, and a
     simple cursor is not enough.
@@ -17,11 +16,6 @@
     platforms, wxGenericDragImage is used. Applications may also prefer to use
     wxGenericDragImage on Windows, too.
 
-    @beginWxPythonOnly
-    wxPython uses wxGenericDragImage on all platforms, but uses the wxDragImage
-    name.
-    @endWxPythonOnly
-
     To use this class, when you wish to start dragging an image, create a
     wxDragImage object and store it somewhere you can access it as the drag
     progresses. Call BeginDrag() to start, and EndDrag() to stop the drag. To
@@ -57,11 +51,8 @@ public:
             Bitmap to be used as the drag image. The bitmap can have a mask.
         @param cursor
             Optional cursor to combine with the image.
-        @param cursorHotspot
-            This parameter is deprecated.
     */
-    wxDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor,
-                const wxPoint& cursorHotspot = wxPoint(0, 0));
+    wxDragImage(const wxBitmap& image, const wxCursor& cursor = wxNullCursor);
     /**
         Constructs a drag image from an icon and optional cursor.
 
@@ -69,15 +60,8 @@ public:
             Icon to be used as the drag image.
         @param cursor
             Optional cursor to combine with the image.
-        @param cursorHotspot
-            This parameter is deprecated.
-
-        @beginWxPythonOnly
-        This constructor is called wxDragIcon in wxPython.
-        @endWxPythonOnly
     */
-    wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor,
-                const wxPoint& cursorHotspot = wxPoint(0, 0));
+    wxDragImage(const wxIcon& image, const wxCursor& cursor = wxNullCursor);
     /**
         Constructs a drag image from a text string and optional cursor.
 
@@ -85,15 +69,8 @@ public:
             Text used to construct a drag image.
         @param cursor
             Optional cursor to combine with the image.
-        @param cursorHotspot
-            This parameter is deprecated.
-
-        @beginWxPythonOnly
-        This constructor is called wxDragString in wxPython.
-        @endWxPythonOnly
     */
-    wxDragImage(const wxString& text, const wxCursor& cursor = wxNullCursor,
-                const wxPoint& cursorHotspot = wxPoint(0, 0));
+    wxDragImage(const wxString& text, const wxCursor& cursor = wxNullCursor);
     /**
         Constructs a drag image from the text in the given tree control item,
         and optional cursor.
@@ -102,10 +79,6 @@ public:
             Tree control for constructing a tree drag image.
         @param id
             Tree control item id.
-
-        @beginWxPythonOnly
-        This constructor is called wxDragTreeItem in wxPython.
-        @endWxPythonOnly
     */
     wxDragImage(const wxTreeCtrl& treeCtrl, wxTreeItemId& id);
     /**
@@ -116,25 +89,8 @@ public:
             List control for constructing a list drag image.
         @param id
             List control item id.
-
-        @beginWxPythonOnly
-        This constructor is called wxDragListItem in wxPython.
-        @endWxPythonOnly
     */
     wxDragImage(const wxListCtrl& listCtrl, long id);
-    /**
-        Constructs a drag image an optional cursor. This constructor is only
-        available for wxGenericDragImage, and can be used when the application
-        supplies DoDrawImage() and GetImageRect().
-
-        @param cursor
-            Optional cursor to combine with the image.
-        @param cursorHotspot
-            This parameter is deprecated.
-    */
-    wxDragImage(const wxCursor& cursor = wxNullCursor,
-                const wxPoint& cursorHotspot = wxPoint(0, 0));
-
     /**
         Start dragging the image, in a window or full screen.
 
@@ -193,7 +149,7 @@ public:
         applications to draw their own image instead of using an actual bitmap.
         If you override this function, you must also override GetImageRect().
     */
-    virtual bool DoDrawImage(wxDC& dc, const wxPoint& pos);
+    virtual bool DoDrawImage(wxDC& dc, const wxPoint& pos) const;
 
     /**
         Call this when the drag has finished.
@@ -255,8 +211,8 @@ public:
 
         This function is available in wxGenericDragImage only.
     */
-    bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
-                                 const wxRect& sourceRect,
-                                 const wxRect& destRect) const;
+    virtual bool UpdateBackingFromWindow(wxDC& windowDC, wxMemoryDC& destDC,
+                                         const wxRect& sourceRect,
+                                         const wxRect& destRect) const;
 };