Kivy-examples 2.3.1.dev0__py3-none-any.whl

kivy/uix/checkbox.py

@@ -0,0 +1,197 @@
+'''
+CheckBox
+========
+
+.. versionadded:: 1.4.0
+
+.. image:: images/checkbox.png
+    :align: right
+
+:class:`CheckBox` is a specific two-state button that can be either checked or
+unchecked. If the CheckBox is in a Group, it becomes a Radio button.
+As with the :class:`~kivy.uix.togglebutton.ToggleButton`, only one Radio button
+at a time can be selected when the :attr:`CheckBox.group` is set.
+
+An example usage::
+
+    from kivy.uix.checkbox import CheckBox
+
+    # ...
+
+    def on_checkbox_active(checkbox, value):
+        if value:
+            print('The checkbox', checkbox, 'is active')
+        else:
+            print('The checkbox', checkbox, 'is inactive')
+
+    checkbox = CheckBox()
+    checkbox.bind(active=on_checkbox_active)
+'''
+
+__all__ = ('CheckBox', )
+
+from kivy.properties import AliasProperty, StringProperty, ColorProperty
+from kivy.uix.behaviors import ToggleButtonBehavior
+from kivy.uix.widget import Widget
+
+
+class CheckBox(ToggleButtonBehavior, Widget):
+    '''CheckBox class, see module documentation for more information.
+    '''
+
+    def _get_active(self):
+        return self.state == 'down'
+
+    def _set_active(self, value):
+        self.state = 'down' if value else 'normal'
+
+    active = AliasProperty(
+        _get_active, _set_active, bind=('state', ), cache=True)
+    '''Indicates if the switch is active or inactive.
+
+    :attr:`active` is a boolean and reflects and sets whether the underlying
+    :attr:`~kivy.uix.button.Button.state` is 'down' (True) or 'normal' (False).
+    It is a :class:`~kivy.properties.AliasProperty`, which accepts boolean
+    values and defaults to False.
+
+    .. versionchanged:: 1.11.0
+
+        It changed from a BooleanProperty to a AliasProperty.
+    '''
+
+    background_checkbox_normal = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_off')
+    '''Background image of the checkbox used for the default graphical
+    representation when the checkbox is not active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_checkbox_normal` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_off'.
+    '''
+
+    background_checkbox_down = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_on')
+    '''Background image of the checkbox used for the default graphical
+    representation when the checkbox is active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_checkbox_down` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_on'.
+    '''
+
+    background_checkbox_disabled_normal = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_disabled_off')
+    '''Background image of the checkbox used for the default graphical
+    representation when the checkbox is disabled and not active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_checkbox_disabled_normal` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_disabled_off'.
+    '''
+
+    background_checkbox_disabled_down = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_disabled_on')
+    '''Background image of the checkbox used for the default graphical
+    representation when the checkbox is disabled and active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_checkbox_disabled_down` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_disabled_on'.
+    '''
+
+    background_radio_normal = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_radio_off')
+    '''Background image of the radio button used for the default graphical
+    representation when the radio button is not active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_radio_normal` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_radio_off'.
+    '''
+
+    background_radio_down = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_radio_on')
+    '''Background image of the radio button used for the default graphical
+    representation when the radio button is active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_radio_down` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_radio_on'.
+    '''
+
+    background_radio_disabled_normal = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_radio_disabled_off')
+    '''Background image of the radio button used for the default graphical
+    representation when the radio button is disabled and not active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_radio_disabled_normal` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_radio_disabled_off'.
+    '''
+
+    background_radio_disabled_down = StringProperty(
+        'atlas://data/images/defaulttheme/checkbox_radio_disabled_on')
+    '''Background image of the radio button used for the default graphical
+    representation when the radio button is disabled and active.
+
+    .. versionadded:: 1.9.0
+
+    :attr:`background_radio_disabled_down` is a
+    :class:`~kivy.properties.StringProperty` and defaults to
+    'atlas://data/images/defaulttheme/checkbox_radio_disabled_on'.
+    '''
+
+    color = ColorProperty([1, 1, 1, 1])
+    '''Color is used for tinting the default graphical representation
+    of checkbox and radio button (images).
+
+    Color is in the format (r, g, b, a).
+
+    .. versionadded:: 1.10.0
+
+    :attr:`color` is a
+    :class:`~kivy.properties.ColorProperty` and defaults to
+    '[1, 1, 1, 1]'.
+
+    .. versionchanged:: 2.0.0
+        Changed from :class:`~kivy.properties.ListProperty` to
+        :class:`~kivy.properties.ColorProperty`.
+    '''
+
+    def __init__(self, **kwargs):
+        self.fbind('state', self._on_state)
+        super(CheckBox, self).__init__(**kwargs)
+
+    def _on_state(self, instance, value):
+        if self.group and self.state == 'down':
+            self._release_group(self)
+
+    def on_group(self, *largs):
+        super(CheckBox, self).on_group(*largs)
+        if self.active:
+            self._release_group(self)
+
+
+if __name__ == '__main__':
+    from random import uniform
+    from kivy.base import runTouchApp
+    from kivy.uix.gridlayout import GridLayout
+    x = GridLayout(cols=4)
+    for i in range(36):
+        r, g, b = [uniform(0.2, 1.0) for j in range(3)]
+        x.add_widget(CheckBox(group='1' if i % 2 else '', color=[r, g, b, 2]))
+    runTouchApp(x)

kivy/uix/codeinput.py

@@ -0,0 +1,238 @@
+'''
+Code Input
+==========
+
+.. versionadded:: 1.5.0
+
+.. image:: images/codeinput.jpg
+
+.. note::
+
+    This widget requires ``pygments`` package to run. Install it with ``pip``.
+
+The :class:`CodeInput` provides a box of editable highlighted text like the one
+shown in the image.
+
+It supports all the features provided by the :class:`~kivy.uix.textinput` as
+well as code highlighting for `languages supported by pygments
+<http://pygments.org/docs/lexers/>`_ along with `KivyLexer` for
+:mod:`kivy.lang` highlighting.
+
+Usage example
+-------------
+
+To create a CodeInput with highlighting for `KV language`::
+
+    from kivy.uix.codeinput import CodeInput
+    from kivy.extras.highlight import KivyLexer
+    codeinput = CodeInput(lexer=KivyLexer())
+
+To create a CodeInput with highlighting for `Cython`::
+
+    from kivy.uix.codeinput import CodeInput
+    from pygments.lexers import CythonLexer
+    codeinput = CodeInput(lexer=CythonLexer())
+
+'''
+
+__all__ = ('CodeInput', )
+
+from pygments import highlight
+from pygments import lexers
+from pygments import styles
+from pygments.formatters import BBCodeFormatter
+
+from kivy.uix.textinput import TextInput
+from kivy.core.text.markup import MarkupLabel as Label
+from kivy.cache import Cache
+from kivy.properties import ObjectProperty, OptionProperty
+from kivy.utils import get_hex_from_color, get_color_from_hex
+from kivy.uix.behaviors import CodeNavigationBehavior
+
+Cache_get = Cache.get
+Cache_append = Cache.append
+
+# TODO: color chooser for keywords/strings/...
+
+
+class CodeInput(CodeNavigationBehavior, TextInput):
+    '''CodeInput class, used for displaying highlighted code.
+    '''
+
+    lexer = ObjectProperty(None)
+    '''This holds the selected Lexer used by pygments to highlight the code.
+
+
+    :attr:`lexer` is an :class:`~kivy.properties.ObjectProperty` and
+    defaults to `PythonLexer`.
+    '''
+
+    style_name = OptionProperty(
+        'default', options=list(styles.get_all_styles())
+    )
+    '''Name of the pygments style to use for formatting.
+
+    :attr:`style_name` is an :class:`~kivy.properties.OptionProperty`
+    and defaults to ``'default'``.
+
+    '''
+
+    style = ObjectProperty(None)
+    '''The pygments style object to use for formatting.
+
+    When ``style_name`` is set, this will be changed to the
+    corresponding style object.
+
+    :attr:`style` is a :class:`~kivy.properties.ObjectProperty` and
+    defaults to ``None``
+
+    '''
+
+    def __init__(self, **kwargs):
+        stylename = kwargs.get('style_name', 'default')
+        style = kwargs['style'] if 'style' in kwargs \
+            else styles.get_style_by_name(stylename)
+        self.formatter = BBCodeFormatter(style=style)
+        self.lexer = lexers.PythonLexer()
+        self.text_color = '#000000'
+        self._label_cached = Label()
+        self.use_text_color = True
+
+        super(CodeInput, self).__init__(**kwargs)
+
+        self._line_options = kw = self._get_line_options()
+        self._label_cached = Label(**kw)
+        # use text_color as foreground color
+        text_color = kwargs.get('foreground_color')
+        if text_color:
+            self.text_color = get_hex_from_color(text_color)
+        # set foreground to white to allow text colors to show
+        # use text_color as the default color in bbcodes
+        self.use_text_color = False
+        self.foreground_color = [1, 1, 1, .999]
+        if not kwargs.get('background_color'):
+            self.background_color = [.9, .92, .92, 1]
+
+    def on_style_name(self, *args):
+        self.style = styles.get_style_by_name(self.style_name)
+        self.background_color = get_color_from_hex(self.style.background_color)
+        self._trigger_refresh_text()
+
+    def on_style(self, *args):
+        self.formatter = BBCodeFormatter(style=self.style)
+        self._trigger_update_graphics()
+
+    def _create_line_label(self, text, hint=False):
+        # Create a label from a text, using line options
+        ntext = text.replace(u'\n', u'').replace(u'\t', u' ' * self.tab_width)
+        if self.password and not hint:  # Don't replace hint_text with *
+            ntext = u'*' * len(ntext)
+        ntext = self._get_bbcode(ntext)
+        kw = self._get_line_options()
+        cid = u'{}\0{}\0{}'.format(text, self.password, kw)
+        texture = Cache_get('textinput.label', cid)
+
+        if texture is None:
+            # FIXME right now, we can't render very long line...
+            # if we move on "VBO" version as fallback, we won't need to
+            # do this.
+            # try to find the maximum text we can handle
+            label = Label(text=ntext, **kw)
+            if text.find(u'\n') > 0:
+                label.text = u''
+            else:
+                label.text = ntext
+            label.refresh()
+
+            # ok, we found it.
+            texture = label.texture
+            Cache_append('textinput.label', cid, texture)
+            label.text = ''
+        return texture
+
+    def _get_line_options(self):
+        kw = super(CodeInput, self)._get_line_options()
+        kw['markup'] = True
+        kw['valign'] = 'top'
+        kw['codeinput'] = repr(self.lexer)
+        return kw
+
+    def _get_text_width(self, text, tab_width, _label_cached):
+        # Return the width of a text, according to the current line options.
+        cid = u'{}\0{}\0{}'.format(text, self.password,
+                                   self._get_line_options())
+        width = Cache_get('textinput.width', cid)
+        if width is not None:
+            return width
+        lbl = self._create_line_label(text)
+        width = lbl.width
+        Cache_append('textinput.width', cid, width)
+        return width
+
+    def _get_bbcode(self, ntext):
+        # get bbcoded text for python
+        try:
+            ntext[0]
+            # replace brackets with special chars that aren't highlighted
+            # by pygment. can't use &bl; ... cause & is highlighted
+            ntext = ntext.replace(u'[', u'\x01').replace(u']', u'\x02')
+            ntext = highlight(ntext, self.lexer, self.formatter)
+            ntext = ntext.replace(u'\x01', u'&bl;').replace(u'\x02', u'&br;')
+            # replace special chars with &bl; and &br;
+            ntext = ''.join((u'[color=', str(self.text_color), u']',
+                             ntext, u'[/color]'))
+            ntext = ntext.replace(u'\n', u'')
+            # remove possible extra highlight options
+            ntext = ntext.replace(u'[u]', '').replace(u'[/u]', '')
+            return ntext
+        except IndexError:
+            return ''
+
+    # overridden to prevent cursor position off screen
+    def _cursor_offset(self):
+        '''Get the cursor x offset on the current line
+        '''
+        offset = 0
+        try:
+            if self.cursor_col:
+                offset = self._get_text_width(
+                    self._lines[self.cursor_row][:self.cursor_col])
+                return offset
+        except:
+            pass
+        finally:
+            return offset
+
+    def on_lexer(self, instance, value):
+        self._trigger_refresh_text()
+
+    def on_foreground_color(self, instance, text_color):
+        if not self.use_text_color:
+            self.use_text_color = True
+            return
+        self.text_color = get_hex_from_color(text_color)
+        self.use_text_color = False
+        self.foreground_color = (1, 1, 1, .999)
+        self._trigger_refresh_text()
+
+
+if __name__ == '__main__':
+    from kivy.extras.highlight import KivyLexer
+    from kivy.app import App
+
+    class CodeInputTest(App):
+        def build(self):
+            return CodeInput(lexer=KivyLexer(),
+                             font_size=12,
+                             text='''
+#:kivy 1.0
+
+<YourWidget>:
+    canvas:
+        Color:
+            rgb: .5, .5, .5
+        Rectangle:
+            pos: self.pos
+            size: self.size''')
+
+    CodeInputTest().run()