使用wxpython开发跨平台桌面应用，基类对话框窗体的封装处理

在开发桌面界面的时候，往往都需要对一些通用的窗体进行一些抽象封装处理，以便统一界面效果，以及继承一些通用的处理过程，减少重复编码。本篇随笔介绍使用wxpython开发跨平台桌面应用，基类对话框窗体的封装处理，介绍基于 wx.lib.sized_controls.SizedDialog 对话框类的基类封装，以便简化子类代码，以及实现一些丰富的编辑界面效果。

1、基类对话框的界面效果

我借用我之前在Winform界面开发的时候，对基类窗体的一些做法，如下是之前Winform界面的一些效果。

如对于一般的数据录入或者查询界面，如下效果所示。

这里可以看到，一般的数据处理界面，都有一些统一的图标设置、校验过程处理、以及提供一些通用的按钮以便进行数据的保存。

该对话框基类的设计视图，我们在其中添加了3个按钮（常用的添加、保存、关闭按钮），并封装一些通用对话框的处理函数，可以简化很多代码。

 

2、使用wxpython开发的界面处理

在 wxPython 开发中，对基类对话框进行封装是一个常见的做法，同样可以提高代码的可复用性和可维护性。

首先，你可以定义一个基类对话框，包含一些通用的功能和属性，例如标题、尺寸和常用控件。这个类可以继承自 wx.Dialog 或者其他对话框类，如可以调节大小的 wx.lib.sized_controls.SizedDialog 对话框类。

然后，创建一个具体的对话框类，继承自 BaseDialog。在这个类中实现 create_ui 方法，设置特定的控件和布局。

封装基类对话框可以帮助你创建结构化、可维护的用户界面。通过继承和重用代码，你可以提高开发效率，并确保应用的一致性。

如我们常规的对话框编辑数据界面，可能如下所示。

 这个界面是参加的表单处理界面效果，而且对话框如果继承自wx.lib.sized_controls.SizedDialog 对话框类，那么对话框可以自由拖动大小，配合缩放可达到比较好的效果。

如果我们对话框不考虑继承自定义基类的情况下，那么代码如下所示

class MyDialog(sc.SizedDialog):
    def __init__(self, parent = None, id = wx.ID_ANY ):

        sc.SizedDialog.__init__(self, parent = parent, id=id, 
            title=u"测试可以滚动的SizedDialog对话框", 
            style=wx.DEFAULT_DIALOG_STYLE| wx.RESIZE_BORDER )
    
        #获得主内容面板
        cpane = self.GetContentsPane()
        #构建一个可滚动的面板，并设置拉伸属性
        pane = sc.SizedScrolledPanel(cpane, wx.ID_ANY)
        pane.SetSizerProps(expand=True, proportion=1)

        pane.SetSizerType("form") # 设置为表单布局，默认2列

        #添加主要内容区域
         。。。。。。。

        # 添加对话框按钮：OK、Cancel
        self.SetButtonSizer(self.CreateStdDialogButtonSizer(wx.OK | wx.CANCEL))

        self.Layout()
        self.Centre(wx.BOTH)
        self.MinSize = (300, 200)
        self.SetSize((400, 300))

上面代码，可以看到，其中的SizedDialog 对话框类提供了一个获得主面板并设置表单布局类型的处理，我们主要基于这个主面板来创建控件即可，创建控件代码不需要太多的布局参数设置，处理比较简单，如下所示

         # row 1       
        wx.StaticText(pane, -1, "姓名")
        textCtrl = wx.TextCtrl(pane, -1, "请输入姓名")
        textCtrl.SetSizerProps(expand=True)

        # row 2
        wx.StaticText(pane, -1, "Email邮箱")
        emailCtrl = wx.TextCtrl(pane, -1, "")
        emailCtrl.SetSizerProps(expand=True)

我们这样就可以按顺序（Form类型的布局默认总共2列）添加即可。

另外，我们看到，对话框的按钮也是很简单的一行代码实现以前需要多行代码处理的效果。

        # 添加对话框按钮：OK、Cancel
        self.SetButtonSizer(self.CreateStdDialogButtonSizer(wx.OK | wx.CANCEL))

通过这样创建的按钮，默认还具有国际化特性，也就是跟随我们的语言设置，系统自动处理对应的标题。

如果不设置程序的locale, 那么可能默认是英文的按钮名称，如下所示。

 

如果是设置了为中文语言，那么就是中文的按钮名称，如下所示。

app = wx.App()
# 设置语言
# local = wx.Locale(wx.LANGUAGE_ENGLISH)
local = wx.Locale(wx.LANGUAGE_CHINESE_SIMPLIFIED)

dlg = MyDialog()
dlg.ShowModal()
dlg.Destroy()
app.MainLoop()

我们有了上面对话框界面的参考，可以把它可能会重复的代码，通过抽象的方式，提取到一个基类对话框里面，如下所示。

class BaseScrolledDialog(sc.SizedDialog):
    """可以调整大小及滚动的对话框基类"""
    def __init__(self, parent = None, id = wx.ID_ANY, title="", 
                 style=wx.DEFAULT_DIALOG_STYLE| wx.RESIZE_BORDER,
                  can_scroll=True ):
        self.can_scroll = can_scroll
        sc.SizedDialog.__init__(self, parent = parent, id=id, 
            title = title,
            style= style )
        self.SetMinSize((300, 200))

        main_panel : wx.Panel = None
        #通过can_scroll判断是否使用滚动面板
        cpane = self.GetContentsPane()
        if can_scroll:
            pane = sc.SizedScrolledPanel(cpane, wx.ID_ANY)
            main_panel = pane
        else:
            main_panel = cpane

        self.AddControls(main_panel)
        self.AddDialogButtons()
        self.Layout()

    def AddControls(self, pane: wx.Panel):
        """为主面板添加控件，不含底部对话框按钮"""
        pass

也就是提供一个子类对话框，可以重写的AddControls函数用来把焦点放在创建控件上即可，这样可以剔除不关心的内容。

这样我们对话框子类，就只需根据不同的业务添加不同的控件上去即可，其他就不要管了，交给基类去实现即可。

class MyScrolledDialog(BaseScrolledDialog):
    """测试可以滚动的SizedDialog对话框-继承实现"""

    def __init__(self, parent = None, id = wx.ID_ANY, title="测试可以滚动的SizedDialog对话框-继承实现"):
        super().__init__(parent, id, title, can_scroll=True)
        self.SetSize((600, 500))

    def AddControls(self, pane):
        """主面板的控件添加"""

        # row 1
        wx.StaticText(pane, -1, "姓名")
        textCtrl = wx.TextCtrl(pane, -1, "请输入姓名")
        textCtrl.SetSizerProps(expand=True)

        # row 2
        wx.StaticText(pane, -1, "Email邮箱")
        emailCtrl = wx.TextCtrl(pane, -1, "")
        emailCtrl.SetSizerProps(expand=True)

        *******

这样同样实现了相同的效果，而且简化了代码。

我们还可以指定对话框的默认位置，让它顶部对齐屏幕的顶部，这样内容显示比较方便。

我们只需在基类窗口的初始化函数里面，设置位置即可。

         # 获取屏幕的大小
        screen_size = wx.GetDisplaySize()
        dialog_width, dialog_height = self.GetSize()
        # 计算顶端对齐的位置
        x_position = (screen_size.x - dialog_width) // 2  # 水平居中
        y_position = 0  # 顶端对齐
        self.SetPosition((x_position, y_position))

当然，我们还可以加入对数据验证的一下空壳函数，基类只需要负责定义接口和逻辑处理，具体的检查细节可以交给子类来实现代码即可。