目录
操作栏¶
在 1.8.0 版本加入.
ActionBar 控件类似于 Android 的 ActionBar,其中项目水平堆叠。当区域变得过小时,控件会被移入 ActionOverflow 区域。
一个 ActionBar 必须包含一个 ActionView,其中可以包含各种 ContextualActionViews。一个 ActionView 必须包含一个子组件 ActionPrevious,该组件可以具有 title、app_icon 和 previous_icon 属性。ActionView 的子组件必须是 ActionItems 的子类。一些预定义的类型包括 ActionButton、ActionToggleButton、ActionCheck、ActionSeparator 和 ActionGroup。
:一个 ActionGroup 用于在组中显示 ActionItems。一个 ActionView 总是会在其他 ActionItems 之后显示一个 ActionGroup。一个 ActionView 包含一个 ActionOverflow,但只有在需要时(即可用区域太小无法容纳所有控件)才会使其可见。一个 ContextualActionView 是 ActionView 的子类。
在 1.10.1 版本发生变更: ActionGroup 核心已从 Spinner 重写为纯 DropDown。
- class kivy.uix.actionbar.ActionBar(**kwargs)[源代码]¶
基类:
BoxLayoutActionBar 类,作为
ActionView实例的主要容器。ActionBar 决定了栏的整体样式方面。ActionItems 不会直接添加到此类中,而是添加到包含的ActionView实例中。- 事件:
- on_previous
当按下action_view的action_previous时触发。
请参阅模块文档以获取更多信息。
- action_view¶
ActionBar 的 action_view。
action_view是一个ObjectProperty,默认值为 None,或者为添加到 ActionBar 中的最后一个 ActionView 实例。
- background_color¶
背景颜色,格式为 (r, g, b, a)。
background_color是一个ColorProperty,默认值为 [1, 1, 1, 1]。在 2.0.0 版本发生变更: 从
ListProperty更改为ColorProperty。
- background_image¶
ActionBar默认图形表示的背景图像。
background_image是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/action_bar'。
- border¶
应用于
background_image的边框。border是一个ListProperty,默认值为 [2, 2, 2, 2]。
- class kivy.uix.actionbar.ActionButton(**kwargs)[源代码]¶
基类:
Button,ActionItemActionButton 类,更多信息请参阅模块文档。
文本颜色、宽度和size_hint_x是通过Kv语言文件手动设置的。它涵盖了许多情况:有/无图标、有/无分组,并处理元素之间的内边距。
你对这些属性的控制有限,因此若想自定义其外观,我们建议你创建自己的按钮表示。你可以通过创建一个继承现有控件和:class:`ActionItem`的子类来实现这一点:
class MyOwnActionButton(Button, ActionItem): pass
然后,您可以使用Kv语言创建自己的样式。
- icon¶
当按钮作为ActionBar的一部分时,使用的源图像。如果按钮位于组中,则优先使用文本。
icon是一个StringProperty,默认值为 None。
- class kivy.uix.actionbar.ActionCheck(**kwargs)[源代码]¶
基类:
ActionItem,CheckBoxActionCheck 类,更多信息请参阅模块文档。
- class kivy.uix.actionbar.ActionGroup(**kwargs)[源代码]¶
基类:
ActionItem,ButtonActionGroup 类,更多信息请参阅模块文档。
- clear_widgets(*args, **kwargs)[源代码]¶
移除该控件的所有(或指定的):attr:~Widget.children。如果指定了'children'参数,它应为当前控件子项的一个列表(或过滤后的列表)。
在 1.8.0 版本发生变更: children 参数可用于指定你想要移除的子项。
在 2.1.0 版本发生变更: 指定一个空的
children列表不会改变现有控件。此前,它会被视为None并移除所有子控件。
- dropdown_width¶
如果非零,则为关联的 DropDown 提供宽度。当 ActionGroup 的 DropDown 中某些项目比通常更宽,而你不想让 ActionGroup 控件本身变宽时,这很有用。
dropdown_width是一个NumericProperty,默认值为 0。在 1.10.0 版本加入.
- is_open¶
默认情况下,DropDown 是关闭的。设置为 True 即可打开。
is_open是一个BooleanProperty,默认值为 False。
- mode¶
设置ActionGroup的当前模式。如果模式为'normal',在空间足够的情况下,ActionGroup的子项将正常显示,否则它们将在下拉选择器中显示。如果模式为'spinner',则子项将始终在下拉选择器中显示。
mode是一个OptionProperty,默认值为 'normal'。
- separator_image¶
ActionView 中 ActionSeparator 的背景图像。
separator_image是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/separator'。
- separator_width¶
ActionView 中 ActionSeparator 的宽度。
separator_width是一个NumericProperty,默认值为 0。
- use_separator¶
指定是否在此组之后/之前使用分隔符。
use_separator是一个BooleanProperty,默认值为 False。
- class kivy.uix.actionbar.ActionItem[源代码]¶
基类:
objectActionItem 类,是所有 ActionBar 控件的抽象基类。若要为 ActionBar 创建自定义控件,请继承此类。更多信息请参阅模块文档。
- background_down¶
ActionItem 在按下时用于默认图形表示的背景图像。
background_down是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/action_item_down'。
- background_normal¶
ActionItem 在未被按下时用于默认图形表示的背景图像。
background_normal是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/action_item'。
- important¶
确定一个ActionItem是否重要。如果某个项目重要且空间有限,该项目将优先于其他项目显示。
important是一个BooleanProperty,默认值为 False。
- inside_group¶
(内部)决定一个ActionItem是否显示在ActionGroup内部。
inside_group是一个BooleanProperty,默认值为 False。
- minimum_width¶
ActionItem 所需的最小宽度。
minimum_width是一个NumericProperty,默认值为 '90sp'。
- mipmap¶
定义按钮上显示的图像/图标是否使用mipmap。
mipmap是一个BooleanProperty,默认值为 True。
- pack_width¶
(只读)打包项目时实际使用的宽度。等于 minimum_width 和 width 中的较大值。
pack_width是一个AliasProperty。
- class kivy.uix.actionbar.ActionOverflow(**kwargs)[源代码]¶
基类:
ActionGroupActionOverflow 类,更多信息请参阅模块文档。
- overflow_image¶
用作溢出图像的图像。
overflow_image是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/overflow'。
- class kivy.uix.actionbar.ActionPrevious(**kwargs)[源代码]¶
基类:
BoxLayout,ActionItemActionPrevious 类,更多信息请参阅模块文档。
- app_icon¶
ActionView 的应用图标。
app_icon是一个StringProperty,默认值为窗口图标(如果已设置),否则为 'data/logo/kivy-icon-32.png'。
- app_icon_height¶
app_icon 图像的高度。
app_icon_height是一个NumericProperty,默认值为 0。
- app_icon_width¶
app_icon 图像的宽度。
app_icon_width是一个NumericProperty,默认值为 0。
- color¶
文本颜色,格式为(r,g,b,a)
color是一个ColorProperty,默认值为 [1, 1, 1, 1]。在 2.0.0 版本发生变更: 从
ListProperty更改为ColorProperty。
- markup¶
如果为 True,文本将使用
MarkupLabel进行渲染:你可以使用标签来改变文本的样式。更多信息请参阅 文本标记 文档。markup是一个BooleanProperty,默认值为 False。
- previous_image¶
“上一个”ActionButton默认图形表示的图像。
previous_image是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/previous_normal'。
- previous_image_height¶
previous_image 图像的高度。
app_icon_width是一个NumericProperty,默认值为 0。
- previous_image_width¶
previous_image 图像的宽度。
width是一个NumericProperty,默认值为 0。
- title¶
ActionView 的标题。
title是一个StringProperty,默认值为 ''。
- with_previous¶
指定是否显示 previous_icon。请注意,用户需自行通过 on_press 或类似事件来实现所需行为。
with_previous是一个BooleanProperty,默认值为 True。
- class kivy.uix.actionbar.ActionSeparator(**kwargs)[源代码]¶
基类:
ActionItem,WidgetActionSeparator 类,更多信息请参阅模块文档。
- background_image¶
分隔符默认图形表示形式的背景图像。
background_image是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/separator'。
- class kivy.uix.actionbar.ActionToggleButton(**kwargs)[源代码]¶
-
ActionToggleButton 类,更多信息请参阅模块文档。
- icon¶
当按钮作为ActionBar的一部分时,使用的源图像。如果按钮位于组中,则优先使用文本。
- class kivy.uix.actionbar.ActionView(**kwargs)[源代码]¶
基类:
BoxLayoutActionView 类,更多信息请参阅模块文档。
- action_previous¶
ActionView 的“上一个”按钮。
action_previous是一个ObjectProperty,默认值为 None。
- background_color¶
背景颜色,格式为 (r, g, b, a)。
background_color是一个ColorProperty,默认值为 [1, 1, 1, 1]。在 2.0.0 版本发生变更: 从
ListProperty更改为ColorProperty。
- background_image¶
ActionView默认图形表示形式的背景图像。
background_image是一个StringProperty,默认值为 'atlas://data/images/defaulttheme/action_view'。
- overflow_group¶
用于溢出的部件。
overflow_group是一个ObjectProperty,默认值为ActionOverflow的一个实例。
- remove_widget(widget, *args, **kwargs)[源代码]¶
从该部件的子部件中移除一个部件。
- 参数:
- widget:
Widget 要从我们的子控件列表中移除的控件。
- widget:
>>> from kivy.uix.button import Button >>> root = Widget() >>> button = Button() >>> root.add_widget(button) >>> root.remove_widget(button)
- use_separator¶
指定是否在每个ActionGroup之前使用分隔符。
use_separator是一个BooleanProperty,默认值为 False。
- class kivy.uix.actionbar.ContextualActionView(**kwargs)[源代码]¶
基类:
ActionViewContextualActionView 类,更多信息请参阅模块文档。