Gsf.DocMetaData¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`foreach` (func, *user_data)
	`insert` (name, value)
	`lookup` (name)
	`odf_subtree` (doc)
	`read_from_msole` (in_)
	`read_from_odf` (input)
	`remove` (name)
	`size` ()
	`steal` (name)
	`store` (prop)
	`write_to_msole` (out, doc_not_component)
	`write_to_odf` (output)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gsf.DocMetaData(**kwargs)¶

Bases:: GObject.Object
Abstract:: No

Class representing information about a document, such as creator and time of last modification.

classmethod new()¶

Returns:: a new metadata property collection
Return type:: Gsf.DocMetaData

foreach(func, *user_data)¶

Parameters:

func (GLib.HFunc) – the function called once for each element in the collection
user_data (object or None) – any supplied user data

Iterate through each (key, value) pair in this collection

insert(name, value)¶

Parameters:

name (str) – the id.
value (GObject.Value) – GObject.Value

Take ownership of name and value and insert a property into self. If a property exists with name, it is replaced (The link is lost)

lookup(name)¶

Parameters:: name (str) –
Returns:: the property with name in self. The caller can modify the property value and link but not the name.
Return type:: Gsf.DocProp or None

odf_subtree(doc)¶

Parameters:: doc (Gsf.XMLIn) – Gsf.XMLInDoc

Extend xin so that it can parse a subtree in OpenDoc metadata format

New in version 1.14.24.

read_from_msole(in_)¶

Parameters:: in (Gsf.Input) – Gsf.Input
Returns:: A GLib.Error if there was an error.
Return type:: GLib.Error

Read a stream formated as a set of MS OLE properties from in and store the results in self.

New in version 1.14.24.

read_from_odf(input)¶

Parameters:: input (Gsf.Input) – Gsf.Input
Returns:: a GLib.Error if there is a problem.
Return type:: GLib.Error

Read an OpenDocument metadata stream from input and store the properties into self. Overwrite any existing properties with the same id.

New in version 1.14.24.

remove(name)¶

Parameters:: name (str) – the non-null string name of the property

If name does not exist in the collection, do nothing. If name does exist, remove it and its value from the collection

size()¶

Returns:: the number of items in this collection
Return type:: int

steal(name)¶

Parameters:: name (str) –
Returns:: the property with name in self.
Return type:: Gsf.DocProp or None

store(prop)¶

Parameters:: prop (Gsf.DocProp) – Gsf.DocProp

write_to_msole(out, doc_not_component)¶

Parameters:

out (Gsf.Output) – Gsf.Output
doc_not_component (bool) – a kludge to differentiate DocumentSummary from Summary

Returns:

True on success;

Return type:

bool

New in version 1.14.24.

write_to_odf(output)¶

Parameters:: output (Gsf.XMLOut) – a pointer to a Gsf.Output.
Returns:: True if no error occured.
Return type:: bool

New in version 1.14.24.