zim.notebook.index.pages.PageIndexRecord

class documentation

class PageIndexRecord(Path): (source)

View In Hierarchy

Object representing a page Path in the index, with data for the corresponding row in the pages table.
Method __init__ No summary
Method exists Undocumented
Class Variable __slots__ Undocumented
Property haschildren Undocumented
Property hascontent Undocumented
Property id Undocumented
Property mtime Undocumented
Property n_children Undocumented
Instance Variable _row Undocumented

Inherited from Path:

Class Method new_from_zim_config Returns a new object based on the string representation for that path.
Static Method assertValidPageName No summary
Static Method makeValidPageName No summary
Method __add__ path + name is an alias for path.child(name)
Method __eq__ Paths are equal when their names are the same
Method __hash__ Undocumented
Method __ne__ Paths are not equal when their names are not the same
Method __repr__ Undocumented
Method __str__ Undocumented
Method child Get a child Path
Method commonparent Find a common parent for two Paths
Method ischild Check whether this path is a child of a given path @param parent: a Path object @returns: True when this path is a (grand-)child of parent
Method match_namespace Check whether this path is in a specific section of the notebook @param namespace: a Path object @returns: True when this path is equal to namespace or is a (grand-)child of namespace
Method parents Generator function for parent Paths including root
Method relname Get a part of this path relative to a parent path
Method serialize_zim_config Returns the name for serializing this path
Instance Variable name Undocumented
Property basename Get the basename of the path (last part of the name)
Property isroot True when this Path represents the top level namespace
Property namespace Gives the name for the parent page. Returns an empty string for the top level namespace.
Property parent Get the path for the parent page
Property parts Get all the parts of the name (split on ":")
def __init__(self, row): (source)
overrides zim.notebook.page.Path.__init__
Constructor
Parameters
rowa sqlite3.Row object for this page in the "pages" table, specifies most other attributes for this object The property hasdata is True when the row is set.
def exists(self): (source)

Undocumented

__slots__: str = (source)
overrides zim.notebook.page.Path.__slots__

Undocumented

@property
haschildren = (source)

Undocumented

@property
hascontent = (source)

Undocumented

@property
id = (source)

Undocumented

@property
mtime = (source)

Undocumented

@property
n_children = (source)

Undocumented

_row = (source)

Undocumented