zim.plugins.PluginClass

class documentation

class PluginClass(ConnectorMixin): (source)

View In Hierarchy

Class Method	`check_dependencies`	Checks what dependencies are met and gives details for display in the preferences dialog
Class Method	`check_dependencies_ok`	Checks minimum dependencies are met
Class Method	`discover_classes`	Yields a list of classes derived from `baseclass` and defined in the same module as the plugin
Class Method	`lookup_subclass`	No summary
Static Method	`form_fields`	Undocumented
Method	`__init__`	Undocumented
Method	`destroy`	Destroy the plugin object and all extensions It is only called when a user actually disables the plugin, not when the application exits.
Method	`notebook_properties`	Undocumented
Method	`teardown`	Cleanup method called by `destroy()`. Can be implemented by sub-classes.
Class Variable	`plugin_info`	Undocumented
Class Variable	`plugin_notebook_properties`	Undocumented
Class Variable	`plugin_preferences`	Undocumented
Instance Variable	`extension_classes`	Undocumented
Instance Variable	`extensions`	Undocumented
Instance Variable	`preferences`	Undocumented
Property	`config_key`	The name of section used in the config files to store the preferences for this plugin.
Static Method	`_init_config`	Undocumented

Inherited from ConnectorMixin:

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

@classmethod
def check_dependencies(klass): (source)

overridden in zim.plugins.diagrameditor.InsertDiagramPlugin, zim.plugins.ditaaeditor.InsertDitaaPlugin, zim.plugins.equationeditor.InsertEquationPlugin, zim.plugins.gnu_r_ploteditor.InsertGNURPlotPlugin, zim.plugins.gnuplot_ploteditor.InsertGnuplotPlugin, zim.plugins.linkmap.LinkMapPlugin, zim.plugins.osx_menubar.OSXmenubarPlugin, zim.plugins.scoreeditor.InsertScorePlugin, zim.plugins.screenshot.InsertScreenshotPlugin, zim.plugins.sequencediagrameditor.InsertSequenceDiagramPlugin, zim.plugins.sourceview.SourceViewPlugin, zim.plugins.spell.SpellPlugin, zim.plugins.trayicon.TrayIconPlugin, zim.plugins.versioncontrol.VersionControlPlugin, zim.plugins.zeitgeist-logger.ZeitgeistPlugin

Checks what dependencies are met and gives details for display in the preferences dialog

Returns
a boolean telling overall dependencies are met, followed by a list with details. This list consists of 3-tuples consisting of a (short) description of the dependency, a boolean for dependency being met, and a boolean for this dependency being optional or not.
Unknown Field: implementation
must be implemented in sub-classes that have one or more (external) dependencies. Default always returns `True` with an empty list.

@classmethod
def check_dependencies_ok(klass): (source)

Checks minimum dependencies are met

Returns
`True` if this plugin can be loaded based on `check_dependencies()`

@classmethod
def discover_classes(pluginklass, baseclass): (source)

Yields a list of classes derived from baseclass and defined in the same module as the plugin

@classmethod
def lookup_subclass(pluginklass, klass): (source)

Returns first subclass of klass found in the module of this plugin. (Similar to zim.utils.lookup_subclass).

Parameters
pluginklass	plugin class
klass	base class of the wanted class

@staticmethod
def form_fields(definitions): (source)

Undocumented

def __init__(self): (source)

overridden in zim.plugins.insertsymbol.InsertSymbolPlugin, zim.plugins.screenshot.InsertScreenshotPlugin, zim.plugins.trayicon.TrayIconPlugin, zim.plugins.zeitgeist-logger.ZeitgeistPlugin

Undocumented

def destroy(self): (source)

Destroy the plugin object and all extensions It is only called when a user actually disables the plugin, not when the application exits.

Destroys all active extensions and disconnects all signals. This should revert any changes the plugin made to the application (although preferences etc. can be left in place).

def notebook_properties(self, notebook): (source)

Undocumented

def teardown(self): (source)

Cleanup method called by destroy(). Can be implemented by sub-classes.

plugin_info: dict = (source)

overridden in zim.plugins.arithmetic.ArithmeticPlugin, zim.plugins.attachmentbrowser.AttachmentBrowserPlugin, zim.plugins.backlinkpane.BackLinksPanePlugin, zim.plugins.bookmarksbar.BookmarksBarPlugin, zim.plugins.commandpalette.CommandPalettePlugin, zim.plugins.diagrameditor.InsertDiagramPlugin, zim.plugins.distractionfree.DistractionFreePlugin, zim.plugins.ditaaeditor.InsertDitaaPlugin, zim.plugins.equationeditor.InsertEquationPlugin, zim.plugins.gnu_r_ploteditor.InsertGNURPlotPlugin, zim.plugins.gnuplot_ploteditor.InsertGnuplotPlugin, zim.plugins.inlinecalculator.InlineCalculatorPlugin, zim.plugins.insertsymbol.InsertSymbolPlugin, zim.plugins.journal.JournalPlugin, zim.plugins.linesorter.LineSorterPlugin, zim.plugins.linkmap.LinkMapPlugin, zim.plugins.osx_menubar.OSXmenubarPlugin, zim.plugins.pageindex.PageIndexPlugin, zim.plugins.pathbar.PathBarPlugin, zim.plugins.printtobrowser.PrintToBrowserPlugin, zim.plugins.quicknote.QuickNotePlugin, zim.plugins.scoreeditor.InsertScorePlugin, zim.plugins.screenshot.InsertScreenshotPlugin, zim.plugins.sequencediagrameditor.InsertSequenceDiagramPlugin, zim.plugins.sourceview.SourceViewPlugin, zim.plugins.spell.SpellPlugin, zim.plugins.tableeditor.TableEditorPlugin, zim.plugins.tableofcontents.ToCPlugin, zim.plugins.tags.TagsPlugin, zim.plugins.tasklist.TaskListPlugin, zim.plugins.toolbar.ToolBarPlugin, zim.plugins.trayicon.TrayIconPlugin, zim.plugins.versioncontrol.VersionControlPlugin, zim.plugins.zeitgeist-logger.ZeitgeistPlugin

Undocumented

plugin_notebook_properties: tuple = (source)

overridden in zim.plugins.journal.JournalPlugin, zim.plugins.spell.SpellPlugin, zim.plugins.tasklist.TaskListPlugin

Undocumented

plugin_preferences: tuple = (source)

overridden in zim.plugins.attachmentbrowser.AttachmentBrowserPlugin, zim.plugins.backlinkpane.BackLinksPanePlugin, zim.plugins.bookmarksbar.BookmarksBarPlugin, zim.plugins.distractionfree.DistractionFreePlugin, zim.plugins.equationeditor.InsertEquationPlugin, zim.plugins.journal.JournalPlugin, zim.plugins.linkmap.LinkMapPlugin, zim.plugins.pageindex.PageIndexPlugin, zim.plugins.scoreeditor.InsertScorePlugin, zim.plugins.screenshot.InsertScreenshotPlugin, zim.plugins.sourceview.SourceViewPlugin, zim.plugins.tableeditor.TableEditorPlugin, zim.plugins.tableofcontents.ToCPlugin, zim.plugins.tags.TagsPlugin, zim.plugins.tasklist.TaskListPlugin, zim.plugins.toolbar.ToolBarPlugin, zim.plugins.trayicon.TrayIconPlugin, zim.plugins.versioncontrol.VersionControlPlugin

Undocumented

extension_classes = (source)

Undocumented

extensions = (source)

Undocumented

preferences = (source)

Undocumented

@classproperty
config_key = (source)

The name of section used in the config files to store the preferences for this plugin.

@staticmethod
def _init_config(config, definitions): (source)

Undocumented