zim.notebook.index.IndexUpdateIter

class documentation

class IndexUpdateIter(SignalEmitter): (source)

View In Hierarchy

Undocumented

Method __call__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method add_indexer Undocumented
Method check_and_update Convenience method to do a full update and check at once
Method check_and_update_iter Undocumented
Method get_indexer Undocumented
Method is_uptodate Undocumented
Method partial_update_iter Like update_iter() but omits checking new files
Method remove_indexer Undocumented
Method update Convenience method to do a full update at once
Class Variable __signals__ Undocumented
Instance Variable db Undocumented
Instance Variable files Undocumented
Instance Variable layout Undocumented
Instance Variable links Undocumented
Instance Variable pages Undocumented
Instance Variable tags Undocumented
Instance Variable _indexers 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
def __call__(self): (source)

Undocumented

def __init__(self, db, layout): (source)

Undocumented

def __iter__(self): (source)

Undocumented

def add_indexer(self, indexer): (source)

Undocumented

def check_and_update(self, file=None): (source)
Convenience method to do a full update and check at once
def check_and_update_iter(self, file=None): (source)

Undocumented

def get_indexer(self, cls): (source)

Undocumented

def is_uptodate(self): (source)

Undocumented

def partial_update_iter(self): (source)
Like update_iter() but omits checking new files
def remove_indexer(self, indexer): (source)

Undocumented

def update(self): (source)
Convenience method to do a full update at once
__signals__: dict[str, tuple] = (source)
overrides zim.signals.SignalEmitter.__signals__

Undocumented

db = (source)

Undocumented

files = (source)

Undocumented

layout = (source)

Undocumented

links = (source)

Undocumented

pages = (source)

Undocumented

tags = (source)

Undocumented

_indexers = (source)

Undocumented