zim.notebook.operations.NotebookOperation

class documentation

class NotebookOperation(SignalEmitter): (source)

Known subclasses: zim.notebook.index.IndexUpdateOperation, zim.notebook.operations.SimpleAsyncOperation

Method	`__call__`	This method is called when another operation tries to start while we are running. When called either finish quickly or raise `NotebookOperationOngoing`.
Method	`__init__`	No summary
Method	`__iter__`	Undocumented
Method	`cancel`	Undocumented
Method	`is_running`	Undocumented
Method	`run_on_idle`	Start the operation by setting up the main loop event handler.
Method	`wait`	Undocumented
Class Variable	`__signals__`	Undocumented
Instance Variable	`cancelled`	Undocumented
Instance Variable	`exception`	Undocumented
Instance Variable	`finished`	Undocumented
Instance Variable	`message`	Undocumented
Instance Variable	`notebook`	Undocumented
Method	`_start`	Undocumented
Instance Variable	`_block`	Undocumented
Instance Variable	`_do_work`	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)

overridden in zim.notebook.operations.SimpleAsyncOperation

This method is called when another operation tries to start while we are running. When called either finish quickly or raise NotebookOperationOngoing.

def __init__(self, notebook, message, iterator): (source)

overridden in zim.notebook.index.IndexUpdateOperation, zim.notebook.operations.SimpleAsyncOperation

Constructor

Parameters
notebook	the `Notebook` object
message	a message string for `NotebookOperationOngoing` errors and for the heading of progress dialogs
iterator	iterator that yields for chunks of work

def __iter__(self): (source)

Undocumented

def cancel(self): (source)

overridden in zim.notebook.operations.SimpleAsyncOperation

Undocumented

def is_running(self): (source)

Undocumented

def run_on_idle(self): (source)

Start the operation by setting up the main loop event handler.

May raise NotebookOperationOngoing if another operation is already ongoing.

def wait(self): (source)

overridden in zim.notebook.operations.SimpleAsyncOperation

Undocumented

__signals__ = (source)

overrides zim.signals.SignalEmitter.__signals__

Undocumented

cancelled: bool = (source)

Undocumented

exception = (source)

Undocumented

finished: bool = (source)

Undocumented

message = (source)

Undocumented

notebook = (source)

Undocumented

def _start(self): (source)

Undocumented

_block: bool = (source)

Undocumented

_do_work = (source)

Undocumented