Updated widget tutorials 1-2

examples/widgets/Part 1 - Basics.ipynb

@@ -1,369 +1,305 b''
 {
  "metadata": {
   "cell_tags": [
    [
     "<None>",
     null
    ]
   ],
   "name": ""
  },
  "nbformat": 3,
  "nbformat_minor": 0,
  "worksheets": [
   {
    "cells": [
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "To use IPython widgets in the notebook, the widget namespace and display function need to be imported."
+      "To use IPython widgets in the notebook, the widget namespace and optionally the display function need to be imported."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "from IPython.html import widgets # Widget definitions\n",
       "from IPython.display import display # Used to display widgets in the notebook"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 1
     },
     {
      "cell_type": "heading",
      "level": 1,
      "metadata": {},
      "source": [
       "Basic Widgets"
      ]
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "The IPython notebook comes preloaded with basic widgets that represent common data types.  These widgets are\n",
       "\n",
-      "- BoolWidget : boolean  \n",
-      "- FloatRangeWidget : bounded float  \n",
-      "- FloatWidget : unbounded float  \n",
-      "- ImageWidget : image\n",
-      "- IntRangeWidget : bounded integer  \n",
-      "- IntWidget : unbounded integer  \n",
-      "- SelectionWidget : enumeration  \n",
-      "- StringWidget : string  \n",
+      "- CheckBoxWidget\n",
+      "- ToggleButtonWidget\n",
+      "- FloatSliderWidget\n",
+      "- BoundedFloatTextWidget\n",
+      "- FloatProgressWidget\n",
+      "- FloatTextWidget\n",
+      "- ImageWidget\n",
+      "- IntSliderWidget\n",
+      "- BoundedIntTextWidget\n",
+      "- IntProgressWidget\n",
+      "- IntTextWidget\n",
+      "- ToggleButtonsWidget\n",
+      "- RadioButtonsWidget\n",
+      "- DropdownWidget\n",
+      "- ListBoxWidget\n",
+      "- HTMLWidget\n",
+      "- LatexWidget\n",
+      "- TextAreaWidget\n",
+      "- TextBoxWidget\n",
       "\n",
       "A few special widgets are also included, that can be used to capture events and change how other widgets are displayed.  These widgets are\n",
       "\n",
-      "- ButtonWidget  \n",
-      "- ContainerWidget  \n",
-      "- MulticontainerWidget  \n",
+      "- ButtonWidget\n",
+      "- ContainerWidget\n",
+      "- PopupWidget\n",
+      "- AccordionWidget\n",
+      "- TabWidget\n",
       "\n",
       "To see the complete list of widgets, one can execute the following"
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "[widget for widget in dir(widgets) if widget.endswith('Widget')]"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "metadata": {},
        "output_type": "pyout",
        "prompt_number": 2,
        "text": [
-        "['BoolWidget',\n",
+        "['AccordionWidget',\n",
+        " 'BoundedFloatTextWidget',\n",
+        " 'BoundedIntTextWidget',\n",
         " 'ButtonWidget',\n",
+        " 'CheckBoxWidget',\n",
         " 'ContainerWidget',\n",
         " 'DOMWidget',\n",
-        " 'FloatRangeWidget',\n",
-        " 'FloatWidget',\n",
+        " 'DropdownWidget',\n",
+        " 'FloatProgressWidget',\n",
+        " 'FloatSliderWidget',\n",
+        " 'FloatTextWidget',\n",
+        " 'HTMLWidget',\n",
         " 'ImageWidget',\n",
-        " 'IntRangeWidget',\n",
-        " 'IntWidget',\n",
-        " 'SelectionContainerWidget',\n",
-        " 'SelectionWidget',\n",
-        " 'StringWidget',\n",
+        " 'IntProgressWidget',\n",
+        " 'IntSliderWidget',\n",
+        " 'IntTextWidget',\n",
+        " 'LatexWidget',\n",
+        " 'ListBoxWidget',\n",
+        " 'PopupWidget',\n",
+        " 'RadioButtonsWidget',\n",
+        " 'TabWidget',\n",
+        " 'TextAreaWidget',\n",
+        " 'TextBoxWidget',\n",
+        " 'ToggleButtonWidget',\n",
+        " 'ToggleButtonsWidget',\n",
         " 'Widget']"
        ]
       }
      ],
      "prompt_number": 2
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "The basic widgets can all be constructed without arguments.  The following creates a FloatRangeWidget without displaying it"
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "mywidget = widgets.FloatRangeWidget()"
+      "mywidget = widgets.FloatSliderWidget()"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 3
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "Constructing a widget does not display it on the page.  To display a widget, the widget must be passed to the IPython `display(object)` method.  `mywidget` is displayed by"
+      "Constructing a widget does not display it on the page.  To display a widget, the widget must be passed to the IPython `display(object)` method or must be returned as the last item in the cell.  `mywidget` is displayed by"
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "display(mywidget)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 4
     },
     {
+     "cell_type": "markdown",
+     "metadata": {},
+     "source": [
+      "or"
+     ]
+    },
+    {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "mywidget.value\n"
+      "mywidget"
      ],
      "language": "python",
      "metadata": {},
-     "outputs": [
-      {
-       "metadata": {},
-       "output_type": "pyout",
-       "prompt_number": 10,
-       "text": [
-        "50.6"
-       ]
-      }
-     ],
-     "prompt_number": 10
+     "outputs": [],
+     "prompt_number": 5
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "It's important to realize that widgets are not the same as output, even though they are displayed with `display`.  Widgets are drawn in a special widget area.  That area is marked with a close button which allows you to collapse the widgets.  Widgets cannot be interleaved with output.  Doing so would break the ability to make simple animations using `clear_output`.\n",
       "\n",
-      "Widgets are manipulated via special instance properties (traitlets).  The names of these instance properties are listed in the widget's `keys` property (as seen below).  A few of these properties are common to most, if not all, widgets.  The common properties are `value`, `description`, `visible`, and `disabled`.  `_css`, `_add_class`, and `_remove_class` are internal properties that exist in all widgets and should not be modified."
+      "Widgets are manipulated via special instance properties (traitlets).  The names of these instance properties are listed in the widget's `keys` property (as seen below).  A few of these properties are common to most, if not all, widgets.  The common properties are `value`, `description`, `visible`, and `disabled`.  `_css` and `_view_name` are internal properties that exist in all widgets and should not be modified."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "mywidget.keys"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "metadata": {},
        "output_type": "pyout",
-       "prompt_number": 11,
+       "prompt_number": 6,
        "text": [
-        "['value',\n",
-        " 'step',\n",
-        " 'max',\n",
+        "['_view_name',\n",
+        " 'description',\n",
         " 'min',\n",
-        " 'disabled',\n",
         " 'orientation',\n",
-        " 'description',\n",
-        " 'visible',\n",
+        " 'max',\n",
         " '_css',\n",
-        " 'view_name']"
+        " 'value',\n",
+        " 'disabled',\n",
+        " 'visible',\n",
+        " 'step']"
        ]
       }
      ],
-     "prompt_number": 11
+     "prompt_number": 6
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "Changing a widget's property value will automatically update that widget everywhere it is displayed in the notebook.  Here the value of `mywidget` is set.  The slider shown above (after input 4) updates automatically to the new value.  In reverse, changing the value of the displayed widget will update the property's value."
+      "Changing a widget's property value will automatically update that widget everywhere it is displayed in the notebook.  Here the value of `mywidget` is set.  The slider shown above (after inputs 4 and 5) updates automatically to the new value.  In reverse, changing the value of the displayed widget will update the property's value."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "mywidget.value = 25.0"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
-     "prompt_number": 12
+     "prompt_number": 7
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "After changing the widget's value in the notebook by hand to 0.0 (sliding the bar to the far left)."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "mywidget.value"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "metadata": {},
        "output_type": "pyout",
-       "prompt_number": 13,
+       "prompt_number": 8,
        "text": [
-        "25.0"
+        "0.0"
        ]
       }
      ],
-     "prompt_number": 13
+     "prompt_number": 8
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Widget property values can also be set with kwargs during the construction of the widget (as seen below)."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "mysecondwidget = widgets.SelectionWidget(values=[\"Item A\", \"Item B\", \"Item C\"], value=\"Nothing Selected\")\n",
+      "mysecondwidget = widgets.RadioButtonsWidget(values=[\"Item A\", \"Item B\", \"Item C\"], value=\"Item A\")\n",
       "display(mysecondwidget)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
-     "prompt_number": 14
+     "prompt_number": 9
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "mysecondwidget.value"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "metadata": {},
        "output_type": "pyout",
-       "prompt_number": 15,
-       "text": [
-        "u'Item B'"
-       ]
-      }
-     ],
-     "prompt_number": 15
-    },
-    {
-     "cell_type": "heading",
-     "level": 1,
-     "metadata": {},
-     "source": [
-      "Views"
-     ]
-    },
-    {
-     "cell_type": "markdown",
-     "metadata": {},
-     "source": [
-      "The data types that most of the widgets represent can be displayed more than one way.  A `view` is a visual representation of a widget in the notebook.  In the example in the section above, the default `view` for the `FloatRangeWidget` is used.  The default view is set in the widgets `default_view_name` instance property (as seen below)."
-     ]
-    },
-    {
-     "cell_type": "code",
-     "collapsed": false,
-     "input": [
-      "mywidget.default_view_name"
-     ],
-     "language": "python",
-     "metadata": {},
-     "outputs": [
-      {
-       "metadata": {},
-       "output_type": "pyout",
-       "prompt_number": 19,
+       "prompt_number": 10,
        "text": [
-        "u'FloatSliderView'"
+        "'Item A'"
        ]
       }
      ],
-     "prompt_number": 19
-    },
-    {
-     "cell_type": "markdown",
-     "metadata": {},
-     "source": [
-      "When a widget is displayed using `display(...)`, the `default_view_name` is used to determine what view type should be used to display the widget.  View names are case sensitive.  Sometimes the default view isn't the best view to represent a piece of data.  To change what view is used, either the `default_view_name` can be changed or the `view_name` kwarg of `display` can be set.  This also can be used to display one widget multiple ways in one output (as seen below)."
-     ]
-    },
-    {
-     "cell_type": "code",
-     "collapsed": false,
-     "input": [
-      "display(mywidget)\n",
-      "display(mywidget, view_name=\"FloatTextView\")"
-     ],
-     "language": "python",
-     "metadata": {},
-     "outputs": [],
-     "prompt_number": 20
-    },
-    {
-     "cell_type": "markdown",
-     "metadata": {},
-     "source": [
-      "Some views work with multiple different widget types and some views only work with one.  The complete list of views and supported widgets is below.  The default views are italicized.\n",
-      "\n",
-      "| Widget Name            | View Names          |\n",
-      "|:-----------------------|:--------------------|\n",
-      "| BoolWidget             |   *CheckboxView*    |\n",
-      "|                        |   ToggleButtonView  |\n",
-      "| ButtonWidget           |   *ButtonView*      |\n",
-      "| ContainerWidget        |   *ContainerView*   |\n",
-      "|                        |   ModalView         |\n",
-      "| FloatRangeWidget       |   *FloatSliderView* |\n",
-      "|                        |   FloatTextView     |\n",
-      "|                        |   ProgressView      |\n",
-      "| FloatWidget            |   *FloatTextView*   |\n",
-      "| ImageWidget            |   *ImageView*       |\n",
-      "| IntRangeWidget         |   *IntSliderView*   |\n",
-      "|                        |   IntTextView       |\n",
-      "|                        |   ProgressView      |\n",
-      "| IntWidget              |   *IntTextView*     |\n",
-      "| MulticontainerWidget   |   AccordionView     |\n",
-      "|                        |   *TabView*         |\n",
-      "| SelectionWidget        |   ToggleButtonsView |\n",
-      "|                        |   RadioButtonsView  |\n",
-      "|                        |   *DropdownView*    |\n",
-      "|                        |   ListBoxView       |\n",
-      "| StringWidget           |   HTMLView          |\n",
-      "|                        |   LatexView         |\n",
-      "|                        |   TextAreaView      |\n",
-      "|                        |   *TextBoxView*     |\n"
-     ]
+     "prompt_number": 10
     }
    ],
    "metadata": {}
   }
  ]
 }
  No newline at end of file

examples/widgets/Part 2 - Events.ipynb

@@ -1,662 +1,272 b''
 {
  "metadata": {
   "cell_tags": [
    [
     "<None>",
     null
    ]
   ],
   "name": ""
  },
  "nbformat": 3,
  "nbformat_minor": 0,
  "worksheets": [
   {
    "cells": [
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "from __future__ import print_function # 2.7 compatability\n",
       "\n",
       "from IPython.html import widgets # Widget definitions\n",
       "from IPython.display import display # Used to display widgets in the notebook"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 1
     },
     {
      "cell_type": "heading",
      "level": 1,
      "metadata": {},
      "source": [
       "Traitlet Events"
      ]
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "The widget properties are IPython traitlets.  Traitlets are eventful.  To handle property value changes, the `on_trait_change` method of the widget can be used to register an event handling callback.  The doc string for `on_trait_change` can be seen below.  Both the `name` and `remove` properties are optional."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "print(widgets.Widget.on_trait_change.__doc__)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "Setup a handler to be called when a trait changes.\n",
         "\n",
         "        This is used to setup dynamic notifications of trait changes.\n",
         "\n",
         "        Static handlers can be created by creating methods on a HasTraits\n",
         "        subclass with the naming convention '_[traitname]_changed'.  Thus,\n",
         "        to create static handler for the trait 'a', create the method\n",
         "        _a_changed(self, name, old, new) (fewer arguments can be used, see\n",
         "        below).\n",
         "\n",
         "        Parameters\n",
         "        ----------\n",
         "        handler : callable\n",
         "            A callable that is called when a trait changes.  Its\n",
         "            signature can be handler(), handler(name), handler(name, new)\n",
         "            or handler(name, old, new).\n",
         "        name : list, str, None\n",
         "            If None, the handler will apply to all traits.  If a list\n",
         "            of str, handler will apply to all names in the list.  If a\n",
         "            str, the handler will apply just to that name.\n",
         "        remove : bool\n",
         "            If False (the default), then install the handler.  If True\n",
         "            then unintall it.\n",
         "        \n"
        ]
       }
      ],
      "prompt_number": 2
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Mentioned in the doc string, the callback registered can have 4 possible signatures:\n",
       "\n",
       "- callback()\n",
       "- callback(trait_name)\n",
       "- callback(trait_name, new_value)\n",
       "- callback(trait_name, old_value, new_value)\n",
       "\n",
       "An example of how to output an IntRangeWiget's value as it is changed can be seen below."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "intrange = widgets.IntRangeWidget()\n",
+      "intrange = widgets.IntSliderWidget()\n",
       "display(intrange)\n",
       "\n",
       "def on_value_change(name, value):\n",
       "    print(value)\n",
       "\n",
       "intrange.on_trait_change(on_value_change, 'value')"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "2\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "5\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "10\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "11\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "13\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "14\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "16\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "18\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "20\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "22\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "24\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "26\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "29\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "30\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "33\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "36\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "38\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "42\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "45\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "46\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "48\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "50\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "51\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "52\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "53\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "54\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "52\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "50\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "48\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "44\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "41\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
         "34\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "30\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "28\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "26\n"
+        "74\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "25\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "24\n"
+        "98\n"
        ]
       }
      ],
      "prompt_number": 3
     },
     {
      "cell_type": "heading",
      "level": 1,
      "metadata": {},
      "source": [
       "Specialized Events"
      ]
     },
     {
      "cell_type": "heading",
      "level": 2,
      "metadata": {},
      "source": [
       "Button On Click Event"
      ]
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "The `ButtonWidget` is a special widget, like the `ContainerWidget` and `MulticontainerWidget`, that isn't used to represent a data type.  Instead the button widget is used to handle mouse clicks.  The `on_click` method of the `ButtonWidget` can be used to register a click even handler.  The doc string of the `on_click` can be seen below."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "print(widgets.ButtonWidget.on_click.__doc__)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "Register a callback to execute when the button is clicked.  The\n",
-        "        callback can either accept no parameters or one sender parameter:\n",
+        "Register a callback to execute when the button is clicked.  \n",
+        "\n",
+        "        The callback can either accept no parameters or one sender parameter:\n",
         "        - callback()\n",
         "        - callback(sender)\n",
         "        If the callback has a sender parameter, the ButtonWidget instance that\n",
         "        called the callback will be passed into the method as the sender.\n",
         "\n",
         "        Parameters\n",
         "        ----------\n",
         "        remove : bool (optional)\n",
         "            Set to true to remove the callback from the list of callbacks.\n"
        ]
       }
      ],
      "prompt_number": 4
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Button clicks are transmitted from the front-end to the back-end using custom messages.  By using the `on_click` method, a button that prints a message when it has been clicked is shown below."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "display(intrange)\n",
-      "print('hi')"
-     ],
-     "language": "python",
-     "metadata": {},
-     "outputs": [
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "hi\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "23\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "24\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "28\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "30\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "37\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "39\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "41\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "44\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "46\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "48\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "50\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "51\n"
-       ]
-      },
-      {
-       "output_type": "stream",
-       "stream": "stdout",
-       "text": [
-        "53\n"
-       ]
-      }
-     ],
-     "prompt_number": 5
-    },
-    {
-     "cell_type": "code",
-     "collapsed": false,
-     "input": [
       "button = widgets.ButtonWidget(description=\"Click Me!\")\n",
       "display(button)\n",
       "\n",
       "def on_button_clicked(sender):\n",
       "    print(\"Button clicked.\")\n",
-      "    intrange.value +=1\n",
       "\n",
       "button.on_click(on_button_clicked)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "Button clicked.\n",
-        "54\n"
+        "Button clicked.\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "Button clicked.\n",
-        "55\n"
+        "Button clicked.\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
-        "Button clicked.\n",
-        "56\n"
+        "Button clicked.\n"
        ]
       }
      ],
-     "prompt_number": 6
+     "prompt_number": 5
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Event handlers can also be used to create widgets.  In the example below, clicking a button spawns another button with a description equal to how many times the parent button had been clicked at the time."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
-     "input": [],
-     "language": "python",
-     "metadata": {},
-     "outputs": [
-      {
-       "metadata": {},
-       "output_type": "pyout",
-       "prompt_number": 11,
-       "text": [
-        "{'content': {'data': \"{'parent_header': {}, 'msg_type': u'comm_msg', 'msg_id': u'3DBB06AD83C942DD85DC6477B08F1FBF', 'content': {u'data': {u'method': u'custom', u'custom_content': {u'event': u'click'}}, u'comm_id': u'eea5f11ae7aa473993dd0c81d6016648'}, 'header': {u'username': u'username', u'msg_id': u'3DBB06AD83C942DD85DC6477B08F1FBF', u'msg_type': u'comm_msg', u'session': u'0F6D6BE728DA47A38CFC4BDEACF34FC4'}, 'buffers': [], 'metadata': {}}\\ncustom message {'parent_header': {}, 'msg_type': u'comm_msg', 'msg_id': u'3DBB06AD83C942DD85DC6477B08F1FBF', 'content': {u'data': {u'method': u'custom', u'custom_content': {u'event': u'click'}}, u'comm_id': u'eea5f11ae7aa473993dd0c81d6016648'}, 'header': {u'username': u'username', u'msg_id': u'3DBB06AD83C942DD85DC6477B08F1FBF', u'msg_type': u'comm_msg', u'session': u'0F6D6BE728DA47A38CFC4BDEACF34FC4'}, 'buffers': [], 'metadata': {}}\\nhandling click\\n{u'event': u'click'}\\nButton clicked.\\n2\\n\",\n",
-        "  'name': 'stdout'},\n",
-        " 'header': {'msg_id': 'd9dc144a-d86c-42c1-8bab-f8a6bc525723',\n",
-        "  'msg_type': 'stream',\n",
-        "  'session': '9b9408d8-7420-4e0c-976d-cdda9f8d2564',\n",
-        "  'username': 'kernel'},\n",
-        " 'metadata': {},\n",
-        " 'msg_id': 'd9dc144a-d86c-42c1-8bab-f8a6bc525723',\n",
-        " 'msg_type': 'stream',\n",
-        " 'parent_header': {'msg_id': '3DBB06AD83C942DD85DC6477B08F1FBF',\n",
-        "  'msg_type': 'comm_msg',\n",
-        "  'session': '0F6D6BE728DA47A38CFC4BDEACF34FC4',\n",
-        "  'username': 'username'}}"
-       ]
-      }
-     ],
-     "prompt_number": 11
-    },
-    {
-     "cell_type": "code",
-     "collapsed": false,
      "input": [
-      "def show_button(sender=None):\n",
+      "def show_button(sender):\n",
       "    button = widgets.ButtonWidget()\n",
       "    button.clicks = 0\n",
-      "    if sender is None:\n",
-      "        button.description = \"0\"\n",
-      "    else:\n",
-      "        sender.clicks += 1\n",
-      "        button.description = \"%d\" % sender.clicks\n",
+      "    sender.clicks += 1\n",
+      "    button.description = \"%d\" % sender.clicks\n",
       "    display(button)\n",
       "    button.on_click(show_button)\n",
-      "show_button()\n",
+      "button = widgets.ButtonWidget(description = \"Start\")\n",
+      "button.clicks = 0\n",
+      "display(button)\n",
+      "button.on_click(show_button)\n",
       "    "
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
-     "prompt_number": 7
-    },
-    {
-     "cell_type": "code",
-     "collapsed": false,
-     "input": [],
-     "language": "python",
-     "metadata": {},
-     "outputs": []
+     "prompt_number": 6
     }
    ],
    "metadata": {}
   }
  ]
 }
  No newline at end of file

examples/widgets/Part 3 - Placement.ipynb

@@ -1,329 +1,336 b''
 {
  "metadata": {
   "cell_tags": [
    [
     "<None>",
     null
    ]
   ],
   "name": ""
  },
  "nbformat": 3,
  "nbformat_minor": 0,
  "worksheets": [
   {
    "cells": [
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "\n",
-      "\n",
-      "\n",
       "from IPython.html import widgets # Widget definitions\n",
       "from IPython.display import display # Used to display widgets in the notebook"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 1
     },
     {
      "cell_type": "heading",
      "level": 1,
      "metadata": {},
      "source": [
       "Parent/Child Relationships"
      ]
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "To display widget A inside widget B, widget A must be a child of widget B.  With IPython widgets, the widgets are instances that live in the back-end (usally Python).  There can be multiple views displayed in the front-end that represent one widget in the backend.  Each view can be displayed at a different time, or even displayed two or more times in the same output.   Because of this, the parent of a widget can only be set before the widget has been displayed.\n",
+      "To display widget A inside widget B, widget A must be a child of widget B.  With IPython widgets, the widgets are instances that live in the back-end (usally Python).  There can be multiple views displayed in the front-end that represent one widget in the backend.  Each view can be displayed at a different time.  Only one instance of any particular model can be child of another.  In other words, *widget A* cannot have *widget B* listed twice in it's children list.\n",
       "\n",
-      "Every widget has a `parent` property.  This property can be set via a kwarg in the widget's constructor or after construction, but before display.  Calling display on an object with children automatically displays those children too (as seen below)."
+      "Widgets that can contain other widgets have a `children` property.  This property can be set via a kwarg in the widget's constructor or after construction.  Calling display on an object with children automatically displays those children too (as seen below)."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
+      "floatrange = widgets.FloatSliderWidget() # You can set the parent in the constructor,\n",
       "\n",
-      "floatrange = widgets.FloatRangeWidget() # You can set the parent in the constructor,\n",
-      "\n",
-      "string = widgets.StringWidget(value='hi')\n",
+      "string = widgets.TextBocWidget(value='hi')\n",
       "container = widgets.ContainerWidget(children=[floatrange, string])\n",
       "\n",
       "display(container) # Displays the `container` and all of it's children."
      ],
      "language": "python",
      "metadata": {},
-     "outputs": [],
-     "prompt_number": 2
+     "outputs": [
+      {
+       "ename": "AttributeError",
+       "evalue": "'module' object has no attribute 'TextBocWidget'",
+       "output_type": "pyerr",
+       "traceback": [
+        "\u001b[1;31m---------------------------------------------------------------------------\u001b[0m\n\u001b[1;31mAttributeError\u001b[0m                            Traceback (most recent call last)",
+        "\u001b[1;32m<ipython-input-4-085d43fdae3d>\u001b[0m in \u001b[0;36m<module>\u001b[1;34m()\u001b[0m\n\u001b[0;32m      1\u001b[0m \u001b[0mfloatrange\u001b[0m \u001b[1;33m=\u001b[0m \u001b[0mwidgets\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mFloatSliderWidget\u001b[0m\u001b[1;33m(\u001b[0m\u001b[1;33m)\u001b[0m \u001b[1;31m# You can set the parent in the constructor,\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m      2\u001b[0m \u001b[1;33m\u001b[0m\u001b[0m\n\u001b[1;32m----> 3\u001b[1;33m \u001b[0mstring\u001b[0m \u001b[1;33m=\u001b[0m \u001b[0mwidgets\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mTextBocWidget\u001b[0m\u001b[1;33m(\u001b[0m\u001b[0mvalue\u001b[0m\u001b[1;33m=\u001b[0m\u001b[1;34m'hi'\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0m\u001b[0;32m      4\u001b[0m \u001b[0mcontainer\u001b[0m \u001b[1;33m=\u001b[0m \u001b[0mwidgets\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mContainerWidget\u001b[0m\u001b[1;33m(\u001b[0m\u001b[0mchildren\u001b[0m\u001b[1;33m=\u001b[0m\u001b[1;33m[\u001b[0m\u001b[0mfloatrange\u001b[0m\u001b[1;33m,\u001b[0m \u001b[0mstring\u001b[0m\u001b[1;33m]\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m      5\u001b[0m \u001b[1;33m\u001b[0m\u001b[0m\n",
+        "\u001b[1;31mAttributeError\u001b[0m: 'module' object has no attribute 'TextBocWidget'"
+       ]
+      }
+     ],
+     "prompt_number": 4
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Children can also be added to parents after the parent has been displayed.  If the children are added after the parent has already been displayed, the children must be displayed themselves.\n",
       "\n",
       "In the example below, the IntRangeWidget is never rendered since display was called on the parent before the parent/child relationship was established."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "intrange = widgets.IntRangeWidget() # Never gets displayed.\n",
       "container = widgets.MulticontainerWidget(children=[intrange])\n",
       "\n",
       "display(container)\n"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 5
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Calling display on the child fixes the problem."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "container = widgets.MulticontainerWidget()\n",
       "display(container)\n",
       "\n",
       "intrange = widgets.IntRangeWidget(parent=container)\n",
       "display(intrange) # This line is needed since the `container` has already been displayed."
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 4
     },
     {
      "cell_type": "heading",
      "level": 1,
      "metadata": {},
      "source": [
       "Changing Child Views"
      ]
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "The view used to display a widget must defined by the time the widget is displayed.  If children widgets are to be displayed along with the parent in one call, their `view_name`s can't be set since all of the widgets are sharing the same display call.  Instead, their `default_view_name`s must be set (as seen below)."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "\n",
       "floatrange = widgets.FloatRangeWidget()\n",
       "floatrange.default_view_name = \"FloatTextView\" # It can be set as a property.\n",
       "\n",
       "string = widgets.StringWidget(default_view_name = \"TextAreaView\") # It can also be set in the constructor.\n",
       "container = widgets.MulticontainerWidget(children=[floatrange, string])\n",
       "display(container)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 6
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "However, if the children are displayed after the parent, their `view_name` can also be set like normal.  Both methods will work.  The code below produces the same output as the code above."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "container = widgets.MulticontainerWidget()\n",
       "display(container)\n",
       "\n",
       "floatrange = widgets.FloatRangeWidget()\n",
       "floatrange.parent=container\n",
       "display(floatrange, view_name = \"FloatTextView\") # view_name can be set during display.\n",
       "\n",
       "string = widgets.StringWidget()\n",
       "string.parent = container\n",
       "string.default_view_name = \"TextAreaView\" # Setting default_view_name still works.\n",
       "display(string)\n"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 6
     },
     {
      "cell_type": "heading",
      "level": 1,
      "metadata": {},
      "source": [
       "Visibility"
      ]
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Sometimes it's necessary to hide/show widget views in place, without ruining the order that they have been displayed on the page.  Using the `display` method, the views are always added to the end of their respective containers.  Instead the `visibility` property of widgets can be used to hide/show widgets that have already been displayed (as seen below)."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "string = widgets.StringWidget(value=\"Hello World!\")\n",
       "display(string, view_name=\"HTMLView\") "
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 7
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "string.visible=False"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 8
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "string.visible=True"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 9
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "In the example below, a form is rendered which conditionally displays widgets depending on the state of other widgets.  Try toggling the student checkbox."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "form = widgets.ContainerWidget()\n",
       "first = widgets.StringWidget(description=\"First Name:\")\n",
       "last = widgets.StringWidget(description=\"Last Name:\")\n",
       "\n",
       "student = widgets.BoolWidget(description=\"Student:\", value=False)\n",
       "form.children=[first, last, student]\n",
       "display(form)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 2
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "form = widgets.ContainerWidget()\n",
       "first = widgets.StringWidget(description=\"First Name:\")\n",
       "last = widgets.StringWidget(description=\"Last Name:\")\n",
       "\n",
       "student = widgets.BoolWidget(description=\"Student:\", value=False)\n",
       "school_info = widgets.ContainerWidget(visible=False, children=[\n",
       "    widgets.StringWidget(description=\"School:\"),\n",
       "    widgets.IntRangeWidget(description=\"Grade:\", min=0, max=12, default_view_name='IntTextView')\n",
       "    ])\n",
       "\n",
       "pet = widgets.StringWidget(description=\"Pet's Name:\")\n",
       "form.children = [first, last, student, school_info, pet]\n",
       "display(form)\n",
       "\n",
       "def on_student_toggle(name, value):\n",
       "    print value\n",
       "    if value:\n",
       "        school_info.visible = True\n",
       "    else:\n",
       "        school_info.visible = False\n",
       "student.on_trait_change(on_student_toggle, 'value')\n"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "True\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "False\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "True\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "False\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "True\n"
        ]
       },
       {
        "output_type": "stream",
        "stream": "stdout",
        "text": [
         "False\n"
        ]
       }
      ],
      "prompt_number": 2
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [],
      "language": "python",
      "metadata": {},
      "outputs": []
     }
    ],
    "metadata": {}
   }
  ]
 }
  No newline at end of file