Quick search

Table Of Contents

Action Bar

New in version 1.8.0.

_images/actionbar.png

The ActionBar widget is like Android’s ActionBar , where items are stacked horizontally.

An ActionBar contains an ActionView with various ContextualActionViews. An ActionView will contain an ActionPrevious having title, app_icon and previous_icon properties. An ActionView will contain subclasses of ActionItems. Some predefined ones include an ActionButton, an ActionToggleButton, an ActionCheck, an ActionSeparator and an ActionGroup.

An ActionGroup is used to display ActionItems in a group. An ActionView will always display an ActionGroup after other ActionItems. An ActionView will contain an ActionOverflow. A ContextualActionView is a subclass of an ActionView.

Changed in version 1.10.1: ActionGroup core rewritten from Spinner to pure DropDown

exception kivy.uix.actionbar.ActionBarException[source]

Bases: Exception

ActionBarException class

class kivy.uix.actionbar.ActionItem[source]

Bases: builtins.object

ActionItem class, an abstract class for all ActionBar widgets. To create a custom widget for an ActionBar, inherit from this class. See module documentation for more information.

background_down

Background image of the ActionItem used for default graphical representation when an ActionItem is pressed.

background_down is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/action_item_down’.

background_normal

Background image of the ActionItem used for the default graphical representation when the ActionItem is not pressed.

background_normal is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/action_item’.

important

Determines if an ActionItem is important or not.

important is a BooleanProperty and defaults to False.

inside_group

(internal) Determines if an ActionItem is displayed inside an ActionGroup or not.

inside_group is a BooleanProperty and defaults to False.

minimum_width

Minimum Width required by an ActionItem.

minimum_width is a NumericProperty and defaults to ’90sp’.

mipmap

Defines whether the image/icon dispayed on top of the button uses a mipmap or not.

mipmap is a BooleanProperty and defaults to True.

pack_width

(read-only) The actual width to use when packing the item. Equal to the greater of minimum_width and width.

pack_width is an AliasProperty.

class kivy.uix.actionbar.ActionButton(**kwargs)[source]

Bases: kivy.uix.button.Button, kivy.uix.actionbar.ActionItem

ActionButton class, see module documentation for more information.

The text color, width and size_hint_x are set manually via the Kv language file. It covers a lot of cases: with/without an icon, with/without a group and takes care of the padding between elements.

You don’t have much control over these properties, so if you want to customize it’s appearance, we suggest you create you own button representation. You can do this by creating a class that subclasses an existing widget and an ActionItem:

class MyOwnActionButton(Button, ActionItem):
    pass

You can then create your own style using the Kv language.

icon

Source image to use when the Button is part of the ActionBar. If the Button is in a group, the text will be preferred.

class kivy.uix.actionbar.ActionToggleButton(**kwargs)[source]

Bases: kivy.uix.actionbar.ActionItem, kivy.uix.togglebutton.ToggleButton

ActionToggleButton class, see module documentation for more information.

icon

Source image to use when the Button is part of the ActionBar. If the Button is in a group, the text will be preferred.

class kivy.uix.actionbar.ActionCheck(**kwargs)[source]

Bases: kivy.uix.actionbar.ActionItem, kivy.uix.checkbox.CheckBox

ActionCheck class, see module documentation for more information.

class kivy.uix.actionbar.ActionSeparator(**kwargs)[source]

Bases: kivy.uix.actionbar.ActionItem, kivy.uix.widget.Widget

ActionSeparator class, see module documentation for more information.

background_image

Background image for the separators default graphical representation.

background_image is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/separator’.

class kivy.uix.actionbar.ActionDropDown(**kwargs)[source]

Bases: kivy.uix.dropdown.DropDown

ActionDropDown class, see module documentation for more information.

class kivy.uix.actionbar.ActionGroup(**kwargs)[source]

Bases: kivy.uix.actionbar.ActionItem, kivy.uix.button.Button

ActionGroup class, see module documentation for more information.

dropdown_width

If non zero, provides the width for the associated DropDown. This is useful when some items in the ActionGroup’s DropDown are wider than usual and you don’t want to make the ActionGroup widget itself wider.

dropdown_width is an NumericProperty and defaults to 0.

New in version 1.10.0.

is_open

By default, the DropDown is not open. Set to True to open it.

is_open is a BooleanProperty and defaults to False.

mode

Sets the current mode of an ActionGroup. If mode is ‘normal’, the ActionGroups children will be displayed normally if there is enough space, otherwise they will be displayed in a spinner. If mode is ‘spinner’, then the children will always be displayed in a spinner.

mode is a OptionProperty and defaults to ‘normal’.

separator_image

Background Image for an ActionSeparator in an ActionView.

separator_image is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/separator’.

separator_width

Width of the ActionSeparator in an ActionView.

separator_width is a NumericProperty and defaults to 0.

use_separator

Specifies whether to use a separator after/before this group or not.

use_separator is a BooleanProperty and defaults to False.

class kivy.uix.actionbar.ActionOverflow(**kwargs)[source]

Bases: kivy.uix.actionbar.ActionGroup

ActionOverflow class, see module documentation for more information.

overflow_image

Image to be used as an Overflow Image.

overflow_image is an ObjectProperty and defaults to ‘atlas://data/images/defaulttheme/overflow’.

class kivy.uix.actionbar.ActionView(**kwargs)[source]

Bases: kivy.uix.boxlayout.BoxLayout

ActionView class, see module documentation for more information.

action_previous

Previous button for an ActionView.

action_previous is an ObjectProperty and defaults to None.

background_color

Background color in the format (r, g, b, a).

background_color is a ListProperty and defaults to [1, 1, 1, 1].

background_image

Background image of an ActionViews default graphical representation.

background_image is an StringProperty and defaults to ‘atlas://data/images/defaulttheme/action_view’.

overflow_group

Widget to be used for the overflow.

overflow_group is an ObjectProperty and defaults to an instance of ActionOverflow.

use_separator

Specify whether to use a separator before every ActionGroup or not.

use_separator is a BooleanProperty and defaults to False.

class kivy.uix.actionbar.ContextualActionView(**kwargs)[source]

Bases: kivy.uix.actionbar.ActionView

ContextualActionView class, see the module documentation for more information.

class kivy.uix.actionbar.ActionPrevious(**kwargs)[source]

Bases: kivy.uix.boxlayout.BoxLayout, kivy.uix.actionbar.ActionItem

ActionPrevious class, see module documentation for more information.

app_icon

Application icon for the ActionView.

app_icon is a StringProperty and defaults to the window icon if set, otherwise ‘data/logo/kivy-icon-32.png’.

app_icon_height

Height of app_icon image.

app_icon_width

Width of app_icon image.

color

Text color, in the format (r, g, b, a)

color is a ListProperty and defaults to [1, 1, 1, 1].

previous_image

Image for the ‘previous’ ActionButtons default graphical representation.

previous_image is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/previous_normal’.

previous_image_height

Height of previous_image image.

previous_image_width

Width of previous_image image.

title

Title for ActionView.

title is a StringProperty and defaults to ‘’.

with_previous

Specifies whether clicking on ActionPrevious will load the previous screen or not. If True, the previous_icon will be shown otherwise it will not.

with_previous is a BooleanProperty and defaults to True.

class kivy.uix.actionbar.ActionBar(**kwargs)[source]

Bases: kivy.uix.boxlayout.BoxLayout

ActionBar, see the module documentation for more information.

Events:
on_previous

Fired when action_previous of action_view is pressed.

action_view

action_view of ActionBar.

action_view is an ObjectProperty and defaults to an instance of ActionView.

background_color

Background color, in the format (r, g, b, a).

background_color is a ListProperty and defaults to [1, 1, 1, 1].

background_image

Background image of the ActionBars default graphical representation.

background_image is an StringProperty and defaults to ‘atlas://data/images/defaulttheme/action_bar’.

border

border to be applied to the background_image.