/**
Toolbar destructor.
*/
- ~wxToolBar();
+ virtual ~wxToolBar();
/**
Adds a new check (or toggle) tool to the toolbar. The parameters are the
@see AddTool()
*/
- wxToolBarToolBase* AddCheckTool(int toolId,
- const wxString& label,
+ wxToolBarToolBase* AddCheckTool(int toolId, const wxString& label,
const wxBitmap& bitmap1,
- const wxBitmap& bitmap2,
- const wxString& shortHelpString = "",
- const wxString& longHelpString = "",
+ const wxBitmap& bmpDisabled = wxNullBitmap,
+ const wxString& shortHelp = wxEmptyString,
+ const wxString& longHelp = wxEmptyString,
wxObject* clientData = NULL);
/**
wxMac: labels are only displayed if wxWidgets is built with @c
wxMAC_USE_NATIVE_TOOLBAR set to 1
*/
- bool AddControl(wxControl* control, const wxString label = "");
+ virtual wxToolBarToolBase* AddControl(wxControl* control,
+ const wxString& label = wxEmptyString);
/**
Adds a new radio tool to the toolbar. Consecutive radio tools form a
@see AddTool()
*/
- wxToolBarToolBase* AddRadioTool(int toolId,
- const wxString& label,
+ wxToolBarToolBase* AddRadioTool(int toolId, const wxString& label,
const wxBitmap& bitmap1,
- const wxBitmap& bitmap2,
- const wxString& shortHelpString = "",
- const wxString& longHelpString = "",
+ const wxBitmap& bmpDisabled = wxNullBitmap,
+ const wxString& shortHelp = wxEmptyString,
+ const wxString& longHelp = wxEmptyString,
wxObject* clientData = NULL);
/**
@see AddTool(), SetToolSeparation()
*/
- void AddSeparator();
+ virtual wxToolBarToolBase* AddSeparator();
/**
Adds a tool to the toolbar.
@see AddSeparator(), AddCheckTool(), AddRadioTool(),
InsertTool(), DeleteTool(), Realize(), SetDropdownMenu()
*/
- wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
+ virtual wxToolBarToolBase* AddTool(wxToolBarToolBase* tool);
/**
Adds a tool to the toolbar. This most commonly used version has fewer
/**
Deletes all the tools in the toolbar.
*/
- void ClearTools();
+ virtual void ClearTools();
/**
Removes the specified tool from the toolbar and deletes it. If you don't
@see DeleteToolByPos()
*/
- bool DeleteTool(int toolId);
+ virtual bool DeleteTool(int toolId);
/**
This function behaves like DeleteTool() but it deletes the tool at the
specified position and not the one with the given id.
*/
- bool DeleteToolByPos(size_t pos);
+ virtual bool DeleteToolByPos(size_t pos);
/**
Enables or disables the tool.
@see GetToolEnabled(), ToggleTool()
*/
- void EnableTool(int toolId, bool enable);
+ virtual void EnableTool(int toolId, bool enable);
/**
Returns a pointer to the tool identified by @a id or @NULL if no
corresponding tool is found.
*/
- wxToolBarToolBase* FindById(int id);
+ wxToolBarToolBase* FindById(int id) const;
/**
Returns a pointer to the control identified by @a id or @NULL if no
corresponding control is found.
*/
- wxControl* FindControl(int id);
+ virtual wxControl* FindControl(int id);
/**
Finds a tool for the given mouse position.
@remarks Currently not implemented in wxGTK (always returns @NULL
there).
*/
- wxToolBarToolBase* FindToolForPosition(wxCoord x, wxCoord y) const;
+ virtual wxToolBarToolBase* FindToolForPosition(wxCoord x, wxCoord y) const;
/**
Returns the left/right and top/bottom margins, which are also used for
@see SetToolBitmapSize(), GetToolSize()
*/
- wxSize GetToolBitmapSize();
+ virtual wxSize GetToolBitmapSize() const;
/**
Get any client data associated with the tool.
@return Client data, or @NULL if there is none.
*/
- wxObject* GetToolClientData(int toolId) const;
+ virtual wxObject* GetToolClientData(int toolId) const;
/**
Called to determine whether a tool is enabled (responds to user input).
@see EnableTool()
*/
- bool GetToolEnabled(int toolId) const;
+ virtual bool GetToolEnabled(int toolId) const;
/**
Returns the long help for the given tool.
@see SetToolLongHelp(), SetToolShortHelp()
*/
- wxString GetToolLongHelp(int toolId) const;
+ virtual wxString GetToolLongHelp(int toolId) const;
/**
Returns the value used for packing tools.
@see SetToolPacking()
*/
- int GetToolPacking() const;
+ virtual int GetToolPacking() const;
/**
Returns the tool position in the toolbar, or @c wxNOT_FOUND if the tool
is not found.
*/
- int GetToolPos(int toolId) const;
+ virtual int GetToolPos(int toolId) const;
/**
Returns the default separator size.
@see SetToolSeparation()
*/
- int GetToolSeparation() const;
+ virtual int GetToolSeparation() const;
/**
Returns the short help for the given tool.
@see GetToolLongHelp(), SetToolShortHelp()
*/
- wxString GetToolShortHelp(int toolId) const;
+ virtual wxString GetToolShortHelp(int toolId) const;
/**
Returns the size of a whole button, which is usually larger than a tool
@see SetToolBitmapSize(), GetToolBitmapSize()
*/
- wxSize GetToolSize();
+ virtual wxSize GetToolSize() const;
/**
Gets the on/off state of a toggle tool.
@see ToggleTool()
*/
- bool GetToolState(int toolId) const;
+ virtual bool GetToolState(int toolId) const;
/**
Returns the number of tools in the toolbar.
*/
- int GetToolsCount() const;
+ size_t GetToolsCount() const;
/**
Inserts the control into the toolbar at the given position. You must
@see AddControl(), InsertTool()
*/
- wxToolBarToolBase* InsertControl(size_t pos, wxControl* control);
+ virtual wxToolBarToolBase* InsertControl(size_t pos, wxControl* control,
+ const wxString& label = wxEmptyString);
/**
Inserts the separator into the toolbar at the given position. You must
@see AddSeparator(), InsertTool()
*/
- wxToolBarToolBase* InsertSeparator(size_t pos);
+ virtual wxToolBarToolBase* InsertSeparator(size_t pos);
//@{
/**
@see OnMouseEnter(), OnRightClick()
*/
- bool OnLeftClick(int toolId, bool toggleDown);
+ virtual bool OnLeftClick(int toolId, bool toggleDown);
/**
This is called when the mouse cursor moves into a tool or out of the
out of the toolbar, wxWidgets may not be able to detect it.
Therefore this function may not always be called when expected.
*/
- void OnMouseEnter(int toolId);
+ virtual void OnMouseEnter(int toolId);
/**
@deprecated This is the old way of detecting tool right clicks;
@see OnMouseEnter(), OnLeftClick()
*/
- void OnRightClick(int toolId, float x, float y);
+ virtual void OnRightClick(int toolId, long x, long y);
/**
This function should be called after you have added tools.
*/
- bool Realize();
+ virtual bool Realize();
/**
Removes the given tool from the toolbar but doesn't delete it. This
@see DeleteTool()
*/
- wxToolBarToolBase* RemoveTool(int id);
+ virtual wxToolBarToolBase* RemoveTool(int id);
/**
Sets the bitmap resource identifier for specifying tool bitmaps as
@see GetMargins()
*/
- void SetMargins(int x, int y);
+ virtual void SetMargins(int x, int y);
/**
Set the margins for the toolbar.
@see GetToolBitmapSize(), GetToolSize()
*/
- void SetToolBitmapSize(const wxSize& size);
+ virtual void SetToolBitmapSize(const wxSize& size);
/**
Sets the client data associated with the tool.
*/
- void SetToolClientData(int id, wxObject* clientData);
+ virtual void SetToolClientData(int id, wxObject* clientData);
/**
Sets the bitmap to be used by the tool with the given ID when the tool
have no effect on those platforms.
*/
- void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
+ virtual void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
/**
Sets the long help for the given tool.
@see GetToolLongHelp(), SetToolShortHelp(),
*/
- void SetToolLongHelp(int toolId, const wxString& helpString);
+ virtual void SetToolLongHelp(int toolId, const wxString& helpString);
/**
Sets the bitmap to be used by the tool with the given ID. This can only
be used on Button tools, not controls.
*/
- void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
+ virtual void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
/**
Sets the value used for spacing tools. The default value is 1.
@see GetToolPacking()
*/
- void SetToolPacking(int packing);
+ virtual void SetToolPacking(int packing);
/**
Sets the default separator size. The default value is 5.
@see AddSeparator()
*/
- void SetToolSeparation(int separation);
+ virtual void SetToolSeparation(int separation);
/**
Sets the short help for the given tool.
@see GetToolShortHelp(), SetToolLongHelp()
*/
- void SetToolShortHelp(int toolId, const wxString& helpString);
+ virtual void SetToolShortHelp(int toolId, const wxString& helpString);
/**
Toggles a tool on or off. This does not cause any event to get emitted.
@remarks Only applies to a tool that has been specified as a toggle
tool.
*/
- void ToggleTool(int toolId, bool toggle);
+ virtual void ToggleTool(int toolId, bool toggle);
};
projects / wxWidgets.git / blobdiff