class documentation

class InsertedObjectTypeExtension(InsertedObjectType, ExtensionBase): (source)

Known subclasses: zim.plugins.base.imagegenerator.ImageGeneratorObjectType, zim.plugins.sourceview.SourceViewObjectType, zim.plugins.tableeditor.TableViewObjectType

View In Hierarchy

Undocumented

Method __init__ Constructor @param plugin: the plugin object to which this extension belongs @param obj: the object being extended
Method teardown No summary
Instance Variable _objmap Undocumented

Inherited from InsertedObjectType:

Method create_widget Return a Gtk widget for the given model @param model: an object created with model_from_data() @returns: a Gtk widget object derived from InsertedObjectWidget
Method data_from_model No summary
Method format Format the object using a specific output format Intended to improve rendering of the object on exporting.
Method model_from_data Returns a model for the object
Method new_model_interactive Create a new object model interactively Interactive means that we can use e.g. a dialog to prompt for input. The default behavior is to use new_object().
Method new_object Create a new empty object @returns: a 2-tuple (attrib, data)
Method parse_attrib Convenience method to enforce the supported attributes and their types. @returns: a ConfigDict using the object_attr dict as definition
Class Variable is_inline Undocumented
Class Variable label Undocumented
Class Variable name Undocumented
Class Variable verb_icon Undocumented
Instance Variable object_attr Undocumented
Method _data_from_model_wrapper Undocumented
Method _format_wrapper Undocumented
Method _model_from_data_wrapper Undocumented

Inherited from ExtensionBase:

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 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, objmap): (source)
Constructor
Parameters
pluginthe plugin object to which this extension belongs
objmapUndocumented
objthe object being extended
def teardown(self): (source)
Remove changes made by this class from the extended object To be overloaded by child classes
Note
do not call parent class teardown() here, that is already taken care of by destroy()
_objmap = (source)

Undocumented