← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/xml/file-priv.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/file-priv.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="GOFileSaver">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="GOFileSaver.top_of_page">GOFileSaver</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GOFFICE-0.6 Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>GOFileSaver</refname>
 
16
<refpurpose></refpurpose>
 
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
18
</refnamediv>
 
19
 
 
20
<refsynopsisdiv id="GOFileSaver.synopsis" role="synopsis">
 
21
<title role="synopsis.title">Synopsis</title>
 
22
 
 
23
<synopsis>
 
24
#define             <link linkend="GO-FILE-OPENER-CLASS:CAPS">GO_FILE_OPENER_CLASS</link>                (klass)
 
25
#define             <link linkend="GO-FILE-OPENER-METHOD:CAPS">GO_FILE_OPENER_METHOD</link>               (obj,name)
 
26
<link linkend="void">void</link>                <link linkend="go-file-opener-setup">go_file_opener_setup</link>                (<link linkend="GOFileOpener">GOFileOpener</link> *fo,
 
27
                                                         const <link linkend="gchar">gchar</link> *id,
 
28
                                                         const <link linkend="gchar">gchar</link> *description,
 
29
                                                         <link linkend="GSList">GSList</link> *suffixes,
 
30
                                                         <link linkend="GSList">GSList</link> *mimes,
 
31
                                                         <link linkend="gboolean">gboolean</link> encoding_dependent,
 
32
                                                         <link linkend="GOFileOpenerProbeFunc">GOFileOpenerProbeFunc</link> probe_func,
 
33
                                                         <link linkend="GOFileOpenerOpenFunc">GOFileOpenerOpenFunc</link> open_func);
 
34
#define             <link linkend="GO-FILE-SAVER-METHOD:CAPS">GO_FILE_SAVER_METHOD</link>                (obj,name)
 
35
#define             <link linkend="GO-FILE-SAVER-CLASS:CAPS">GO_FILE_SAVER_CLASS</link>                 (klass)
 
36
</synopsis>
 
37
</refsynopsisdiv>
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
<refsect1 id="GOFileSaver.description" role="desc">
 
48
<title role="desc.title">Description</title>
 
49
<para>
 
50
 
 
51
</para>
 
52
</refsect1>
 
53
 
 
54
<refsect1 id="GOFileSaver.details" role="details">
 
55
<title role="details.title">Details</title>
 
56
<refsect2 id="GO-FILE-OPENER-CLASS:CAPS" role="macro">
 
57
<title>GO_FILE_OPENER_CLASS()</title>
 
58
<indexterm zone="GO-FILE-OPENER-CLASS:CAPS"><primary>GO_FILE_OPENER_CLASS</primary></indexterm><programlisting>#define GO_FILE_OPENER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_GO_FILE_OPENER, GOFileOpenerClass))
 
59
</programlisting>
 
60
<para>
 
61
 
 
62
</para><variablelist role="params">
 
63
<varlistentry><term><parameter>klass</parameter>&nbsp;:</term>
 
64
<listitem><simpara>
 
65
 
 
66
 
 
67
</simpara></listitem></varlistentry>
 
68
</variablelist></refsect2>
 
69
<refsect2 id="GO-FILE-OPENER-METHOD:CAPS" role="macro">
 
70
<title>GO_FILE_OPENER_METHOD()</title>
 
71
<indexterm zone="GO-FILE-OPENER-METHOD:CAPS"><primary>GO_FILE_OPENER_METHOD</primary></indexterm><programlisting>#define             GO_FILE_OPENER_METHOD(obj,name)</programlisting>
 
72
<para>
 
73
 
 
74
</para><variablelist role="params">
 
75
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
76
<listitem><simpara>
 
77
</simpara></listitem></varlistentry>
 
78
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
79
<listitem><simpara>
 
80
 
 
81
 
 
82
</simpara></listitem></varlistentry>
 
83
</variablelist></refsect2>
 
84
<refsect2 id="go-file-opener-setup" role="function">
 
85
<title>go_file_opener_setup ()</title>
 
86
<indexterm zone="go-file-opener-setup"><primary>go_file_opener_setup</primary></indexterm><programlisting><link linkend="void">void</link>                go_file_opener_setup                (<link linkend="GOFileOpener">GOFileOpener</link> *fo,
 
87
                                                         const <link linkend="gchar">gchar</link> *id,
 
88
                                                         const <link linkend="gchar">gchar</link> *description,
 
89
                                                         <link linkend="GSList">GSList</link> *suffixes,
 
90
                                                         <link linkend="GSList">GSList</link> *mimes,
 
91
                                                         <link linkend="gboolean">gboolean</link> encoding_dependent,
 
92
                                                         <link linkend="GOFileOpenerProbeFunc">GOFileOpenerProbeFunc</link> probe_func,
 
93
                                                         <link linkend="GOFileOpenerOpenFunc">GOFileOpenerOpenFunc</link> open_func);</programlisting>
 
94
<para>
 
95
Sets up GOFileOpener object, newly created with g_object_new function.
 
96
This is intended to be used only by GOFileOpener derivates.
 
97
Use go_file_opener_new, if you want to create GOFileOpener object.</para>
 
98
<para>
 
99
 
 
100
</para><variablelist role="params">
 
101
<varlistentry><term><parameter>fo</parameter>&nbsp;:</term>
 
102
<listitem><simpara> Newly created GOFileOpener object
 
103
</simpara></listitem></varlistentry>
 
104
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
 
105
<listitem><simpara> Optional ID of the opener (or NULL)
 
106
</simpara></listitem></varlistentry>
 
107
<varlistentry><term><parameter>description</parameter>&nbsp;:</term>
 
108
<listitem><simpara> Description of supported file format
 
109
</simpara></listitem></varlistentry>
 
110
<varlistentry><term><parameter>suffixes</parameter>&nbsp;:</term>
 
111
<listitem><simpara>
 
112
</simpara></listitem></varlistentry>
 
113
<varlistentry><term><parameter>mimes</parameter>&nbsp;:</term>
 
114
<listitem><simpara>
 
115
</simpara></listitem></varlistentry>
 
116
<varlistentry><term><parameter>encoding_dependent</parameter>&nbsp;:</term>
 
117
<listitem><simpara> whether the opener depends on an encoding sel.
 
118
</simpara></listitem></varlistentry>
 
119
<varlistentry><term><parameter>probe_func</parameter>&nbsp;:</term>
 
120
<listitem><simpara> Optional pointer to "probe" function (or NULL)
 
121
</simpara></listitem></varlistentry>
 
122
<varlistentry><term><parameter>open_func</parameter>&nbsp;:</term>
 
123
<listitem><simpara> Pointer to "open" function
 
124
</simpara></listitem></varlistentry>
 
125
</variablelist></refsect2>
 
126
<refsect2 id="GO-FILE-SAVER-METHOD:CAPS" role="macro">
 
127
<title>GO_FILE_SAVER_METHOD()</title>
 
128
<indexterm zone="GO-FILE-SAVER-METHOD:CAPS"><primary>GO_FILE_SAVER_METHOD</primary></indexterm><programlisting>#define             GO_FILE_SAVER_METHOD(obj,name)</programlisting>
 
129
<para>
 
130
 
 
131
</para><variablelist role="params">
 
132
<varlistentry><term><parameter>obj</parameter>&nbsp;:</term>
 
133
<listitem><simpara>
 
134
</simpara></listitem></varlistentry>
 
135
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
136
<listitem><simpara>
 
137
 
 
138
 
 
139
</simpara></listitem></varlistentry>
 
140
</variablelist></refsect2>
 
141
<refsect2 id="GO-FILE-SAVER-CLASS:CAPS" role="macro">
 
142
<title>GO_FILE_SAVER_CLASS()</title>
 
143
<indexterm zone="GO-FILE-SAVER-CLASS:CAPS"><primary>GO_FILE_SAVER_CLASS</primary></indexterm><programlisting>#define GO_FILE_SAVER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_GO_FILE_SAVER, GOFileSaverClass))
 
144
</programlisting>
 
145
<para>
 
146
 
 
147
</para><variablelist role="params">
 
148
<varlistentry><term><parameter>klass</parameter>&nbsp;:</term>
 
149
<listitem><simpara>
 
150
 
 
151
 
 
152
</simpara></listitem></varlistentry>
 
153
</variablelist></refsect2>
 
154
 
 
155
</refsect1>
 
156
 
 
157
 
 
158
 
 
159
 
 
160
</refentry>