zim.notebook.info.NotebookInfo

class documentation

class NotebookInfo(object): (source)

This class keeps the info for a notebook

Method	`__eq__`	Undocumented
Method	`__init__`	Constructor
Method	`__repr__`	Undocumented
Method	`update`	Check if info is still up to date and update this object
Instance Variable	`active`	The attribute is used to signal whether the notebook is already open or not, used in the daemon context, `None` if this is not used, `True` or `False` otherwise
Instance Variable	`icon`	The file uri for the notebook icon
Instance Variable	`icon_path`	The location of the icon as configured (either relative to the notebook location, relative to home folder or absolute path)
Instance Variable	`interwiki`	The interwiki keyword (if any)
Instance Variable	`mtime`	The mtime of the config file this info was read from (if any)
Instance Variable	`name`	The notebook name (or the basename of the uri)
Instance Variable	`uri`	The location of the notebook
Instance Variable	`userpath`	The location of the notebook relative to the home folder (starts with '~/') or `None`

def __eq__(self, other): (source)

Undocumented

def __init__(self, uri, name=None, icon=None, mtime=None, interwiki=None, **a): (source)

Constructor

Known values for name, icon etc. can be specified. Alternatively update() can be called to read there from the notebook configuration (if any). If mtime is given the object acts as a cache and update() will only read the config if it is newer than mtime

Parameters
uri	location uri or file path for the notebook (esp. `userpath`)
name	notebook name
icon	the notebook icon path
mtime	the mtime when config was last read
interwiki	the interwiki keyword for this notebook
**a	any additional arguments will be discarded

def __repr__(self): (source)

Undocumented

def update(self): (source)

active = (source)

The attribute is used to signal whether the notebook is already open or not, used in the daemon context, None if this is not used, True or False otherwise

icon = (source)

The file uri for the notebook icon

icon_path = (source)

The location of the icon as configured (either relative to the notebook location, relative to home folder or absolute path)

interwiki = (source)

The interwiki keyword (if any)

mtime = (source)

The mtime of the config file this info was read from (if any)

name = (source)

The notebook name (or the basename of the uri)

uri = (source)

The location of the notebook

userpath = (source)

The location of the notebook relative to the home folder (starts with '~/') or None