Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Correct wxDropSource constructors documentation.

Browse Source 
The types of the arguments (wxCursor vs wxIcon) were inversed. Even though the
description correctly said that wxCursor version was used by MSW and wxIcon --
by wxGTK the converse was actually documented.

Fix this and also mention OS X.

Finally remove the unnecessary and useless destructor documentation.

Closes #13856.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70326 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-01-12 18:15:12 +00:00
parent aae3b9d5ca
commit c0211f554c
1 changed files with 22 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
interface/wx/dnd.h
View File

@@ -188,8 +188,8 @@ public:
This constructor requires that you must call SetData() later. This constructor requires that you must call SetData() later.
Note that the type of @a iconCopy and subsequent parameters Note that the type of @a iconCopy and subsequent parameters
differs between different ports: these are cursors under Windows but differs between different ports: these are cursors under Windows and OS
icons for GTK. You should use the macro wxDROP_ICON() in portable X but icons for GTK. You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types. programs instead of directly using either of these types.
@onlyfor{wxmsw,wxosx} @onlyfor{wxmsw,wxosx}
@@ -204,16 +204,16 @@ public:
The icon or cursor used for feedback when operation can't be done. The icon or cursor used for feedback when operation can't be done.
*/ */
wxDropSource(wxWindow* win = NULL, wxDropSource(wxWindow* win = NULL,
const wxIcon& iconCopy = wxNullIcon, const wxCursor& iconCopy = wxNullIcon,
const wxIcon& iconMove = wxNullIcon, const wxCursor& iconMove = wxNullIcon,
const wxIcon& iconNone = wxNullIcon); const wxCursor& iconNone = wxNullIcon);
/** /**
The constructor for wxDataObject. The constructor taking a wxDataObject.
Note that the type of @a iconCopy and subsequent parameters Note that the type of @a iconCopy and subsequent parameters
differs between different ports: these are cursors under Windows but differs between different ports: these are cursors under Windows and OS
icons for GTK. You should use the macro wxDROP_ICON() in portable X but icons for GTK. You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types. programs instead of directly using either of these types.
@onlyfor{wxmsw,wxosx} @onlyfor{wxmsw,wxosx}
@@ -230,17 +230,15 @@ public:
The icon or cursor used for feedback when operation can't be done. The icon or cursor used for feedback when operation can't be done.
*/ */
wxDropSource(wxDataObject& data, wxWindow* win = NULL, wxDropSource(wxDataObject& data, wxWindow* win = NULL,
const wxIcon& iconCopy = wxNullIcon, const wxCursor& iconCopy = wxNullIcon,
const wxIcon& iconMove = wxNullIcon, const wxCursor& iconMove = wxNullIcon,
const wxIcon& iconNone = wxNullIcon); const wxCursor& iconNone = wxNullIcon);
/** /**
This constructor requires that you must call SetData() later. This constructor requires that you must call SetData() later.
Note that the type of @a iconCopy and subsequent parameters This is the wxGTK-specific version of the constructor taking wxIcon
differs between different ports: these are cursors under Windows but instead of wxCursor as the other ports.
icons for GTK. You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types.
@onlyfor{wxgtk} @onlyfor{wxgtk}
@@ -254,17 +252,15 @@ public:
The icon or cursor used for feedback when operation can't be done. The icon or cursor used for feedback when operation can't be done.
*/ */
wxDropSource(wxWindow* win = NULL, wxDropSource(wxWindow* win = NULL,
const wxCursor& iconCopy = wxNullCursor, const wxIcon& iconCopy = wxNullCursor,
const wxCursor& iconMove = wxNullCursor, const wxIcon& iconMove = wxNullCursor,
const wxCursor& iconNone = wxNullCursor); const wxIcon& iconNone = wxNullCursor);
/** /**
The constructor for wxDataObject. The constructor taking a wxDataObject.
Note that the type of @a iconCopy and subsequent parameters This is the wxGTK-specific version of the constructor taking wxIcon
differs between different ports: these are cursors under Windows but instead of wxCursor as the other ports.
icons for GTK. You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types.
@onlyfor{wxgtk} @onlyfor{wxgtk}
@@ -280,14 +276,9 @@ public:
The icon or cursor used for feedback when operation can't be done. The icon or cursor used for feedback when operation can't be done.
*/ */
wxDropSource(wxDataObject& data, wxWindow* win = NULL, wxDropSource(wxDataObject& data, wxWindow* win = NULL,
const wxCursor& iconCopy = wxNullCursor, const wxIcon& iconCopy = wxNullCursor,
const wxCursor& iconMove = wxNullCursor, const wxIcon& iconMove = wxNullCursor,
const wxCursor& iconNone = wxNullCursor); const wxIcon& iconNone = wxNullCursor);
/**
Default constructor.
*/
virtual ~wxDropSource();
/** /**
Starts the drag-and-drop operation which will terminate when the user Starts the drag-and-drop operation which will terminate when the user