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

Improve wxListCtrl::SetItemState() documentation.

Browse Source 
Better explain the meaning of its parameters.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70910 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2012-03-15 23:24:41 +00:00
parent 9827ce9208
commit f9c2e12fff
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
interface/wx/listctrl.h
View File

@ -971,8 +971,24 @@ public:
bool SetItemPtrData(long item, wxUIntPtr data);
/**
Sets the item state. For a list of state flags, see SetItem().
The @b stateMask indicates which state flags are valid.
Sets the item state.
The @a stateMask is a combination of @c wxLIST_STATE_XXX constants
described in wxListItem documentation. For each of the bits specified
in @a stateMask, the corresponding state is set or cleared depending on
whether @a state argument contains the same bit or not.
So to select an item you can use
@code
list->SetItemState(item, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
@endcode
while to deselect it you should use
@code
list->SetItemState(item, 0, wxLIST_STATE_SELECTED);
@endcode
Consider using wxListView if possible to avoid dealing with this
error-prone and confusing method.
*/
bool SetItemState(long item, long state, long stateMask);