Class: Gtk::AboutDialog

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Instance Method Details

#add_credit_section(section_name, people) ⇒ nil

Creates a new section in the Credits page.

Parameters:

  • section_name (String) —

    The name of the section

  • people (Array<String>) —

    The people who belong to that section

Returns:

  • (nil)

#artists ⇒ Gtk::

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

Returns:

#artists=(artists) ⇒ Gtk::

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

Parameters:

Returns:

#authors ⇒ Gtk::

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

Returns:

#authors=(authors) ⇒ Gtk::

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

Parameters:

Returns:

#comments ⇒ String

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.

Returns:

  • (String) —

    comments

#comments=(comments) ⇒ String

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.

Parameters:

  • comments (String)

Returns:

  • (String) —

    comments

  • (String) —

    comments

#copyright ⇒ String

Copyright information for the program.

Returns:

  • (String) —

    copyright

#copyright=(copyright) ⇒ String

Copyright information for the program.

Parameters:

  • copyright (String)

Returns:

  • (String) —

    copyright

  • (String) —

    copyright

#documenters ⇒ Gtk::

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

Returns:

  • (Gtk::) —

    documenters

#documenters=(documenters) ⇒ Gtk::

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

Parameters:

Returns:

#license ⇒ String

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. When setting this property to a non-nil value, the Gtk::AboutDialog:license-type property is set to %GTK_LICENSE_CUSTOM as a side effect.

Returns:

  • (String) —

    license

#license=(license) ⇒ String

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. When setting this property to a non-nil value, the Gtk::AboutDialog:license-type property is set to %GTK_LICENSE_CUSTOM as a side effect.

Parameters:

  • license (String)

Returns:

  • (String) —

    license

  • (String) —

    license

#license_type ⇒ Gtk::License

The license of the program, as a value of the %GtkLicense enumeration.

The Gtk::AboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If %GTK_LICENSE_UNKNOWN is used, the link used will be the same specified in the Gtk::AboutDialog:website property.

If %GTK_LICENSE_CUSTOM is used, the current contents of the Gtk::AboutDialog:license property are used.

For any other Gtk::License value, the contents of the Gtk::AboutDialog:license property are also set by this property as a side effect.

Returns:

#license_type=(license_type) ⇒ Gtk::License

The license of the program, as a value of the %GtkLicense enumeration.

The Gtk::AboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If %GTK_LICENSE_UNKNOWN is used, the link used will be the same specified in the Gtk::AboutDialog:website property.

If %GTK_LICENSE_CUSTOM is used, the current contents of the Gtk::AboutDialog:license property are used.

For any other Gtk::License value, the contents of the Gtk::AboutDialog:license property are also set by this property as a side effect.

Parameters:

Returns:

#logo ⇒ GdkPixbuf::Pixbuf

A logo for the about box. If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.

Returns:

#logo=(logo) ⇒ GdkPixbuf::Pixbuf

A logo for the about box. If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.

Parameters:

Returns:

#logo_icon_name ⇒ String

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

Returns:

  • (String) —

    logo-icon-name

#logo_icon_name=(logo_icon_name) ⇒ String

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

Parameters:

  • logo_icon_name (String)

Returns:

  • (String) —

    logo-icon-name

  • (String) —

    logo-icon-name

#new ⇒ Gtk::Widget

Creates a new Gtk::AboutDialog.

Returns:

#program_name ⇒ String

The name of the program. If this is not set, it defaults to g_get_application_name().

Returns:

  • (String) —

    program-name

#program_name=(program_name) ⇒ String

The name of the program. If this is not set, it defaults to g_get_application_name().

Parameters:

  • program_name (String)

Returns:

  • (String) —

    program-name

  • (String) —

    program-name

#translator_credits ⇒ String

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.

Returns:

  • (String) —

    translator-credits

#translator_credits=(translator_credits) ⇒ String

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.

Parameters:

  • translator_credits (String)

Returns:

  • (String) —

    translator-credits

  • (String) —

    translator-credits

#version ⇒ String

The version of the program.

Returns:

  • (String) —

    version

#version=(version) ⇒ String

The version of the program.

Parameters:

  • version (String)

Returns:

  • (String) —

    version

  • (String) —

    version

#website ⇒ String

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

Returns:

  • (String) —

    website

#website=(website) ⇒ String

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

Parameters:

  • website (String)

Returns:

  • (String) —

    website

  • (String) —

    website

#website_label ⇒ String

The label for the link to the website of the program.

Returns:

  • (String) —

    website-label

#website_label=(website_label) ⇒ String

The label for the link to the website of the program.

Parameters:

  • website_label (String)

Returns:

  • (String) —

    website-label

  • (String) —

    website-label

#wrap_license ⇒ TrueClass

Returns whether the license text in about is automatically wrapped.

Returns:

  • (TrueClass) —

    true if the license text is wrapped

#wrap_license=(wrap_license) ⇒ TrueClass

Whether to wrap the text in the license dialog.

Parameters:

  • wrap_license (TrueClass)

Returns:

  • (TrueClass) —

    wrap-license

  • (TrueClass) —

    wrap-license

#wrap_license? ⇒ TrueClass

Whether to wrap the text in the license dialog.

Returns:

  • (TrueClass) —

    wrap-license