1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>metadata</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GSF Reference Manual">
8 <link rel="up" href="parsers.html" title="Stream Parsers">
9 <link rel="prev" href="gsf-MS-OLE2.html" title="MS OLE2">
10 <link rel="next" href="gsf-OASIS-Open-Document.html" title="OASIS Open Document">
11 <meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="gsf-MS-OLE2.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="parsers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GSF Reference Manual</th>
21 <td><a accesskey="n" href="gsf-OASIS-Open-Document.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gsf-metadata.synopsis" class="shortcut">Top</a>
26 <a href="#gsf-metadata.description" class="shortcut">Description</a>
28 <a href="#gsf-metadata.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry" title="metadata">
32 <a name="gsf-metadata"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="gsf-metadata.top_of_page"></a>metadata</span></h2>
38 <td valign="top" align="right"></td>
40 <div class="refsynopsisdiv" title="Synopsis">
41 <a name="gsf-metadata.synopsis"></a><h2>Synopsis</h2>
42 <a name="GsfDocMetaData"></a><a name="GsfDocPropVector"></a><pre class="synopsis"> <a class="link" href="gsf-metadata.html#GsfDocMetaData-struct" title="GsfDocMetaData">GsfDocMetaData</a>;
43 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="returnvalue">GsfDocMetaData</span></a> * <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-new" title="gsf_doc_meta_data_new ()">gsf_doc_meta_data_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
44 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="returnvalue">GsfDocProp</span></a> * <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-lookup" title="gsf_doc_meta_data_lookup ()">gsf_doc_meta_data_lookup</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>,
45 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);
46 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-insert" title="gsf_doc_meta_data_insert ()">gsf_doc_meta_data_insert</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
47 <em class="parameter"><code><span class="type">char</span> *name</code></em>,
48 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-remove" title="gsf_doc_meta_data_remove ()">gsf_doc_meta_data_remove</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
50 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);
51 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="returnvalue">GsfDocProp</span></a> * <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-steal" title="gsf_doc_meta_data_steal ()">gsf_doc_meta_data_steal</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
52 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-store" title="gsf_doc_meta_data_store ()">gsf_doc_meta_data_store</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
54 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-foreach" title="gsf_doc_meta_data_foreach ()">gsf_doc_meta_data_foreach</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>,
56 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHFunc"><span class="type">GHFunc</span></a> func</code></em>,
57 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
58 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> <a class="link" href="gsf-metadata.html#gsf-doc-meta-data-size" title="gsf_doc_meta_data_size ()">gsf_doc_meta_data_size</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-meta-dump" title="gsf_doc_meta_dump ()">gsf_doc_meta_dump</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>);
60 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp">GsfDocProp</a>;
61 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="returnvalue">GsfDocProp</span></a> * <a class="link" href="gsf-metadata.html#gsf-doc-prop-new" title="gsf_doc_prop_new ()">gsf_doc_prop_new</a> (<em class="parameter"><code><span class="type">char</span> *name</code></em>);
62 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-prop-free" title="gsf_doc_prop_free ()">gsf_doc_prop_free</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>);
63 <span class="returnvalue">char</span> const * <a class="link" href="gsf-metadata.html#gsf-doc-prop-get-name" title="gsf_doc_prop_get_name ()">gsf_doc_prop_get_name</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);
64 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> const * <a class="link" href="gsf-metadata.html#gsf-doc-prop-get-val" title="gsf_doc_prop_get_val ()">gsf_doc_prop_get_val</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);
65 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-prop-set-val" title="gsf_doc_prop_set_val ()">gsf_doc_prop_set_val</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>,
66 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);
67 <span class="returnvalue">char</span> const * <a class="link" href="gsf-metadata.html#gsf-doc-prop-get-link" title="gsf_doc_prop_get_link ()">gsf_doc_prop_get_link</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);
68 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-prop-set-link" title="gsf_doc_prop_set_link ()">gsf_doc_prop_set_link</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>,
69 <em class="parameter"><code><span class="type">char</span> *link</code></em>);
70 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-doc-prop-dump" title="gsf_doc_prop_dump ()">gsf_doc_prop_dump</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);
71 <a class="link" href="gsf-metadata.html#GsfDocPropVector-struct" title="GsfDocPropVector">GsfDocPropVector</a>;
72 <a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="returnvalue">GsfDocPropVector</span></a> * <a class="link" href="gsf-metadata.html#gsf-docprop-vector-new" title="gsf_docprop_vector_new ()">gsf_docprop_vector_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
73 <span class="returnvalue">void</span> <a class="link" href="gsf-metadata.html#gsf-docprop-vector-append" title="gsf_docprop_vector_append ()">gsf_docprop_vector_append</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="type">GsfDocPropVector</span></a> *vector</code></em>,
74 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
75 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="gsf-metadata.html#gsf-docprop-vector-as-string" title="gsf_docprop_vector_as_string ()">gsf_docprop_vector_as_string</a> (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="type">GsfDocPropVector</span></a> const *vector</code></em>);
76 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> * <a class="link" href="gsf-metadata.html#gsf-value-get-docprop-varray" title="gsf_value_get_docprop_varray ()">gsf_value_get_docprop_varray</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> const *value</code></em>);
77 <a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="returnvalue">GsfDocPropVector</span></a> * <a class="link" href="gsf-metadata.html#gsf-value-get-docprop-vector" title="gsf_value_get_docprop_vector ()">gsf_value_get_docprop_vector</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> const *value</code></em>);
79 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-TITLE:CAPS" title="GSF_META_NAME_TITLE">GSF_META_NAME_TITLE</a>
80 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-DESCRIPTION:CAPS" title="GSF_META_NAME_DESCRIPTION">GSF_META_NAME_DESCRIPTION</a>
81 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-SUBJECT:CAPS" title="GSF_META_NAME_SUBJECT">GSF_META_NAME_SUBJECT</a>
82 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-DATE-MODIFIED:CAPS" title="GSF_META_NAME_DATE_MODIFIED">GSF_META_NAME_DATE_MODIFIED</a>
83 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-DATE-CREATED:CAPS" title="GSF_META_NAME_DATE_CREATED">GSF_META_NAME_DATE_CREATED</a>
84 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-KEYWORDS:CAPS" title="GSF_META_NAME_KEYWORDS">GSF_META_NAME_KEYWORDS</a>
85 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-LANGUAGE:CAPS" title="GSF_META_NAME_LANGUAGE">GSF_META_NAME_LANGUAGE</a>
86 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-CODEPAGE:CAPS" title="GSF_META_NAME_CODEPAGE">GSF_META_NAME_CODEPAGE</a>
87 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-REVISION-COUNT:CAPS" title="GSF_META_NAME_REVISION_COUNT">GSF_META_NAME_REVISION_COUNT</a>
88 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-EDITING-DURATION:CAPS" title="GSF_META_NAME_EDITING_DURATION">GSF_META_NAME_EDITING_DURATION</a>
89 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-TABLE-COUNT:CAPS" title="GSF_META_NAME_TABLE_COUNT">GSF_META_NAME_TABLE_COUNT</a>
90 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-IMAGE-COUNT:CAPS" title="GSF_META_NAME_IMAGE_COUNT">GSF_META_NAME_IMAGE_COUNT</a>
91 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-OBJECT-COUNT:CAPS" title="GSF_META_NAME_OBJECT_COUNT">GSF_META_NAME_OBJECT_COUNT</a>
92 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-PAGE-COUNT:CAPS" title="GSF_META_NAME_PAGE_COUNT">GSF_META_NAME_PAGE_COUNT</a>
93 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-PARAGRAPH-COUNT:CAPS" title="GSF_META_NAME_PARAGRAPH_COUNT">GSF_META_NAME_PARAGRAPH_COUNT</a>
94 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-WORD-COUNT:CAPS" title="GSF_META_NAME_WORD_COUNT">GSF_META_NAME_WORD_COUNT</a>
95 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-CHARACTER-COUNT:CAPS" title="GSF_META_NAME_CHARACTER_COUNT">GSF_META_NAME_CHARACTER_COUNT</a>
96 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-CELL-COUNT:CAPS" title="GSF_META_NAME_CELL_COUNT">GSF_META_NAME_CELL_COUNT</a>
97 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-SPREADSHEET-COUNT:CAPS" title="GSF_META_NAME_SPREADSHEET_COUNT">GSF_META_NAME_SPREADSHEET_COUNT</a>
98 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-CREATOR:CAPS" title="GSF_META_NAME_CREATOR">GSF_META_NAME_CREATOR</a>
99 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-TEMPLATE:CAPS" title="GSF_META_NAME_TEMPLATE">GSF_META_NAME_TEMPLATE</a>
100 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-LAST-SAVED-BY:CAPS" title="GSF_META_NAME_LAST_SAVED_BY">GSF_META_NAME_LAST_SAVED_BY</a>
101 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-LAST-PRINTED:CAPS" title="GSF_META_NAME_LAST_PRINTED">GSF_META_NAME_LAST_PRINTED</a>
102 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-PRINT-DATE:CAPS" title="GSF_META_NAME_PRINT_DATE">GSF_META_NAME_PRINT_DATE</a>
103 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-PRINTED-BY:CAPS" title="GSF_META_NAME_PRINTED_BY">GSF_META_NAME_PRINTED_BY</a>
104 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-KEYWORD:CAPS" title="GSF_META_NAME_KEYWORD">GSF_META_NAME_KEYWORD</a>
105 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-SECURITY:CAPS" title="GSF_META_NAME_SECURITY">GSF_META_NAME_SECURITY</a>
106 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-CATEGORY:CAPS" title="GSF_META_NAME_CATEGORY">GSF_META_NAME_CATEGORY</a>
107 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-PRESENTATION-FORMAT:CAPS" title="GSF_META_NAME_PRESENTATION_FORMAT">GSF_META_NAME_PRESENTATION_FORMAT</a>
108 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-THUMBNAIL:CAPS" title="GSF_META_NAME_THUMBNAIL">GSF_META_NAME_THUMBNAIL</a>
109 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-GENERATOR:CAPS" title="GSF_META_NAME_GENERATOR">GSF_META_NAME_GENERATOR</a>
110 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-LINE-COUNT:CAPS" title="GSF_META_NAME_LINE_COUNT">GSF_META_NAME_LINE_COUNT</a>
111 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-SLIDE-COUNT:CAPS" title="GSF_META_NAME_SLIDE_COUNT">GSF_META_NAME_SLIDE_COUNT</a>
112 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-NOTE-COUNT:CAPS" title="GSF_META_NAME_NOTE_COUNT">GSF_META_NAME_NOTE_COUNT</a>
113 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-HIDDEN-SLIDE-COUNT:CAPS" title="GSF_META_NAME_HIDDEN_SLIDE_COUNT">GSF_META_NAME_HIDDEN_SLIDE_COUNT</a>
114 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MM-CLIP-COUNT:CAPS" title="GSF_META_NAME_MM_CLIP_COUNT">GSF_META_NAME_MM_CLIP_COUNT</a>
115 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-BYTE-COUNT:CAPS" title="GSF_META_NAME_BYTE_COUNT">GSF_META_NAME_BYTE_COUNT</a>
116 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-SCALE:CAPS" title="GSF_META_NAME_SCALE">GSF_META_NAME_SCALE</a>
117 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-HEADING-PAIRS:CAPS" title="GSF_META_NAME_HEADING_PAIRS">GSF_META_NAME_HEADING_PAIRS</a>
118 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-DOCUMENT-PARTS:CAPS" title="GSF_META_NAME_DOCUMENT_PARTS">GSF_META_NAME_DOCUMENT_PARTS</a>
119 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MANAGER:CAPS" title="GSF_META_NAME_MANAGER">GSF_META_NAME_MANAGER</a>
120 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-COMPANY:CAPS" title="GSF_META_NAME_COMPANY">GSF_META_NAME_COMPANY</a>
121 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-LINKS-DIRTY:CAPS" title="GSF_META_NAME_LINKS_DIRTY">GSF_META_NAME_LINKS_DIRTY</a>
122 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-DICTIONARY:CAPS" title="GSF_META_NAME_DICTIONARY">GSF_META_NAME_DICTIONARY</a>
123 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-17:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_17">GSF_META_NAME_MSOLE_UNKNOWN_17</a>
124 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-18:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_18">GSF_META_NAME_MSOLE_UNKNOWN_18</a>
125 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-19:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_19">GSF_META_NAME_MSOLE_UNKNOWN_19</a>
126 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-20:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_20">GSF_META_NAME_MSOLE_UNKNOWN_20</a>
127 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-21:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_21">GSF_META_NAME_MSOLE_UNKNOWN_21</a>
128 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-22:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_22">GSF_META_NAME_MSOLE_UNKNOWN_22</a>
129 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-MSOLE-UNKNOWN-23:CAPS" title="GSF_META_NAME_MSOLE_UNKNOWN_23">GSF_META_NAME_MSOLE_UNKNOWN_23</a>
130 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-LOCALE-SYSTEM-DEFAULT:CAPS" title="GSF_META_NAME_LOCALE_SYSTEM_DEFAULT">GSF_META_NAME_LOCALE_SYSTEM_DEFAULT</a>
131 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-CASE-SENSITIVE:CAPS" title="GSF_META_NAME_CASE_SENSITIVE">GSF_META_NAME_CASE_SENSITIVE</a>
132 #define <a class="link" href="gsf-metadata.html#GSF-META-NAME-INITIAL-CREATOR:CAPS" title="GSF_META_NAME_INITIAL_CREATOR">GSF_META_NAME_INITIAL_CREATOR</a>
135 <div class="refsect1" title="Object Hierarchy">
136 <a name="gsf-metadata.object-hierarchy"></a><h2>Object Hierarchy</h2>
137 <pre class="synopsis">
138 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
141 <pre class="synopsis">
142 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
143 +----GsfDocPropVector
146 <div class="refsect1" title="Description">
147 <a name="gsf-metadata.description"></a><h2>Description</h2>
151 <div class="refsect1" title="Details">
152 <a name="gsf-metadata.details"></a><h2>Details</h2>
153 <div class="refsect2" title="GsfDocMetaData">
154 <a name="GsfDocMetaData-struct"></a><h3>GsfDocMetaData</h3>
155 <pre class="programlisting">typedef struct _GsfDocMetaData GsfDocMetaData;</pre>
157 Class representing information about a document, such as creator and time of
162 <div class="refsect2" title="gsf_doc_meta_data_new ()">
163 <a name="gsf-doc-meta-data-new"></a><h3>gsf_doc_meta_data_new ()</h3>
164 <pre class="programlisting"><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="returnvalue">GsfDocMetaData</span></a> * gsf_doc_meta_data_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
165 <div class="variablelist"><table border="0">
166 <col align="left" valign="top">
168 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
169 <td> a new metadata property collection
175 <div class="refsect2" title="gsf_doc_meta_data_lookup ()">
176 <a name="gsf-doc-meta-data-lookup"></a><h3>gsf_doc_meta_data_lookup ()</h3>
177 <pre class="programlisting"><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="returnvalue">GsfDocProp</span></a> * gsf_doc_meta_data_lookup (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>,
178 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);</pre>
179 <div class="variablelist"><table border="0">
180 <col align="left" valign="top">
183 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
185 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
189 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
190 <td> the property with name <em class="parameter"><code>id</code></em> in <em class="parameter"><code>meta</code></em>. The caller can modify the
191 property value and link but not the name.
198 <div class="refsect2" title="gsf_doc_meta_data_insert ()">
199 <a name="gsf-doc-meta-data-insert"></a><h3>gsf_doc_meta_data_insert ()</h3>
200 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_meta_data_insert (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
201 <em class="parameter"><code><span class="type">char</span> *name</code></em>,
202 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
204 Take ownership of <em class="parameter"><code>name</code></em> and <em class="parameter"><code>value</code></em> and insert a property into <em class="parameter"><code>meta</code></em>.
205 If a property exists with <em class="parameter"><code>name</code></em>, it is replaced (The link is lost)
207 <div class="variablelist"><table border="0">
208 <col align="left" valign="top">
211 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
213 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
217 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
222 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
224 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
231 <div class="refsect2" title="gsf_doc_meta_data_remove ()">
232 <a name="gsf-doc-meta-data-remove"></a><h3>gsf_doc_meta_data_remove ()</h3>
233 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_meta_data_remove (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
234 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);</pre>
236 If <em class="parameter"><code>name</code></em> does not exist in the collection, do nothing. If <em class="parameter"><code>name</code></em> does exist,
237 remove it and its value from the collection
239 <div class="variablelist"><table border="0">
240 <col align="left" valign="top">
243 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
248 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
249 <td>the non-null string name of the property
256 <div class="refsect2" title="gsf_doc_meta_data_steal ()">
257 <a name="gsf-doc-meta-data-steal"></a><h3>gsf_doc_meta_data_steal ()</h3>
258 <pre class="programlisting"><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="returnvalue">GsfDocProp</span></a> * gsf_doc_meta_data_steal (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
259 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);</pre>
262 <div class="variablelist"><table border="0">
263 <col align="left" valign="top">
266 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
271 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
276 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284 <div class="refsect2" title="gsf_doc_meta_data_store ()">
285 <a name="gsf-doc-meta-data-store"></a><h3>gsf_doc_meta_data_store ()</h3>
286 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_meta_data_store (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *meta</code></em>,
287 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>);</pre>
288 <div class="variablelist"><table border="0">
289 <col align="left" valign="top">
292 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
294 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
298 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
300 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
307 <div class="refsect2" title="gsf_doc_meta_data_foreach ()">
308 <a name="gsf-doc-meta-data-foreach"></a><h3>gsf_doc_meta_data_foreach ()</h3>
309 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_meta_data_foreach (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>,
310 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHFunc"><span class="type">GHFunc</span></a> func</code></em>,
311 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
313 Iterate through each (key, value) pair in this collection
315 <div class="variablelist"><table border="0">
316 <col align="left" valign="top">
319 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
324 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
325 <td>the function called once for each element in the collection
329 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
330 <td>any supplied user data or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
337 <div class="refsect2" title="gsf_doc_meta_data_size ()">
338 <a name="gsf-doc-meta-data-size"></a><h3>gsf_doc_meta_data_size ()</h3>
339 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> gsf_doc_meta_data_size (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>);</pre>
340 <div class="variablelist"><table border="0">
341 <col align="left" valign="top">
344 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
349 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
350 <td> the number of items in this collection
357 <div class="refsect2" title="gsf_doc_meta_dump ()">
358 <a name="gsf-doc-meta-dump"></a><h3>gsf_doc_meta_dump ()</h3>
359 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_meta_dump (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta</code></em>);</pre>
361 A debugging utility to dump the content of <em class="parameter"><code>meta</code></em> via g_print
363 <div class="variablelist"><table border="0">
364 <col align="left" valign="top">
366 <td><p><span class="term"><em class="parameter"><code>meta</code></em> :</span></p></td>
368 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
374 <div class="refsect2" title="GsfDocProp">
375 <a name="GsfDocProp"></a><h3>GsfDocProp</h3>
376 <pre class="programlisting">typedef struct _GsfDocProp GsfDocProp;</pre>
378 Class representing a properties of a document.
382 <div class="refsect2" title="gsf_doc_prop_new ()">
383 <a name="gsf-doc-prop-new"></a><h3>gsf_doc_prop_new ()</h3>
384 <pre class="programlisting"><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="returnvalue">GsfDocProp</span></a> * gsf_doc_prop_new (<em class="parameter"><code><span class="type">char</span> *name</code></em>);</pre>
385 <div class="variablelist"><table border="0">
386 <col align="left" valign="top">
388 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
389 <td> a new <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> which the caller is responsible for freeing.
390 Takes ownership of <em class="parameter"><code>name</code></em>.
396 <div class="refsect2" title="gsf_doc_prop_free ()">
397 <a name="gsf-doc-prop-free"></a><h3>gsf_doc_prop_free ()</h3>
398 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_prop_free (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>);</pre>
400 If <em class="parameter"><code>prop</code></em> is non <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> free the memory associated with it
402 <div class="variablelist"><table border="0">
403 <col align="left" valign="top">
405 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
407 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
413 <div class="refsect2" title="gsf_doc_prop_get_name ()">
414 <a name="gsf-doc-prop-get-name"></a><h3>gsf_doc_prop_get_name ()</h3>
415 <pre class="programlisting"><span class="returnvalue">char</span> const * gsf_doc_prop_get_name (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);</pre>
416 <div class="variablelist"><table border="0">
417 <col align="left" valign="top">
420 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
422 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
426 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
427 <td> the name of the property, the caller should not modify the result.
434 <div class="refsect2" title="gsf_doc_prop_get_val ()">
435 <a name="gsf-doc-prop-get-val"></a><h3>gsf_doc_prop_get_val ()</h3>
436 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> const * gsf_doc_prop_get_val (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);</pre>
437 <div class="variablelist"><table border="0">
438 <col align="left" valign="top">
441 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
446 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
447 <td> the value of the property, the caller should not modify the result.
454 <div class="refsect2" title="gsf_doc_prop_set_val ()">
455 <a name="gsf-doc-prop-set-val"></a><h3>gsf_doc_prop_set_val ()</h3>
456 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_prop_set_val (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>,
457 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);</pre>
459 Assigns <em class="parameter"><code>val</code></em> to <em class="parameter"><code>prop</code></em>, and unsets and frees the current value.
461 <div class="variablelist"><table border="0">
462 <col align="left" valign="top">
465 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
467 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
471 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
473 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
480 <div class="refsect2" title="gsf_doc_prop_get_link ()">
481 <a name="gsf-doc-prop-get-link"></a><h3>gsf_doc_prop_get_link ()</h3>
482 <pre class="programlisting"><span class="returnvalue">char</span> const * gsf_doc_prop_get_link (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);</pre>
483 <div class="variablelist"><table border="0">
484 <col align="left" valign="top">
487 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
489 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
493 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
494 <td> the current link descriptor of <em class="parameter"><code>prop</code></em>. The result should not be
502 <div class="refsect2" title="gsf_doc_prop_set_link ()">
503 <a name="gsf-doc-prop-set-link"></a><h3>gsf_doc_prop_set_link ()</h3>
504 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_prop_set_link (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> *prop</code></em>,
505 <em class="parameter"><code><span class="type">char</span> *link</code></em>);</pre>
507 Sets <em class="parameter"><code>prop</code></em>'s link to <em class="parameter"><code>link</code></em>
509 <div class="variablelist"><table border="0">
510 <col align="left" valign="top">
513 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
515 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
519 <td><p><span class="term"><em class="parameter"><code>link</code></em> :</span></p></td>
520 <td>optionally <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
527 <div class="refsect2" title="gsf_doc_prop_dump ()">
528 <a name="gsf-doc-prop-dump"></a><h3>gsf_doc_prop_dump ()</h3>
529 <pre class="programlisting"><span class="returnvalue">void</span> gsf_doc_prop_dump (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a> const *prop</code></em>);</pre>
531 A debugging utility to dump <em class="parameter"><code>prop</code></em> as text via g_print
534 <div class="variablelist"><table border="0">
535 <col align="left" valign="top">
537 <td><p><span class="term"><em class="parameter"><code>prop</code></em> :</span></p></td>
539 <a class="link" href="gsf-metadata.html#GsfDocProp" title="GsfDocProp"><span class="type">GsfDocProp</span></a>
545 <div class="refsect2" title="GsfDocPropVector">
546 <a name="GsfDocPropVector-struct"></a><h3>GsfDocPropVector</h3>
547 <pre class="programlisting">typedef struct _GsfDocPropVector GsfDocPropVector;</pre>
552 <div class="refsect2" title="gsf_docprop_vector_new ()">
553 <a name="gsf-docprop-vector-new"></a><h3>gsf_docprop_vector_new ()</h3>
554 <pre class="programlisting"><a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="returnvalue">GsfDocPropVector</span></a> * gsf_docprop_vector_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
556 This function creates a new gsf_docprop_vector object.
558 <div class="variablelist"><table border="0">
559 <col align="left" valign="top">
561 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
562 <td> GsfDocPropVector*
568 <div class="refsect2" title="gsf_docprop_vector_append ()">
569 <a name="gsf-docprop-vector-append"></a><h3>gsf_docprop_vector_append ()</h3>
570 <pre class="programlisting"><span class="returnvalue">void</span> gsf_docprop_vector_append (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="type">GsfDocPropVector</span></a> *vector</code></em>,
571 <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
573 Insert a copy of <em class="parameter"><code>value</code></em> as the last element of <em class="parameter"><code>vector</code></em>.
575 <div class="variablelist"><table border="0">
576 <col align="left" valign="top">
579 <td><p><span class="term"><em class="parameter"><code>vector</code></em> :</span></p></td>
580 <td>The vector to which the GValue will be added
584 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
585 <td>The GValue to add to <em class="parameter"><code>vector</code></em>
592 <div class="refsect2" title="gsf_docprop_vector_as_string ()">
593 <a name="gsf-docprop-vector-as-string"></a><h3>gsf_docprop_vector_as_string ()</h3>
594 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gsf_docprop_vector_as_string (<em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="type">GsfDocPropVector</span></a> const *vector</code></em>);</pre>
596 This function returns a string which represents all the GValues in <em class="parameter"><code>vector</code></em>.
597 The caller is responsible for freeing the result.
599 <div class="variablelist"><table border="0">
600 <col align="left" valign="top">
603 <td><p><span class="term"><em class="parameter"><code>vector</code></em> :</span></p></td>
604 <td>The <a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="type">GsfDocPropVector</span></a> from which GValues will be extracted.
608 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
609 <td> a string of comma-separated values
616 <div class="refsect2" title="gsf_value_get_docprop_varray ()">
617 <a name="gsf-value-get-docprop-varray"></a><h3>gsf_value_get_docprop_varray ()</h3>
618 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="returnvalue">GValueArray</span></a> * gsf_value_get_docprop_varray (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> const *value</code></em>);</pre>
621 <div class="variablelist"><table border="0">
622 <col align="left" valign="top">
625 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
630 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
638 <div class="refsect2" title="gsf_value_get_docprop_vector ()">
639 <a name="gsf-value-get-docprop-vector"></a><h3>gsf_value_get_docprop_vector ()</h3>
640 <pre class="programlisting"><a class="link" href="gsf-metadata.html#GsfDocPropVector"><span class="returnvalue">GsfDocPropVector</span></a> * gsf_value_get_docprop_vector (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> const *value</code></em>);</pre>
643 <div class="variablelist"><table border="0">
644 <col align="left" valign="top">
647 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
652 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
660 <div class="refsect2" title="GSF_META_NAME_TITLE">
661 <a name="GSF-META-NAME-TITLE:CAPS"></a><h3>GSF_META_NAME_TITLE</h3>
662 <pre class="programlisting">#define GSF_META_NAME_TITLE "dc:title"
665 (String) A formal name given to the resource.
669 <div class="refsect2" title="GSF_META_NAME_DESCRIPTION">
670 <a name="GSF-META-NAME-DESCRIPTION:CAPS"></a><h3>GSF_META_NAME_DESCRIPTION</h3>
671 <pre class="programlisting">#define GSF_META_NAME_DESCRIPTION "dc:description"
674 (String) An account of the content of the resource.
678 <div class="refsect2" title="GSF_META_NAME_SUBJECT">
679 <a name="GSF-META-NAME-SUBJECT:CAPS"></a><h3>GSF_META_NAME_SUBJECT</h3>
680 <pre class="programlisting">#define GSF_META_NAME_SUBJECT "dc:subject"
683 (String) The topic of the content of the resource,
684 <span class="emphasis"><em>typically</em></span> including keywords.
688 <div class="refsect2" title="GSF_META_NAME_DATE_MODIFIED">
689 <a name="GSF-META-NAME-DATE-MODIFIED:CAPS"></a><h3>GSF_META_NAME_DATE_MODIFIED</h3>
690 <pre class="programlisting">#define GSF_META_NAME_DATE_MODIFIED "dc:date"
693 (GsfTimestamp) The last time this document was saved.
696 1.14.0 Moved from dc:date-modified to dc:date.
700 <div class="refsect2" title="GSF_META_NAME_DATE_CREATED">
701 <a name="GSF-META-NAME-DATE-CREATED:CAPS"></a><h3>GSF_META_NAME_DATE_CREATED</h3>
702 <pre class="programlisting">#define GSF_META_NAME_DATE_CREATED "meta:creation-date"
705 (Date as ISO String) A date associated with an event in the life cycle of
706 the resource (creation/publication date).
707 Moved from gsf:date-created to meta:creation-date. This way can be used correctly
708 by OpenDocument and Gnumeric.
712 <div class="refsect2" title="GSF_META_NAME_KEYWORDS">
713 <a name="GSF-META-NAME-KEYWORDS:CAPS"></a><h3>GSF_META_NAME_KEYWORDS</h3>
714 <pre class="programlisting">#define GSF_META_NAME_KEYWORDS "dc:keywords"
717 (GsfDocPropVector of String) Searchable, indexable keywords. Similar to PDF
718 keywords or HTML's meta block.
722 <div class="refsect2" title="GSF_META_NAME_LANGUAGE">
723 <a name="GSF-META-NAME-LANGUAGE:CAPS"></a><h3>GSF_META_NAME_LANGUAGE</h3>
724 <pre class="programlisting">#define GSF_META_NAME_LANGUAGE "dc:language"
727 (String) The locale language of the intellectual content of the resource
728 (basically xx_YY form for us).
729 1.14.0 Clarified that this is unique from _NAME_CODEPAGE in msole
733 <div class="refsect2" title="GSF_META_NAME_CODEPAGE">
734 <a name="GSF-META-NAME-CODEPAGE:CAPS"></a><h3>GSF_META_NAME_CODEPAGE</h3>
735 <pre class="programlisting">#define GSF_META_NAME_CODEPAGE "msole:codepage"
738 (UnsignedShort) The MS codepage to encode strings for metadata
739 1.14.0 Clarified that this is unique from _NAME_CODEPAGE in msole
743 <div class="refsect2" title="GSF_META_NAME_REVISION_COUNT">
744 <a name="GSF-META-NAME-REVISION-COUNT:CAPS"></a><h3>GSF_META_NAME_REVISION_COUNT</h3>
745 <pre class="programlisting">#define GSF_META_NAME_REVISION_COUNT "meta:editing-cycles"
748 (Integer) Count of revision on the document, if appropriate.
749 Moved from gsf:revision-count to meta:editing-cycles. This way can be used
750 correctly by OpenDocument and Gnumeric.
754 <div class="refsect2" title="GSF_META_NAME_EDITING_DURATION">
755 <a name="GSF-META-NAME-EDITING-DURATION:CAPS"></a><h3>GSF_META_NAME_EDITING_DURATION</h3>
756 <pre class="programlisting">#define GSF_META_NAME_EDITING_DURATION "meta:editing-duration"
759 (Date as ISO String) The total-time taken until the last modification.
760 Moved from "gsf" to "meta". This way can be used correctly by OpenDocument
765 <div class="refsect2" title="GSF_META_NAME_TABLE_COUNT">
766 <a name="GSF-META-NAME-TABLE-COUNT:CAPS"></a><h3>GSF_META_NAME_TABLE_COUNT</h3>
767 <pre class="programlisting">#define GSF_META_NAME_TABLE_COUNT "gsf:table-count"
770 (Integer) Count of tables in the document, if appropriate.
774 <div class="refsect2" title="GSF_META_NAME_IMAGE_COUNT">
775 <a name="GSF-META-NAME-IMAGE-COUNT:CAPS"></a><h3>GSF_META_NAME_IMAGE_COUNT</h3>
776 <pre class="programlisting">#define GSF_META_NAME_IMAGE_COUNT "gsf:image-count"
779 (Integer) Count of images in the document, if appropriate.
783 <div class="refsect2" title="GSF_META_NAME_OBJECT_COUNT">
784 <a name="GSF-META-NAME-OBJECT-COUNT:CAPS"></a><h3>GSF_META_NAME_OBJECT_COUNT</h3>
785 <pre class="programlisting">#define GSF_META_NAME_OBJECT_COUNT "gsf:object-count"
788 (Integer) Count of objects (OLE and other graphics) in the document, if
793 <div class="refsect2" title="GSF_META_NAME_PAGE_COUNT">
794 <a name="GSF-META-NAME-PAGE-COUNT:CAPS"></a><h3>GSF_META_NAME_PAGE_COUNT</h3>
795 <pre class="programlisting">#define GSF_META_NAME_PAGE_COUNT "gsf:page-count"
798 (Integer) Count of pages in the document, if appropriate.
802 <div class="refsect2" title="GSF_META_NAME_PARAGRAPH_COUNT">
803 <a name="GSF-META-NAME-PARAGRAPH-COUNT:CAPS"></a><h3>GSF_META_NAME_PARAGRAPH_COUNT</h3>
804 <pre class="programlisting">#define GSF_META_NAME_PARAGRAPH_COUNT "gsf:paragraph-count"
807 (Integer) Count of paragraphs in the document, if appropriate.
811 <div class="refsect2" title="GSF_META_NAME_WORD_COUNT">
812 <a name="GSF-META-NAME-WORD-COUNT:CAPS"></a><h3>GSF_META_NAME_WORD_COUNT</h3>
813 <pre class="programlisting">#define GSF_META_NAME_WORD_COUNT "gsf:word-count"
816 (Integer) Count of words in the document.
820 <div class="refsect2" title="GSF_META_NAME_CHARACTER_COUNT">
821 <a name="GSF-META-NAME-CHARACTER-COUNT:CAPS"></a><h3>GSF_META_NAME_CHARACTER_COUNT</h3>
822 <pre class="programlisting">#define GSF_META_NAME_CHARACTER_COUNT "gsf:character-count"
825 (Integer) Count of characters in the document.
828 TODO See how to sync this with ODF's document-statistic
832 <div class="refsect2" title="GSF_META_NAME_CELL_COUNT">
833 <a name="GSF-META-NAME-CELL-COUNT:CAPS"></a><h3>GSF_META_NAME_CELL_COUNT</h3>
834 <pre class="programlisting">#define GSF_META_NAME_CELL_COUNT "gsf:cell-count"
837 (Integer) Count of cells in the spread-sheet document, if appropriate.
841 <div class="refsect2" title="GSF_META_NAME_SPREADSHEET_COUNT">
842 <a name="GSF-META-NAME-SPREADSHEET-COUNT:CAPS"></a><h3>GSF_META_NAME_SPREADSHEET_COUNT</h3>
843 <pre class="programlisting">#define GSF_META_NAME_SPREADSHEET_COUNT "gsf:spreadsheet-count"
846 (Integer) Count of pages in the document, if appropriate.
850 <div class="refsect2" title="GSF_META_NAME_CREATOR">
851 <a name="GSF-META-NAME-CREATOR:CAPS"></a><h3>GSF_META_NAME_CREATOR</h3>
852 <pre class="programlisting">#define GSF_META_NAME_CREATOR "dc:creator"
855 (String) An entity primarily responsible for making the content of the
856 resource typically a person, organization, or service.
859 1.14.0 Moved from "gsf" to "dc".
863 <div class="refsect2" title="GSF_META_NAME_TEMPLATE">
864 <a name="GSF-META-NAME-TEMPLATE:CAPS"></a><h3>GSF_META_NAME_TEMPLATE</h3>
865 <pre class="programlisting">#define GSF_META_NAME_TEMPLATE "meta:template"
868 (String) The template file that is been used to generate this document.
871 1.14.0 Moved from "gsf" to "meta"
875 <div class="refsect2" title="GSF_META_NAME_LAST_SAVED_BY">
876 <a name="GSF-META-NAME-LAST-SAVED-BY:CAPS"></a><h3>GSF_META_NAME_LAST_SAVED_BY</h3>
877 <pre class="programlisting">#define GSF_META_NAME_LAST_SAVED_BY "gsf:last-saved-by"
880 (String) The entity that made the last change to the document, typically a
881 person, organization, or service.
885 <div class="refsect2" title="GSF_META_NAME_LAST_PRINTED">
886 <a name="GSF-META-NAME-LAST-PRINTED:CAPS"></a><h3>GSF_META_NAME_LAST_PRINTED</h3>
887 <pre class="programlisting">#define GSF_META_NAME_LAST_PRINTED "gsf:last-printed"
890 (GSF_META_NAME_HEADING_PAIRS) The last time this document was printed.
893 1.14.0 Moved from "gsf" to "dc".
894 1.14.1 Moved back to "gsf" from "dc".
898 <div class="refsect2" title="GSF_META_NAME_PRINT_DATE">
899 <a name="GSF-META-NAME-PRINT-DATE:CAPS"></a><h3>GSF_META_NAME_PRINT_DATE</h3>
900 <pre class="programlisting">#define GSF_META_NAME_PRINT_DATE "meta:print-date"
903 (GsfTimestamp) Specifies the date and time when the document was last
908 <div class="refsect2" title="GSF_META_NAME_PRINTED_BY">
909 <a name="GSF-META-NAME-PRINTED-BY:CAPS"></a><h3>GSF_META_NAME_PRINTED_BY</h3>
910 <pre class="programlisting">#define GSF_META_NAME_PRINTED_BY "meta:printed-by"
913 (String) Specifies the name of the last person who printed the document.
916 1.14.0 Moved from "gsf" to "meta".
920 <div class="refsect2" title="GSF_META_NAME_KEYWORD">
921 <a name="GSF-META-NAME-KEYWORD:CAPS"></a><h3>GSF_META_NAME_KEYWORD</h3>
922 <pre class="programlisting">#define GSF_META_NAME_KEYWORD "meta:keyword"
925 (String) Searchable, indexable keywords. Similar to PDF keywords or HTML's
930 <div class="refsect2" title="GSF_META_NAME_SECURITY">
931 <a name="GSF-META-NAME-SECURITY:CAPS"></a><h3>GSF_META_NAME_SECURITY</h3>
932 <pre class="programlisting">#define GSF_META_NAME_SECURITY "gsf:security"
935 (Integer) Level of security.
939 <div class="informaltable"><table border="0">
945 <th align="left">Level</th>
954 <td>Password protected</td>
958 <td>Read-only recommended</td>
962 <td>Read-only enforced</td>
966 <td>Locked for annotations</td>
975 <div class="refsect2" title="GSF_META_NAME_CATEGORY">
976 <a name="GSF-META-NAME-CATEGORY:CAPS"></a><h3>GSF_META_NAME_CATEGORY</h3>
977 <pre class="programlisting">#define GSF_META_NAME_CATEGORY "gsf:category"
980 (String) Category of the document. </p>
981 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
982 <h3 class="title">Note</h3>example???</div>
987 <div class="refsect2" title="GSF_META_NAME_PRESENTATION_FORMAT">
988 <a name="GSF-META-NAME-PRESENTATION-FORMAT:CAPS"></a><h3>GSF_META_NAME_PRESENTATION_FORMAT</h3>
989 <pre class="programlisting">#define GSF_META_NAME_PRESENTATION_FORMAT "gsf:presentation-format"
992 (String) Type of presentation, like "On-screen Show", "SlideView" etc.
996 <div class="refsect2" title="GSF_META_NAME_THUMBNAIL">
997 <a name="GSF-META-NAME-THUMBNAIL:CAPS"></a><h3>GSF_META_NAME_THUMBNAIL</h3>
998 <pre class="programlisting">#define GSF_META_NAME_THUMBNAIL "gsf:thumbnail"
1001 (GsfClipData) Thumbnail data of the document, typically a
1002 preview image of the document.
1006 <div class="refsect2" title="GSF_META_NAME_GENERATOR">
1007 <a name="GSF-META-NAME-GENERATOR:CAPS"></a><h3>GSF_META_NAME_GENERATOR</h3>
1008 <pre class="programlisting">#define GSF_META_NAME_GENERATOR "meta:generator"
1011 (String) The application that generated this document. AbiWord, Gnumeric,
1015 1.14.0 Moved from "gsf" to "meta".
1019 <div class="refsect2" title="GSF_META_NAME_LINE_COUNT">
1020 <a name="GSF-META-NAME-LINE-COUNT:CAPS"></a><h3>GSF_META_NAME_LINE_COUNT</h3>
1021 <pre class="programlisting">#define GSF_META_NAME_LINE_COUNT "gsf:line-count"
1024 (Integer) Count of liness in the document.
1028 <div class="refsect2" title="GSF_META_NAME_SLIDE_COUNT">
1029 <a name="GSF-META-NAME-SLIDE-COUNT:CAPS"></a><h3>GSF_META_NAME_SLIDE_COUNT</h3>
1030 <pre class="programlisting">#define GSF_META_NAME_SLIDE_COUNT "gsf:slide-count"
1033 (Integer) Count of slides in the presentation document.
1037 <div class="refsect2" title="GSF_META_NAME_NOTE_COUNT">
1038 <a name="GSF-META-NAME-NOTE-COUNT:CAPS"></a><h3>GSF_META_NAME_NOTE_COUNT</h3>
1039 <pre class="programlisting">#define GSF_META_NAME_NOTE_COUNT "gsf:note-count"
1042 (Integer) Count of "notes" in the document.
1046 <div class="refsect2" title="GSF_META_NAME_HIDDEN_SLIDE_COUNT">
1047 <a name="GSF-META-NAME-HIDDEN-SLIDE-COUNT:CAPS"></a><h3>GSF_META_NAME_HIDDEN_SLIDE_COUNT</h3>
1048 <pre class="programlisting">#define GSF_META_NAME_HIDDEN_SLIDE_COUNT "gsf:hidden-slide-count"
1051 (Integer) Count of hidden-slides in the presentation document.
1055 <div class="refsect2" title="GSF_META_NAME_MM_CLIP_COUNT">
1056 <a name="GSF-META-NAME-MM-CLIP-COUNT:CAPS"></a><h3>GSF_META_NAME_MM_CLIP_COUNT</h3>
1057 <pre class="programlisting">#define GSF_META_NAME_MM_CLIP_COUNT "gsf:MM-clip-count"
1060 (Integer) Count of "multi-media" clips in the document.
1064 <div class="refsect2" title="GSF_META_NAME_BYTE_COUNT">
1065 <a name="GSF-META-NAME-BYTE-COUNT:CAPS"></a><h3>GSF_META_NAME_BYTE_COUNT</h3>
1066 <pre class="programlisting">#define GSF_META_NAME_BYTE_COUNT "gsf:byte-count"
1069 (Integer) Count of bytes in the document.
1073 <div class="refsect2" title="GSF_META_NAME_SCALE">
1074 <a name="GSF-META-NAME-SCALE:CAPS"></a><h3>GSF_META_NAME_SCALE</h3>
1075 <pre class="programlisting">#define GSF_META_NAME_SCALE "gsf:scale"
1082 <div class="refsect2" title="GSF_META_NAME_HEADING_PAIRS">
1083 <a name="GSF-META-NAME-HEADING-PAIRS:CAPS"></a><h3>GSF_META_NAME_HEADING_PAIRS</h3>
1084 <pre class="programlisting">#define GSF_META_NAME_HEADING_PAIRS "gsf:heading-pairs"
1087 (Vector of string value pairs stored in alternating elements) Store the
1088 counts of objects in the document as names 'worksheet' and count '4'
1093 <div class="refsect2" title="GSF_META_NAME_DOCUMENT_PARTS">
1094 <a name="GSF-META-NAME-DOCUMENT-PARTS:CAPS"></a><h3>GSF_META_NAME_DOCUMENT_PARTS</h3>
1095 <pre class="programlisting">#define GSF_META_NAME_DOCUMENT_PARTS "gsf:document-parts"
1098 (Vector of strings) Names of the 'interesting' parts of the document. In
1099 spreadsheets this is a list of the sheet names, and the named expressions.
1104 <div class="refsect2" title="GSF_META_NAME_MANAGER">
1105 <a name="GSF-META-NAME-MANAGER:CAPS"></a><h3>GSF_META_NAME_MANAGER</h3>
1106 <pre class="programlisting">#define GSF_META_NAME_MANAGER "gsf:manager"
1109 (String) Name of the manager of "CREATOR" entity.
1113 <div class="refsect2" title="GSF_META_NAME_COMPANY">
1114 <a name="GSF-META-NAME-COMPANY:CAPS"></a><h3>GSF_META_NAME_COMPANY</h3>
1115 <pre class="programlisting">#define GSF_META_NAME_COMPANY "dc:publisher"
1118 (String) Name of the company/organization that the "CREATOR" entity is
1122 1.14.1 Moved from "gsf:company" to "dc:publisher".
1126 <div class="refsect2" title="GSF_META_NAME_LINKS_DIRTY">
1127 <a name="GSF-META-NAME-LINKS-DIRTY:CAPS"></a><h3>GSF_META_NAME_LINKS_DIRTY</h3>
1128 <pre class="programlisting">#define GSF_META_NAME_LINKS_DIRTY "gsf:links-dirty"
1135 <div class="refsect2" title="GSF_META_NAME_DICTIONARY">
1136 <a name="GSF-META-NAME-DICTIONARY:CAPS"></a><h3>GSF_META_NAME_DICTIONARY</h3>
1137 <pre class="programlisting">#define GSF_META_NAME_DICTIONARY "gsf:dictionary"
1140 (None) Reserved name (PID) for Dictionary
1144 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_17">
1145 <a name="GSF-META-NAME-MSOLE-UNKNOWN-17:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_17</h3>
1146 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_17 "msole:unknown-doc-17"
1149 (Unknown) User-defined name
1153 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_18">
1154 <a name="GSF-META-NAME-MSOLE-UNKNOWN-18:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_18</h3>
1155 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_18 "msole:unknown-doc-18"
1158 (Unknown) User-defined name
1162 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_19">
1163 <a name="GSF-META-NAME-MSOLE-UNKNOWN-19:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_19</h3>
1164 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_19 "msole:unknown-doc-19"
1167 (Boolean) User-defined name
1171 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_20">
1172 <a name="GSF-META-NAME-MSOLE-UNKNOWN-20:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_20</h3>
1173 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_20 "msole:unknown-doc-20"
1176 (Unknown) User-defined name
1180 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_21">
1181 <a name="GSF-META-NAME-MSOLE-UNKNOWN-21:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_21</h3>
1182 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_21 "msole:unknown-doc-21"
1185 (Unknown) User-defined name
1189 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_22">
1190 <a name="GSF-META-NAME-MSOLE-UNKNOWN-22:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_22</h3>
1191 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_22 "msole:unknown-doc-22"
1194 (Boolean) User-defined name
1198 <div class="refsect2" title="GSF_META_NAME_MSOLE_UNKNOWN_23">
1199 <a name="GSF-META-NAME-MSOLE-UNKNOWN-23:CAPS"></a><h3>GSF_META_NAME_MSOLE_UNKNOWN_23</h3>
1200 <pre class="programlisting">#define GSF_META_NAME_MSOLE_UNKNOWN_23 "msole:unknown-doc-23"
1203 (i4) User-defined name
1207 <div class="refsect2" title="GSF_META_NAME_LOCALE_SYSTEM_DEFAULT">
1208 <a name="GSF-META-NAME-LOCALE-SYSTEM-DEFAULT:CAPS"></a><h3>GSF_META_NAME_LOCALE_SYSTEM_DEFAULT</h3>
1209 <pre class="programlisting">#define GSF_META_NAME_LOCALE_SYSTEM_DEFAULT "gsf:default-locale"
1212 (Unsigned Integer) Identifier representing the default system locale.
1216 <div class="refsect2" title="GSF_META_NAME_CASE_SENSITIVE">
1217 <a name="GSF-META-NAME-CASE-SENSITIVE:CAPS"></a><h3>GSF_META_NAME_CASE_SENSITIVE</h3>
1218 <pre class="programlisting">#define GSF_META_NAME_CASE_SENSITIVE "gsf:case-sensitivity"
1221 (Unsigned Integer) Identifier representing the case-sensitiveness.
1223 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1224 <h3 class="title">Note</h3>of what ?? why is it an integer ??</div>
1229 <div class="refsect2" title="GSF_META_NAME_INITIAL_CREATOR">
1230 <a name="GSF-META-NAME-INITIAL-CREATOR:CAPS"></a><h3>GSF_META_NAME_INITIAL_CREATOR</h3>
1231 <pre class="programlisting">#define GSF_META_NAME_INITIAL_CREATOR "meta:initial-creator"
1234 (String) Specifies the name of the person who created the document
1236 1.14.0 Moved from "gsf" to "meta".
1241 <div class="footer">
1243 Generated by GTK-Doc V1.14</div>