XfceAboutDialog

XfceAboutDialog — display information about a project.

Synopsis


#include <libxfcegui4/libxfcegui4.h>


            XfceAboutInfo;
            XfceAboutDialog;
#define     XFCE_COPYRIGHT_TEXT             (years, owner)
XfceAboutInfo* xfce_about_info_new          (const gchar *program,
                                             const gchar *version,
                                             const gchar *description,
                                             const gchar *copyright,
                                             const gchar *license);
void        xfce_about_info_free            (XfceAboutInfo *info);
void        xfce_about_info_set_homepage    (XfceAboutInfo *info,
                                             const gchar *homepage);
void        xfce_about_info_add_credit      (XfceAboutInfo *info,
                                             const gchar *name,
                                             const gchar *mail,
                                             const gchar *task);
GtkWidget*  xfce_about_dialog_new           (GtkWindow *parent,
                                             const XfceAboutInfo *info,
                                             GdkPixbuf *icon);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----XfceAboutDialog

Implemented Interfaces

XfceAboutDialog implements AtkImplementorIface.

Properties


  "copyright"            gchararray            : Read / Write
  "description"          gchararray            : Read / Write
  "homepage"             gchararray            : Read / Write
  "icon"                 GdkPixbuf             : Read / Write
  "license"              gchararray            : Read / Write
  "program"              gchararray            : Read / Write
  "version"              gchararray            : Read / Write

Description

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

Details

XfceAboutInfo

typedef struct _XfceAboutInfo XfceAboutInfo;

XfceAboutDialog

typedef struct _XfceAboutDialog XfceAboutDialog;

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

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.

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);

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.

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.

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.

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);

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.

Property Details

The "copyright" property

  "copyright"            gchararray            : Read / Write

Program Copyright.

Default value: NULL

The "description" property

  "description"          gchararray            : Read / Write

Program Description.

Default value: NULL

The "homepage" property

  "homepage"             gchararray            : Read / Write

Program Homepage.

Default value: NULL

The "icon" property

  "icon"                 GdkPixbuf             : Read / Write

icon to use, if any.

The "license" property

  "license"              gchararray            : Read / Write

Program License.

Default value: NULL

The "program" property

  "program"              gchararray            : Read / Write

Program Name.

Default value: NULL

The "version" property

  "version"              gchararray            : Read / Write

Program Version.

Default value: NULL