wxPython – AddLabelTool() function in wx.ToolBar

In this article we are going to learn about another method in wx.ToolBar class of wxPython, that is, AddLabelTool() method. AddLabelTool() is old style method to add a tool to the toolbar.

Syntax: wx.ToolBar.AddLabelTool(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.

Code Example:

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()

        # add tool using AddLabelTool() method
        qtool = self.toolbar.AddLabelTool(12, 'Quit',
                    wx.Bitmap('/Desktop/wxPython/right.png'),
                                       kind = wx.ITEM_NORMAL,
                                   shortHelp ="AddLabelTool")

        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()

Output :