1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
<refentry id="GnomeAbout">
<refmeta>
<refentrytitle role="top_of_page">GnomeAbout</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeAbout</refname>
<refpurpose>Display author, documenter and translator credits for an application.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
<link linkend="GnomeAbout-struct">GnomeAbout</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-about-new">gnome_about_new</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *version,
const <link linkend="gchar">gchar</link> *copyright,
const <link linkend="gchar">gchar</link> *comments,
const <link linkend="gchar">gchar</link> **authors,
const <link linkend="gchar">gchar</link> **documenters,
const <link linkend="gchar">gchar</link> *translator_credits,
<link linkend="GdkPixbuf">GdkPixbuf</link> *logo_pixbuf);
<link linkend="void">void</link> <link linkend="gnome-about-construct">gnome_about_construct</link> (<link linkend="GnomeAbout">GnomeAbout</link> *about,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *version,
const <link linkend="gchar">gchar</link> *copyright,
const <link linkend="gchar">gchar</link> *comments,
const <link linkend="gchar">gchar</link> **authors,
const <link linkend="gchar">gchar</link> **documenters,
const <link linkend="gchar">gchar</link> *translator_credits,
<link linkend="GdkPixbuf">GdkPixbuf</link> *logo_pixbuf);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkWindow">GtkWindow</link>
+----<link linkend="GtkDialog">GtkDialog</link>
+----GnomeAbout
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeAbout implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GnomeAbout--authors">authors</link>" <link linkend="GValueArray">GValueArray</link> : Write
"<link linkend="GnomeAbout--comments">comments</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GnomeAbout--copyright">copyright</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GnomeAbout--documenters">documenters</link>" <link linkend="GValueArray">GValueArray</link> : Write
"<link linkend="GnomeAbout--logo">logo</link>" <link linkend="GdkPixbuf">GdkPixbuf</link> : Write
"<link linkend="GnomeAbout--name">name</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GnomeAbout--translator-credits">translator-credits</link>" <link linkend="gchararray">gchararray</link> : Read / Write
"<link linkend="GnomeAbout--version">version</link>" <link linkend="gchararray">gchararray</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
The GnomeAbout widget is used as the standard way of displaying credits in an
application. Typically, it will be called when a user selects the
<literal>About...</literal> option from the <literal>Help</literal> menu. With
one simple function call, the application can then display all of the
appropriate information.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomeAbout-struct" role="struct"/>GnomeAbout</title>
<indexterm role="deprecated"><primary>GnomeAbout</primary></indexterm><programlisting>typedef struct _GnomeAbout GnomeAbout;</programlisting>
<warning><para><literal>GnomeAbout</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
A dialog box widget containing all of the relevant credit information and
displaying as three notebook pages.
</para></refsect2>
<refsect2>
<title><anchor id="gnome-about-new" role="function" condition="deprecated:"/>gnome_about_new ()</title>
<indexterm role="deprecated"><primary>gnome_about_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_about_new (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *version,
const <link linkend="gchar">gchar</link> *copyright,
const <link linkend="gchar">gchar</link> *comments,
const <link linkend="gchar">gchar</link> **authors,
const <link linkend="gchar">gchar</link> **documenters,
const <link linkend="gchar">gchar</link> *translator_credits,
<link linkend="GdkPixbuf">GdkPixbuf</link> *logo_pixbuf);</programlisting>
<warning><para><literal>gnome_about_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Construct an application's credits box. The <parameter>authors</parameter> array cannot be empty
and the <parameter>translator_credits</parameter> should be marked as a translatable string (so
that only the translator for the currently active locale is displayed).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The name of the application.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>version</parameter> :</term>
<listitem><simpara> The version string of the application.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>copyright</parameter> :</term>
<listitem><simpara> The application's copyright statement.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>comments</parameter> :</term>
<listitem><simpara> A short miscellaneous string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>authors</parameter> :</term>
<listitem><simpara> An <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array of the application authors.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>documenters</parameter> :</term>
<listitem><simpara> An array of the application documenters.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>translator_credits</parameter> :</term>
<listitem><simpara> The translator for the current locale.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>logo_pixbuf</parameter> :</term>
<listitem><simpara> The application's logo.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new "About" dialog.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-about-construct" role="function" condition="deprecated:"/>gnome_about_construct ()</title>
<indexterm role="deprecated"><primary>gnome_about_construct</primary></indexterm><programlisting><link linkend="void">void</link> gnome_about_construct (<link linkend="GnomeAbout">GnomeAbout</link> *about,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *version,
const <link linkend="gchar">gchar</link> *copyright,
const <link linkend="gchar">gchar</link> *comments,
const <link linkend="gchar">gchar</link> **authors,
const <link linkend="gchar">gchar</link> **documenters,
const <link linkend="gchar">gchar</link> *translator_credits,
<link linkend="GdkPixbuf">GdkPixbuf</link> *logo_pixbuf);</programlisting>
<warning><para><literal>gnome_about_construct</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Similar to <link linkend="gnome-about-new"><function>gnome_about_new()</function></link> except that the pre-existing <parameter>about</parameter> widget is
used. Note that in this version of the function, <parameter>authors</parameter> is not checked to
be non-<link linkend="NULL:CAPS"><literal>NULL</literal></link>, so callers must be careful, since bad things will happen if
this condition is not met.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>about</parameter> :</term>
<listitem><simpara> An existing <link linkend="GnomeAbout"><type>GnomeAbout</type></link> instance.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The name of the application.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>version</parameter> :</term>
<listitem><simpara> The version string of the application.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>copyright</parameter> :</term>
<listitem><simpara> The application's copyright statement.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>comments</parameter> :</term>
<listitem><simpara> A short miscellaneous string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>authors</parameter> :</term>
<listitem><simpara> An <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array of the application authors.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>documenters</parameter> :</term>
<listitem><simpara> An array of the application documenters.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>translator_credits</parameter> :</term>
<listitem><simpara> The translator for the current locale.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>logo_pixbuf</parameter> :</term>
<listitem><simpara> The application's logo.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomeAbout--authors"/>The <literal>"authors"</literal> property</title>
<indexterm><primary>GnomeAbout:authors</primary></indexterm><programlisting> "authors" <link linkend="GValueArray">GValueArray</link> : Write</programlisting>
<para>List of authors of the programs.</para></refsect2>
<refsect2><title><anchor id="GnomeAbout--comments"/>The <literal>"comments"</literal> property</title>
<indexterm><primary>GnomeAbout:comments</primary></indexterm><programlisting> "comments" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>Comments about the program.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GnomeAbout--copyright"/>The <literal>"copyright"</literal> property</title>
<indexterm><primary>GnomeAbout:copyright</primary></indexterm><programlisting> "copyright" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>Copyright information for the program.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GnomeAbout--documenters"/>The <literal>"documenters"</literal> property</title>
<indexterm><primary>GnomeAbout:documenters</primary></indexterm><programlisting> "documenters" <link linkend="GValueArray">GValueArray</link> : Write</programlisting>
<para>List of people documenting the program.</para></refsect2>
<refsect2><title><anchor id="GnomeAbout--logo"/>The <literal>"logo"</literal> property</title>
<indexterm><primary>GnomeAbout:logo</primary></indexterm><programlisting> "logo" <link linkend="GdkPixbuf">GdkPixbuf</link> : Write</programlisting>
<para>A logo for the about box.</para></refsect2>
<refsect2><title><anchor id="GnomeAbout--name"/>The <literal>"name"</literal> property</title>
<indexterm><primary>GnomeAbout:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>The name of the program.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GnomeAbout--translator-credits"/>The <literal>"translator-credits"</literal> property</title>
<indexterm><primary>GnomeAbout:translator-credits</primary></indexterm><programlisting> "translator-credits" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>Credits to the translators. This string should be marked as translatable.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GnomeAbout--version"/>The <literal>"version"</literal> property</title>
<indexterm><primary>GnomeAbout:version</primary></indexterm><programlisting> "version" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>The version of the program.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
