Quick search

Table Of Contents

Source code for kivy.uix.spinner


.. versionadded:: 1.4.0

.. image:: images/spinner.jpg
    :align: right

Spinner is a widget that provides a quick way to select one value from a set.
In the default state, a spinner shows its currently selected value.
Touching the spinner displays a dropdown menu with all the other available
values from which the user can select a new one.


    from kivy.base import runTouchApp
    from kivy.uix.spinner import Spinner

    spinner = Spinner(
        # default value shown
        # available values
        values=('Home', 'Work', 'Other', 'Custom'),
        # just for positioning in our example
        size_hint=(None, None),
        size=(100, 44),
        pos_hint={'center_x': .5, 'center_y': .5})

    def show_selected_value(spinner, text):
        print('The spinner', spinner, 'has text', text)



Kv Example::

            size_hint: None, None
            size: 100, 44
            pos_hint: {'center': (.5, .5)}
            text: 'Home'
            values: 'Home', 'Work', 'Other', 'Custom'
                print("The spinner {} has text {}".format(self, self.text))

__all__ = ('Spinner', 'SpinnerOption')

from kivy.compat import string_types
from kivy.factory import Factory
from import ListProperty, ObjectProperty, BooleanProperty
from kivy.uix.button import Button
from kivy.uix.dropdown import DropDown

[docs]class SpinnerOption(Button): '''Special button used in the :class:`Spinner` dropdown list. By default, this is just a :class:`~kivy.uix.button.Button` with a size_hint_y of None and a height of :meth:`48dp <kivy.metrics.dp>`. ''' pass
[docs]class Spinner(Button): '''Spinner class, see module documentation for more information. ''' values = ListProperty() '''Values that can be selected by the user. It must be a list of strings. :attr:`values` is a :class:`` and defaults to []. ''' text_autoupdate = BooleanProperty(False) '''Indicates if the spinner's :attr:`text` should be automatically updated with the first value of the :attr:`values` property. Setting it to True will cause the spinner to update its :attr:`text` property every time attr:`values` are changed. .. versionadded:: 1.10.0 :attr:`text_autoupdate` is a :class:`` and defaults to False. ''' option_cls = ObjectProperty(SpinnerOption) '''Class used to display the options within the dropdown list displayed under the Spinner. The `text` property of the class will be used to represent the value. The option class requires: - a `text` property, used to display the value. - an `on_release` event, used to trigger the option when pressed/touched. - a :attr:`~kivy.uix.widget.Widget.size_hint_y` of None. - the :attr:`~kivy.uix.widget.Widget.height` to be set. :attr:`option_cls` is an :class:`` and defaults to :class:`SpinnerOption`. .. versionchanged:: 1.8.0 If you set a string, the :class:`~kivy.factory.Factory` will be used to resolve the class. ''' dropdown_cls = ObjectProperty(DropDown) '''Class used to display the dropdown list when the Spinner is pressed. :attr:`dropdown_cls` is an :class:`` and defaults to :class:`~kivy.uix.dropdown.DropDown`. .. versionchanged:: 1.8.0 If set to a string, the :class:`~kivy.factory.Factory` will be used to resolve the class name. ''' is_open = BooleanProperty(False) '''By default, the spinner is not open. Set to True to open it. :attr:`is_open` is a :class:`` and defaults to False. .. versionadded:: 1.4.0 ''' sync_height = BooleanProperty(False) '''Each element in a dropdown list uses a default/user-supplied height. Set to True to propagate the Spinner's height value to each dropdown list element. .. versionadded:: 1.10.0 :attr:`sync_height` is a :class:`` and defaults to False. ''' def __init__(self, **kwargs): self._dropdown = None super(Spinner, self).__init__(**kwargs) fbind = self.fbind build_dropdown = self._build_dropdown fbind('on_release', self._toggle_dropdown) fbind('dropdown_cls', build_dropdown) fbind('option_cls', build_dropdown) fbind('values', self._update_dropdown) fbind('size', self._update_dropdown_size) fbind('text_autoupdate', self._update_dropdown) build_dropdown() def _build_dropdown(self, *largs): if self._dropdown: self._dropdown.unbind(on_select=self._on_dropdown_select) self._dropdown.unbind(on_dismiss=self._close_dropdown) self._dropdown.dismiss() self._dropdown = None cls = self.dropdown_cls if isinstance(cls, string_types): cls = Factory.get(cls) self._dropdown = cls() self._dropdown.bind(on_select=self._on_dropdown_select) self._dropdown.bind(on_dismiss=self._close_dropdown) self._update_dropdown() def _update_dropdown_size(self, *largs): if not self.sync_height: return dp = self._dropdown if not dp: return container = dp.container if not container: return h = self.height for item in container.children[:]: item.height = h def _update_dropdown(self, *largs): dp = self._dropdown cls = self.option_cls values = self.values text_autoupdate = self.text_autoupdate if isinstance(cls, string_types): cls = Factory.get(cls) dp.clear_widgets() for value in values: item = cls(text=value) item.height = self.height if self.sync_height else item.height item.bind(on_release=lambda option: dp.add_widget(item) if text_autoupdate: if values: if not self.text or self.text not in values: self.text = values[0] else: self.text = '' def _toggle_dropdown(self, *largs): if self.values: self.is_open = not self.is_open def _close_dropdown(self, *largs): self.is_open = False def _on_dropdown_select(self, instance, data, *largs): self.text = data self.is_open = False def on_is_open(self, instance, value): if value: else: if self._dropdown.attach_to: self._dropdown.dismiss()