class documentation

class IndexerBase(SignalEmitter, ConnectorMixin): (source)

Known subclasses: zim.notebook.index.links.LinksIndexer, zim.notebook.index.pages.PagesIndexer, zim.notebook.index.tags.TagsIndexer, zim.plugins.tasklist.indexer.TasksIndexer

View In Hierarchy

Base class for "content indexer" objects. It defines the callback functions that are calls from PagesIndexer
Method __init__ Undocumented
Method is_uptodate Undocumented
Method update Undocumented
Method update_iter Undocumented
Class Variable __signals__ Undocumented
Instance Variable db Undocumented

Inherited from SignalEmitter:

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:

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 is_uptodate(self): (source)

Undocumented

def update(self): (source)

Undocumented

Undocumented