upstream/ipython Files · IPython/html/widgets/widget_bool.py

Added some nice comments,...

Added some nice comments, so devs can easily figure out what options to pass into the objects they want to construct.

Maximilian Albert - - Load All Authors

File last commit:

r16376:7cc6a1ea


                r17211:beb15f5e

Download file

             widget_bool.py
        
                    34 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html / widgets / widget_bool.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """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 DOMWidget

      from IPython.utils.traitlets import Unicode, Bool

      #-----------------------------------------------------------------------------

      # Classes

      #-----------------------------------------------------------------------------

      class _BoolWidget(DOMWidget):

          value = Bool(False, help="Bool value", sync=True)

          description = Unicode('', help="Description of the boolean (label).", sync=True) 

          disabled = Bool(False, help="Enable or disable user changes.", sync=True)

      class CheckboxWidget(_BoolWidget):

          _view_name = Unicode('CheckboxView', sync=True)

      class ToggleButtonWidget(_BoolWidget):

          _view_name = Unicode('ToggleButtonView', sync=True)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				"""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 DOMWidget
				from IPython.utils.traitlets import Unicode, Bool

				#-----------------------------------------------------------------------------
				# Classes
				#-----------------------------------------------------------------------------
				class _BoolWidget(DOMWidget):
				value = Bool(False, help="Bool value", sync=True)
				description = Unicode('', help="Description of the boolean (label).", sync=True)
				disabled = Bool(False, help="Enable or disable user changes.", sync=True)


				class CheckboxWidget(_BoolWidget):
				_view_name = Unicode('CheckboxView', sync=True)


				class ToggleButtonWidget(_BoolWidget):
				_view_name = Unicode('ToggleButtonView', sync=True)