org.gnome.gtk
Class AboutDialog

java.lang.Object
  org.freedesktop.bindings.Proxy
      org.gnome.glib.Object
          org.gnome.gtk.Object
              org.gnome.gtk.Widget
                  org.gnome.gtk.Container
                      org.gnome.gtk.Bin
                          org.gnome.gtk.Window
                              org.gnome.gtk.Dialog
                                  org.gnome.gtk.AboutDialog

public class AboutDialog
extends Dialog

A Dialog which presents information about a program. The AboutDialog presents simple meta information including program name, a short description, copyright info, and then lists of authors, documenters, and translators of responsible for the program.

As a convention, every GNOME application has a MenuItem labelled "About" in the main "Help" menu.

Since:

4.0.6

Author:

Andrew Cowie

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gtk.Dialog

Dialog.RESPONSE

Nested classes/interfaces inherited from class org.gnome.gtk.Window

Window.CONFIGURE_EVENT, Window.DELETE_EVENT

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.BUTTON_PRESS_EVENT, Widget.BUTTON_RELEASE_EVENT, Widget.ENTER_NOTIFY_EVENT, Widget.EXPOSE_EVENT, Widget.FOCUS_IN_EVENT, Widget.FOCUS_OUT_EVENT, Widget.HIDE, Widget.KEY_PRESS_EVENT, Widget.KEY_RELEASE_EVENT, Widget.LEAVE_NOTIFY_EVENT, Widget.UNMAP_EVENT, Widget.VISIBILITY_NOTIFY_EVENT

Constructor Summary

AboutDialog()
Instantiate a new AboutDialog.

Method Summary

void	setAuthors(java.lang.String[] authors) Add a list of authors to the AboutDialog.
void	setComments(java.lang.String text) Set a simple description of the program.
void	setCopyright(java.lang.String text) Specify the copyright holder of the application.
void	setLogo(Pixbuf icon) Set the image to be displayed in the AboutDialog.
void	setProgramName(java.lang.String name) Specify the name of the application.
void	setVersion(java.lang.String version) Set the version number of this release.

Methods inherited from class org.gnome.gtk.Dialog

add, addButton, addButton, connect, run

Methods inherited from class org.gnome.gtk.Window

connect, connect, getHeight, getMaximized, getPositionX, getPositionY, getScreen, getWidth, move, present, resize, setDecorated, setDefaultSize, setFullscreen, setGravity, setIcon, setKeepAbove, setKeepBelow, setMaximize, setModal, setPosition, setResizable, setSkipPagerHint, setSkipTaskbarHint, setStick, setTitle, setTransientFor, setTypeHint

Methods inherited from class org.gnome.gtk.Bin

getChild

Methods inherited from class org.gnome.gtk.Container

getChildren, remove, setBorderWidth

Methods inherited from class org.gnome.gtk.Widget

activate, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, getAllocation, getHasFocus, getParent, getRequisition, getToplevel, getWindow, grabDefault, grabFocus, hide, modifyBackground, modifyText, setCanFocus, setSensitive, setSizeRequest, setTooltipMarkup, setTooltipText, show, showAll

Methods inherited from class org.freedesktop.bindings.Proxy

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AboutDialog

public AboutDialog()

Instantiate a new AboutDialog. You'll need to call the various setters in this class to populate it.

Since:

4.0.6

Method Detail

setAuthors

public void setAuthors(java.lang.String[] authors)

Add a list of authors to the AboutDialog. You pass in an array of Strings, with one author listed per String, for example:

 about.setAuthors(new String[] {
         "Andrew Cowie <andrew@operationaldynamics.com>",
         "Srichand Pendyala <srichand.pendyala@gmail.com>",
         "Vreixo Formoso Lopes <metalpain2002@yahoo.es>",
         "Sebastian Mancke <s.mancke@tarent.de>"
 });
 

It is indeed tradition for authors of Open Source Software to include their email addresses when identifying their work.

Since:

4.0.6

setComments

public void setComments(java.lang.String text)

Set a simple description of the program. This will essentially be shown as a subtitle to your application's name.

Since:

4.0.6

setCopyright

public void setCopyright(java.lang.String text)

Specify the copyright holder of the application. This should be short and to the point, for example:

 setCopyright("Copyright (c) 2008 ACME, Inc");
 

Since:

4.0.6

setLogo

public void setLogo(Pixbuf icon)

Set the image to be displayed in the AboutDialog. Most apps just want to use the default icon which was set with Gtk.setDefaultIcon().

Since:

4.0.6

setProgramName

public void setProgramName(java.lang.String name)

Specify the name of the application. Some people choose to use a human readable name like "The Epiphany Web Browser", whereas others will use the project name, for example "epiphany". This will be shown prominently in a large font as the title of the Dialog.

Since:

4.0.6

setVersion

public void setVersion(java.lang.String version)

Set the version number of this release. It will be shown beside the program name.

Since:

4.0.6