doc: revisions to uix/actionbar.py (5)

This commit is contained in:
Richard Larkin 2013-09-07 22:14:00 +02:00
parent 41e8c045ca
commit 504bd8b0fe
1 changed files with 12 additions and 12 deletions

View File

@ -350,7 +350,7 @@ class ActionView(BoxLayout):
background_image = StringProperty( background_image = StringProperty(
'atlas://data/images/defaulttheme/action_view') 'atlas://data/images/defaulttheme/action_view')
'''Background image of an ActionViews default graphical represenation. '''Background image of an ActionViews default graphical representation.
:data:`background_image` is an :class:`~kivy.properties.StringProperty` :data:`background_image` is an :class:`~kivy.properties.StringProperty`
and defaults to 'atlas://data/images/defaulttheme/action_view'. and defaults to 'atlas://data/images/defaulttheme/action_view'.
@ -558,14 +558,14 @@ class ActionView(BoxLayout):
class ContextualActionView(ActionView): class ContextualActionView(ActionView):
'''ContextualActionView class, see module documentation '''ContextualActionView class, see the module documentation
for more information. for more information.
''' '''
pass pass
class ActionBar(BoxLayout): class ActionBar(BoxLayout):
'''ActionBar, see module documentation for more information. '''ActionBar, see the module documentation for more information.
:Events: :Events:
`on_previous` `on_previous`
@ -575,28 +575,28 @@ class ActionBar(BoxLayout):
action_view = ObjectProperty(None) action_view = ObjectProperty(None)
'''action_view of ActionBar. '''action_view of ActionBar.
:data:`action_view` is an :class:`~kivy.properties.ObjectProperty`, :data:`action_view` is an :class:`~kivy.properties.ObjectProperty` and
default to an instance of ActionView. defaults to an instance of ActionView.
''' '''
background_color = ListProperty([1, 1, 1, 1]) background_color = ListProperty([1, 1, 1, 1])
'''Background color, in the format (r, g, b, a). '''Background color, in the format (r, g, b, a).
:data:`background_color` is a :class:`~kivy.properties.ListProperty`, :data:`background_color` is a :class:`~kivy.properties.ListProperty` and
default to [1, 1, 1, 1]. defaults to [1, 1, 1, 1].
''' '''
background_image = StringProperty( background_image = StringProperty(
'atlas://data/images/defaulttheme/action_bar') 'atlas://data/images/defaulttheme/action_bar')
'''Background image of ActionBar for default graphical represenation. '''Background image of the ActionBars default graphical representation.
:data:`background_image` is an :class:`~kivy.properties.StringProperty`, :data:`background_image` is an :class:`~kivy.properties.StringProperty`
default to 'action_bar' and defaults to 'atlas://data/images/defaulttheme/action_bar'.
''' '''
border = ListProperty([2, 2, 2, 2]) border = ListProperty([2, 2, 2, 2])
''':data:`border` to be applied to the :data:`background_image` ''':data:`border` to be applied to the :data:`background_image`.
''' '''
__events__ = ('on_previous',) __events__ = ('on_previous',)
@ -628,7 +628,7 @@ class ActionBar(BoxLayout):
def _pop_contextual_action_view(self): def _pop_contextual_action_view(self):
'''Remove the current ContextualActionView and display either the '''Remove the current ContextualActionView and display either the
previous one or the ActionView previous one or the ActionView.
''' '''
self._stack_cont_action_view.pop() self._stack_cont_action_view.pop()
self.clear_widgets() self.clear_widgets()