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

Add wxAuiToolBar::DestroyTool() and DestroyToolByIndex()

Browse Source 
These new functions destroy the associated window too, unlike the
existing DeleteTool() and DeleteByIndex().

Closes #16552.
This commit is contained in:
Vadim Zeitlin
2020-03-10 23:37:42 +01:00
parent 95b1f7b7ea
commit 700eaff131
3 changed files with 48 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
interface/wx/aui/auibar.h
View File

@@ -724,11 +724,33 @@ public:
void Clear();
/**
Removes the tool with the given ID from the tool bar.
Destroys the tool with the given ID and its associated window, if any.
@param tool_id ID of a previously added tool.
@return @true if the tool was destroyed or @false otherwise, e.g. if
the tool with the given ID was not found.
@since 3.1.4
*/
bool DestroyTool(int tool_id);
/**
Destroys the tool at the given position and its associated window, if
any.
@param idx The index, or position, of a previously added tool.
@return @true if the tool was destroyed or @false otherwise, e.g. if
the provided index is out of range.
*/
bool DestroyToolByIndex(int idx);
/**
Removes the tool with the given ID from the toolbar.
Note that if this tool was added by AddControl(), the associated
control is @e not deleted and must either be reused (e.g. by
reparenting it under a different window) or destroyed by caller.
If this behaviour is unwanted, prefer using DestroyTool() instead.
@param tool_id ID of a previously added tool.
@return @true if the tool was removed or @false otherwise, e.g. if the
@@ -737,11 +759,13 @@ public:
bool DeleteTool(int tool_id);
/**
Removes the tool at the given position from the tool bar.
Removes the tool at the given position from the toolbar.
Note that if this tool was added by AddControl(), the associated
control is @e not deleted and must either be reused (e.g. by
reparenting it under a different window) or destroyed by caller.
If this behaviour is unwanted, prefer using DestroyToolByIndex()
instead.
@param idx The index, or position, of a previously added tool.
@return @true if the tool was removed or @false otherwise, e.g. if the