// Name: ribbon/toolbar.h
// Purpose: interface of wxRibbonToolBar
// Author: Peter Cawley
-// RCS-ID: $Id$
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
@param pos
Position of the new tool (number of tools and separators from the
- begining of the toolbar).
+ beginning of the toolbar).
@param tool_id
ID of the new tool (used for event callbacks).
@param bitmap
/**
This function behaves like DeleteTool() but it deletes the tool at the
specified position and not the one with the given id.
- Usefull to delete separators.
+ Useful to delete separators.
@since 2.9.4
*/
/**
Get any client data associated with the tool.
- @param toolId
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@return Client data, or @NULL if there is none.
/**
Called to determine whether a tool is enabled (responds to user input).
- @param toolId
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@return @true if the tool is enabled, @false otherwise.
/**
Returns the help string for the given tool.
- @param toolId
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@since 2.9.4
/**
Return the kind of the given tool.
- @param toolId
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@since 2.9.4
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
is not found.
- @param toolId
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@since 2.9.4
/**
Gets the on/off state of a toggle tool.
- @param toolId
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@return @true if the tool is toggled on, @false otherwise.
/**
Sets the client data associated with the tool.
- @param id
+ @param tool_id
ID of the tool in question, as passed to AddTool().
+ @param clientData
+ The client data to use.
@since 2.9.4
*/
@param tool_id
ID of the tool in question, as passed to AddTool().
+ @param bitmap
+ Bitmap to use for disabled tools.
@since 2.9.4
*/
/**
Sets the help string shown in tooltip for the given tool.
- @param tool_Id
+ @param tool_id
ID of the tool in question, as passed to AddTool().
@param helpString
A string for the help.
@param tool_id
ID of the tool in question, as passed to AddTool().
+ @param bitmap
+ Bitmap to use for normals tools.
@since 2.9.4
*/