wxPython - AddTool() function in wx.ToolBar

Last Updated : 17 May, 2020

AddTool() is another function in wx.ToolBar class of wxPython. AddTool() function simply adds a tool to the Toolbar. This is another version of AddTool() function with greater number of parameters. it adds parameters like : bmpDisabled, longHelp, clientData.

Syntax: wx.ToolBar.AddTool(self, id, label, bitmap, bmpDisabled=wx.NullBitmap, kind=wx.ITEM_NORMAL, shortHelp="", longHelp="", clientData=None) Parameters :

Parameter Input Type Description

toolid int An integer by which the tool may be identified in subsequent operations.

label string The string to be displayed with the tool.

bitmap wx.bitmap The primary tool bitmap.

bmpDisabled wx.bitmap The bitmap used when the tool is disabled.

kind int kind of toolbar.

shortHelp string This string is used for the tools tooltip.

longHelp string detailed string associated with tool.

clientData PyUserData An optional pointer to client data which can be retrieved later using GetToolClientData.

Parameter	Input Type	Description
toolid	int	An integer by which the tool may be identified in subsequent operations.
label	string	The string to be displayed with the tool.
bitmap	wx.bitmap	The primary tool bitmap.
bmpDisabled	wx.bitmap	The bitmap used when the tool is disabled.
kind	int	kind of toolbar.
shortHelp	string	This string is used for the tools tooltip.
longHelp	string	detailed string associated with tool.
clientData	PyUserData	An optional pointer to client data which can be retrieved later using GetToolClientData.

Code Example:

Python3 1==

import wx


class Example(wx.Frame):
    global count
    count = 0;
    def __init__(self, *args, **kwargs):
        super(Example, self).__init__(*args, **kwargs)

        self.InitUI()

    def InitUI(self):
        pnl = wx.Panel(self)
        self.toolbar = self.CreateToolBar()

        # Radio tool using AddTool() Function
        ptool = self.toolbar.AddTool(12, 'oneTool',  
                                  wx.Bitmap('/home/wxPython/right.png'),
                                  wx.Bitmap('/home/wxPython/wrong.png'), 
                                  kind = wx.ITEM_RADIO, shortHelp ="Simple Tool")

        spc = self.toolbar.AddStretchableSpace()

        # Check tool using AddTool() Function
        qtool = self.toolbar.AddTool(12, 'oneTool',  wx.Bitmap('/home/wxPython/right.png'), 
                                                     wx.Bitmap('/home/wxPython/wrong.png'), 
                                             kind = wx.ITEM_CHECK, shortHelp ="Simple Tool")

        spc = self.toolbar.AddStretchableSpace()
        # Normal tool using AddTool() Function
        rtool = self.toolbar.AddTool(12, 'oneTool',  wx.Bitmap('/home/wxPython/right.png'),
                                                     wx.Bitmap('/home/wxPython/wrong.png'), 
                                           kind = wx.ITEM_NORMAL, shortHelp ="Simple Tool")


        self.toolbar.Realize()
        self.SetSize((350, 250))
        self.SetTitle('Control')
        self.Centre()
        


def main():

    app = wx.App()
    ex = Example(None)
    ex.Show()
    app.MainLoop()


if __name__ == '__main__':
    main()