zim.plugins.base.imagegenerator.BackwardImageGeneratorObjectType

class documentation

class BackwardImageGeneratorObjectType(ImageGeneratorObjectType): (source)

Known subclasses: zim.plugins.diagrameditor.BackwardDiagramImageObjectType, zim.plugins.ditaaeditor.BackwardDitaaImageObjectType, zim.plugins.equationeditor.BackwardEquationImageObjectType, zim.plugins.gnu_r_ploteditor.BackwardGnuRPlotImageObjectType, zim.plugins.gnuplot_ploteditor.BackwardGnuplotImageObjectType, zim.plugins.scoreeditor.BackwardScoreImageObjectType, zim.plugins.sequencediagrameditor.BackwardSequenceDiagramImageObjectType

View In Hierarchy

Base class for backward compatible image generator objects.

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
Class Variable	`imagefile_extension`	Undocumented
Class Variable	`is_inline`	Undocumented
Class Variable	`object_attr`	Undocumented
Class Variable	`scriptname`	Undocumented

Inherited from ImageGeneratorObjectType:

Method	`__init__`	Constructor @param plugin: the plugin object to which this extension belongs @param obj: the object being extended
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	`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()`.
Class Variable	`syntax`	Undocumented
Class Variable	`widget_style`	Undocumented
Instance Variable	`generator_klass`	Undocumented

Inherited from InsertedObjectTypeExtension (via ImageGeneratorObjectType):

Method	`teardown`	No summary
Instance Variable	`_objmap`	Undocumented

Inherited from InsertedObjectType (via ImageGeneratorObjectType, InsertedObjectTypeExtension):

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	`label`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`verb_icon`	Undocumented
Method	`_data_from_model_wrapper`	Undocumented
Method	`_format_wrapper`	Undocumented
Method	`_model_from_data_wrapper`	Undocumented

Inherited from ExtensionBase (via ImageGeneratorObjectType, InsertedObjectTypeExtension):

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 ImageGeneratorObjectType, InsertedObjectTypeExtension, 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 ImageGeneratorObjectType, InsertedObjectTypeExtension, 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 format(self, format, dumper, attrib, data): (source)

overrides zim.insertedobjects.InsertedObjectType.format

Format the object using a specific output format Intended to improve rendering of the object on exporting.

This method should always be robust for missing attributes and body contents. The attrib will automatically be checked by parse_attrib before being given to this method.

Implementing this method is optional, default checks for a specific method per format (e.g. format_html() for the "html" format) and raises ValueError if no such method is defined.

Parameters
format	name of the output format
dumper	`Dumper` object
attrib	dict with object attributes
data	string with object content
Returns
a list of strings
Raises
`ValueError`	if no specific formatting for "format" is available

def model_from_data(self, notebook, page, attrib, data): (source)

overrides zim.plugins.base.imagegenerator.ImageGeneratorObjectType.model_from_data

Returns a model for the object

The main purpose for the model is that it is shared between widgets that show the same object. See e.g. Gtk.TextBuffer or Gtk.TreeModel for examples.

No API is expected of the model object other than that it can be used as argument for create_widget() and data_from_model() and a "changed" signal that should be emitted when the content has changed, so the pageview knows that the page has changed and should be saved before closing.

Since the model is specific for the page where the object occurs, any user of the object type should serialize back to data before e.g. copying the object to a different page.

This method should always be robust for missing attributes and body contents. The attrib will automatically be checked by parse_attrib before being given to this method.

Parameters
notebook	a `Notebook` object
page	a `Page` object for the page where this object occurs
attrib	dict with object attributes
data	string with object content
Returns
a model object

imagefile_extension = (source)

overridden in zim.plugins.diagrameditor.BackwardDiagramImageObjectType, zim.plugins.ditaaeditor.BackwardDitaaImageObjectType, zim.plugins.equationeditor.BackwardEquationImageObjectType, zim.plugins.gnu_r_ploteditor.BackwardGnuRPlotImageObjectType, zim.plugins.gnuplot_ploteditor.BackwardGnuplotImageObjectType, zim.plugins.scoreeditor.BackwardScoreImageObjectType, zim.plugins.sequencediagrameditor.BackwardSequenceDiagramImageObjectType

Undocumented

is_inline: bool = (source)

overrides zim.insertedobjects.InsertedObjectType.is_inline

Undocumented

object_attr = (source)

overrides zim.insertedobjects.InsertedObjectType.object_attr

Undocumented

scriptname = (source)

Undocumented