gtk.AboutDialogpopup window displaying information about an
application (new in PyGTK 2.6)Synopsisgtk.AboutDialoggtk.Dialoggtk.AboutDialogget_nameset_namenameget_program_nameset_program_namenameget_versionset_versionversionget_copyrightset_copyrightcopyrightget_commentsset_commentscommentsget_licenseset_licenselicenseget_wrap_licenseset_wrap_licensewrap_licenseget_websiteset_websitewebsiteget_website_labelset_website_labelwebsite_labelget_authorsset_authorsauthorsget_documentersset_documentersdocumentersget_artistsset_artistsartistsget_translator_creditsset_translator_creditstranslator_creditsget_logoset_logologoget_logo_icon_nameset_logo_icon_nameicon_nameFunctionsgtk.about_dialog_set_email_hookfuncdatagtk.about_dialog_set_url_hookfuncdataAncestry+-- gobject.GObject
+-- gtk.Object
+-- gtk.Widget
+-- gtk.Container
+-- gtk.Bin
+-- gtk.Window
+-- gtk.Dialog
+--gtk.AboutDialog
Implemented Interfacesgtk.AboutDialog
implements
gtk.Buildableatk.ImplementorIFacegtk.AboutDialog Propertiesgtk.Object Propertiesgtk.Widget Propertiesgtk.Container Propertiesgtk.Window Propertiesgtk.Dialog Properties
"artists"Read-WriteThe list of people who have contributed artwork to
the program.
This property is available in GTK+ 2.6 and above."authors"Read-WriteThe list of authors of the program.
This property is available in GTK+ 2.6 and above."comments"Read-WriteA string containing comments about the program.
Default value: None.
This property is available in GTK+ 2.6 and above."copyright"Read-WriteA string containing copyright information for
the program. Default value: None.
This property is available in GTK+ 2.6 and above."documenters"Read-WriteThe list of people documenting the program.
This property is available in GTK+ 2.6 and above."license"Read-WriteA string containing the license of the program.
Default value: None.
This property is available in GTK+ 2.6 and above."logo"Read-WriteA logo for the about box. If this is not set,
it defaults to the default window icon list.
This property is available in GTK+ 2.6 and above."logo-icon-name"Read-WriteThe name of an icon to use as the logo for the
about box. Default value: None.
This property is available in GTK+ 2.6 and above."program-name"Read-WriteThe name of the program. If this is not set, it
defaults to g_get_application_name().
Default value: None.
This property is available in GTK+ 2.12 and above."translator-credits"Read-WriteCredits to the translators. This string should be
marked as translatable. Default value: None.
This property is available in GTK+ 2.6 and above."version"Read-WriteA string containing the version of the program.
Default value: None.
This property is available in GTK+ 2.6 and above."website"Read-WriteThe URL for the link to the website of the
program. Default value: None.
This property is available in GTK+ 2.6 and above."website-label"Read-WriteThe label for the link to the website of the program.
If this is not set, it defaults to the URL.
Default value: None.
This property is available in GTK+ 2.6 and above."wrap-license"Read-WriteIf True the license text should be
wrapped. Default value: False.
This property is available in GTK+ 2.6 and above.
"link-color"ReadThe color of hyperlinks. This property is not available
in GTK+ 2.10 and above.
gtk.AboutDialog Signal Prototypesgobject.GObject Signal Prototypesgtk.Object Signal Prototypesgtk.Widget Signal Prototypesgtk.Container Signal Prototypesgtk.Window Signal Prototypesgtk.Dialog Signal Prototypes"activate-link"callbackaboutdialoguriuser_param1...DescriptionThis widget is available in PyGTK 2.6 and above.The gtk.AboutDialog
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 About option from the Help
menu. All parts of the dialog are optional.About dialog often contain links and email addresses. gtk.AboutDialog
supports this by offering global hooks, which are called when the user
clicks on a link or email address, see the gtk.about_dialog_set_email_hook()
and gtk.about_dialog_set_url_hook()
functions. Email addresses in the authors, documenters and artists
properties are recognized by looking for <user@host>, URLs are recognized by looking for
http://url, with url extending to
the next space, tab or line break.Constructorgtk.AboutDialogReturns :a new gtk.AboutDialogThis constructor is available in PyGTK 2.6 and above.Creates a new gtk.AboutDialog with default property values.Methodsgtk.AboutDialog.get_nameget_nameReturns :the program name.This method is available in PyGTK 2.6 and above.
This method is deprecated in PyGTK 2.12 and above and should not be
used in newly-written code. Use the get_program_name()
method instead.
The get_name() method returns the
program name displayed in the about dialog.gtk.AboutDialog.set_nameset_namenamename :a string containing the program
name or None to use the default name.This method is available in PyGTK 2.6 and above.
This method is deprecated in PyGTK 2.12 and above and should not be
used in newly-written code. Use the set_program_name()
method instead.
The set_name() method sets the name
to display in the about dialog. If name is None,
it defaults to g_get_application_name().gtk.AboutDialog.get_program_nameget_program_nameReturns :the program name.This method is available in PyGTK 2.12 and above.The get_program_name() method returns the
program name displayed in the about dialog.gtk.AboutDialog.set_program_nameset_program_namenamename :a string containing the program
name or None to use the default name.This method is available in PyGTK 2.12 and above.The set_program_name() method sets the name
to display in the about dialog. If name is None,
it defaults to g_get_application_name().gtk.AboutDialog.get_versionget_versionReturns :The version string or
None.This method is available in PyGTK 2.6 and above.The get_version() method returns the
string contained in the "version" property.gtk.AboutDialog.set_versionset_versionversionversion :the version string or
NoneThis method is available in PyGTK 2.6 and above.The set_version() method sets the
"version" property to the string in version.gtk.AboutDialog.get_copyrightget_copyrightReturns :the copyright string or
None.This method is available in PyGTK 2.6 and above.The get_copyright() method returns the
string contained in the "copyright" property.gtk.AboutDialog.set_copyrightset_copyrightcopyrightcopyright :a string containing the copyright
notice or None.This method is available in PyGTK 2.6 and above.The set_copyright() method sets the
"copyright" property to the string contained in
copyright. If copyright is
None, the copyright notice is hidden.gtk.AboutDialog.get_commentsget_commentsReturns :a string containing the
comments or NoneThis method is available in PyGTK 2.6 and above.The get_comments() method returns the
string contained in the "comments" property.gtk.AboutDialog.set_commentsset_commentscommentscomments :a string containing the
comments or None.This method is available in PyGTK 2.6 and above.The set_comments() method sets the
"comments" property to the string contained in
comments. If comments is
None the comments label is hidden.gtk.AboutDialog.get_licenseget_licenseReturns :a string containing the license
information or NoneThis method is available in PyGTK 2.6 and above.The get_license() method returns the
string contained in the "license" property.gtk.AboutDialog.set_licenseset_licenselicenselicense :This method is available in PyGTK 2.6 and above.The set_license() method sets the
"license" property to the string contained in
license. If license is
None the license button is hidden.gtk.AboutDialog.get_wrap_licenseget_wrap_licenseReturns :True if the license text
should be wrappedThis method is available in PyGTK 2.8 and above.The get_wrap_license() method returns
the value of the "wrap-license" property. If "wrap-license" is
True the license text should be automatically
wrapped.gtk.AboutDialog.set_wrap_licenseset_wrap_licensewrap_licensewrap_license :This method is available in PyGTK 2.8 and above.The set_wrap_license() method sets the
"wrap-license" property to the value of
wrap_license. If wrap_license
is True the license text should be automatically
wrapped.gtk.AboutDialog.get_websiteget_websiteReturns :a string containing the website URL or
NoneThis method is available in PyGTK 2.6 and above.The get_website() method returns the
string contained in the "website" property. The website should be a
URL.gtk.AboutDialog.set_websiteset_websitewebsitewebsite :a string containing the URL of the program's
website or NoneThis method is available in PyGTK 2.6 and above.The set_website() method sets the
"website" property to the string contained in
website. The string should be a valid URL.gtk.AboutDialog.get_website_labelget_website_labelReturns :a string containing the website link
labelThis method is available in PyGTK 2.6 and above.The get_website_label() method returns
the contents of the "website_label" property. The website label is used if
the url hook has been set using the gtk.about_dialog_set_url_hook()
function.gtk.AboutDialog.set_website_labelset_website_labelwebsite_labelwebsite_label :This method is available in PyGTK 2.6 and above.The set_website_label() method sets the
"website_label" property to the string contained in
website_label if the url hook has been set using the
gtk.about_dialog_set_url_hook()
function.gtk.AboutDialog.get_authorsget_authorsReturns :a list containing the names of the program
authorsThis method is available in PyGTK 2.6 and above.The get_authors() method returns the
contents of the "authors" property. The "authors" property contains a list
of the names of the authors of the program.gtk.AboutDialog.set_authorsset_authorsauthorsauthors :a list containing the names of the program
authors.This method is available in PyGTK 2.6 and above.The set_authors() method sets the
"authors" property to the list contained in
authors. The author names are displayed in the
authors tab of the secondary credits
dialog. set_authors() method will show the
Credits button if it is not displayed.gtk.AboutDialog.get_documentersget_documentersReturns :a list of the program
documentersThis method is available in PyGTK 2.6 and above.The get_documenters() method returns
the contents of the "documenters" property which contains a list of the
names of the program documenters.gtk.AboutDialog.set_documentersset_documentersdocumentersdocumenters :a list of the names of the program
documentersThis method is available in PyGTK 2.6 and above.The set_documenters() method sets the
"documenters" property to the contents of
documenters. The documenter names are displayed in
the documenters tab of the secondary credits
dialog. set_documenters() method will show the
Credits button if it is not displayed.gtk.AboutDialog.get_artistsget_artistsReturns :a list of the names of the program
artistsThis method is available in PyGTK 2.6 and above.The get_artists() method returns the
contents of the "artists" property which contains a list of the names of the
program artists.gtk.AboutDialog.set_artistsset_artistsartistsartists :a list of the names of the program
artistsThis method is available in PyGTK 2.6 and above.The set_artists() method sets the
"artists" property to the contents of artists. The
artist names are displayed in the artists tab of the secondary credits
dialog. set_artists() method will show the
Credits button if it is not displayed.gtk.AboutDialog.get_translator_creditsget_translator_creditsReturns :a string containing the translator
creditsThis method is available in PyGTK 2.6 and above.The get_translator_credits() method
returns the contents of the "translator-credits" property which contains the
credits for the current translation.gtk.AboutDialog.set_translator_creditsset_translator_creditstranslator_creditstranslator_credits :a string containing the current translation
creditsThis method is available in PyGTK 2.6 and above.The set_translator_credits() method
sets the "translator_credits" property to the value of
translator_credits. The translator credits are
displayed in the translators tab of the secondary credits dialog.The intended use for this string is to display the translator of
the language which is currently used in the user interface. Using the
gettext() function, a simple way to achieve that is to
mark the string for translation.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 gtk.AboutDialog
will detect if "translator-credits" is untranslated and hide the tab.gtk.AboutDialog.get_logoget_logoReturns :the gtk.gdk.Pixbuf
used as the logoThis method is available in PyGTK 2.6 and above.The get_logo() method returns the
contents of the "logo" property which contains a gtk.gdk.Pixbuf that
is used as the logo.gtk.AboutDialog.set_logoset_logologologo :a gtk.gdk.Pixbuf to be
used as the logoThis method is available in PyGTK 2.6 and above.The set_logo() method sets the "logo"
property to the gtk.gdk.Pixbuf
contained in logo. If logo is
None, the default window icon set with the gtk.window_set_default_icon_list()
function will be used.gtk.AboutDialog.get_logo_icon_nameget_logo_icon_nameReturns :the name of the icon used as the
logoThis method is available in PyGTK 2.6 and above.The get_logo_name() method returns the
contents of the "logo-icon-name" property which contains the name of the
icon used as the logo.gtk.AboutDialog.set_logo_icon_nameset_logo_icon_nameicon_nameicon_name :the name of an icon or
NoneThis method is available in PyGTK 2.6 and above.The set_logo_icon_name() method sets
the "logo-icon-name" property to the value of
icon_name. If icon_name is
None, the default window icon set with the gtk.window_set_default_icon_list()
function will be used.Functionsgtk.about_dialog_set_email_hookgtk.about_dialog_set_email_hookfuncdatafunc : a function to call when an email link is
activated.data : data to pass to
funcThis function is available in PyGTK 2.6 and above.The gtk.about_dialog_set_email_hook
function installs a global function (specified by
func) to be called whenever the user activates an
email link in an about dialog.The signature of the callback function
func is:
def func(dialog, link, user_data)
where link is the email address
destination of the activated link, dialog is the
gtk.AboutDialog
containing link and user_data
is the data argument passed to gtk.about_dialog_set_email_hook().gtk.about_dialog_set_url_hookgtk.about_dialog_set_url_hookfuncdatafunc : a function to call when a URL link is
activated.data : data to pass to
funcThis function is available in PyGTK 2.6 and above.The gtk.about_dialog_set_url_hook function
installs a global function (specified by func) to be
called whenever the user activates a URL link in an about dialog.The signature of the callback function
func is:
def func(dialog, link, user_data)
where link is the URL destination of the
activated link, dialog is the gtk.AboutDialog
containing link and user_data
is the data argument passed to gtk.about_dialog_set_url_hook().SignalsThe "activate-link" gtk.AboutDialog Signalcallbackaboutdialoguriuser_param1...aboutdialog :the aboutdialog that received the signaluri :the URI that is activateduser_param1 :the first user parameter (if any) specified with the connect() method... :additional user parameters (if any)This signal is available in GTK+ 2.24 and above.The "activate-link" signal is emitted when an URI is activated. Applications may connect to it to override the default behaviour, which is to call
gtk.show_uri().