class documentation

class ToCPageViewExtension(PageViewExtension): (source)

View In Hierarchy

Undocumented

Method __init__ Constructor @param plugin: the plugin object to which this extension belongs @param obj: the object being extended
Method on_preferences_changed Undocumented
Instance Variable tocwidget Undocumented

Inherited from PageViewExtensionBase (via PageViewExtension):

Method add_sidepane_widget Undocumented
Method remove_sidepane_widget Undocumented
Method teardown No summary
Instance Variable navigation Undocumented
Instance Variable pageview Undocumented
Instance Variable uistate Undocumented
Instance Variable _sidepane_widgets Undocumented
Instance Variable _window Undocumented

Inherited from ActionExtensionBase (via PageViewExtension, PageViewExtensionBase):

Method add_to_headerbar Undocumented
Method remove_from_headerbar Undocumented
Method set_action_in_headerbar Undocumented
Instance Variable actiongroup Undocumented
Static Method _uimanager_xml Undocumented
Method _add_actions Undocumented
Instance Variable _uimanager Undocumented
Instance Variable _uimanager_ids Undocumented

Inherited from ExtensionBase (via PageViewExtension, PageViewExtensionBase, ActionExtensionBase):

Method destroy Called when the plugin is being destroyed Calls teardown() followed by the teardown() methods of parent base classes.
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 PageViewExtension, PageViewExtensionBase, ActionExtensionBase, 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 PageViewExtension, PageViewExtensionBase, ActionExtensionBase, 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, pageview): (source)
Constructor
Parameters
pluginthe plugin object to which this extension belongs
pageviewUndocumented
objthe object being extended
def on_preferences_changed(self, preferences): (source)

Undocumented

tocwidget = (source)

Undocumented