Aravis.DomDocument¶

Subclasses:: Aravis.Gc

Methods¶

Inherited:: Aravis.DomNode (17), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new_from_memory` (buffer, size)
class	`new_from_path` (path)
class	`new_from_url` (url)
	`append_from_memory` (node, buffer, size)
	`create_element` (tag_name)
	`create_text_node` (data)
	`get_document_element` ()
	`get_href_data` (href, size)
	`get_url` ()
	`set_path` (path)
	`set_url` (url)

Virtual Methods¶

Inherited:: Aravis.DomNode (9), GObject.Object (7)

	`do_create_element` (tag_name)
	`do_create_text_node` (data)
	`do_get_document_element` ()

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Aravis.DomNode`	r

Class Details¶

class Aravis.DomDocument(**kwargs)¶

Bases:: Aravis.DomNode
Abstract:: Yes
Structure:: Aravis.DomDocumentClass

classmethod new_from_memory(buffer, size)¶

Parameters:

buffer (object or None) –
size (int) –

Raises:

GLib.Error

Return type:

Aravis.DomDocument

classmethod new_from_path(path)¶

Parameters:: path (str) –
Raises:: GLib.Error
Return type:: Aravis.DomDocument

classmethod new_from_url(url)¶

Parameters:: url (str) –
Raises:: GLib.Error
Return type:: Aravis.DomDocument

append_from_memory(node, buffer, size)¶

Parameters:

node (Aravis.DomNode) – a Aravis.DomNode
buffer (object or None) – a memory buffer holding xml data
size (int) – size of the xml data, in bytes

Raises:

GLib.Error

Append a chunk of xml tree to an existing document. The resulting nodes will be appended to node, or to self if node == None.

Size set to a negative value indicated an unknow xml data size.

create_element(tag_name)¶

Parameters:: tag_name (str) – node name of the element to create
Returns:: a new orphan Aravis.DomElement, None on error.
Return type:: Aravis.DomElement

Create a new element.

create_text_node(data)¶

Parameters:: data (str) – initial content
Returns:: a new orphan Aravis.DomText, None on error.
Return type:: Aravis.DomText

Create a new text element.

get_document_element()¶

Returns:: the top element of self.
Return type:: Aravis.DomElement

get_href_data(href, size)¶

Parameters:

href (str) – document reference
size (int) – data size placeholder

Returns:

a newly allocated data buffer.

Return type:

object or None

Load the content referenced by href.

get_url()¶

Return type:: str

set_path(path)¶

Parameters:: path (str) –

set_url(url)¶

Parameters:: url (str) –

do_create_element(tag_name) virtual¶

Parameters:: tag_name (str) – node name of the element to create
Returns:: a new orphan Aravis.DomElement, None on error.
Return type:: Aravis.DomElement

Create a new element.

do_create_text_node(data) virtual¶

Parameters:: data (str) – initial content
Returns:: a new orphan Aravis.DomText, None on error.
Return type:: Aravis.DomText

Create a new text element.

do_get_document_element() virtual¶

Returns:: the top element of self.
Return type:: Aravis.DomElement