Class: Gsf::DocMetaData

Inherits:

Object

• Object
• Gsf::DocMetaData

Defined in:

(unknown)

Overview

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

Instance Method Summary

• #foreach(func, user_data) ⇒ nil

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

• #initialize ⇒ Gsf::DocMetaData constructor

  A new metadata property collection.

• #insert(name, value) ⇒ nil

  Take ownership of name and value and insert a property into meta.

• #lookup(name) ⇒ Gsf::DocProp

  modify the property value and link but not the name.

• #odf_subtree(doc) ⇒ nil

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

• #read_from_msole(in) ⇒ GLib::Error

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

• #read_from_odf(input) ⇒ GLib::Error

  Read an OpenDocument metadata stream from input and store the properties into md.

• #remove(name) ⇒ nil

  If name does not exist in the collection, do nothing.

• #size ⇒ Integer

  The number of items in this collection.

• #steal(name) ⇒ Gsf::DocProp

  The property with name in meta.

• #store(prop) ⇒ nil
• #write_to_msole(out, doc_not_component) ⇒ Boolean

  True on success;.

• #write_to_odf(output) ⇒ Boolean

  True if no error occured.

Constructor Details

#initialize ⇒ Gsf::DocMetaData

Returns a new metadata property collection.

Instance Method Details

#foreach(func, user_data) ⇒ nil

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

Parameters:

• func (GLib::HFunc) —

  the function called once for each element in the collection

• user_data (GObject) —

  any supplied user data

Returns:

• (nil)

#insert(name, value) ⇒ nil

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

Parameters:

• name (String) —

  the id.

• value (GObject::Value) —

  #GValue

Returns:

• (nil)

#lookup(name) ⇒ Gsf::DocProp

modify the property value and link but not the name.

Parameters:

• name (String)

Returns:

• (Gsf::DocProp) —

  the property with name in meta. The caller can

#odf_subtree(doc) ⇒ nil

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

Parameters:

• doc (Gsf::XMLIn) —

  Gsf::XMLInDoc

Returns:

• (nil)

#read_from_msole(in) ⇒ GLib::Error

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

Parameters:

• in (Gsf::Input) —

  Gsf::Input

Returns:

• (GLib::Error) —

  A #GError if there was an error.

#read_from_odf(input) ⇒ GLib::Error

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

Parameters:

• input (Gsf::Input) —

  Gsf::Input

Returns:

• (GLib::Error) —

  a #GError if there is a problem.

#remove(name) ⇒ nil

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

Parameters:

• name (String) —

  the non-null string name of the property

Returns:

• (nil)

#size ⇒ Integer

Returns the number of items in this collection.

Returns:

• (Integer) —

  the number of items in this collection

#steal(name) ⇒ Gsf::DocProp

Returns the property with name in meta.

Parameters:

• name (String)

Returns:

• (Gsf::DocProp) —

  the property with name in meta.

#store(prop) ⇒ nil

Parameters:

• prop (Gsf::DocProp) —

  Gsf::DocProp

Returns:

• (nil)

#write_to_msole(out, doc_not_component) ⇒ Boolean

Returns true on success;.

Parameters:

• out (Gsf::Output) —

  Gsf::Output

• doc_not_component (Boolean) —

  a kludge to differentiate DocumentSummary from Summary

Returns:

• (Boolean) —

  true on success;

#write_to_odf(output) ⇒ Boolean

Returns true if no error occured.

Parameters:

• output (Gsf::XMLOut) —

  a pointer to a Gsf::Output.

Returns:

• (Boolean) —

  true if no error occured.