|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeAbout</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="application-mgmt.html" title="Application management">
<link rel="prev" href="libgnomeui-gnome-window-icon.html" title="gnome-window-icon">
<link rel="next" href="libgnomeui-GnomeMultiScreen.html" title="GnomeMultiScreen">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="GNOME UI Library (libgnomeui)">
</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="libgnomeui-gnome-window-icon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="application-mgmt.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">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-GnomeMultiScreen.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2961545" class="shortcut">Top</a>
 | 
<a href="#id2961982" class="shortcut">Description</a>
 | 
<a href="#id2961730" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2961807" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2961830" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeAbout"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2961545"></a><span class="refentrytitle">GnomeAbout</span>
</h2>
<p>GnomeAbout — Display author, documenter and translator credits for an application.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
<a href="GnomeAbout.html#GnomeAbout-struct">GnomeAbout</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeAbout.html#gnome-about-new">gnome_about_new</a> (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *version,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *copyright,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *comments,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **authors,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **documenters,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *translator_credits,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *logo_pixbuf);
void <a href="GnomeAbout.html#gnome-about-construct">gnome_about_construct</a> (<a href="GnomeAbout.html" title="GnomeAbout">GnomeAbout</a> *about,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *version,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *copyright,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *comments,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **authors,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **documenters,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *translator_credits,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *logo_pixbuf);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2961730"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
>GtkBin</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkDialog.html"
>GtkDialog</a>
+----GnomeAbout
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2961807"></a><h2>Implemented Interfaces</h2>
<p>
GnomeAbout implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2961830"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GnomeAbout.html#GnomeAbout--authors">authors</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Write
"<a href="GnomeAbout.html#GnomeAbout--comments">comments</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--copyright">copyright</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--documenters">documenters</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Write
"<a href="GnomeAbout.html#GnomeAbout--logo">logo</a>" <a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Write
"<a href="GnomeAbout.html#GnomeAbout--name">name</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--translator-credits">translator-credits</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GnomeAbout.html#GnomeAbout--version">version</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2961982"></a><h2>Description</h2>
<p>
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
<code class="literal">About...</code> option from the <code class="literal">Help</code> menu. With
one simple function call, the application can then display all of the
appropriate information.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2962013"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2962023"></a><h3>
<a name="GnomeAbout-struct"></a>GnomeAbout</h3>
<a class="indexterm" name="id2962036"></a><pre class="programlisting">typedef struct _GnomeAbout GnomeAbout;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GnomeAbout</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
A dialog box widget containing all of the relevant credit information and
displaying as three notebook pages.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962066"></a><h3>
<a name="gnome-about-new"></a>gnome_about_new ()</h3>
<a class="indexterm" name="id2962081"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_about_new (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *version,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *copyright,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *comments,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **authors,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **documenters,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *translator_credits,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *logo_pixbuf);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_about_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Construct an application's credits box. The <em class="parameter"><code>authors</code></em> array cannot be empty
and the <em class="parameter"><code>translator_credits</code></em> should be marked as a translatable string (so
that only the translator for the currently active locale is displayed).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the application.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>version</code></em> :</span></td>
<td> The version string of the application.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>copyright</code></em> :</span></td>
<td> The application's copyright statement.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>comments</code></em> :</span></td>
<td> A short miscellaneous string.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>authors</code></em> :</span></td>
<td> An <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> terminated array of the application authors.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>documenters</code></em> :</span></td>
<td> An array of the application documenters.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>translator_credits</code></em> :</span></td>
<td> The translator for the current locale.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>logo_pixbuf</code></em> :</span></td>
<td> The application's logo.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new "About" dialog.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962334"></a><h3>
<a name="gnome-about-construct"></a>gnome_about_construct ()</h3>
<a class="indexterm" name="id2962349"></a><pre class="programlisting">void gnome_about_construct (<a href="GnomeAbout.html" title="GnomeAbout">GnomeAbout</a> *about,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *version,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *copyright,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *comments,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **authors,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **documenters,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *translator_credits,
<a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *logo_pixbuf);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_about_construct</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Similar to <a href="GnomeAbout.html#gnome-about-new"><code class="function">gnome_about_new()</code></a> except that the pre-existing <em class="parameter"><code>about</code></em> widget is
used. Note that in this version of the function, <em class="parameter"><code>authors</code></em> is not checked to
be non-<a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>, so callers must be careful, since bad things will happen if
this condition is not met.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>about</code></em> :</span></td>
<td> An existing <a href="GnomeAbout.html" title="GnomeAbout"><span class="type">GnomeAbout</span></a> instance.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the application.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>version</code></em> :</span></td>
<td> The version string of the application.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>copyright</code></em> :</span></td>
<td> The application's copyright statement.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>comments</code></em> :</span></td>
<td> A short miscellaneous string.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>authors</code></em> :</span></td>
<td> An <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> terminated array of the application authors.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>documenters</code></em> :</span></td>
<td> An array of the application documenters.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>translator_credits</code></em> :</span></td>
<td> The translator for the current locale.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>logo_pixbuf</code></em> :</span></td>
<td> The application's logo.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2962644"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2962654"></a><h3>
<a name="GnomeAbout--authors"></a>The "<code class="literal">authors</code>" property</h3>
<a class="indexterm" name="id2962670"></a><pre class="programlisting"> "authors" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Write</pre>
<p>List of authors of the programs.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962693"></a><h3>
<a name="GnomeAbout--comments"></a>The "<code class="literal">comments</code>" property</h3>
<a class="indexterm" name="id2962709"></a><pre class="programlisting"> "comments" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>Comments about the program.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962735"></a><h3>
<a name="GnomeAbout--copyright"></a>The "<code class="literal">copyright</code>" property</h3>
<a class="indexterm" name="id2962752"></a><pre class="programlisting"> "copyright" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>Copyright information for the program.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962778"></a><h3>
<a name="GnomeAbout--documenters"></a>The "<code class="literal">documenters</code>" property</h3>
<a class="indexterm" name="id2962795"></a><pre class="programlisting"> "documenters" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Write</pre>
<p>List of people documenting the program.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962818"></a><h3>
<a name="GnomeAbout--logo"></a>The "<code class="literal">logo</code>" property</h3>
<a class="indexterm" name="id2962834"></a><pre class="programlisting"> "logo" <a
href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> : Write</pre>
<p>A logo for the about box.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962857"></a><h3>
<a name="GnomeAbout--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2962874"></a><pre class="programlisting"> "name" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>The name of the program.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962900"></a><h3>
<a name="GnomeAbout--translator-credits"></a>The "<code class="literal">translator-credits</code>" property</h3>
<a class="indexterm" name="id2962918"></a><pre class="programlisting"> "translator-credits" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>Credits to the translators. This string should be marked as translatable.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2962945"></a><h3>
<a name="GnomeAbout--version"></a>The "<code class="literal">version</code>" property</h3>
<a class="indexterm" name="id2962960"></a><pre class="programlisting"> "version" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>The version of the program.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
</body>
</html>