zim.plugins.tasklist.indexer.TasksIndexer

class documentation

class TasksIndexer(IndexerBase): (source)

Indexer that gets added to the Index to keep track of tasks in the database

Class Method	`new_from_index`	Undocumented
Method	`__init__`	Undocumented
Method	`on_page_changed`	Undocumented
Method	`on_page_row_deleted`	Undocumented
Constant	`INIT_SCRIPT`	Undocumented
Constant	`PLUGIN_DB_FORMAT`	Undocumented
Constant	`PLUGIN_NAME`	Undocumented
Constant	`TEARDOWN_SCRIPT`	Undocumented
Class Variable	`__signals__`	Undocumented
Instance Variable	`excluded_subtrees`	Undocumented
Instance Variable	`included_subtrees`	Undocumented
Instance Variable	`integrate_with_journal`	Undocumented
Instance Variable	`parser`	Undocumented
Method	`_insert_tasks`	Undocumented

Inherited from IndexerBase:

Method	`is_uptodate`	Undocumented
Method	`update`	Undocumented
Method	`update_iter`	Undocumented
Instance Variable	`db`	Undocumented

Inherited from SignalEmitter (via IndexerBase):

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

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 new_from_index(cls, index, properties): (source)

Undocumented

def __init__(self, db, pagesindexer, properties): (source)

overrides zim.notebook.index.base.IndexerBase.__init__

Undocumented

def on_page_changed(self, o, row, doc): (source)

Undocumented

def on_page_row_deleted(self, o, row): (source)

Undocumented

INIT_SCRIPT = (source)

Undocumented

Value

'''
\t\tCREATE TABLE IF NOT EXISTS tasklist (
\t\t\tid INTEGER PRIMARY KEY,
\t\t\tsource INTEGER,
\t\t\tparent INTEGER,
\t\t\thaschildren BOOLEAN,
\t\t\thasopenchildren BOOLEAN,
...

PLUGIN_DB_FORMAT: str = (source)

Undocumented

Value

'0.9'

PLUGIN_NAME: str = (source)

Undocumented

Value

'tasklist'

TEARDOWN_SCRIPT = (source)

Undocumented

Value

'''
\t\tDROP TABLE IF EXISTS "tasklist";
\t\tDELETE FROM zim_index WHERE key = %r;
\t'''%PLUGIN_NAME

__signals__: dict[str, tuple] = (source)

overrides zim.notebook.index.base.IndexerBase.__signals__

Undocumented

excluded_subtrees = (source)

Undocumented

included_subtrees = (source)

Undocumented

integrate_with_journal = (source)

Undocumented

parser = (source)

Undocumented

def _insert_tasks(self, db, pageid, parentid, tasks): (source)

Undocumented