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

Rename tool ID parameter in wxAuiToolBar documentation

Browse Source 
Use "toolId" to match the actual name in the header instead of
"tool_id".

No real changes.
This commit is contained in:
Vadim Zeitlin
2020-03-15 17:09:54 +01:00
parent 700eaff131
commit ea359e02ab
1 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -681,13 +681,13 @@ public:
bool SetFont(const wxFont& font); bool SetFont(const wxFont& font);
wxAuiToolBarItem* AddTool(int tool_id, wxAuiToolBarItem* AddTool(int toolId,
const wxString& label, const wxString& label,
const wxBitmap& bitmap, const wxBitmap& bitmap,
const wxString& short_help_string = wxEmptyString, const wxString& short_help_string = wxEmptyString,
wxItemKind kind = wxITEM_NORMAL); wxItemKind kind = wxITEM_NORMAL);
wxAuiToolBarItem* AddTool(int tool_id, wxAuiToolBarItem* AddTool(int toolId,
const wxString& label, const wxString& label,
const wxBitmap& bitmap, const wxBitmap& bitmap,
const wxBitmap& disabled_bitmap, const wxBitmap& disabled_bitmap,
@@ -696,7 +696,7 @@ public:
const wxString& long_help_string, const wxString& long_help_string,
wxObject* client_data); wxObject* client_data);
wxAuiToolBarItem* AddTool(int tool_id, wxAuiToolBarItem* AddTool(int toolId,
const wxBitmap& bitmap, const wxBitmap& bitmap,
const wxBitmap& disabled_bitmap, const wxBitmap& disabled_bitmap,
bool toggle = false, bool toggle = false,
@@ -704,7 +704,7 @@ public:
const wxString& short_help_string = wxEmptyString, const wxString& short_help_string = wxEmptyString,
const wxString& long_help_string = wxEmptyString); const wxString& long_help_string = wxEmptyString);
wxAuiToolBarItem* AddLabel(int tool_id, wxAuiToolBarItem* AddLabel(int toolId,
const wxString& label = wxEmptyString, const wxString& label = wxEmptyString,
const int width = -1); const int width = -1);
wxAuiToolBarItem* AddControl(wxControl* control, wxAuiToolBarItem* AddControl(wxControl* control,
@@ -718,7 +718,7 @@ public:
wxControl* FindControl(int window_id); wxControl* FindControl(int window_id);
wxAuiToolBarItem* FindToolByPosition(wxCoord x, wxCoord y) const; wxAuiToolBarItem* FindToolByPosition(wxCoord x, wxCoord y) const;
wxAuiToolBarItem* FindToolByIndex(int idx) const; wxAuiToolBarItem* FindToolByIndex(int idx) const;
wxAuiToolBarItem* FindTool(int tool_id) const; wxAuiToolBarItem* FindTool(int toolId) const;
void ClearTools(); void ClearTools();
void Clear(); void Clear();
@@ -726,13 +726,13 @@ public:
/** /**
Destroys the tool with the given ID and its associated window, if any. Destroys the tool with the given ID and its associated window, if any.
@param tool_id ID of a previously added tool. @param toolId ID of a previously added tool.
@return @true if the tool was destroyed or @false otherwise, e.g. if @return @true if the tool was destroyed or @false otherwise, e.g. if
the tool with the given ID was not found. the tool with the given ID was not found.
@since 3.1.4 @since 3.1.4
*/ */
bool DestroyTool(int tool_id); bool DestroyTool(int toolId);
/** /**
Destroys the tool at the given position and its associated window, if Destroys the tool at the given position and its associated window, if
@@ -752,11 +752,11 @@ public:
reparenting it under a different window) or destroyed by caller. reparenting it under a different window) or destroyed by caller.
If this behaviour is unwanted, prefer using DestroyTool() instead. If this behaviour is unwanted, prefer using DestroyTool() instead.
@param tool_id ID of a previously added tool. @param toolId ID of a previously added tool.
@return @true if the tool was removed or @false otherwise, e.g. if the @return @true if the tool was removed or @false otherwise, e.g. if the
tool with the given ID was not found. tool with the given ID was not found.
*/ */
bool DeleteTool(int tool_id); bool DeleteTool(int toolId);
/** /**
Removes the tool at the given position from the toolbar. Removes the tool at the given position from the toolbar.
@@ -774,11 +774,11 @@ public:
bool DeleteByIndex(int idx); bool DeleteByIndex(int idx);
size_t GetToolCount() const; size_t GetToolCount() const;
int GetToolPos(int tool_id) const; int GetToolPos(int toolId) const;
int GetToolIndex(int tool_id) const; int GetToolIndex(int toolId) const;
bool GetToolFits(int tool_id) const; bool GetToolFits(int toolId) const;
wxRect GetToolRect(int tool_id) const; wxRect GetToolRect(int toolId) const;
bool GetToolFitsByIndex(int tool_id) const; bool GetToolFitsByIndex(int toolId) const;
bool GetToolBarFits() const; bool GetToolBarFits() const;
void SetMargins(const wxSize& size); void SetMargins(const wxSize& size);
@@ -794,11 +794,11 @@ public:
bool GetGripperVisible() const; bool GetGripperVisible() const;
void SetGripperVisible(bool visible); void SetGripperVisible(bool visible);
void ToggleTool(int tool_id, bool state); void ToggleTool(int toolId, bool state);
bool GetToolToggled(int tool_id) const; bool GetToolToggled(int toolId) const;
void EnableTool(int tool_id, bool state); void EnableTool(int toolId, bool state);
bool GetToolEnabled(int tool_id) const; bool GetToolEnabled(int toolId) const;
/** /**
Set whether the specified toolbar item has a drop down button. Set whether the specified toolbar item has a drop down button.
@@ -807,7 +807,7 @@ public:
@see wxAuiToolBarItem::SetHasDropDown() @see wxAuiToolBarItem::SetHasDropDown()
*/ */
void SetToolDropDown(int tool_id, bool dropdown); void SetToolDropDown(int toolId, bool dropdown);
/** /**
Returns whether the specified toolbar item has an associated drop down Returns whether the specified toolbar item has an associated drop down
@@ -815,7 +815,7 @@ public:
@see wxAuiToolBarItem::HasDropDown() @see wxAuiToolBarItem::HasDropDown()
*/ */
bool GetToolDropDown(int tool_id) const; bool GetToolDropDown(int toolId) const;
void SetToolBorderPadding(int padding); void SetToolBorderPadding(int padding);
int GetToolBorderPadding() const; int GetToolBorderPadding() const;
@@ -826,26 +826,26 @@ public:
void SetToolPacking(int packing); void SetToolPacking(int packing);
int GetToolPacking() const; int GetToolPacking() const;
void SetToolProportion(int tool_id, int proportion); void SetToolProportion(int toolId, int proportion);
int GetToolProportion(int tool_id) const; int GetToolProportion(int toolId) const;
void SetToolSeparation(int separation); void SetToolSeparation(int separation);
int GetToolSeparation() const; int GetToolSeparation() const;
void SetToolSticky(int tool_id, bool sticky); void SetToolSticky(int toolId, bool sticky);
bool GetToolSticky(int tool_id) const; bool GetToolSticky(int toolId) const;
wxString GetToolLabel(int tool_id) const; wxString GetToolLabel(int toolId) const;
void SetToolLabel(int tool_id, const wxString& label); void SetToolLabel(int toolId, const wxString& label);
wxBitmap GetToolBitmap(int tool_id) const; wxBitmap GetToolBitmap(int toolId) const;
void SetToolBitmap(int tool_id, const wxBitmap& bitmap); void SetToolBitmap(int toolId, const wxBitmap& bitmap);
wxString GetToolShortHelp(int tool_id) const; wxString GetToolShortHelp(int toolId) const;
void SetToolShortHelp(int tool_id, const wxString& help_string); void SetToolShortHelp(int toolId, const wxString& help_string);
wxString GetToolLongHelp(int tool_id) const; wxString GetToolLongHelp(int toolId) const;
void SetToolLongHelp(int tool_id, const wxString& help_string); void SetToolLongHelp(int toolId, const wxString& help_string);
void SetCustomOverflowItems(const wxAuiToolBarItemArray& prepend, void SetCustomOverflowItems(const wxAuiToolBarItemArray& prepend,
const wxAuiToolBarItemArray& append); const wxAuiToolBarItemArray& append);