/usr/share/gtk-doc/html/libxfcegui4/XfceAboutDialog.html is in libxfcegui4-dev 4.8.1-5ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfceAboutDialog</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libxfcegui4 Reference Manual">
<link rel="up" href="libxfcegui4-core.html" title="Xfce GUI Core Reference">
<link rel="prev" href="libxfcegui4-dialogs.html" title="Dialogs">
<link rel="next" href="XfceAppMenuItem.html" title="XfceAppMenuItem">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libxfcegui4-dialogs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfcegui4-core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libxfcegui4 Reference Manual</th>
<td><a accesskey="n" href="XfceAppMenuItem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#XfceAboutDialog.synopsis" class="shortcut">Top</a>
|
<a href="#XfceAboutDialog.description" class="shortcut">Description</a>
|
<a href="#XfceAboutDialog.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#XfceAboutDialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#XfceAboutDialog.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="XfceAboutDialog">
<a name="XfceAboutDialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XfceAboutDialog.top_of_page"></a>XfceAboutDialog</span></h2>
<p>XfceAboutDialog — display information about a project.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="XfceAboutDialog.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libxfcegui4/libxfcegui4.h>
<a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo">XfceAboutInfo</a>;
<a class="link" href="XfceAboutDialog.html#XfceAboutDialog-struct" title="XfceAboutDialog">XfceAboutDialog</a>;
#define <a class="link" href="XfceAboutDialog.html#XFCE-COPYRIGHT-TEXT:CAPS" title="XFCE_COPYRIGHT_TEXT()">XFCE_COPYRIGHT_TEXT</a> (years,
owner)
<a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="returnvalue">XfceAboutInfo</span></a> * <a class="link" href="XfceAboutDialog.html#xfce-about-info-new" title="xfce_about_info_new ()">xfce_about_info_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *program</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *version</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *copyright</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *license</code></em>);
<span class="returnvalue">void</span> <a class="link" href="XfceAboutDialog.html#xfce-about-info-free" title="xfce_about_info_free ()">xfce_about_info_free</a> (<em class="parameter"><code><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>);
<span class="returnvalue">void</span> <a class="link" href="XfceAboutDialog.html#xfce-about-info-set-homepage" title="xfce_about_info_set_homepage ()">xfce_about_info_set_homepage</a> (<em class="parameter"><code><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *homepage</code></em>);
<span class="returnvalue">void</span> <a class="link" href="XfceAboutDialog.html#xfce-about-info-add-credit" title="xfce_about_info_add_credit ()">xfce_about_info_add_credit</a> (<em class="parameter"><code><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *mail</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *task</code></em>);
<span class="returnvalue">GtkWidget</span>* <a class="link" href="XfceAboutDialog.html#xfce-about-dialog-new" title="xfce_about_dialog_new ()">xfce_about_dialog_new</a> (<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
<em class="parameter"><code>const <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="XfceAboutDialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkWindow
+----GtkDialog
+----XfceAboutDialog
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="XfceAboutDialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
XfceAboutDialog implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" title="Properties">
<a name="XfceAboutDialog.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--copyright" title='The "copyright" property'>copyright</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--description" title='The "description" property'>description</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--homepage" title='The "homepage" property'>homepage</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--icon" title='The "icon" property'>icon</a>" <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--license" title='The "license" property'>license</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--program" title='The "program" property'>program</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="XfceAboutDialog.html#XfceAboutDialog--version" title='The "version" property'>version</a>" <span class="type">gchar</span>* : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="XfceAboutDialog.description"></a><h2>Description</h2>
<p>
A dialog box widget containing all of the relevant credit information.
</p>
</div>
<div class="refsect1" title="Details">
<a name="XfceAboutDialog.details"></a><h2>Details</h2>
<div class="refsect2" title="XfceAboutInfo">
<a name="XfceAboutInfo"></a><h3>XfceAboutInfo</h3>
<pre class="programlisting">typedef struct _XfceAboutInfo XfceAboutInfo;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="XfceAboutDialog">
<a name="XfceAboutDialog-struct"></a><h3>XfceAboutDialog</h3>
<pre class="programlisting">typedef struct _XfceAboutDialog XfceAboutDialog;</pre>
<p>
A dialog box widget that contains all the credit information relevant to
a projects, and displays it in up to three notebook tabs.
</p>
</div>
<hr>
<div class="refsect2" title="XFCE_COPYRIGHT_TEXT()">
<a name="XFCE-COPYRIGHT-TEXT:CAPS"></a><h3>XFCE_COPYRIGHT_TEXT()</h3>
<pre class="programlisting">#define XFCE_COPYRIGHT_TEXT(years, owner) ("Copyright (c) " years "\n" owner "\nAll rights reserved.")
</pre>
<p>
Generates a default copyright text from the given information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>years</code></em> :</span></p></td>
<td>year information (e.g. "2002-2004").
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td>
<td>the copyright owner.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="xfce_about_info_new ()">
<a name="xfce-about-info-new"></a><h3>xfce_about_info_new ()</h3>
<pre class="programlisting"><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="returnvalue">XfceAboutInfo</span></a> * xfce_about_info_new (<em class="parameter"><code>const <span class="type">gchar</span> *program</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *version</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *copyright</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *license</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td>program name (e.g. "xfce4-session")
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
<td>application version.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td>short descriptive text (e.g. "Xfce session manager").
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>copyright</code></em> :</span></p></td>
<td>copyright text, use the <a class="link" href="XfceAboutDialog.html#XFCE-COPYRIGHT-TEXT:CAPS" title="XFCE_COPYRIGHT_TEXT()"><span class="type">XFCE_COPYRIGHT_TEXT</span></a> macro. This
parameter is optional. If set to NULL, a default copyright
text will be choosen.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>license</code></em> :</span></p></td>
<td>optional license text, can either be the text of a license
or can be one of the builtin license constants, which are
limited to XFCE_LICENSE_BSD, XFCE_LICENSE_GPL and
XFCE_LICENSE_LGPL currently. If NULL, no license text will
be displayed.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> object or NULL on error. The result
needs to be freed using <a class="link" href="XfceAboutDialog.html#xfce-about-info-free" title="xfce_about_info_free ()"><code class="function">xfce_about_info_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="xfce_about_info_free ()">
<a name="xfce-about-info-free"></a><h3>xfce_about_info_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfce_about_info_free (<em class="parameter"><code><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>);</pre>
<p>
Frees the <em class="parameter"><code>info</code></em> object and all resources covered by it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>an <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="xfce_about_info_set_homepage ()">
<a name="xfce-about-info-set-homepage"></a><h3>xfce_about_info_set_homepage ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfce_about_info_set_homepage (<em class="parameter"><code><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *homepage</code></em>);</pre>
<p>
Associates a <em class="parameter"><code>homepage</code></em> with the <em class="parameter"><code>info</code></em> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>an <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>homepage</code></em> :</span></p></td>
<td>the URL of the projects website, has to be a valid URL, that
can be loaded by a webbrowser.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="xfce_about_info_add_credit ()">
<a name="xfce-about-info-add-credit"></a><h3>xfce_about_info_add_credit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfce_about_info_add_credit (<em class="parameter"><code><a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *mail</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *task</code></em>);</pre>
<p>
Adds a credit to the <em class="parameter"><code>info</code></em> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>an <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the full name of the person.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mail</code></em> :</span></p></td>
<td>the persons email address.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>task</code></em> :</span></p></td>
<td>the persons task in the project.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="xfce_about_dialog_new ()">
<a name="xfce-about-dialog-new"></a><h3>xfce_about_dialog_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span>* xfce_about_dialog_new (<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
<em class="parameter"><code>const <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> *info</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>parent window or NULL.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>an <a class="link" href="XfceAboutDialog.html#XfceAboutInfo" title="XfceAboutInfo"><span class="type">XfceAboutInfo</span></a> object with the about info.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>an optional icon, if NULL, no icon will be displayed.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly allocated dialog widget.
<em class="parameter"><code>Deprecated</code></em>: Use xfce_about_dialog_new_with_values instead.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="XfceAboutDialog.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "copyright" property'>
<a name="XfceAboutDialog--copyright"></a><h3>The <code class="literal">"copyright"</code> property</h3>
<pre class="programlisting"> "copyright" <span class="type">gchar</span>* : Read / Write</pre>
<p>Program Copyright.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "description" property'>
<a name="XfceAboutDialog--description"></a><h3>The <code class="literal">"description"</code> property</h3>
<pre class="programlisting"> "description" <span class="type">gchar</span>* : Read / Write</pre>
<p>Program Description.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "homepage" property'>
<a name="XfceAboutDialog--homepage"></a><h3>The <code class="literal">"homepage"</code> property</h3>
<pre class="programlisting"> "homepage" <span class="type">gchar</span>* : Read / Write</pre>
<p>Program Homepage.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "icon" property'>
<a name="XfceAboutDialog--icon"></a><h3>The <code class="literal">"icon"</code> property</h3>
<pre class="programlisting"> "icon" <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write</pre>
<p>icon to use, if any.</p>
</div>
<hr>
<div class="refsect2" title='The "license" property'>
<a name="XfceAboutDialog--license"></a><h3>The <code class="literal">"license"</code> property</h3>
<pre class="programlisting"> "license" <span class="type">gchar</span>* : Read / Write</pre>
<p>Program License.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "program" property'>
<a name="XfceAboutDialog--program"></a><h3>The <code class="literal">"program"</code> property</h3>
<pre class="programlisting"> "program" <span class="type">gchar</span>* : Read / Write</pre>
<p>Program Name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "version" property'>
<a name="XfceAboutDialog--version"></a><h3>The <code class="literal">"version"</code> property</h3>
<pre class="programlisting"> "version" <span class="type">gchar</span>* : Read / Write</pre>
<p>Program Version.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|