zim.plugins.tasklist.indexer.AllTasks

class documentation

class AllTasks(IndexView): (source)

Database "view" that shows tasks that are indexed

Method	`__init__`	Undocumented
Method	`__iter__`	Undocumented
Method	`count_labels_and_tags_pages`	No summary
Method	`get_path`	Get the `Path` for the source of a task @param task: the task (as returned by `list_tasks()` @returns: an `IndexPath` object
Method	`get_task`	Undocumented
Method	`list_tasks`	No summary
Method	`set_status_included`	Undocumented
Constant	`STYLE`	Undocumented
Instance Variable	`status`	Undocumented
Method	`_count_rows`	Undocumented
Class Variable	`_include_not_started`	Undocumented
Class Variable	`_sql_filter`	Undocumented
Instance Variable	`_pages`	Undocumented
Instance Variable	`_status_sql`	Undocumented

Inherited from IndexView:

Class Method	`new_from_index`	Undocumented
Instance Variable	`db`	Undocumented

def __init__(self, db): (source)

overrides zim.notebook.index.base.IndexView.__init__

Undocumented

def __iter__(self): (source)

Undocumented

def count_labels_and_tags_pages(self, task_labels, intersect=None): (source)

Get mapping with count of the tasks with given label or tag

Parameters
task_labels	list of task labels to be parsed
intersect	2-tuple of labels and tags already selected, will return count based on intersecting with this selection
Returns
3 maps, one for label count, one for tag count and one for pagenames

def get_path(self, task): (source)

Get the Path for the source of a task

Parameters
task	the task (as returned by `list_tasks()`
Returns
an `IndexPath` object

def get_task(self, taskid): (source)

Undocumented

def list_tasks(self, parent=None, _sql_filter=None, _include_not_started=None): (source)

overridden in zim.plugins.tasklist.indexer.ActiveTasks, zim.plugins.tasklist.indexer.OpenProjectsTasks

List tasks

Parameters
parent	the parent task (as returned by this method) or `None` to list all top level tasks
_sql_filter	sql snippet, defaults to class attribute - private param used by sub-classes, do not use elsewhere
_include_not_started	boolean, defaults to class attribute - private param used by sub-classes, do not use elsewhere
Returns
a iterator of tasks at this level as sqlite Row objects

def set_status_included(self, *status): (source)

overridden in zim.plugins.tasklist.indexer.ActiveTasks, zim.plugins.tasklist.indexer.WaitingTasks

Undocumented

STYLE: str = (source)

overridden in zim.plugins.tasklist.indexer.InboxTasks, zim.plugins.tasklist.indexer.WaitingTasks

Undocumented

Value

'default'

Undocumented

def _count_rows(self, parent, tag_filter_func, label_filter_func, task_label_re, labels, tags, pages): (source)

Undocumented

_include_not_started: bool = (source)

overridden in zim.plugins.tasklist.indexer.ActiveTasks

Undocumented

_sql_filter: str = (source)

overridden in zim.plugins.tasklist.indexer.WaitingTasks

Undocumented

Undocumented

_status_sql = (source)

overridden in zim.plugins.tasklist.indexer.WaitingTasks

Undocumented