class documentation

class VersionControlPlugin(PluginClass): (source)

View In Hierarchy

Undocumented

Class Method check_dependencies Checks what dependencies are met and gives details for display in the preferences dialog
Class Variable plugin_info Undocumented
Class Variable plugin_preferences Undocumented

Inherited from PluginClass:

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_notebook_properties 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 (via PluginClass):

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)
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.
plugin_info = (source)

Undocumented

plugin_preferences = (source)