wxPython - wx.ToolBar 中的 AddSimpleTool()函数

wx.ToolBar 是 wxPython GUI 编程中常用的工具栏组件。AddSimpleTool() 是其常用的方法之一。本篇介绍 AddSimpleTool() 的用法及注意事项。

方法概述

AddSimpleTool() 是 wx.ToolBar 中用于添加简单工具按钮的方法。该方法的完整定义如下：

AddSimpleTool(self, toolId: int, bitmap: wx.Bitmap, label: str = "", shortHelp: str = "", kind: int = wx.ITEM_NORMAL) -> wx.ToolBarToolBase

其中，各参数的含义如下：

• toolId: 工具按钮的 ID。
• bitmap: 工具按钮的位图。可使用 wx.Bitmap() 方法创建位图对象。
• label: 工具按钮旁边的标签。默认为空。
• shortHelp: 当鼠标悬停在工具按钮上时显示的文字提示。默认为空。
• kind: 工具按钮的类型。默认为 wx.ITEM_NORMAL。

该方法返回一个 wx.ToolBarToolBase 对象。

代码示例

下面是一个使用 AddSimpleTool() 添加工具按钮的示例代码：

import wx

class MyToolBar(wx.Frame):

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        self.InitUI()

    def InitUI(self):

        toolbar = self.CreateToolBar()
        qtool = toolbar.AddSimpleTool(wx.ID_ANY, wx.Bitmap('question.png'))
        htool = toolbar.AddSimpleTool(wx.ID_ANY, wx.Bitmap('help.png'), shortHelp='Help')

        toolbar.Realize()

    def Center(self):

        fsize = self.GetSize()
        ssize = wx.DisplaySize()
        x = (ssize[0] - fsize[0])/2
        y = (ssize[1] - fsize[1])/2
        self.SetPosition((x, y))

def main():

    app = wx.App()
    ex = MyToolBar(None, title='Toolbars')
    ex.Show()
    ex.Center()
    app.MainLoop()


if __name__ == '__main__':
    main()

在该示例代码中，创建了 MyToolBar 类，并在其中定义了 InitUI() 方法。在 InitUI() 方法中，首先通过 self.CreateToolBar() 方法创建一个工具栏，并将其赋值给 toolbar 变量。接着，使用 toolbar.AddSimpleTool() 方法添加了两个工具按钮：

• qtool: 该按钮的 ID 为 wx.ID_ANY，位图文件为 'question.png'。
• htool: 该按钮的 ID 为 wx.ID_ANY，位图文件为 'help.png'，且鼠标悬停在该按钮上时的提示为 'Help'。

最后，通过 toolbar.Realize() 方法将工具栏添加到窗口中。

注意事项

在使用 AddSimpleTool() 方法添加工具按钮时，需要注意以下几点：

• 所有工具按钮的 ID 必须唯一且大于等于 wx.ID_HIGHEST，可以使用 wx.NewId() 方法为其生成唯一 ID。
• 位图文件应该是相对于运行程序的目录路径，如果路径不正确，则无法显示图像。
• 对于工具按钮的文字提示，如果包含了换行符 '\n'，则只有第一行会被显示在提示框中。
• 工具按钮可以有三种类型：NORMAL、RADIO 和 CHECK。其中 NORMAL 是最常用的类型。

结论

AddSimpleTool() 方法是在 wxPython 中添加简单工具按钮的常用方法之一，使用它可以方便地向工具栏添加工具按钮，并且可以自定义按钮的位图、文字提示等。需要注意的是，工具按钮的 ID 必须唯一且大于等于 wx.ID_HIGHEST，位图文件应该是相对于运行程序的目录路径，文字提示中换行符 '\n' 只有第一行会被显示在提示框中。