zim.main.GuiCommand

class documentation

class GuiCommand(NotebookCommand, GtkCommand): (source)

Known subclasses: zim.main.ManualCommand

View In Hierarchy

Class implementing the --gui command and run the gtk interface
Method build_notebook No summary
Method run Run the command @raises UsageError: when arguments are not correct @implementation: must be implemented by subclasses
Class Variable arguments Undocumented
Class Variable options Undocumented
Method _present_window Undocumented
Method _run_new_window Undocumented

Inherited from NotebookCommand:

Method get_default_or_only_notebook Helper to get a default notebook
Method get_notebook_argument No summary

Inherited from Command (via NotebookCommand):

Method __init__ Constructor @param command: the command switch (first commandline argument) @param pwd: optional working directory path
Method get_arguments Get the arguments, to be used by the implementation of run() @raises UsageError: when arguments are not correct @returns: tuple of arguments, padded with None to correct length
Method get_options Retrieve a dict with a sub-set of the command options @param names: that options in the subset
Method ignore_options Undocumented
Method parse_options No summary
Class Variable default_options Undocumented
Instance Variable args Undocumented
Instance Variable command Undocumented
Instance Variable opts Undocumented
Instance Variable pwd Undocumented

Inherited from GtkCommand:

Method run_local No summary
Class Variable default_options Undocumented
Property standalone_process Undocumented

Inherited from Command (via GtkCommand):

Method __init__ Constructor @param command: the command switch (first commandline argument) @param pwd: optional working directory path
Method get_arguments Get the arguments, to be used by the implementation of run() @raises UsageError: when arguments are not correct @returns: tuple of arguments, padded with None to correct length
Method get_options Retrieve a dict with a sub-set of the command options @param names: that options in the subset
Method ignore_options Undocumented
Method parse_options No summary
Instance Variable args Undocumented
Instance Variable command Undocumented
Instance Variable opts Undocumented
Instance Variable pwd Undocumented
def build_notebook(self, ensure_uptodate=False): (source)
overrides zim.main.NotebookCommand.build_notebook
Get the Notebook object for this command Tries to automount the file location if needed.
Parameters
ensure_uptodateif True index is updated when needed. Only set to False when index update is handled explicitly (e.g. in the main gui).
Returns
a Notebook object and a Path object or None
Raises
NotebookLookupErrorif the notebook could not be resolved or is not given
FileNotFoundErrorif the notebook location does not exist and could not be mounted.
def run(self): (source)
overrides zim.main.command.Command.run
overridden in zim.main.ManualCommand
Run the command
Raises
UsageErrorwhen arguments are not correct
Unknown Field: implementation
must be implemented by subclasses
arguments: tuple[str, ...] = (source)
overrides zim.main.command.Command.arguments
overridden in zim.main.ManualCommand

Undocumented

options: tuple = (source)
overrides zim.main.command.Command.options
overridden in zim.main.ManualCommand

Undocumented

def _present_window(self, window, page): (source)

Undocumented

def _run_new_window(self, notebook, page): (source)

Undocumented