Kivy 简明教程

Kivy - Settings

“kivy.uix.settings”模块包含一个非常有用的功能，让您能够处理 Kivy 安装环境的设置参数。您可以在应用程序窗口上打开“设置”面板，并修改任何的配置标记。

在安装 Kivy 软件时，它会创建配置文件，其中包含各种带有默认值的参数标记。该文件名为“config.ini”，存储在由 KIVY_HOME 环境变量指定的目录中。

  1. 在 Windows 机器 − 文件存储在 C:\Users\user\.kivy\config.ini。

  2. On Linux − /home/user/.kivy/config.ini.

  3. On macOS − /Users/user/.kivy/config.ini.

  4. On Android − /data/data/org.kivy.launcher/files/.kivy/config.ini.

  5. On iOS − <HOME_DIRECTORY>/Documents/.kivy/config.ini.

要打开设置面板，请调用 App 类中 open_settings() 方法，通常是对 GUI 的 on_press 事件（或任何其他事件）的响应。

def onpress(self, instance):
   app.open_settings()

我们从简单的 Kivy App 开始，在窗口上安装 Button。当按下该按钮时，它将调用 onpress() 方法以显示 Kivy 设置面板。

class HelloApp(App):
   def onpress(self, instance):
      app.open_settings()
   def build(self):
      b1=Button(
         text='Click Here', font_size=50,
         on_press=self.onpress
      )
      return b1

app = HelloApp()
app.run()

在应用程序运行后，单击按钮以进入设置面板。

kivy settings

此处显示的设置与您在 config.ini 文件中看到的设置相同。尝试更改任何配置标记的值，您将看到对 config 文件所做的更改。

有几个设置面板布局可用。

  1. Settings − 使用左侧边栏显示设置以便在 json 面板之间切换。

  2. SettingsWithSidebar − Settings 的一个简单子类。

  3. SettingsWithSpinner − 使用顶部的一个筛选器显示设置，该筛选器可以用于在 json 面板之间切换。这是默认设置。

  4. SettingsWithTabbedPanel − 在 TabbedPanel 中将 json 面板显示为单个选项卡。

  5. SettingsWithNoMenu − 显示单个 json 面板，而无法切换到其他面板，也没有关闭按钮。

要使用 SeetingsWithSidebar 布局，请从 kivy.uix.settings 模块导入该布局，并将其指定为 App 类中 settings_cls 参数的值。

from kivy.uix.settings import SettingsWithSidebar
class HelloApp(App):
   def onpress(self, instance):
      app.open_settings()
   def build(self):
      self.settings_cls = SettingsWithSidebar
      b1=Button(text='Click Here', font_size=50, on_press=self.onpress)
      return b1

窗口现在提供侧边栏，可在设置面板之间切换。

kivy settings panels

Create a New Panel

现在，您只有一个名为 Kivy 的面板，该面板显示 Kivy 配置的默认设置。您可以添加新的面板来定义应用程序的设置。您需要两件事 −

  1. 带有默认值的一个 ConfigParser 实例。

  2. a JSON object.

您必须创建和处理 ConfigParser 对象来告知 kivy 的 configparser 在配置文件中存储哪些设置。SettingsPanel 将从中读取值。这些设置的默认值使用 JSON 对象中所有部分/键的 setdefaults 指定。

让我们添加 build_config 方法，该方法为按钮的“文本”和字体大小”属性提供默认值。

def build_config(self, config):
   config.setdefaults('My Button', {'text': 'Hello Kivy, 'font_size': 20})

build_settings() 方法使用代码中的 JSON 对象在配置中构建一个新面板。

此示例中使用的 JSON 对象为：

json = '''
[
   {
      "type": "string",
      "title": "Button text",
      "desc": "text on the button",
      "section": "My Button",
      "key": "text"
   },
   {
      "type": "numeric",
      "title": "Button font size",
      "desc": "font size",
      "section": "My Button",
      "key": "font_size"
   }
]

要基于此 JSON 对象的定义添加一个新面板，请定义 build_settings() 方法：

def build_settings(self, settings):
   settings.add_json_panel('My Button', self.config, data=json)

然后完成。当您打开设置时，您应该会看到一个新添加的“我的按钮”面板。

Example

complete code 如下所示 -

from kivy.app import App
from kivy.uix.button import Button
from kivy.core.window import Window
from kivy.uix.settings import SettingsWithSidebar

Window.size = (720,350)
json = '''
[
   {
      "type": "string",
      "title": "Button text",
      "desc": "text on the button",
      "section": "My Button",
      "key": "text"
   },
   {
      "type": "numeric",
      "title": "Button font size",
      "desc": "font size",
      "section": "My Button",
      "key": "font_size"
   }
]
'''
class MyApp(App):
   def onpress(self, instance):
      app.open_settings()

   def build(self):
      self.settings_cls = SettingsWithSidebar
      self.btn = Button(on_press=self.onpress)
      self.btn.text = self.config.get('My Button', 'text')
      self.btn.font_size = float(self.config.get('My Button', 'font_size'))
      return self.btn

   def build_config(self, config):
      config.setdefaults(
         'My Button', {'text': 'Hello Python', 'font_size': 20}
      )

   def build_settings(self, settings):
      settings.add_json_panel('My Button', self.config, data=json)

   def on_config_change(self, config, section, key, value):
      if section == "My Button":
         if key == "text":
            self.btn.text = value
         elif key == 'font_size':
            self.btn.font_size = float(value)
app=MyApp()
app.run()

Output

当您打开设置面板时，您现在会看到带有两个设置的“我的按钮”面板。根据需要修改值。最后，关闭设置对话框并返回查看更改。

kivy settings hello