← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/goffice/jaunty-updates

« back to all changes in this revision

Viewing changes to docs/reference/xml/go-doc-impl.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gauvain Pocentek
  • Date: 2008-11-09 18:10:54 UTC
  • mfrom: (1.1.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20081109181054-uazweo6uci8h7bc5
Tags: 0.6.5-1ubuntu1
* Merge from debian unstable, remaining changes:
  - call intltool-update -p in debian/rules
  - libgoffice-gtk-0-6 is a transitional package
  - libgoffice-0-6 conflicts with libgoffice-gtk-0-6 (<< 0.6.3-1ubuntu2)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/go-doc-impl.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY version SYSTEM "version.xml">
 
5
]
 
6
>
 
7
<refentry id="GODoc">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="GODoc.top_of_page">GODoc</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GOFFICE-0.6 Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>GODoc</refname>
 
16
<refpurpose></refpurpose>
 
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
18
</refnamediv>
 
19
 
 
20
<refsynopsisdiv id="GODoc.synopsis" role="synopsis">
 
21
<title role="synopsis.title">Synopsis</title>
 
22
 
 
23
<synopsis>
 
24
                    <link linkend="GODoc-struct">GODoc</link>;
 
25
#define             <link linkend="GO-DOC-CLASS:CAPS">GO_DOC_CLASS</link>                        (k)
 
26
#define             <link linkend="IS-GO-DOC-CLASS:CAPS">IS_GO_DOC_CLASS</link>                     (k)
 
27
#define             <link linkend="GO-DOC-GET-CLASS:CAPS">GO_DOC_GET_CLASS</link>                    (o)
 
28
</synopsis>
 
29
</refsynopsisdiv>
 
30
 
 
31
<refsect1 id="GODoc.object-hierarchy" role="object_hierarchy">
 
32
<title role="object_hierarchy.title">Object Hierarchy</title>
 
33
<synopsis>
 
34
  <link linkend="GObject">GObject</link>
 
35
   +----GODoc
 
36
</synopsis>
 
37
 
 
38
</refsect1>
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
<refsect1 id="GODoc.properties" role="properties">
 
45
<title role="properties.title">Properties</title>
 
46
<synopsis>
 
47
  &quot;<link linkend="GODoc--dirty">dirty</link>&quot;                    <link linkend="gboolean">gboolean</link>              : Read / Write
 
48
  &quot;<link linkend="GODoc--uri">uri</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write
 
49
</synopsis>
 
50
</refsect1>
 
51
 
 
52
<refsect1 id="GODoc.signals" role="signal_proto">
 
53
<title role="signal_proto.title">Signals</title>
 
54
<synopsis>
 
55
  &quot;<link linkend="GODoc-metadata-changed">metadata-changed</link>&quot;                               : Run Last
 
56
  &quot;<link linkend="GODoc-metadata-update">metadata-update</link>&quot;                                : Run Last
 
57
</synopsis>
 
58
</refsect1>
 
59
 
 
60
 
 
61
<refsect1 id="GODoc.description" role="desc">
 
62
<title role="desc.title">Description</title>
 
63
<para>
 
64
 
 
65
</para>
 
66
</refsect1>
 
67
 
 
68
<refsect1 id="GODoc.details" role="details">
 
69
<title role="details.title">Details</title>
 
70
<refsect2 id="GODoc-struct" role="struct">
 
71
<title>GODoc</title>
 
72
<indexterm zone="GODoc-struct"><primary>GODoc</primary></indexterm><programlisting>typedef struct _GODoc GODoc;</programlisting>
 
73
<para>
 
74
 
 
75
</para></refsect2>
 
76
<refsect2 id="GO-DOC-CLASS:CAPS" role="macro">
 
77
<title>GO_DOC_CLASS()</title>
 
78
<indexterm zone="GO-DOC-CLASS:CAPS"><primary>GO_DOC_CLASS</primary></indexterm><programlisting>#define GO_DOC_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GO_DOC_TYPE, GODocClass))
 
79
</programlisting>
 
80
<para>
 
81
 
 
82
</para><variablelist role="params">
 
83
<varlistentry><term><parameter>k</parameter>&nbsp;:</term>
 
84
<listitem><simpara>
 
85
 
 
86
 
 
87
</simpara></listitem></varlistentry>
 
88
</variablelist></refsect2>
 
89
<refsect2 id="IS-GO-DOC-CLASS:CAPS" role="macro">
 
90
<title>IS_GO_DOC_CLASS()</title>
 
91
<indexterm zone="IS-GO-DOC-CLASS:CAPS"><primary>IS_GO_DOC_CLASS</primary></indexterm><programlisting>#define IS_GO_DOC_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GO_DOC_TYPE))
 
92
</programlisting>
 
93
<para>
 
94
 
 
95
</para><variablelist role="params">
 
96
<varlistentry><term><parameter>k</parameter>&nbsp;:</term>
 
97
<listitem><simpara>
 
98
 
 
99
 
 
100
</simpara></listitem></varlistentry>
 
101
</variablelist></refsect2>
 
102
<refsect2 id="GO-DOC-GET-CLASS:CAPS" role="macro">
 
103
<title>GO_DOC_GET_CLASS()</title>
 
104
<indexterm zone="GO-DOC-GET-CLASS:CAPS"><primary>GO_DOC_GET_CLASS</primary></indexterm><programlisting>#define GO_DOC_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GO_DOC_TYPE, GODocClass))
 
105
</programlisting>
 
106
<para>
 
107
 
 
108
</para><variablelist role="params">
 
109
<varlistentry><term><parameter>o</parameter>&nbsp;:</term>
 
110
<listitem><simpara>
 
111
 
 
112
 
 
113
</simpara></listitem></varlistentry>
 
114
</variablelist></refsect2>
 
115
 
 
116
</refsect1>
 
117
<refsect1 id="GODoc.property-details" role="property_details">
 
118
<title role="property_details.title">Property Details</title>
 
119
<refsect2 id="GODoc--dirty"><title>The <literal>&quot;dirty&quot;</literal> property</title>
 
120
<indexterm zone="GODoc--dirty"><primary>GODoc:dirty</primary></indexterm><programlisting>  &quot;dirty&quot;                    <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
121
<para>Whether the document has been changed.</para><para>Default value: FALSE</para>
 
122
</refsect2>
 
123
<refsect2 id="GODoc--uri"><title>The <literal>&quot;uri&quot;</literal> property</title>
 
124
<indexterm zone="GODoc--uri"><primary>GODoc:uri</primary></indexterm><programlisting>  &quot;uri&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
 
125
<para>The URI associated with this document.</para><para>Default value: NULL</para>
 
126
</refsect2>
 
127
 
 
128
</refsect1>
 
129
 
 
130
<refsect1 id="GODoc.signal-details" role="signals">
 
131
<title role="signals.title">Signal Details</title>
 
132
<refsect2 id="GODoc-metadata-changed"><title>The <literal>&quot;metadata-changed&quot;</literal> signal</title>
 
133
<indexterm zone="GODoc-metadata-changed"><primary>GODoc::metadata-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GODoc">GODoc</link>   *godoc,
 
134
                                                        <link linkend="gpointer">gpointer</link> user_data)      : Run Last</programlisting>
 
135
<para>
 
136
 
 
137
</para><variablelist role="params">
 
138
<varlistentry><term><parameter>godoc</parameter>&nbsp;:</term>
 
139
<listitem><simpara>the object which received the signal.
 
140
 
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
143
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
144
</variablelist></refsect2><refsect2 id="GODoc-metadata-update"><title>The <literal>&quot;metadata-update&quot;</literal> signal</title>
 
145
<indexterm zone="GODoc-metadata-update"><primary>GODoc::metadata-update</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GODoc">GODoc</link>   *godoc,
 
146
                                                        <link linkend="gpointer">gpointer</link> user_data)      : Run Last</programlisting>
 
147
<para>
 
148
 
 
149
</para><variablelist role="params">
 
150
<varlistentry><term><parameter>godoc</parameter>&nbsp;:</term>
 
151
<listitem><simpara>the object which received the signal.
 
152
 
 
153
</simpara></listitem></varlistentry>
 
154
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
155
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
156
</variablelist></refsect2>
 
157
</refsect1>
 
158
 
 
159
 
 
160
 
 
161
</refentry>