我可以在 .kv 文件中定义小部件并在 .py 文件中引用它吗？

Posted 2023-04-14

【中文标题】我可以在 .kv 文件中定义小部件并在 .py 文件中引用它吗？

【英文标题】：Can I define a widget in a .kv file and reference it in a .py file?

【发布时间】：2015-07-17 22:59:34

【问题描述】：

我正在使用 kvlang 为我的 kivy 测试应用程序定义 UI 布局。我使用 Button 作为根小部件，我希望在按下按钮时出现弹出窗口。

为此，我在 .kv 文件中指定了“on_press: app.do_popup()”属性。

我可以在同一个 .kv 文件中定义作为命名类出现的弹出窗口，并从 do_popup() 定义中引用它，还是必须在应用程序的 main.py 文件中定义它？

感谢和问候！

编辑：

这是在 .py 文件中定义小部件的情况：

.py:

from kivy.app import App
from kivy.uix.popup import Popup
from kivy.uix.boxlayout import BoxLayout
from kivy.uix.label import Label
from kivy.uix.button import Button

class kkkApp(App):
    def do_popup(self):
        pu = Popup(title = 'title', size_hint = (0.5, 0.5))
        box = BoxLayout(orientation = 'vertical')
        lab = Label(text = 'text', size_hint = (1, 5))
        but = Button(text = 'Close', size_hint = (1, 1))
        box.add_widget(lab)
        box.add_widget(but)
        pu.add_widget(box)
        pu.open()
        but.bind(on_release = pu.dismiss)

kkkApp().run()

.kv:

<MaButton@Button>:
    text: '123'

<MaPopup@Popup>:
    auto_dismiss: True
    # ... more stuff defining the popup with button and behavior...

MaButton:
    id: main_button
    on_release: app.do_popup()

问题是是否有某种方法可以利用 kvlang 并使用 kv 文件中定义的 MaPopup 编写更少的 python，如下所示：

.py:

from kivy.app import App

class kkkApp(App):
    def do_popup(self):
        pu = MaPopup(title = 'title', size_hint = (0.5, 0.5))
        pu.open()

kkkApp().run()

省略的内容在 .kv 文件中定义

【参考方案1】：

是的，您可以在 .kv 文件中定义任何对象/布局并在主 .py 文件中引用它，我相信这就是 Kivy 的方式。但是，我建议不要从 Popup 类派生（如<MaPopup@Popup>），而是建议定义弹出窗口的 content 并在主 .py 文件中创建 Popup 实例时提供它。如果您只对 Popup 的内容感兴趣，则无需将其子类化。

因此，要根据您在 .py 文件中声明的内容在 .kv 中创建弹出内容：

<MaPopup@BoxLayout>:
    orientation: "vertical"
    Label:
        text: "text"
        size_hint: (1,5)
    Button:
        text: "Close"
        size_hint: (1,1)
        on_release: root.cancel()

由于MaPopup 是BoxLayout 而不是Popup，它没有dismiss 方法，所以我们将root.cancel() 绑定到on_release 并在.py 文件中赋予它功能。

在您的 .py 文件中，您需要创建一个具有相同名称的类并定义在 .kv 文件中引用的 cancel 属性（对于初学者来说，这将是 None）：

from kivy.properties import ObjectProperty
class MaPopup(BoxLayout):
    cancel = ObjectProperty(None)

这将允许您创建任何您想要的 MaPopup 实例并将其插入到 .py 文件中的任何位置。

最后，您可以使用实例MaPopup 作为其内容创建一个弹出窗口。有一些额外的行可以帮助您使弹出窗口的打开/关闭更通用

class kkkApp(App):
    # Use this class attribute to reference Popups
    _popup = None

    # Use this method to close Popups referenced by _popup
    def _dismiss_popup(self):
        self._popup.dismiss()

    def do_popup(self):
        # Instantiate MaPopup and give functionality to cancel button
        popup_content = MaPopup(cancel=self._dismiss_popup)
        self._popup = Popup(title = 'title', size_hint = (0.5, 0.5), content=popup_content)
        self._popup.open()

请注意，我们创建了一个名为 popup_content 的 MaPopup 实例，并使用 content= 关键字将此实例作为弹出内容提供。我们还在此阶段为取消按钮添加了功能，这使您可以灵活地将on_release 事件绑定到您想要的任何其他方法。您可以创建另一个MaPopup 为取消按钮提供完全不同的功能。

【讨论】：

感谢您的回答！现在我可以将所有布局/小部件的东西放在 kv 文件中。我注意到您发布的最后一段代码的最后一行，but.bind(on_release = pu.dismiss)，这并没有真正绑定到任何东西，对吧？ but 超出范围，不是吗？

如果你在kv文件中定义<MaPopup@Popup>，你不能用dismiss方法绑定按钮为：on_release: root.dismiss吗？在命名类定义中，在 kv 文件中，root 将具有 MaPopup 实例的范围，对吗？

啊，是的，我的错。我忘记了按钮事件。我会更新的。