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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.AboutDialog</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="next" href="class-gtkaccelgroup.html" title="gtk.AccelGroup"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.AboutDialog</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gtk-class-reference.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtkaccelgroup.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkaboutdialog"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.AboutDialog</h2><p>gtk.AboutDialog — popup window displaying information about an
application (new in PyGTK 2.6)</p></div><div class="refsect1" lang="en"><a name="id3385463"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.AboutDialog</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtkdialog.html" title="gtk.Dialog">gtk.Dialog</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gtkaboutdialog.html#constructor-gtkaboutdialog" title="Constructor">gtk.AboutDialog</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-name" title="gtk.AboutDialog.get_name">get_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-name" title="gtk.AboutDialog.set_name">set_name</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>name</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-version" title="gtk.AboutDialog.get_version">get_version</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-version" title="gtk.AboutDialog.set_version">set_version</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>version</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-copyright" title="gtk.AboutDialog.get_copyright">get_copyright</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-copyright" title="gtk.AboutDialog.set_copyright">set_copyright</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>copyright</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-comments" title="gtk.AboutDialog.get_comments">get_comments</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-comments" title="gtk.AboutDialog.set_comments">set_comments</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>comments</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-license" title="gtk.AboutDialog.get_license">get_license</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-license" title="gtk.AboutDialog.set_license">set_license</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>license</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-website" title="gtk.AboutDialog.get_website">get_website</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-website" title="gtk.AboutDialog.set_website">set_website</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>website</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-website-label" title="gtk.AboutDialog.get_website_label">get_website_label</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-website-label" title="gtk.AboutDialog.set_website_label">set_website_label</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>website_label</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-authors" title="gtk.AboutDialog.get_authors">get_authors</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-authors" title="gtk.AboutDialog.set_authors">set_authors</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>authors</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-documenters" title="gtk.AboutDialog.get_documenters">get_documenters</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-documenters" title="gtk.AboutDialog.set_documenters">set_documenters</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>documenters</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-artists" title="gtk.AboutDialog.get_artists">get_artists</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-artists" title="gtk.AboutDialog.set_artists">set_artists</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>artists</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-translator-credits" title="gtk.AboutDialog.get_translator_credits">get_translator_credits</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-translator-credits" title="gtk.AboutDialog.set_translator_credits">set_translator_credits</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>translator_credits</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-logo" title="gtk.AboutDialog.get_logo">get_logo</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-logo" title="gtk.AboutDialog.set_logo">set_logo</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>logo</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--get-logo-icon-name" title="gtk.AboutDialog.get_logo_icon_name">get_logo_icon_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#method-gtkaboutdialog--set-logo-icon-name" title="gtk.AboutDialog.set_logo_icon_name">set_logo_icon_name</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>icon_name</tt></b></span></span>)</code><br></pre></td></tr></table><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
<span class="bold"><b>Functions</b></span>
<code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#function-gtk--about-dialog-set-email-hook" title="gtk.about_dialog_set_email_hook">gtk.about_dialog_set_email_hook</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>func</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaboutdialog.html#function-gtk--about-dialog-set-url-hook" title="gtk.about_dialog_set_url_hook">gtk.about_dialog_set_url_hook</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>func</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span></span>)</code></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3384945"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
+-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
+-- <a href="class-gtkdialog.html" title="gtk.Dialog">gtk.Dialog</a>
+--<a href="class-gtkaboutdialog.html" title="gtk.AboutDialog">gtk.AboutDialog</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3384888"></a><h2>Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"artists"</td><td valign="top">Read-Write</td><td valign="top">The list of people who have contributed artwork to
the program.</td></tr><tr valign="top"><td valign="top">"authors"</td><td valign="top">Read-Write</td><td valign="top">The list of authors of the program.</td></tr><tr valign="top"><td valign="top">"comments"</td><td valign="top">Read-Write</td><td valign="top">A string containing comments about the program.</td></tr><tr valign="top"><td valign="top">"copyright"</td><td valign="top">Read-Write</td><td valign="top">A string containing copyright information for
the program.</td></tr><tr valign="top"><td valign="top">"documenters"</td><td valign="top">Read-Write</td><td valign="top">The list of people documenting the program.</td></tr><tr valign="top"><td valign="top">"license"</td><td valign="top">Read-Write</td><td valign="top">A string containing the license of the program.</td></tr><tr valign="top"><td valign="top">"logo"</td><td valign="top">Read-Write</td><td valign="top">A logo for the about box. If this is not set,
it defaults to the default window icon list..</td></tr><tr valign="top"><td valign="top">"logo-icon-name"</td><td valign="top">Read-Write</td><td valign="top">The name of an icon to use as the logo for the
about box.</td></tr><tr valign="top"><td valign="top">"name"</td><td valign="top">Read-Write</td><td valign="top">The name of the program. If this is not set, it
defaults to g_get_application_name().</td></tr><tr valign="top"><td valign="top">"translator-credits"</td><td valign="top">Read-Write</td><td valign="top">Credits to the translators. This string should be
marked as translatable.</td></tr><tr valign="top"><td valign="top">"version"</td><td valign="top">Read-Write</td><td valign="top">A string containing the version of the program.</td></tr><tr valign="top"><td valign="top">"website"</td><td valign="top">Read-Write</td><td valign="top">The URL for the link to the website of the
program.</td></tr><tr valign="top"><td valign="top">"website-label"</td><td valign="top">Read-Write</td><td valign="top">The label for the link to the website of the program.
If this is not set, it defaults to the URL.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3384590"></a><h2>Style Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"link-color"</td><td valign="top">Read</td><td valign="top">The color of hyperlinks.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3384524"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.6 and above.</p></div><p>The <a href="class-gtkaboutdialog.html" title="gtk.AboutDialog"><tt class="classname">gtk.AboutDialog</tt></a>
offers a simple way to display information about a program like its logo,
name, copyright, website and license. It is also possible to give credits to
the authors, documenters, translators and artists who have worked on the
program. An about dialog is typically opened when the user selects the
<span class="guimenu">Help</span><span class="guimenuitem">About</span> menu. All parts of
the dialog are optional.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkaboutdialog"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.AboutDialog</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gtkdialog.html" title="gtk.Dialog"><tt class="classname">gtk.AboutDialog</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.6 and above.</p></div><p>Creates a new gtk.AboutDialog with default property values.</p></div><div class="refsect1" lang="en"><a name="id3384444"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-name"></a><h3>gtk.AboutDialog.get_name</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_name</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>The program name or
<tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_name</tt>() method returns the value
of the "name" property which is the program name displayed in the about
dialog. <tt class="methodname">get_name</tt>() returns <tt class="literal">None</tt>
if the name is not set.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-name"></a><h3>gtk.AboutDialog.set_name</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_name</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>name</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>name</tt></b>:</span></td><td>a string containing the program
name or <tt class="literal">None</tt> to use the default name.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_name</tt>() method sets the "name"
property to the string contained in <i class="parameter"><tt>name</tt></i>. The "name"
property is used as the program name in the about dialog. If
<i class="parameter"><tt>name</tt></i> is <tt class="literal">None</tt>, it defaults to
g_get_application_name().</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-version"></a><h3>gtk.AboutDialog.get_version</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_version</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>The version string or
<tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_version</tt>() method returns the
string contained in the "version" property.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-version"></a><h3>gtk.AboutDialog.set_version</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_version</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>version</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>version</tt></b>:</span></td><td>the version string or
<tt class="literal">None</tt></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_version</tt>() method sets the
"version" property to the string in <i class="parameter"><tt>version</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-copyright"></a><h3>gtk.AboutDialog.get_copyright</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_copyright</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the copyright string or
<tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_copyright</tt>() method returns the
string contained in the "copyright" property.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-copyright"></a><h3>gtk.AboutDialog.set_copyright</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_copyright</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>copyright</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>copyright</tt></b>:</span></td><td>a string containing the copyright
notice or <tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_copyright</tt>() method sets the
"copyright" property to the string contained in
<i class="parameter"><tt>copyright</tt></i>. If <i class="parameter"><tt>copyright</tt></i> is
<tt class="literal">None</tt>, the copyright notice is hidden.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-comments"></a><h3>gtk.AboutDialog.get_comments</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_comments</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string containing the
comments or <tt class="literal">None</tt></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_comments</tt>() method returns the
string contained in the "comments" property.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-comments"></a><h3>gtk.AboutDialog.set_comments</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_comments</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>comments</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>comments</tt></b>:</span></td><td>a string containing the
comments or <tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_comments</tt>() method sets the
"comments" property to the string contained in
<i class="parameter"><tt>comments</tt></i>. If <i class="parameter"><tt>comments</tt></i> is
<tt class="literal">None</tt> the comments label is hidden.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-license"></a><h3>gtk.AboutDialog.get_license</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_license</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string containing the license
information or <tt class="literal">None</tt></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_license</tt>() method returns the
string contained in the "license" property.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-license"></a><h3>gtk.AboutDialog.set_license</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_license</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>license</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>license</tt></b>:</span></td><td></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_license</tt>() method sets the
"license" property to the string contained in
<i class="parameter"><tt>license</tt></i>. If <i class="parameter"><tt>license</tt></i> is
<tt class="literal">None</tt> the license button is hidden.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-website"></a><h3>gtk.AboutDialog.get_website</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_website</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string containing the website URL or
<tt class="literal">None</tt></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_website</tt>() method returns the
string contained in the "website" property. The website should be a
URL.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-website"></a><h3>gtk.AboutDialog.set_website</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_website</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>website</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>website</tt></b>:</span></td><td>a string containing the URL of the program's
website or <tt class="literal">None</tt></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_website</tt>() method sets the
"website" property to the string contained in
<i class="parameter"><tt>website</tt></i>. The string should be a valid URL.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-website-label"></a><h3>gtk.AboutDialog.get_website_label</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_website_label</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string containing the website link
label</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_website_label</tt>() method returns
the contents of the "website_label" property. The website label is used if
the url hook has been set using the <a href="class-gtkaboutdialog.html#function-gtk--about-dialog-set-url-hook" title="gtk.about_dialog_set_url_hook"><tt class="function">gtk.about_dialog_set_url_hook</tt>()</a>
function.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-website-label"></a><h3>gtk.AboutDialog.set_website_label</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_website_label</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>website_label</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>website_label</tt></b>:</span></td><td></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_website_label</tt>() method sets the
"website_label" property to the string contained in
<i class="parameter"><tt>website_label</tt></i> if the url hook has been set using the
<a href="class-gtkaboutdialog.html#function-gtk--about-dialog-set-url-hook" title="gtk.about_dialog_set_url_hook"><tt class="function">gtk.about_dialog_set_url_hook</tt>()</a>
function.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-authors"></a><h3>gtk.AboutDialog.get_authors</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_authors</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list containing the names of the program
authors</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_authors</tt>() method returns the
contents of the "authors" property. The "authors" property contains a list
of the names of the authors of the program.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-authors"></a><h3>gtk.AboutDialog.set_authors</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_authors</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>authors</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>authors</tt></b>:</span></td><td>a list containing the names of the program
authors.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_authors</tt>() method sets the
"authors" property to the list contained in
<i class="parameter"><tt>authors</tt></i>. The author names are displayed in the
authors tab of the secondary credits
dialog. <tt class="methodname">set_authors</tt>() method will show the
<span class="guibutton">Credits</span> button if it is not displayed.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-documenters"></a><h3>gtk.AboutDialog.get_documenters</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_documenters</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list of the program
documenters</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_documenters</tt>() method returns
the contents of the "documenters" property which contains a list of the
names of the program documenters.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-documenters"></a><h3>gtk.AboutDialog.set_documenters</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_documenters</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>documenters</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>documenters</tt></b>:</span></td><td>a list of the names of the program
documenters</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_documenters</tt>() method sets the
"documenters" property to the contents of
<i class="parameter"><tt>documenters</tt></i>. The documenter names are displayed in
the documenters tab of the secondary credits
dialog. <tt class="methodname">set_documenters</tt>() method will show the
<span class="guibutton">Credits</span> button if it is not displayed.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-artists"></a><h3>gtk.AboutDialog.get_artists</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_artists</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list of the names of the program
artists</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_artists</tt>() method returns the
contents of the "artists" property which contains a list of the names of the
program artists.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-artists"></a><h3>gtk.AboutDialog.set_artists</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_artists</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>artists</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>artists</tt></b>:</span></td><td>a list of the names of the program
artists</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_artists</tt>() method sets the
"artists" property to the contents of <i class="parameter"><tt>artists</tt></i>. The
artist names are displayed in the artists tab of the secondary credits
dialog. <tt class="methodname">set_artists</tt>() method will show the
<span class="guibutton">Credits</span> button if it is not displayed.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-translator-credits"></a><h3>gtk.AboutDialog.get_translator_credits</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_translator_credits</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string containing the translator
credits</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_translator_credits</tt>() method
returns the contents of the "translator-credits" property which contains the
credits for the current translation.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-translator-credits"></a><h3>gtk.AboutDialog.set_translator_credits</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_translator_credits</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>translator_credits</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>translator_credits</tt></b>:</span></td><td>a string containing the current translation
credits</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_translator_credits</tt>() method
sets the "translator_credits" property to the value of
<i class="parameter"><tt>translator_credits</tt></i>. The translator credits are
displayed in the translators tab of the secondary credits dialog.</p><p>The intended use for this string is to display the translator of
the language which is currently used in the user interface. Using the
<tt class="function">gettext</tt>() function, a simple way to achieve that is to
mark the string for translation.</p><p>It is a good idea to use the customary msgid
"translator-credits" for this purpose, since translators will already know
the purpose of that msgid, and since <a href="class-gtkaboutdialog.html" title="gtk.AboutDialog"><tt class="classname">gtk.AboutDialog</tt></a>
will detect if "translator-credits" is untranslated and hide the tab.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-logo"></a><h3>gtk.AboutDialog.get_logo</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_logo</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the <a href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><tt class="classname">gtk.gdk.Pixbuf</tt></a>
used as the logo</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_logo</tt>() method returns the
contents of the "logo" property which contains a <a href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><tt class="classname">gtk.gdk.Pixbuf</tt></a> that
is used as the logo.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-logo"></a><h3>gtk.AboutDialog.set_logo</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_logo</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>logo</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>logo</tt></b>:</span></td><td>a <a href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><tt class="classname">gtk.gdk.Pixbuf</tt></a> to be
used as the logo</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_logo</tt>() method sets the "logo"
property to the <a href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><tt class="classname">gtk.gdk.Pixbuf</tt></a>
contained in <i class="parameter"><tt>logo</tt></i>. If <i class="parameter"><tt>logo</tt></i> is
<tt class="literal">None</tt>, the default window icon set with the <a href="class-gtkwindow.html#function-gtk--window-set-default-icon" title="gtk.window_set_default_icon"><tt class="function">gtk.window_set_default_icon_list</tt>()</a>
function will be used.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--get-logo-icon-name"></a><h3>gtk.AboutDialog.get_logo_icon_name</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_logo_icon_name</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the name of the icon used as the
logo</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_logo_name</tt>() method returns the
contents of the "logo-icon-name" property which contains the name of the
icon used as the logo.</p></div><div class="refsect2" lang="en"><a name="method-gtkaboutdialog--set-logo-icon-name"></a><h3>gtk.AboutDialog.set_logo_icon_name</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_logo_icon_name</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>icon_name</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>icon_name</tt></b>:</span></td><td>the name of an icon or
<tt class="literal">None</tt></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_logo_icon_name</tt>() method sets
the "logo-icon-name" property to the value of
<i class="parameter"><tt>icon_name</tt></i>. If <i class="parameter"><tt>icon_name</tt></i> is
<tt class="literal">None</tt>, the default window icon set with the <a href="class-gtkwindow.html#function-gtk--window-set-default-icon-list" title="gtk.window_set_default_icon_list"><tt class="function">gtk.window_set_default_icon_list</tt>()</a>
function will be used.</p></div></div><div class="refsect1" lang="en"><a name="id3338294"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--about-dialog-set-email-hook"></a><h3>gtk.about_dialog_set_email_hook</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.about_dialog_set_email_hook</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>func</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>func</tt></b>:</span></td><td> a function to call when an email link is
activated.</td></tr><tr><td><span class="term"><b class="parameter"><tt>data</tt></b>:</span></td><td> data to pass to
<i class="parameter"><tt>func</tt></i></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.6 and above.</p></div><p>The <tt class="function">gtk.about_dialog_set_email_hook</tt>
function installs a global function (specified by
<i class="parameter"><tt>func</tt></i>) to be called whenever the user activates an
email link in an about dialog.</p></div><div class="refsect2" lang="en"><a name="function-gtk--about-dialog-set-url-hook"></a><h3>gtk.about_dialog_set_url_hook</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.about_dialog_set_url_hook</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>func</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>data</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>func</tt></b>:</span></td><td> a function to call when a URL link is
activated.</td></tr><tr><td><span class="term"><b class="parameter"><tt>data</tt></b>:</span></td><td> data to pass to
<i class="parameter"><tt>func</tt></i></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.6 and above.</p></div><p>The <tt class="function">gtk.about_dialog_set_url_hook</tt> function
installs a global function (specified by <i class="parameter"><tt>func</tt></i>) to be
called whenever the user activates a URL link in an about dialog.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gtk-class-reference.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gtkaccelgroup.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The gtk Class Reference</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.AccelGroup</td></tr></table></div></body></html>
|
