Make widget keys have more explicit inheritance

IPython/html/widgets/widget_bool.py

@@ -1,31 +1,31 b''
 """BoolWidget class.  
 
 Represents a boolean using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Bool, List
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class BoolWidget(Widget):
     target_name = Unicode('BoolWidgetModel')
     default_view_name = Unicode('CheckboxView')
 
     # Model Keys
-    _keys = ['value', 'description', 'disabled']
+    keys = ['value', 'description', 'disabled'] + Widget.keys
     value = Bool(False, help="Bool value")
     description = Unicode('', help="Description of the boolean (label).") 
     disabled = Bool(False, help="Enable or disable user changes.")
     
  No newline at end of file

IPython/html/widgets/widget_button.py

@@ -1,93 +1,93 b''
 """ButtonWidget class.  
 
 Represents a button in the frontend using a widget.  Allows user to listen for
 click events on the button and trigger backend code when the clicks are fired.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 import inspect
 import types
 
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Bool, Int
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class ButtonWidget(Widget):
     target_name = Unicode('ButtonWidgetModel')
     default_view_name = Unicode('ButtonView')
 
     # Keys
-    _keys = ['description', 'disabled']
+    keys = ['description', 'disabled'] + Widget.keys
     description = Unicode('', help="Description of the button (label).")
     disabled = Bool(False, help="Enable or disable user changes.")
     
 
     def __init__(self, **kwargs):
         super(ButtonWidget, self).__init__(**kwargs)
         
         self._click_handlers = []
         self.on_msg(self._handle_button_msg)
 
 
     def on_click(self, callback, remove=False):
         """Register a callback to execute when the button is clicked.  The
         callback can either accept no parameters or one sender parameter:
         - callback()
         - callback(sender)
         If the callback has a sender parameter, the ButtonWidget instance that
         called the callback will be passed into the method as the sender.
 
         Parameters
         ----------
         remove : bool (optional)
             Set to true to remove the callback from the list of callbacks."""
         if remove:
             self._click_handlers.remove(callback)
         elif not callback in self._click_handlers:
             self._click_handlers.append(callback)
 
 
     def _handle_button_msg(self, content):
         """Handle a msg from the front-end
 
         Parameters
         ----------
         content: dict
             Content of the msg."""
         if 'event' in content and content['event'] == 'click':
             self._handle_click()
 
 
     def _handle_click(self):
         """Handles when the button has been clicked.  Fires on_click
         callbacks when appropriate."""
         
         for handler in self._click_handlers:
             if callable(handler):
                 argspec = inspect.getargspec(handler)
                 nargs = len(argspec[0])
 
                 # Bound methods have an additional 'self' argument
                 if isinstance(handler, types.MethodType):
                     nargs -= 1
 
                 # Call the callback
                 if nargs == 0:
                     handler()
                 elif nargs == 1:
                     handler(self)
                 else:
                     raise TypeError('ButtonWidget click callback must ' \
                         'accept 0 or 1 arguments.')
         

IPython/html/widgets/widget_container.py

@@ -1,203 +1,203 b''
 """ContainerWidget class.  
 
 Represents a container that can be used to group other widgets.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Bool, List, Instance
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class ContainerWidget(Widget):
     target_name = Unicode('ContainerWidgetModel')
     default_view_name = Unicode('ContainerView')
 
     # Keys, all private and managed by helper methods.  Flexible box model
     # classes...
-    _keys = ['_vbox', '_hbox', '_align_start', '_align_end', '_align_center',
+    keys = ['_vbox', '_hbox', '_align_start', '_align_end', '_align_center',
             '_pack_start', '_pack_end', '_pack_center', '_flex0', '_flex1', 
             '_flex2', 'description', 'button_text',
-            'children']
+            'children'] + Widget.keys
     children = List(Instance(Widget))
     
     description = Unicode()
     button_text = Unicode()
     _hbox = Bool(False)
     _vbox = Bool(False)
     _align_start = Bool(False)
     _align_end = Bool(False)
     _align_center = Bool(False)
     _pack_start = Bool(False)
     _pack_end = Bool(False)
     _pack_center = Bool(False)
     _flex0 = Bool(False)
     _flex1 = Bool(False)
     _flex2 = Bool(False)
     
     def hbox(self, enabled=True):
         """Make this container an hbox.  Automatically disables conflicting
         features.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the hbox feature of the container, defaults to 
             True."""
         self._hbox = enabled
         if enabled:
             self._vbox = False
     
     def vbox(self, enabled=True):
         """Make this container an vbox.  Automatically disables conflicting
         features.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the vbox feature of the container, defaults to 
             True."""
         self._vbox = enabled
         if enabled:
             self._hbox = False
             
     def align_start(self, enabled=True):
         """Make the contents of this container align to the start of the axis.  
         Automatically disables conflicting alignments.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the start alignment of the container, defaults to 
             True."""
         self._align_start = enabled
         if enabled:
             self._align_end = False
             self._align_center = False
             
     def align_end(self, enabled=True):
         """Make the contents of this container align to the end of the axis.  
         Automatically disables conflicting alignments.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the end alignment of the container, defaults to 
             True."""
         self._align_end = enabled
         if enabled:
             self._align_start = False
             self._align_center = False
             
     def align_center(self, enabled=True):
         """Make the contents of this container align to the center of the axis.  
         Automatically disables conflicting alignments.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the center alignment of the container, defaults to 
             True."""
         self._align_center = enabled
         if enabled:
             self._align_start = False
             self._align_end = False
 
             
     def pack_start(self, enabled=True):
         """Make the contents of this container pack to the start of the axis.  
         Automatically disables conflicting packings.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the start packing of the container, defaults to 
             True."""
         self._pack_start = enabled
         if enabled:
             self._pack_end = False
             self._pack_center = False
             
     def pack_end(self, enabled=True):
         """Make the contents of this container pack to the end of the axis.  
         Automatically disables conflicting packings.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the end packing of the container, defaults to 
             True."""
         self._pack_end = enabled
         if enabled:
             self._pack_start = False
             self._pack_center = False
             
     def pack_center(self, enabled=True):
         """Make the contents of this container pack to the center of the axis.  
         Automatically disables conflicting packings.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the center packing of the container, defaults to 
             True."""
         self._pack_center = enabled
         if enabled:
             self._pack_start = False
             self._pack_end = False
 
             
     def flex0(self, enabled=True):
         """Put this container in flex0 mode.  Automatically disables conflicting
         flex modes.  See the widget tutorial part 5 example notebook for more
         information.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the flex0 attribute of the container, defaults to 
             True."""
         self._flex0 = enabled
         if enabled:
             self._flex1 = False
             self._flex2 = False
             
     def flex1(self, enabled=True):
         """Put this container in flex1 mode.  Automatically disables conflicting
         flex modes.  See the widget tutorial part 5 example notebook for more
         information.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the flex1 attribute of the container, defaults to 
             True."""
         self._flex1 = enabled
         if enabled:
             self._flex0 = False
             self._flex2 = False
             
     def flex2(self, enabled=True):
         """Put this container in flex2 mode.  Automatically disables conflicting
         flex modes.  See the widget tutorial part 5 example notebook for more
         information.
 
         Parameters
         ----------
         enabled: bool (optional)
             Enabled or disable the flex2 attribute of the container, defaults to 
             True."""
         self._flex2 = enabled
         if enabled:
             self._flex0 = False
             self._flex1 = False

IPython/html/widgets/widget_float.py

@@ -1,30 +1,30 b''
 """FloatWidget class.  
 
 Represents an unbounded float using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Float, Bool, List
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class FloatWidget(Widget):
     target_name = Unicode('FloatWidgetModel')
     default_view_name = Unicode('FloatTextView')
 
     # Keys
-    _keys = ['value', 'disabled', 'description']
+    keys = ['value', 'disabled', 'description'] + Widget.keys
     value = Float(0.0, help="Float value") 
     disabled = Bool(False, help="Enable or disable user changes")
     description = Unicode(help="Description of the value this widget represents")

IPython/html/widgets/widget_float_range.py

@@ -1,34 +1,34 b''
 """FloatRangeWidget class.  
 
 Represents a bounded float using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Float, Bool, List
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class FloatRangeWidget(Widget):
     target_name = Unicode('FloatRangeWidgetModel')
     default_view_name = Unicode('FloatSliderView')
 
     # Keys
-    _keys = ['value', 'step', 'max', 'min', 'disabled', 'orientation', 'description']
+    keys = ['value', 'step', 'max', 'min', 'disabled', 'orientation', 'description'] + Widget.keys
     value = Float(0.0, help="Flaot value") 
     max = Float(100.0, help="Max value")
     min = Float(0.0, help="Min value")
     disabled = Bool(False, help="Enable or disable user changes")
     step = Float(0.1, help="Minimum step that the value can take (ignored by some views)")
     orientation = Unicode(u'horizontal', help="Vertical or horizontal (ignored by some views)")
     description = Unicode(help="Description of the value this widget represents")

IPython/html/widgets/widget_image.py

@@ -1,38 +1,38 b''
 """ButtonWidget class.  
 
 Represents a button in the frontend using a widget.  Allows user to listen for
 click events on the button and trigger backend code when the clicks are fired.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 import base64
 
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Bytes
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class ImageWidget(Widget):
     target_name = Unicode('ImageWidgetModel')
     default_view_name = Unicode('ImageView')
     
     # Define the custom state properties to sync with the front-end
-    _keys = ['image_format', 'width', 'height', '_b64value']
+    keys = ['image_format', 'width', 'height', '_b64value'] + Widget.keys
     image_format = Unicode('png')
     width = Unicode()
     height = Unicode()
     _b64value = Unicode()
     
     value = Bytes()
     def _value_changed(self, name, old, new):
         self._b64value = base64.b64encode(new)
  No newline at end of file

IPython/html/widgets/widget_int.py

@@ -1,30 +1,30 b''
 """IntWidget class.  
 
 Represents an unbounded int using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Int, Bool, List
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class IntWidget(Widget):
     target_name = Unicode('IntWidgetModel')
     default_view_name = Unicode('IntTextView')
 
     # Keys
-    _keys = ['value', 'disabled', 'description']
+    keys = ['value', 'disabled', 'description'] + Widget.keys
     value = Int(0, help="Int value") 
     disabled = Bool(False, help="Enable or disable user changes")
     description = Unicode(help="Description of the value this widget represents")

IPython/html/widgets/widget_int_range.py

@@ -1,34 +1,34 b''
 """IntRangeWidget class.  
 
 Represents a bounded int using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Int, Bool, List
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class IntRangeWidget(Widget):
     target_name = Unicode('IntRangeWidgetModel')
     default_view_name = Unicode('IntSliderView')
 
     # Keys
-    _keys = ['value', 'step', 'max', 'min', 'disabled', 'orientation', 'description']
+    keys = ['value', 'step', 'max', 'min', 'disabled', 'orientation', 'description'] + Widget.keys
     value = Int(0, help="Int value") 
     max = Int(100, help="Max value")
     min = Int(0, help="Min value")
     disabled = Bool(False, help="Enable or disable user changes")
     step = Int(1, help="Minimum step that the value can take (ignored by some views)")
     orientation = Unicode(u'horizontal', help="Vertical or horizontal (ignored by some views)")
     description = Unicode(help="Description of the value this widget represents")

IPython/html/widgets/widget_multicontainer.py

@@ -1,58 +1,58 b''
 """MulticontainerWidget class.  
 
 Represents a multipage container that can be used to group other widgets into
 pages.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Dict, Int, List, Instance
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class MulticontainerWidget(Widget):
     target_name = Unicode('MulticontainerWidgetModel')
     default_view_name = Unicode('TabView')
 
     # Keys
-    _keys = ['_titles', 'selected_index', 'children']
+    keys = ['_titles', 'selected_index', 'children'] + Widget.keys
     _titles = Dict(help="Titles of the pages")
     selected_index = Int(0)
 
     children = List(Instance(Widget))
 
     # Public methods
     def set_title(self, index, title):
         """Sets the title of a container page
 
         Parameters
         ----------
         index : int
             Index of the container page
         title : unicode
             New title"""
         self._titles[index] = title
         self.send_state('_titles')
 
 
     def get_title(self, index):
         """Gets the title of a container pages
 
         Parameters
         ----------
         index : int
             Index of the container page"""
         if index in self._titles:
             return self._titles[index]
         else:
             return None

IPython/html/widgets/widget_selection.py

@@ -1,32 +1,32 b''
 """SelectionWidget class.  
 
 Represents an enumeration using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, List, Bool
 
 #-----------------------------------------------------------------------------
 # SelectionWidget
 #-----------------------------------------------------------------------------
 class SelectionWidget(Widget):
     target_name = Unicode('SelectionWidgetModel')
     default_view_name = Unicode('DropdownView')
 
     # Keys
-    _keys = ['value', 'values', 'disabled', 'description']
+    keys = ['value', 'values', 'disabled', 'description'] + Widget.keys
     value = Unicode(help="Selected value")
     values = List(help="List of values the user can select")
     disabled = Bool(False, help="Enable or disable user changes")
     description = Unicode(help="Description of the value this widget represents")
  
  No newline at end of file

IPython/html/widgets/widget_string.py

@@ -1,93 +1,93 b''
 """StringWidget class.  
 
 Represents a unicode string using a widget.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 import inspect
 import types
 
 from .widget import Widget
 from IPython.utils.traitlets import Unicode, Bool, List, Int
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 class StringWidget(Widget):
     target_name = Unicode('StringWidgetModel')
     default_view_name = Unicode('TextBoxView')
 
     # Keys
-    _keys = ['value', 'disabled', 'description']
+    keys = ['value', 'disabled', 'description'] + Widget.keys
     value = Unicode(help="String value")
     disabled = Bool(False, help="Enable or disable user changes")
     description = Unicode(help="Description of the value this widget represents")
 
 
     def __init__(self, **kwargs):
         super(StringWidget, self).__init__(**kwargs)
         self._submission_callbacks = []        
         self.on_msg(self._handle_string_msg)
 
 
     def scroll_to_bottom(self):
         self.send({"method": "scroll_to_bottom"})
 
 
     def _handle_string_msg(self, content):
         """Handle a msg from the front-end
 
         Parameters
         ----------
         content: dict
             Content of the msg."""
         if 'event' in content and content['event'] == 'submit':
             self._handle_submit()
 
 
     def on_submit(self, callback, remove=False):
         """Register a callback to handle text submission (triggered when the 
         user clicks enter).
 
         Parameters
         callback: Method handle
             Function to be called when the text has been submitted.  Function
             can have two possible signatures:
             callback()
             callback(sender)
         remove: bool (optional)
             Whether or not to unregister the callback"""
         if remove and callback in self._submission_callbacks:
             self._submission_callbacks.remove(callback)
         elif not remove and not callback in self._submission_callbacks:
             self._submission_callbacks.append(callback)
 
 
     def _handle_submit(self):
         """Handles when a string widget view is submitted."""
         for handler in self._submission_callbacks:
             if callable(handler):
                 argspec = inspect.getargspec(handler)
                 nargs = len(argspec[0])
 
                 # Bound methods have an additional 'self' argument
                 if isinstance(handler, types.MethodType):
                     nargs -= 1
 
                 # Call the callback
                 if nargs == 0:
                     handler()
                 elif nargs == 1:
                     handler(self)
                 else:
                     raise TypeError('StringWidget submit callback must ' \
                         'accept 0 or 1 arguments.')