X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/76e9224eb2edea8afe45faa6a1cd1b2894d245c2..f2b6dd8c508ddc1ebfee5b7d6e68a44b4e05a50f:/interface/wx/dnd.h diff --git a/interface/wx/dnd.h b/interface/wx/dnd.h index 9c8359c7ba..bdc65be16b 100644 --- a/interface/wx/dnd.h +++ b/interface/wx/dnd.h @@ -3,7 +3,7 @@ // Purpose: interface of wxDropSource and wx*DropTarget // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -28,7 +28,7 @@ public: See wxDropTarget::OnDrop(). This function is implemented appropriately for text, and calls OnDropText(). */ - virtual bool OnDrop(long x, long y, const void data, size_t size); + virtual bool OnDrop(wxCoord x, wxCoord y); /** Override this function to receive dropped text. @@ -99,7 +99,7 @@ public: associated with this drop target, calling its wxDataObject::SetData() method. */ - virtual void GetData(); + virtual bool GetData(); /** Called after OnDrop() returns @true. By default this will usually @@ -187,11 +187,13 @@ public: /** This constructor requires that you must call SetData() later. - Note that the exact type of @a iconCopy and subsequent parameters - differs between wxMSW and wxGTK: these are cursors under Windows but - icons for GTK. You should use the macro wxDROP_ICON() in portable + Note that the type of @a iconCopy and subsequent parameters + differs between different ports: these are cursors under Windows and OS + X but icons for GTK. You should use the macro wxDROP_ICON() in portable programs instead of directly using either of these types. + @onlyfor{wxmsw,wxosx} + @param win The window which initiates the drag and drop operation. @param iconCopy @@ -202,18 +204,20 @@ public: The icon or cursor used for feedback when operation can't be done. */ wxDropSource(wxWindow* win = NULL, - const wxIconOrCursor& iconCopy = wxNullIconOrCursor, - const wxIconOrCursor& iconMove = wxNullIconOrCursor, - const wxIconOrCursor& iconNone = wxNullIconOrCursor); + const wxCursor& iconCopy = wxNullIcon, + const wxCursor& iconMove = wxNullIcon, + const wxCursor& iconNone = wxNullIcon); /** - The constructor for wxDataObject. + The constructor taking a wxDataObject. - Note that the exact type of @a iconCopy and subsequent parameters - differs between wxMSW and wxGTK: these are cursors under Windows but - icons for GTK. You should use the macro wxDROP_ICON() in portable + Note that the type of @a iconCopy and subsequent parameters + differs between different ports: these are cursors under Windows and OS + X but icons for GTK. You should use the macro wxDROP_ICON() in portable programs instead of directly using either of these types. + @onlyfor{wxmsw,wxosx} + @param data The data associated with the drop source. @param win @@ -226,14 +230,55 @@ public: The icon or cursor used for feedback when operation can't be done. */ wxDropSource(wxDataObject& data, wxWindow* win = NULL, - const wxIconOrCursor& iconCopy = wxNullIconOrCursor, - const wxIconOrCursor& iconMove = wxNullIconOrCursor, - const wxIconOrCursor& iconNone = wxNullIconOrCursor); + const wxCursor& iconCopy = wxNullIcon, + const wxCursor& iconMove = wxNullIcon, + const wxCursor& iconNone = wxNullIcon); + + /** + This constructor requires that you must call SetData() later. + + This is the wxGTK-specific version of the constructor taking wxIcon + instead of wxCursor as the other ports. + + @onlyfor{wxgtk} + + @param win + The window which initiates the drag and drop operation. + @param iconCopy + The icon or cursor used for feedback for copy operation. + @param iconMove + The icon or cursor used for feedback for move operation. + @param iconNone + The icon or cursor used for feedback when operation can't be done. + */ + wxDropSource(wxWindow* win = NULL, + const wxIcon& iconCopy = wxNullCursor, + const wxIcon& iconMove = wxNullCursor, + const wxIcon& iconNone = wxNullCursor); /** - Default constructor. + The constructor taking a wxDataObject. + + This is the wxGTK-specific version of the constructor taking wxIcon + instead of wxCursor as the other ports. + + @onlyfor{wxgtk} + + @param data + The data associated with the drop source. + @param win + The window which initiates the drag and drop operation. + @param iconCopy + The icon or cursor used for feedback for copy operation. + @param iconMove + The icon or cursor used for feedback for move operation. + @param iconNone + The icon or cursor used for feedback when operation can't be done. */ - virtual ~wxDropSource(); + wxDropSource(wxDataObject& data, wxWindow* win = NULL, + const wxIcon& iconCopy = wxNullCursor, + const wxIcon& iconMove = wxNullCursor, + const wxIcon& iconNone = wxNullCursor); /** Starts the drag-and-drop operation which will terminate when the user @@ -313,7 +358,7 @@ public: See wxDropTarget::OnDrop(). This function is implemented appropriately for files, and calls OnDropFiles(). */ - virtual bool OnDrop(long x, long y, const void data, size_t size); + virtual bool OnDrop(wxCoord x, wxCoord y); /** Override this function to receive dropped files. @@ -328,7 +373,7 @@ public: Return @true to accept the data, or @false to veto the operation. */ virtual bool OnDropFiles(wxCoord x, wxCoord y, - const wxArrayString& filenames); + const wxArrayString& filenames) = 0; }; @@ -337,7 +382,7 @@ public: // Global functions/macros // ============================================================================ -/** @ingroup group_funcmacro_gdi */ +/** @addtogroup group_funcmacro_gdi */ //@{ /**