Merge pull request kivy#3894 from kivy/key_bindings

rename EmacsBehavior/CodeInput active_key_bindings to key_bindings

Author: dessant

examples/widgets/codeinput.py

@@ -10,7 +10,6 @@
 from kivy.core.text import LabelBase
 from pygments import lexers
 import codecs
-import glob
 import os
 
 example_text = '''
@@ -111,7 +110,8 @@ def cancel(self):
 
 class CodeInputWithBindings(EmacsBehavior, CodeInput):
     '''CodeInput with keybindings.
-    To add more bindings, add behavior before CodeInput in class definition
+    To add more bindings, add the behavior before CodeInput in the class
+    definition.
     '''
     pass
 
@@ -165,7 +165,7 @@ def build(self):
             lexer=KivyLexer(),
             font_size=12,
             text=example_text,
-            active_key_bindings='default',
+            key_bindings='default',
         )
 
         b.add_widget(self.codeinput)
@@ -204,7 +204,7 @@ def _file_menu_selected(self, instance, value):
 
     def _bindings_selected(self, instance, value):
         value = value.split(' ')[0]
-        self.codeinput.active_key_bindings = value.lower()
+        self.codeinput.key_bindings = value.lower()
 
     def on_files(self, instance, values):
         if not values[0]:

kivy/uix/behaviors/emacs.py

@@ -7,7 +7,7 @@
 
 This `mixin <https://en.wikipedia.org/wiki/Mixin>`_ allows you to add
 `Emacs <https://www.gnu.org/software/emacs/>`_ keyboard shortcuts for basic
-movement and editing to the :class:`~kivy.uix.textinput.TextInput` widget.
+movement and editing to the :class:`~kivy.uix.codeinput.CodeInput` widget.
 The shortcuts currently available are listed below::
 
 Emacs shortcuts
@@ -44,18 +44,18 @@
 class EmacsBehavior(object):
     '''
     A `mixin <https://en.wikipedia.org/wiki/Mixin>`_ that enables Emacs-style
-    keyboard shortcuts for the :class:`~kivy.uix.textinput.TextInput` widget.
+    keyboard shortcuts for the :class:`~kivy.uix.codeinput.CodeInput` widget.
     '''
 
-    active_key_bindings = StringProperty('emacs')
+    key_bindings = StringProperty('emacs')
     '''String name which determines the type of key bindings to use with the
-    :class:`~kivy.uix.textinput.TextInput`. This allows Emacs key bindings to
+    :class:`~kivy.uix.codeinput.CodeInput`. This allows Emacs key bindings to
     be enabled/disabled programmatically for widgets that inherit from
-    :class:`EmacsBehavior`. If the value is not ``'emacs'`` Emacs bindings will
-    be disabled.
+    :class:`EmacsBehavior`. If the value is not ``'emacs'``, Emacs bindings
+    will be disabled.
 
-    :attr:`active_key_bindings` is a :class:`~kivy.properties.StringProperty`
-    and defaults to ``'emacs'``
+    :attr:`key_bindings` is a :class:`~kivy.properties.StringProperty`
+    and defaults to ``'emacs'``.
 
     .. versionadded:: 1.9.2
     '''
@@ -89,7 +89,7 @@ def keyboard_on_key_down(self, window, keycode, text, modifiers):
         mod = modifiers[0] if modifiers else None
         is_emacs_shortcut = False
 
-        if key in range(256) and self.active_key_bindings == 'emacs':
+        if key in range(256) and self.key_bindings == 'emacs':
             is_emacs_shortcut = ((mod == 'ctrl' and
                                   chr(key) in self.bindings['ctrl'].keys()) or
                                  (mod == 'alt' and

kivy/uix/codeinput.py

@@ -85,11 +85,11 @@ class CodeInput(CodeNavigationBehavior, TextInput):
 
     '''
 
-    active_key_bindings = StringProperty('default')
-    '''String name which determines the type of key bindings to use.
+    key_bindings = StringProperty('default')
+    '''Determines the type of key bindings to use.
 
-    :attr:`active_key_bindings` is a :class:`~kivy.properties.StringProperty`
-    and defaults to ``'default'``
+    :attr:`key_bindings` is a :class:`~kivy.properties.StringProperty`
+    and defaults to ``'default'``.
 
     .. versionadded:: 1.9.2
     '''

kivy/uix/textinput.py

@@ -2252,7 +2252,7 @@ def _key_up(self, key, repeat=False):
             self._alt_r = False
 
     def keyboard_on_key_down(self, window, keycode, text, modifiers):
-        # Keycodes on OSX:
+        # Keycodes on OS X:
         ctrl, cmd = 64, 1024
         key, key_str = keycode
         win = EventLoop.window