inviwopy.doc

Inviwo document classes

Classes

Document
DocumentHandle
Element
ElementType	Members:
PathComponent

class inviwopy.doc.Document

Bases: pybind11_object

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: inviwopy.doc.Document) -> None

2. __init__(self: inviwopy.doc.Document, arg0: str) -> None

append(*args, **kwargs)

Overloaded function.

1. append(self: inviwopy.doc.Document, arg0: str, arg1: str, arg2: collections.abc.Mapping[str, str]) -> inviwopy.doc.DocumentHandle

2. append(self: inviwopy.doc.Document, arg0: inviwopy.doc.Document) -> inviwopy.doc.DocumentHandle

appendText(self: inviwopy.doc.Document, arg0: str) → inviwopy.doc.DocumentHandle

empty(self: inviwopy.doc.Document) → bool

get(self: inviwopy.doc.Document, arg0: collections.abc.Sequence[inviwopy.doc.PathComponent]) → inviwopy.doc.DocumentHandle

handle(self: inviwopy.doc.Document) → inviwopy.doc.DocumentHandle

insert(*args, **kwargs)

Overloaded function.

1. insert(self: inviwopy.doc.Document, arg0: inviwopy.doc.PathComponent, arg1: str, arg2: str, arg3: collections.abc.Mapping[str, str]) -> inviwopy.doc.DocumentHandle

2. insert(self: inviwopy.doc.Document, arg0: inviwopy.doc.PathComponent, arg1: inviwopy.doc.Document) -> inviwopy.doc.DocumentHandle

insertText(self: inviwopy.doc.Document, arg0: inviwopy.doc.PathComponent, arg1: str) → inviwopy.doc.DocumentHandle

str(self: inviwopy.doc.Document) → str

visit(self: inviwopy.doc.Document, arg0: collections.abc.Callable[[inviwopy.doc.Element, collections.abc.Sequence[inviwopy.doc.Element]], None], arg1: collections.abc.Callable[[inviwopy.doc.Element, collections.abc.Sequence[inviwopy.doc.Element]], None]) → None

class inviwopy.doc.DocumentHandle

Bases: pybind11_object

__init__(*args, **kwargs)

append(*args, **kwargs)

Overloaded function.

1. append(self: inviwopy.doc.DocumentHandle, arg0: str, arg1: str, arg2: collections.abc.Mapping[str, str]) -> inviwopy.doc.DocumentHandle

2. append(self: inviwopy.doc.DocumentHandle, arg0: inviwo::Document) -> inviwopy.doc.DocumentHandle

appendText(self: inviwopy.doc.DocumentHandle, arg0: str) → inviwopy.doc.DocumentHandle

get(self: inviwopy.doc.DocumentHandle, arg0: collections.abc.Sequence[inviwopy.doc.PathComponent]) → inviwopy.doc.DocumentHandle

insert(*args, **kwargs)

Overloaded function.

1. insert(self: inviwopy.doc.DocumentHandle, arg0: inviwopy.doc.PathComponent, arg1: str, arg2: str, arg3: collections.abc.Mapping[str, str]) -> inviwopy.doc.DocumentHandle

2. insert(self: inviwopy.doc.DocumentHandle, arg0: inviwopy.doc.PathComponent, arg1: inviwo::Document) -> inviwopy.doc.DocumentHandle

insertText(self: inviwopy.doc.DocumentHandle, arg0: inviwopy.doc.PathComponent, arg1: str) → inviwopy.doc.DocumentHandle

property element

class inviwopy.doc.Element

Bases: pybind11_object

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: inviwopy.doc.Element, type: inviwopy.doc.ElementType, content: str) -> None

2. __init__(self: inviwopy.doc.Element, name: str, content: str = ‘’, attributes: collections.abc.Mapping[str, str] = {}) -> None

emptyTag(self: inviwopy.doc.Element) → bool

isNode(self: inviwopy.doc.Element) → bool

isText(self: inviwopy.doc.Element) → bool

noIndent(self: inviwopy.doc.Element) → bool

property attributes

property content

property name

property type

class inviwopy.doc.ElementType

Bases: pybind11_object

Members:

Node

Text

__eq__(self: object, other: object, /) → bool

__hash__(self: object, /) → int

__index__(self: inviwopy.doc.ElementType, /) → int

__init__(self: inviwopy.doc.ElementType, value: SupportsInt) → None

__int__(self: inviwopy.doc.ElementType, /) → int

__ne__(self: object, other: object, /) → bool

__repr__(self: object, /) → str

__str__(self: object, /) → str

Node = <ElementType.Node: 0>

Text = <ElementType.Text: 1>

ElementType.name -> str

property value

class inviwopy.doc.PathComponent

Bases: pybind11_object

static end() → inviwopy.doc.PathComponent

static first() → inviwopy.doc.PathComponent

static last() → inviwopy.doc.PathComponent

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: inviwopy.doc.PathComponent, index: typing.SupportsInt) -> None

2. __init__(self: inviwopy.doc.PathComponent, name: str) -> None

3. __init__(self: inviwopy.doc.PathComponent, attributes: collections.abc.Mapping[str, str]) -> None

4. __init__(self: inviwopy.doc.PathComponent, name: str, attributes: collections.abc.Mapping[str, str]) -> None