zim.notebook.index.files.FilesIndexer

class documentation

class FilesIndexer(SignalEmitter): (source)

Class that will update the "files" table in the index based on changes seen on the file system.

Unknown Field: signal
`file-row-inserted (row, file)`: on new file found
`file-row-changed (row, file)`: on file content changed
`file-row-deleted (row)`: on file deleted

Method	`__init__`	Undocumented
Method	`delete_file`	Undocumented
Method	`delete_folder`	Undocumented
Method	`interactive_add_file`	Undocumented
Method	`interactive_add_folder`	Undocumented
Method	`is_uptodate`	Undocumented
Method	`set_node_uptodate`	Undocumented
Method	`update_file`	Undocumented
Method	`update_folder`	Undocumented
Method	`update_iter`	Generator function for the actual update
Class Variable	`__signals__`	Undocumented
Instance Variable	`db`	Undocumented
Instance Variable	`folder`	Undocumented
Method	`_add_parent`	Undocumented
Method	`_update_iter_inner`	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 __init__(self, db, folder): (source)

Undocumented

def delete_file(self, node_id): (source)

Undocumented

def delete_folder(self, node_id): (source)

Undocumented

def interactive_add_file(self, file): (source)

Undocumented

def interactive_add_folder(self, folder): (source)

Undocumented

def is_uptodate(self): (source)

Undocumented

def set_node_uptodate(self, node_id, mtime): (source)

Undocumented

def update_file(self, node_id, file): (source)

Undocumented

def update_folder(self, node_id, folder): (source)

Undocumented

def update_iter(self): (source)

Generator function for the actual update

__signals__ = (source)

overrides zim.signals.SignalEmitter.__signals__

Undocumented

Undocumented

Undocumented

def _add_parent(self, folder): (source)

Undocumented

def _update_iter_inner(self, prefix=''): (source)

Undocumented