zim.gui.insertedobjects.UnknownInsertedImageObject

class documentation

class UnknownInsertedImageObject(InsertedObjectType): (source)

Undocumented

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	`model_from_data`	Returns a model for the object
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

Inherited from InsertedObjectType:

Method	`__init__`	Undocumented
Method	`format`	Format the object using a specific output format Intended to improve rendering of the object on exporting.
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)`
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

def create_widget(self, model): (source)

overrides zim.insertedobjects.InsertedObjectType.create_widget

Return a Gtk widget for the given model

Parameters
model	an object created with `model_from_data()`
Returns
a Gtk widget object derived from `InsertedObjectWidget`

def data_from_model(self, model): (source)

overrides zim.insertedobjects.InsertedObjectType.data_from_model

Returns the object data for a model object This method is used to serialize the model object back into a form that can be handled when parsing wiki content.

Parameters
model	an object created with `model_from_data()`
Returns
a 2-tuple `(attrib, data)`

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

overrides zim.insertedobjects.InsertedObjectType.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

def parse_attrib(self, attrib): (source)

overrides zim.insertedobjects.InsertedObjectType.parse_attrib

Convenience method to enforce the supported attributes and their types.

Returns
a `ConfigDict` using the `object_attr` dict as definition

is_inline: bool = (source)

overrides zim.insertedobjects.InsertedObjectType.is_inline

Undocumented

label = (source)

overrides zim.insertedobjects.InsertedObjectType.label

Undocumented

name: str = (source)

overrides zim.insertedobjects.InsertedObjectType.name

Undocumented