Merge branch 'master' of ssh://github.com/kivy/kivy

Author: tito

kivy/config.py

@@ -30,11 +30,11 @@
 ------------------------------
 
 :kivy:
+
     `desktop`: (0, 1)
         Enable/disable specific features if True/False. For example enabling
         drag-able scroll-bar in scroll views, disabling of bubbles in
         TextInput...  True etc.
-
     `log_level`: (debug, info, warning, error, critical)
         Set the minimum log level to use
     `log_dir`: string
@@ -44,7 +44,7 @@
     `log_enable`: (0, 1)
         Activate file logging
     `keyboard_mode`: ('', 'system', 'dock', 'multi', 'systemanddock',
-            'systemandmulti')
+        'systemandmulti')
         Keyboard mode to use. If empty, Kivy will decide for you what is the
         best for your current platform. Otherwise, you can set one of 'system'
         (real keyboard), 'dock' (one virtual keyboard docked in a screen side),

kivy/core/window/__init__.py

@@ -71,8 +71,9 @@ class Keyboard(EventDispatcher):
         # numpad
         'numpad0': 256, 'numpad1': 257, 'numpad2': 258, 'numpad3': 259,
         'numpad4': 260, 'numpad5': 261, 'numpad6': 262, 'numpad7': 263,
-        'numpad8': 264, 'numpad9': 265, 'numpaddecimal': 266, 'numpaddivide': 267,
-        'numpadmul': 268, 'numpadsubstract': 269, 'numpadadd': 270,
+        'numpad8': 264, 'numpad9': 265, 'numpaddecimal': 266,
+        'numpaddivide': 267, 'numpadmul': 268, 'numpadsubstract': 269,
+        'numpadadd': 270,
 
         # F1-15
         'f1': 282, 'f2': 283, 'f3': 282, 'f4': 285, 'f5': 286, 'f6': 287,
@@ -436,7 +437,8 @@ def __init__(self, **kwargs):
         if 'rotation' not in kwargs:
             kwargs['rotation'] = Config.getint('graphics', 'rotation')
         if 'position' not in kwargs:
-            kwargs['position'] = Config.getdefault('graphics', 'position', 'auto')
+            kwargs['position'] = Config.getdefault('graphics', 'position',
+                                     'auto')
         if 'top' in kwargs:
             kwargs['position'] = 'custom'
             kwargs['top'] = kwargs['top']
@@ -968,12 +970,11 @@ def request_keyboard(self, callback, target):
             keyboard.target = target
 
         # use system (hardware) keyboard according to flag
-        if self.use_syskeyboard:
-            self.bind(
+        if self.allow_vkeyboard and self.use_syskeyboard:
+            self.unbind(
                 on_key_down=keyboard._on_window_key_down,
                 on_key_up=keyboard._on_window_key_up)
-        else:
-            self.unbind(
+            self.bind(
                 on_key_down=keyboard._on_window_key_down,
                 on_key_up=keyboard._on_window_key_up)
 

kivy/data/style.kv

@@ -576,7 +576,7 @@
             source: root.app_icon
             allow_stretch: True
             size_hint_x: None
-            width: self.height
+            width: min(self.height, self.texture_size[0]) if self.texture else self.height
 			mipmap: root.mipmap
 		Widget:
 			size_hint_x: None

kivy/graphics/fbo.pyx

@@ -392,9 +392,8 @@ cdef class Fbo(RenderContext):
             return data
 
     cpdef get_pixel_color(self, int wx, int wy):
-        """
-            Get the color of the pixel with specified window
-            coordinates wx, wy. It returns result in RGBA format
+        """Get the color of the pixel with specified window
+        coordinates wx, wy. It returns result in RGBA format.
  
         .. versionadded:: 1.8.0
         """

kivy/input/provider.py

@@ -2,7 +2,8 @@
 Motion Event Provider
 =====================
 
-Abstract class for a implement a :class:`~kivy.input.motionevent.MotionEvent`
+Abstract class for the implemention of a
+:class:`~kivy.input.motionevent.MotionEvent`
 provider. The implementation must support the
 :func:`~MotionEventProvider.start`, :func:`~MotionEventProvider.stop` and
 :func:`~MotionEventProvider.update` methods.
@@ -22,18 +23,18 @@ def __init__(self, device, args):
 
     def start(self):
         '''Start the provider. This method is automatically called when the
-        application is started, and if the configuration use the current
+        application is started and if the configuration uses the current
         provider.
         '''
         pass
 
     def stop(self):
-        '''Stop the provider
+        '''Stop the provider.
         '''
         pass
 
     def update(self, dispatch_fn):
-        '''Update the provider, and dispatch all the new touch event though the
+        '''Update the provider and dispatch all the new touch events though the
         `dispatch_fn` argument.
         '''
         pass

kivy/input/recorder.py

@@ -6,28 +6,28 @@
 
 .. warning::
 
-    This part of Kivy is still experimental, and his API is subject to change in
+    This part of Kivy is still experimental and this API is subject to change in
     a future version.
 
-This is a class that can record and replay some part of input events. This can
-be used for test case, screen saver etc.
+This is a class that can record and replay some input events. This can
+be used for test cases, screen savers etc.
 
-Once activated, the recorder will listen to any input event, and save some
-properties in a file + the delta time. Later, you can play the input file: it
-will generate fake touch with saved properties, and dispatch it to the event
-loop.
+Once activated, the recorder will listen for any input event and save its
+properties in a file with the delta time. Later, you can play the input file: it
+will generate fake touch events with the saved properties and dispatch it to
+the event loop.
 
-By default, only the position are saved ('pos' profile and 'sx', 'sy',
-attributes). Changes it only if you understand how input is working.
+By default, only the position is saved ('pos' profile and 'sx', 'sy',
+attributes). Change it only if you understand how input handling works.
 
 Recording events
 ----------------
 
 The best way is to use the "recorder" module. Check the :doc:`api-kivy.modules`
-documentation for learning about how to activate a module.
+documentation to see how to activate a module.
 
-When activated, you can press F8 to start the recording. By default, events will
-be written at `<currentpath>/recorder.kvi`. When you want to stop recording,
+Once activated, you can press F8 to start the recording. By default, events will
+be written to `<currentpath>/recorder.kvi`. When you want to stop recording,
 press F8 again.
 
 You can replay the file by pressing F7.
@@ -60,10 +60,10 @@ def recorder_loop(instance, value):
 Recording more attributes
 -------------------------
 
-You can extend the attributes to save, at one condition: attributes values must
-be simple value, not instance of complex class. Aka, saving shape will not work.
+You can extend the attributes to save on one condition: attributes values must
+be simple values, not instances of complex classes.
 
-Let's say you want to save angle and pressure of the touch, if available::
+Let's say you want to save the angle and pressure of the touch, if available::
 
     from kivy.input.recorder import Recorder
 
@@ -80,11 +80,11 @@ def recorder_loop(instance, value):
 Known limitations
 -----------------
 
-  - Unable to save attributes with instance of complex class
-  - Values that represent time will be not adjusted
-  - Can replay only complete record, if a begin/update/end event is missing,
-    this could lead to ghost touch.
-  - Stopping the replay before the end can lead to ghost touch.
+  - Unable to save attributes with instances of complex classes.
+  - Values that represent time will not be adjusted.
+  - Can replay only complete records. If a begin/update/end event is missing,
+    this could lead to ghost touches.
+  - Stopping the replay before the end can lead to ghost touches.
 
 '''
 
@@ -111,57 +111,57 @@ def depack(self, args):
 
 
 class Recorder(EventDispatcher):
-    '''Recorder class, check module documentation for more information.
+    '''Recorder class. Please check module documentation for more information.
     '''
 
     window = ObjectProperty(None)
-    '''Window instance to attach the recorder. If None set, it will use the
-    default one.
+    '''Window instance to attach the recorder. If None, it will use the
+    default instance.
 
-    :data:`window` is a :class:`~kivy.properties.ObjectProperty`, default to
+    :data:`window` is a :class:`~kivy.properties.ObjectProperty` and defaults to
     None.
     '''
 
     counter = NumericProperty(0)
     '''Number of events recorded in the last session.
 
-    :data:`counter` is a :class:`~kivy.properties.NumericProperty`, default to
-    0, read-only.
+    :data:`counter` is a :class:`~kivy.properties.NumericProperty` and defaults
+    to 0, read-only.
     '''
 
     play = BooleanProperty(False)
-    '''Boolean to start/stop the replay of the current file (if exist.)
+    '''Boolean to start/stop the replay of the current file (if it exists).
 
-    :data:`play` is a :class:`~kivy.properties.BooleanProperty`, default to
+    :data:`play` is a :class:`~kivy.properties.BooleanProperty` and defaults to
     False.
     '''
 
     record = BooleanProperty(False)
     '''Boolean to start/stop the recording of input events.
 
-    :data:`record` is a :class:`~kivy.properties.BooleanProperty`, default to
-    False.
+    :data:`record` is a :class:`~kivy.properties.BooleanProperty` and defaults
+    to False.
     '''
 
     filename = StringProperty('recorder.kvi')
-    '''Filename to save the output of recorder.
+    '''Filename to save the output of the recorder.
 
-    :data:`filename` is a :class:`~kivy.properties.StringProperty`, default to
-    'recorder.kvi'.
+    :data:`filename` is a :class:`~kivy.properties.StringProperty` and defaults
+    to 'recorder.kvi'.
     '''
 
     record_attrs = ListProperty(['is_touch', 'sx', 'sy'])
     '''Attributes to record from the motion event.
 
-    :data:`record_attrs` is a :class:`~kivy.properties.ListProperty`, default to
-    ['is_touch', 'sx', 'sy'].
+    :data:`record_attrs` is a :class:`~kivy.properties.ListProperty` and
+    defaults to ['is_touch', 'sx', 'sy'].
     '''
 
     record_profile_mask = ListProperty(['pos'])
     '''Profile to save in the fake motion event when replayed.
 
-    :data:`record_profile_mask` is a :class:`~kivy.properties.ListProperty`,
-    default to ['pos'].
+    :data:`record_profile_mask` is a :class:`~kivy.properties.ListProperty` and
+    defaults to ['pos'].
     '''
 
     # internals

kivy/input/shape.py

@@ -9,12 +9,12 @@
 
 
 class Shape(object):
-    '''Abstract class for all implementation of a shape'''
+    '''Abstract class for all implementations of a shape'''
     pass
 
 
 class ShapeRect(Shape):
-    '''Represent a rectangle shape.'''
+    '''Class for the representation of a rectangle.'''
     __slots__ = ('width', 'height')
 
     def __init__(self):

kivy/loader.py

@@ -375,17 +375,27 @@ def _update(self, *largs):
         self._trigger_update()
 
     def image(self, filename, load_callback=None, post_callback=None, **kwargs):
-        '''Load a image using loader. A Proxy image is returned with a loading
-        image.
-
-      ::
-            img = Loader.image(filename)
-            # img will be a ProxyImage.
-            # You'll use it the same as an Image class.
-            # Later, when the image is really loaded,
-            # the loader will change the img.image property
-            # to the new loaded image
-
+        '''Load a image using the Loader. A ProxyImage is returned with a
+        loading image. You can use it as follows::
+            
+            from kivy.app import App
+            from kivy.uix.image import Image
+            from kivy.loader import Loader
+
+            class TestApp(App):
+                def _image_loaded(self, proxyImage):
+                    if proxyImage.image.texture:
+                        self.image.texture = proxyImage.image.texture
+
+                def build(self):
+                    proxyImage = Loader.image("myPic.jpg")
+                    proxyImage.bind(on_load=self._image_loaded)
+                    self.image = Image()
+                    return self.image
+
+            TestApp().run()
+
+        In order to cancel all background loading, call *Loader.stop()*.
         '''
         data = Cache.get('kv.loader', filename)
         if data not in (None, False):