plopp.widgets.Checkboxes

class plopp.widgets.Checkboxes(entries, description='', value=True)

Widget providing a list of checkboxes, along with a button to toggle them all.

Parameters:

• entries (list[str]) – List of strings to create the names for the different checkboxes.

• description (str, default: '') – Global description for all the checkboxes.

• value (bool, default: True) – Default value to set all the checkboxes to.

__init__(entries, description='', value=True)

Public constructor

Methods

__init__(entries[, description, value])	Public constructor
add_class(className)	Adds a class to the top level element of the widget.
add_traits(**traits)	Dynamically add trait attributes to the Widget.
blur()	Blur the widget.
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_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.
close_all()
focus()	Focus on the widget.
get_manager_state([drop_defaults, widgets])	Returns the full state for a widget manager for embedding
get_state([key, drop_defaults])	Gets the widget state, or a piece of it.
get_view_spec()
handle_comm_opened(comm, msg)	Static method, called when a widget is constructed.
handle_control_comm_opened(comm, msg)	Class method, called when the comm-open message on the "jupyter.widget.control" comm channel is received
has_trait(name)	Returns True if the object has a trait with the specified name.
hold_sync()	Hold syncing any state until the outermost context manager exits
hold_trait_notifications()	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_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.
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, if it exists.
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(**kwargs)	This is called before self.__init__ is called.
trait_defaults(*names, **metadata)	Return a trait's default value or a dictionary of them
trait_events([name])	Get a dict of all the event handlers of this class.
trait_has_value(name)	Returns True if the specified trait has a value.
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.
trait_values(**metadata)	A dict of trait names and their values.
traits(**metadata)	Get a dict of all the traits of this class.
unobserve(handler[, names, type])	Remove a trait change handler.
unobserve_all([name])	Remove trait change handlers of any type for the specified name.

Attributes

box_style	Use a predefined styling for the box.
children	List of widget children
comm	A trait which allows any value.
cross_validation_lock	A contextmanager for running a block with our cross validation lock set to True.
keys	The traits which are synced.
layout	An instance trait which coerces a dict to an instance.
log	A trait whose value must be an instance of a specified class.
model_id	Gets the model id of this widget.
tabbable	Is widget tabbable?
tooltip	A tooltip caption.
value	Returns a dict containing one entry per checkbox, giving the checkbox's value.
widget_types
widgets