class documentation

class NotebookExtension(ExtensionBase): (source)

View In Hierarchy

Base class for extending the notebook
Method __init__ Constructor @param plugin: the plugin object to which this extension belongs @param obj: the object being extended
Instance Variable notebook the Notebook object

Inherited from ExtensionBase:

Method destroy Called when the plugin is being destroyed Calls teardown() followed by the teardown() methods of parent base classes.
Method teardown No summary
Class Variable __signals__ Undocumented
Instance Variable obj the extendable object
Instance Variable plugin the plugin object to which this extension belongs

Inherited from SignalEmitter (via ExtensionBase):

Method __new__ Undocumented
Method block_signals Returns a context manager for blocking one or more signals
Method connect Register a handler for a specific object.
Method connect_after Like connect() but handler will be called after default handler
Method disconnect Undocumented
Method emit Undocumented
Method emit_return_first Emits a signal and stops emission on the first handler that returns a not-None value.
Method emit_return_iter Returns an generator that calls one handler on each iteration and yields the return values. This allows aggregating return values.
Method _connect Undocumented
Method _setup_signal Undocumented
Method _teardown_signal Undocumented

Inherited from ConnectorMixin (via ExtensionBase):

Method connectto Connect to signals of another object E.g.:
Method connectto_all Convenience method to combine multiple calls to connectto().
Method disconnect_all Disconnect all signals that have been connected with connectto and friends. Typically called when you want to destroy this object.
Method disconnect_from Disc all signals that have been connected with connectto and friends to a specific object.
Method _disconnect_from Undocumented
Instance Variable _connected_signals Undocumented
def __init__(self, plugin, notebook): (source)
Constructor
Parameters
pluginthe plugin object to which this extension belongs
notebookUndocumented
objthe object being extended
notebook = (source)
the Notebook object