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

Improve wxWindow::FindWindowByName() documentation

Browse Source 
Mention that the "name" is interpreted as the label if no window with
such name is found.

Also document that both this and FindWindowByLabel() functions do
recurse into child TLWs, unlike FindWindow().
This commit is contained in:
Vadim Zeitlin
2018-07-03 18:54:19 +02:00
parent 64ae76fadd
commit 5e5f878db0
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
interface/wx/window.h
View File

@@ -3825,7 +3825,9 @@ public:
or panel item label. If @a parent is @NULL, the search will start from all
top-level frames and dialog boxes; if non-@NULL, the search will be
limited to the given window hierarchy.
The search is recursive in both cases.
The search is recursive in both cases and, unlike with FindWindow(),
recurses into top level child windows too.
@see FindWindow()
@@ -3842,10 +3844,14 @@ public:
and dialog boxes; if non-@NULL, the search will be limited to the given
window hierarchy.
The search is recursive in both cases. If no window with such name is found,
FindWindowByLabel() is called.
The search is recursive in both cases and, unlike FindWindow(),
recurses into top level child windows too.
@see FindWindow()
If no window with such name is found, FindWindowByLabel() is called,
i.e. the name is interpreted as (internal) name first but if this
fails, it's internal as (user-visible) label. As this behaviour may be
confusing, it is usually better to use either the FindWindow() overload
taking the name or FindWindowByLabel() directly.
@return Window with the given @a name or @NULL if not found.
*/