XfceAboutDialog

XfceAboutDialog — display information about a project.

Functions

#define XFCE_COPYRIGHT_TEXT()
XfceAboutInfo * xfce_about_info_new ()
void xfce_about_info_free ()
void xfce_about_info_set_homepage ()
void xfce_about_info_add_credit ()
GtkWidget * xfce_about_dialog_new ()

Properties

gchar * copyright Read / Write
gchar * description Read / Write
gchar * homepage Read / Write
GdkPixbuf * icon Read / Write
gchar * license Read / Write
gchar * program Read / Write
gchar * version Read / Write

Types and Values

  XfceAboutInfo
struct XfceAboutDialog

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBin
                        ╰── GtkWindow
                            ╰── GtkDialog
                                ╰── XfceAboutDialog

Implemented Interfaces

XfceAboutDialog implements AtkImplementorIface and GtkBuildable.

Includes

#include <libxfcegui4/libxfcegui4.h>

Description

A dialog box widget containing all of the relevant credit information.

Functions

XFCE_COPYRIGHT_TEXT()

#define XFCE_COPYRIGHT_TEXT(years, owner) ("Copyright (c) " years "\n" owner "\nAll rights reserved.")

Generates a default copyright text from the given information.

Parameters

years

year information (e.g. "2002-2004").

  

owner

the copyright owner.

  

xfce_about_info_new ()

XfceAboutInfo *
xfce_about_info_new (const gchar *program,
                     const gchar *version,
                     const gchar *description,
                     const gchar *copyright,
                     const gchar *license);

Parameters

program

program name (e.g. "xfce4-session")

  

version

application version.

  

description

short descriptive text (e.g. "Xfce session manager").

  

copyright

copyright text, use the XFCE_COPYRIGHT_TEXT macro. This parameter is optional. If set to NULL, a default copyright text will be choosen.

  

license

optional license text, can either be the text of a license or can be one of the builtin license constants, which are limited to XFCE_LICENSE_BSD, XFCE_LICENSE_GPL and XFCE_LICENSE_LGPL currently. If NULL, no license text will be displayed.

  

Returns

the new XfceAboutInfo object or NULL on error. The result needs to be freed using xfce_about_info_free().

xfce_about_info_free ()

void
xfce_about_info_free (XfceAboutInfo *info);

Frees the info object and all resources covered by it.

Parameters

info

an XfceAboutInfo.

  

xfce_about_info_set_homepage ()

void
xfce_about_info_set_homepage (XfceAboutInfo *info,
                              const gchar *homepage);

Associates a homepage with the info object.

Parameters

info

an XfceAboutInfo.

  

homepage

the URL of the projects website, has to be a valid URL, that can be loaded by a webbrowser.

  

xfce_about_info_add_credit ()

void
xfce_about_info_add_credit (XfceAboutInfo *info,
                            const gchar *name,
                            const gchar *mail,
                            const gchar *task);

Adds a credit to the info object.

Parameters

info

an XfceAboutInfo.

  

name

the full name of the person.

  

mail

the persons email address.

  

task

the persons task in the project.

  

xfce_about_dialog_new ()

GtkWidget *
xfce_about_dialog_new (GtkWindow *parent,
                       const XfceAboutInfo *info,
                       GdkPixbuf *icon);

xfce_about_dialog_new is deprecated and should not be used in newly-written code.

Parameters

parent

parent window or NULL.

  

info

an XfceAboutInfo object with the about info.

  

icon

an optional icon, if NULL, no icon will be displayed.

  

Returns

the newly allocated dialog widget.

Deprecated : Use xfce_about_dialog_new_with_values instead.

Types and Values

XfceAboutInfo

typedef struct _XfceAboutInfo XfceAboutInfo;

struct XfceAboutDialog

struct XfceAboutDialog;

A dialog box widget that contains all the credit information relevant to a projects, and displays it in up to three notebook tabs.

Property Details

The “copyright” property

  “copyright”                gchar *

Program Copyright.

Flags: Read / Write

Default value: NULL

The “description” property

  “description”              gchar *

Program Description.

Flags: Read / Write

Default value: NULL

The “homepage” property

  “homepage”                 gchar *

Program Homepage.

Flags: Read / Write

Default value: NULL

The “icon” property

  “icon”                     GdkPixbuf *

icon to use, if any.

Flags: Read / Write

The “license” property

  “license”                  gchar *

Program License.

Flags: Read / Write

Default value: NULL

The “program” property

  “program”                  gchar *

Program Name.

Flags: Read / Write

Default value: NULL

The “version” property

  “version”                  gchar *

Program Version.

Flags: Read / Write

Default value: NULL

Generated by GTK-Doc V1.21