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

Minor updates to the wxSizer docs

Browse Source 
Don't mention inexistent "recursive" parameter of GetItem() overload not
taking it.

Closes https://github.com/wxWidgets/wxWidgets/pull/2302
This commit is contained in:
Ian McInerney
2021-04-03 23:13:55 +01:00
committed by Vadim Zeitlin
parent 996469115b
commit 6c9f9af7fc
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
interface/wx/sizer.h
View File

@@ -465,38 +465,41 @@ public:
Returns the number of items in the sizer. Returns the number of items in the sizer.
If you just need to test whether the sizer is empty or not you can also If you just need to test whether the sizer is empty or not you can also
use IsEmpty() function. use the IsEmpty() function.
*/ */
size_t GetItemCount() const; size_t GetItemCount() const;
/** /**
Finds wxSizerItem which holds the given @a window. Finds the wxSizerItem which holds the given @a window.
Use parameter @a recursive to search in subsizers too. Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
@return Pointer to the item or @NULL if there is no item with the window.
*/ */
wxSizerItem* GetItem(wxWindow* window, bool recursive = false); wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
/** /**
Finds wxSizerItem which holds the given @a sizer. Finds the wxSizerItem which holds the given @a sizer.
Use parameter @a recursive to search in subsizers too. Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
@return Pointer to the item or @NULL if the given sizer is not in the sizer.
*/ */
wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false); wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
/** /**
Finds wxSizerItem which is located in the sizer at position @a index. Finds the wxSizerItem which is located in the sizer at position @a index.
Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL. @return Pointer to the item or @NULL if there is no item at that index.
*/ */
wxSizerItem* GetItem(size_t index); wxSizerItem* GetItem(size_t index);
/** /**
Finds item of the sizer which has the given @e id. Finds the item in the sizer which has the given @e id.
This @a id is not the window id but the id of the wxSizerItem itself. This @a id is not the window id but the id of the wxSizerItem itself.
This is mainly useful for retrieving the sizers created from XRC resources. This is mainly useful for retrieving the sizers created from XRC resources.
Use parameter @a recursive to search in subsizers too. Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
@return Pointer to item or @NULL if no item has that id.
*/ */
wxSizerItem* GetItemById(int id, bool recursive = false); wxSizerItem* GetItemById(int id, bool recursive = false);