ToggleGo¶
-
class
reducer.gui.
ToggleGo
(*args, **kwd)[source]¶ Bases:
reducer.gui.ToggleContainer
ToggleContainer whose state is linked to a button.
The intent is for that button to be activated when the contents of the container are in a “sane” state.
Attributes
border
container
Widget that contains the elements controlled by the toggle. cross_validation_lock
A contextmanager for running a block with our cross validation lock set to True. disabled
True if widget is disabled. height
is_sane
margin
model_id
Gets the model id of this widget. padding
progress_bar
toggle
Toggle widget that controls other display elements. width
Methods
action
()The default action is to invoke the action of each child with an update of the progress bar along the way. add_child
(child)Append a child to the container part of the widget. add_class
(className)Adds a class to the top level element of the widget. add_traits
(**traits)Dynamically add trait attributes to the Widget. class_config_rst_doc
()Generate rST documentation for this class’ config options. class_config_section
()Get the config class config section class_get_help
([inst])Get the help string for this class in ReST format. class_get_trait_help
(trait[, inst])Get the help string for a single trait. class_own_trait_events
(name)Get a dict of all event handlers defined on this class, not a parent. class_own_traits
(**metadata)Get a dict of all the traitlets defined on this class, not a parent. class_print_help
([inst])Get the help string for a single trait and print it. class_trait_names
(**metadata)Get a list of all the names of this class’ traits. class_traits
(**metadata)Get a dict
of all the traits of this class.close
()Close method. display
()Display and format this widget. format
()Format the widget; must be invoked after displaying the widget. get_state
([key])Gets the widget state, or a piece of it. go
()Returns the action to be taken when the “Go” button is clicked. handle_comm_opened
(comm, msg)Static method, called when a widget is constructed. has_trait
(name)Returns True if the object has a trait with the specified name. hold_sync
(*args, **kwds)Hold syncing any state until the outermost context manager exits hold_trait_notifications
(*args, **kwds)Context manager for bundling trait change notifications and cross validation. notify_change
(change)Called when a property has changed. observe
(handler[, names, type])Setup a handler to be called when a trait changes. on_displayed
(callback[, remove])(Un)Register a widget displayed callback. on_msg
(callback[, remove])(Un)Register a custom msg receive callback. on_trait_change
([handler, name, remove])DEPRECATED: Setup a handler to be called when a trait changes. on_widget_constructed
(callback)Registers a callback to be called when a widget is constructed. open
()Open a comm to the frontend if one isn’t already open. remove_class
(className)Removes a class from the top level element of the widget. section_names
()return section names as a list send
(content[, buffers])Sends a custom msg to the widget model in the front-end. send_state
([key])Sends the widget state, or a piece of it, to the front-end. set_state
(sync_data)Called when a state is received from the front-end. set_trait
(name, value)Forcibly sets trait attribute, including read-only attributes. setup_instance
(*args, **kwargs)state_change_handler
()Ties sanity state to go button controls and others trait_events
([name])Get a dict
of all the event handlers of this class.trait_metadata
(traitname, key[, default])Get metadata values for trait by key. trait_names
(**metadata)Get a list of all the names of this class’ traits. traits
(**metadata)Get a dict
of all the traits of this class.unlock
()Handler for the unlock button. unobserve
(handler[, names, type])Remove a trait change handler. unobserve_all
([name])Remove trait change handlers of any type for the specified name. update_config
(config)Update config and load the new values Attributes Summary
is_sane
progress_bar
Methods Summary
action
()The default action is to invoke the action of each child with an update of the progress bar along the way. format
()Format the widget; must be invoked after displaying the widget. go
()Returns the action to be taken when the “Go” button is clicked. state_change_handler
()Ties sanity state to go button controls and others unlock
()Handler for the unlock button. Attributes Documentation
-
is_sane
¶
-
progress_bar
¶
Methods Documentation
-