Search this site
    Documentation‎ > ‎Toplevel Windows‎ > ‎

    gnocl::aboutDialog

    A widget that displays basic information about the creation of a program.

    Synopsis

    gnocl::aboutDialog [-option value...]

    Screenshot


    Options

    -artists string (default: "")

    The people who contributed artwork to the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

    -authors string (default: "")

    The authors of the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

    -comments string (default: "")

    Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

    -copyright string (default: "")

    Copyright information for the program.

    -data string (default: "")
    User defined data which can be retrieved via the cget subcommand.
    -documenters string (default: "")

    The people documenting the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

    -license string (default: "")

    The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the "wrap-license" property is set to TRUE; otherwise the text itself must contain the intended linebreaks.
    -icon percent-string (default: "")
    Sets the icon of the window which is shown, depending on the window manager, in the window decoration, the window list, and/or if the window is iconified. This must be either a file name (prefix "%/") or empty.
    -logo string (default: "")

    A named icon to use as the logo for the about box. This property overrides the logo property.

    -logoIconName     string (default: "")

    A named icon to use as the logo for the about box. This property overrides the logo property.
    -name string (default: "")
    Name of the widget, can be used to set options in an rc file.
    -programName string (default: "")

    The name of the program. If this is not set, it defaults to the application name,

    -translatorCredits string (default: "")

    Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

    -version string (default: "")

    The version of the program.

    -website string (default: "")

    The URL for the link to the website of the program. This should be a string starting with "http://".

    -websiteLabel string (default: "")

    The label for the link to the website of the program. If this is not set, it defaults to the URL specified in the website property.

    -wrapLicense boolean (default: 0)

    Whether to wrap the text in the license dialog.


    Description

    The gnocl::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.  

    Commands

    id cget option

    Returns the value for the specified option. The option may have any of hte values accepted by configure.

    id class

    Returns the class of the widget, i.e. statusIcon.

    id configure [-option value...]

    Configures the widget. Option may have any of the values accepted on creation of the widget.

    id delete
    Deletes the widget and the associated tcl command.

    Example

    #!/bin/sh
    # the next line restarts using tclsh \
    exec tclsh "$0" "$@"

    set auto_path [linsert $auto_path 0 [file join [file dirname [info script]] ../src]]
    package require Gnocl

    gnocl::aboutDialog \
          -programName "Gnocl" \
          -artists {artist1 artist2} \
          -authors {author1 author2} \
          -name "Gnocl" \
          -comments "This is a comment." \
          -copyright "Copyright." \
          -documenters {documenter1 documenter2} \
          -license "This is a license" \
          -version "Version 1.2.3" \
          -website "http://www.dr-baum.net/gnocl/" \
          -websiteLabel "www.gnocl.org" \
          -logo %/gnocl_logo.png

    gnocl::mainLoop

    Sections