Make "NOT the index" in wxListCtrl::SortItems() stand out even more.

Any reasonable person expects the sort callback to receive the indices of the
items, but it doesn't: it's passed the client data associated with them
instead. Make it even more noticeable in the documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76205 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2014-03-27 22:10:38 +00:00
parent 9b09ca16a6
commit 1e0a6af966

View File

@ -1192,8 +1192,8 @@ public:
second one and positive value if the first one is greater than the second one
(the same convention as used by @c qsort(3)).
The parameter @e item1 is the client data associated with the first item (NOT the index).
The parameter @e item2 is the client data associated with the second item (NOT the index).
The parameter @e item1 is the client data associated with the first item (@b NOT the index).
The parameter @e item2 is the client data associated with the second item (@b NOT the index).
The parameter @e data is the value passed to SortItems() itself.
Notice that the control may only be sorted on client data associated with