GtkAboutDialog

GtkAboutDialog — Affiche des informations au sujet de l'application

Synopsis

#include <gtk/gtk.h>


GtkAboutDialog;
GtkWidget* gtk_about_dialog_new (void);
const gchar* gtk_about_dialog_get_name (GtkAboutDialog *about);
void gtk_about_dialog_set_name (GtkAboutDialog *about,
const gchar *name);
const gchar* gtk_about_dialog_get_version (GtkAboutDialog *about);
void gtk_about_dialog_set_version (GtkAboutDialog *about,
const gchar *version);
const gchar* gtk_about_dialog_get_copyright (GtkAboutDialog *about);
void gtk_about_dialog_set_copyright (GtkAboutDialog *about,
const gchar *copyright);
const gchar* gtk_about_dialog_get_comments (GtkAboutDialog *about);
void gtk_about_dialog_set_comments (GtkAboutDialog *about,
const gchar *comments);
const gchar* gtk_about_dialog_get_license (GtkAboutDialog *about);
void gtk_about_dialog_set_license (GtkAboutDialog *about,
const gchar *license);
gboolean gtk_about_dialog_get_wrap_license (GtkAboutDialog *about);
void gtk_about_dialog_set_wrap_license (GtkAboutDialog *about,
gboolean wrap_license);
const gchar* gtk_about_dialog_get_website (GtkAboutDialog *about);
void gtk_about_dialog_set_website (GtkAboutDialog *about,
const gchar *website);
const gchar* gtk_about_dialog_get_website_label (GtkAboutDialog *about);
void gtk_about_dialog_set_website_label (GtkAboutDialog *about,
const gchar *website_label);
const gchar* const * gtk_about_dialog_get_authors (GtkAboutDialog *about);
void gtk_about_dialog_set_authors (GtkAboutDialog *about,
const gchar **authors);
const gchar* const * gtk_about_dialog_get_artists (GtkAboutDialog *about);
void gtk_about_dialog_set_artists (GtkAboutDialog *about,
const gchar **artists);
const gchar* const * gtk_about_dialog_get_documenters (GtkAboutDialog *about);
void gtk_about_dialog_set_documenters (GtkAboutDialog *about,
const gchar **documenters);
const gchar* gtk_about_dialog_get_translator_credits
(GtkAboutDialog *about);
void gtk_about_dialog_set_translator_credits
(GtkAboutDialog *about,
const gchar *translator_credits);
GdkPixbuf* gtk_about_dialog_get_logo (GtkAboutDialog *about);
void gtk_about_dialog_set_logo (GtkAboutDialog *about,
GdkPixbuf *logo);
const gchar* gtk_about_dialog_get_logo_icon_name (GtkAboutDialog *about);
void gtk_about_dialog_set_logo_icon_name (GtkAboutDialog *about,
const gchar *icon_name);
void (*GtkAboutDialogActivateLinkFunc) (GtkAboutDialog *about,
const gchar *link,
gpointer data);
GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_email_hook
(GtkAboutDialogActivateLinkFunc func,
gpointer data,
GDestroyNotify destroy);
GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_url_hook
(GtkAboutDialogActivateLinkFunc func,
gpointer data,
GDestroyNotify destroy);
void gtk_show_about_dialog (GtkWindow *parent,
const gchar *first_property_name,
...);

Hiérarchier de l'Obejt

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

Iterfaces Implémentées

GtkAboutDialog implémente  AtkImplementorIface.

Propriétés

  "artists"                  GStrv                 : Lire / Ecrire
"authors" GStrv : Lire / Ecrire
"comments" gchararray : Lire / Ecrire
"copyright" gchararray : Lire / Ecrire
"documenters" GStrv : Lire / Ecrire
"license" gchararray : Lire / Ecrire
"logo" GdkPixbuf : Lire / Ecrire
"logo-icon-name" gchararray : Lire / Ecrire
"name" gchararray : Lire / Ecrire
"translator-credits" gchararray : Lire / Ecrire
"version" gchararray : Lire / Ecrire
"website" gchararray : Lire / Ecrire
"website-label" gchararray : Lire / Ecrire
"wrap-license" gboolean : Lire / Ecrire

Description

La fenêtre GtkAboutDialog propose une façon assez simple d'afficher des informations au sujet du programme comme son logo, son nom, le copyright, un site web  et une licence. Il est également possible de nommer les auteurs, les documentalistes, les traducteurs et les artistes qui ont travaillé sur le programme. Une boîte de dialogue "à propos de " est généralement ouverte quand l'utilisateur sélectionne l'option A propos dans le menu d'aide. Toutes les parties de la boîte de dialogue sont optionnelles.

Les boîtes de dialogues "à propos de " contiennent souvent des liens et des adresses électroniques. GtkAboutDialog supporte cela en offrant des fonctions globales, permettant le contrôle des entrées et sorties (hooks), appelées quand l'utilisateur clique sur un lien ou sur une adresse électronique, voir  gtk_about_dialog_set_email_hook() et gtk_about_dialog_set_url_hook(). Les adresses électroniques dans les propriétés des auteurs, des documentalistes et des artistes sont reconnues en recherchant  <user@host>, les  URLs sont reconnus en cherchant http://url, avec  url se prolongeant à l'espace suivant, tabulation ou coupure de ligne.

Pour provoquer la construction d'une  GtkAboutDialog le plus facilement possible, vous pouvez utiliser la fonction gtk_show_about_dialog() qui construit et montre une boîte de dialogue et la concerve pour l'afficherà nouveau.

Détails

GtkAboutDialog


typedef struct _GtkAboutDialog GtkAboutDialog;

La structure  GtkAboutDialog  contient seulement des champs privés et on ne devrait pas y accéder directement.


gtk_about_dialog_new ()


GtkWidget*          gtk_about_dialog_new                (void);

Crée une nouvelle GtkAboutDialog.
Retourne : une boîte de dialogue  GtkAboutDialog nouvellement créée.

Depuis 2.6


gtk_about_dialog_get_name ()


const gchar*        gtk_about_dialog_get_name           (GtkAboutDialog *about);

Retoune le nom du programme affiché dans la boîte de dialogue " à propos de".

about : une  GtkAboutDialog
Retourne :  nom du programme. La chaîne appartient à la boîte de dialogue et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_name ()


void                gtk_about_dialog_set_name           (GtkAboutDialog *about,
const gchar *name);

Définit le nom affiché dans la boîte de dialogue "à propos de". Si il n'est pas définit,  il fera défaut à g_get_application_name().

about : une  GtkAboutDialog
name : me nom du programme

Depuis 2.6


gtk_about_dialog_get_version ()


const gchar*        gtk_about_dialog_get_version        (GtkAboutDialog *about);

Retourne la chaîne de la version.

about : une  GtkAboutDialog
Retourne : chaîne de ma version. Cette chaîne appartient à la boîte de dialogue "à propos de" et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_version ()


void                gtk_about_dialog_set_version        (GtkAboutDialog *about,
const gchar *version);

Definit la chaîne de la version qui sera affichée dans la boîte de dialogue "à propos de".

about : une GtkAboutDialog
version : chaîne de la version

Depuis 2.6


gtk_about_dialog_get_copyright ()


const gchar*        gtk_about_dialog_get_copyright      (GtkAboutDialog *about);

Retourne la chaîne du copyright.

about : une  GtkAboutDialog
Retourne : chaîne du copyright. Cette chaîne appartient à la boîte de dialogue "à propos de" et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_copyright ()


void                gtk_about_dialog_set_copyright      (GtkAboutDialog *about,
const gchar *copyright);

Définit la chaîne du copyright affichée dans la boîte de dialogue "à propos de". Elle doit être courte, une ou deux lignes.

about : une GtkAboutDialog
copyright : la chaîne du copyright

Since 2.6


gtk_about_dialog_get_comments ()


const gchar*        gtk_about_dialog_get_comments       (GtkAboutDialog *about);

Retourne la chaîne de commentaires.

about : une GtkAboutDialog
Retourne : commentaire . La chaîne appartient à la boîte de dialogue "à propos de " et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_comments ()


void                gtk_about_dialog_set_comments       (GtkAboutDialog *about,
const gchar *comments);

Définit la chaîne du commentaire affichée dans la boîte de dialogue "à propos de". Elle doit être courte, une ou deux lignes.

about : une GtkAboutDialog
comments : chaîne du commentaire

Depuis 2.6


gtk_about_dialog_get_license ()


const gchar*        gtk_about_dialog_get_license        (GtkAboutDialog *about);

Retourne les information sur la licence.

about : une GtkAboutDialog
Retourne : les information sur la licence. La chaîne appartient à la boîte de dialogue "à propos de " et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_license ()


void                gtk_about_dialog_set_license        (GtkAboutDialog *about,
const gchar *license);

Définit les informations sur la licence affichées dans la boîte de dialogue secondaire de licence. Si  license est NULL, le bouton de licence est caché.

about : une GtkAboutDialog
license : les informations sur la licence ou  NULL

Depuis 2.6


gtk_about_dialog_get_wrap_license ()


gboolean            gtk_about_dialog_get_wrap_license   (GtkAboutDialog *about);

Retourne si le texte de la licence dans "à propos de " est automatiquement encadré.

about : une GtkAboutDialog
Retourne : TRUE si le texte de la licence est encadré.

Depuis 2.8


gtk_about_dialog_set_wrap_license ()


void                gtk_about_dialog_set_wrap_license   (GtkAboutDialog *about,
gboolean wrap_license);

Définit si le texte de la licence dans "à propos de" est automatiquement encadré.

about : une  GtkAboutDialog
wrap_license : s'il faut encadrer la licence

Depuis 2.8


gtk_about_dialog_get_website ()


const gchar*        gtk_about_dialog_get_website        (GtkAboutDialog *about);

Retourne l'URL du site web

about : une GtkAboutDialog
Retourne : l'URL du site Web. La chaîne appartient à la boîte de dialogue "à propos de " et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_website ()


void                gtk_about_dialog_set_website        (GtkAboutDialog *about,
const gchar *website);

Définit l'URL utilisé pour le lien du site web.

about : une GtkAboutDialog
website : une chaîne  URL débutant par "http://"

Depuis 2.6


gtk_about_dialog_get_website_label ()


const gchar*        gtk_about_dialog_get_website_label  (GtkAboutDialog *about);

Retourne  le label utilisé pour le lien du site web.

about : une GtkAboutDialog
Retourne : le label utilisé pour le lien du site web. La chaîne appartient à la boîte de dialogue "à propos de " et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_website_label ()


void                gtk_about_dialog_set_website_label  (GtkAboutDialog *about,
const gchar *website_label);

Définit le label utilisé pour le lien du site web. It defaults to the website URL.

about : une  GtkAboutDialog
website_label : le label utilisé pour le lien du site web.

Depuis 2.6


gtk_about_dialog_get_authors ()


const gchar* const * gtk_about_dialog_get_authors       (GtkAboutDialog *about);

Retourne la chaîne qui est affiché sous l'onglet des auteurs de la boîte de dialogue secondaire des contributeurs.

about : une  GtkAboutDialog
Retourne : un tableau  terminés par NULL, de  chaines, contenant les noms des  auteurs. Le tableau appartient à la boîte de dialogue "à propos de " et ne doit pas être modifié.

Depuis 2.6


gtk_about_dialog_set_authors ()


void                gtk_about_dialog_set_authors        (GtkAboutDialog *about,
const gchar **authors);

Définit les chaînes qui sont affichées sous l'onglet des auteurs de la boîte de dialogue secondaire des contributeurs.

about : une GtkAboutDialog
authors : un tabelau terminé par  NULL de chaînes

Depuis 2.6


gtk_about_dialog_get_artists ()


const gchar* const * gtk_about_dialog_get_artists       (GtkAboutDialog *about);

Retourne la chaîne (un tableau de chaînes ?) qui est affichée sous l'onglet des artistes de la boîte de dialogue secondaire des contributeurs.

about : une  GtkAboutDialog
Retourne : un tableau terminé par  NULL de chaînes, contenant les noms des artistes. Le tableau appartient à la boîte de dialogue "à propos de " et ne doit pas être modifié.

Depuis 2.6


gtk_about_dialog_set_artists ()


void                gtk_about_dialog_set_artists        (GtkAboutDialog *about,
const gchar **artists);

Definit les chaînes qui son affichées sous l'onglet des artiste dans la boîte de dialogue secondaire des contributeurs.

about : une GtkAboutDialog
artists : un tableau terminé par  NULL de chaînes.

Depuis 2.6


gtk_about_dialog_get_documenters ()


const gchar* const * gtk_about_dialog_get_documenters   (GtkAboutDialog *about);

Retourne la chaîne qui est affichée sous l'onglet des documentalistes dans la boîte de dialogue secondaire des contributeurs.

about : une  GtkAboutDialog
Retourne : un tableau terminé par  NULL de chaînes, contenant le nom des documentalistes. Le tableau appartient à la boîte de dialogue "à propos de " et ne doit pas être modifié.

Depuis 2.6


gtk_about_dialog_set_documenters ()


void                gtk_about_dialog_set_documenters    (GtkAboutDialog *about,
const gchar **documenters);

Définit les chaîne qui sont affichées sous l'onglet documentaliste de la boîte de dialogue secondaire des contributeurs.

about : une GtkAboutDialog
documenters : une tableau terminé par NULL de chaînes.

Depuis 2.6


gtk_about_dialog_get_translator_credits ()


const gchar*        gtk_about_dialog_get_translator_credits
(GtkAboutDialog *about);

Retourne la chaîne des taducteurs qui s'affiche sour l'onglet des traducteurs de la boîte de dialogue secondaire des contributeurs.

about : une GtkAboutDialog
Retourne : la chaîne des traducteurs. La chaîne appartient à la boîte de dialogue "à propos de " et ne doit pas être modifiée.

Depuis 2.6


gtk_about_dialog_set_translator_credits ()


void                gtk_about_dialog_set_translator_credits
(GtkAboutDialog *about,
const gchar *translator_credits);

Définit la chaîne des noms des traducteurs qui est affichée sous l'onglet des traducteurs dans la boîte de dialogue secondaire des contibuteurs.

L'utilisation de cette chaîne se fait de telle sorte que seul le traducteur de la langue utilisée s'affiche. L'utilisation de gettext() pour  marquer la chaîne pour la traduction :

 gtk_about_dialog_set_translator_credits (about, _("translator-credits"));

Il est bon d'utiliser l'identificateur de message "translator-credits" à cette fin puisque les traducteurs connaîtront déjà le but de cette identificateur, et que  GtkAboutDialog détectera si  "translator-credits" est non traduit pour cacher l'onglet des traducteurs.

about : une GtkAboutDialog
translator_credits : les contributeurs traducteurs

Depuis 2.6


gtk_about_dialog_get_logo ()


GdkPixbuf*          gtk_about_dialog_get_logo           (GtkAboutDialog *about);

Retourne le pixbuf affiché comme logo dans la boîte de dialogue "à propos de".

about : une  GtkAboutDialog
Retourne : le pixbuf afficher comme logo.Le pixbuf appartient à la boîte de dialogue. Si vous voulez conserver un référence à ce pixbuf, appelez  g_object_ref() sur lui. 

Depuis 2.6


gtk_about_dialog_set_logo ()


void                gtk_about_dialog_set_logo           (GtkAboutDialog *about,
GdkPixbuf *logo);

Définit le pixbuf affiché comme logo dans la boîte de dialogue "à propos de ". Si logo est  NULL, l'icône par défaut de la fenêtre définie avec gtk_window_set_default_icon() sera utilisée.

about : une GtkAboutDialog
logo : un  GdkPixbuf, ou NULL

Depuis 2.6


gtk_about_dialog_get_logo_icon_name ()


const gchar*        gtk_about_dialog_get_logo_icon_name (GtkAboutDialog *about);

Retourne le nom de l'icône affichée comme logo dans la boîte de dialogue "à propos de ".

about : une GtkAboutDialog
Retourne : le nom de l'icône affichée comme logo. La chaîne appartient à la boîte de dialogue. Si vous voulez conserver une référence à cette icône, vous devez appeler  g_strdup() sur elle,

Depuis 2.6


gtk_about_dialog_set_logo_icon_name ()


void                gtk_about_dialog_set_logo_icon_name (GtkAboutDialog *about,
const gchar *icon_name);

Définit le pixbuf affiché comme logo dans la boîte de dialogue "à propos de". S'il est  NULL, l'icône par défaut de la fenêtre définie avec  gtk_window_set_default_icon() sera utilisée.

about : une GtkAboutDialog
icon_name : un nom d'icône, ou NULL

Depuis 2.6


GtkAboutDialogActivateLinkFunc ()


void                (*GtkAboutDialogActivateLinkFunc)   (GtkAboutDialog *about,
const gchar *link,
gpointer data);

Le type d'une fonction qui est appelé quand le lien d'un URL ou d'une adresse électronique est activé.

about : la GtkAboutDialog dans laquelle le lien a été activé.
link :  URL ou adresse électronique sur lequel le lien activé pointe.
data : données utilisateur qui sont passées quand la fonction est enregistrée avec gtk_about_dialog_set_email_hook() ou gtk_about_dialog_set_url_hook()

gtk_about_dialog_set_email_hook ()


GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_email_hook
(GtkAboutDialogActivateLinkFunc func,
gpointer data,
GDestroyNotify destroy);

Installe une fonction globale qui sera appelée si  l'utilisateur active un lien d'adresse électronique dans la boîte de dialogue "à propos de".

func : une fonction appelée quand un lien d'adresse électronique est activé.
data : données à passer à func
destroy : GDestroyNotify pour  data
Retourne : the previous email hook.

Depuis 2.6


gtk_about_dialog_set_url_hook ()


GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_url_hook
(GtkAboutDialogActivateLinkFunc func,
gpointer data,
GDestroyNotify destroy);

Installe une fonction globale qui sera appelée si  l'utilisateur active un lien d'URL dans la boîte de dialogue "à propos de".

func : une fonction appelée quand un lien d'URL est activé.
data : données à passer à  func
destroy : GDestroyNotify pour data
Retourne : the previous URL hook.

Depuis 2.6


gtk_show_about_dialog ()


void                gtk_show_about_dialog               (GtkWindow *parent,
const gchar *first_property_name,
...);

C'est une fonction pratique pour montrer une boîte de dialogue "à propos de" d'application. La boîte de dialogue construite est associée à la fenêtre parent et est réutilisé pour d'autres appels de cette fonction.

parent : parent transitoire, ou NULL s'il n'y en a pas.
first_property_name : le nom de la première propriété
... : valeur de la première propriété, suivie par d'autres propriétés, terminé par NULL

Depuis 2.6

Détails de Propriétés

La propriété "artists


  "artists"                  GStrv                 : Lire / Ecrire 

Les personnes qui ont contribué à la partie graphique du programme, tableau terminé par  NULL de chaînes. Chaque chaîne peut contenir l'adresse électronique et l'URL qui s'afficheront sous forme de liens, voir l'introduction pour plus de détails.

Depuis 2.6


La propriété "authors


  "authors"                  GStrv                 : Lire / Ecrire 

Les auteus du programme sous forme d'un tableau terminé par  NULL de chaînes. Chaque chaîne peut contenir l'adresse électronique et l'URL qui s'afficheront sous forme de liens, voir l'introduction pour plus de détails.

Depuis 2.6


La propriété "comments


  "comments"                 gchararray            : Lire / Ecrire 

Commentaires au sujet du programme. Cette chaîne est affichée dans un label dans la boîte de dialogue principale, aisni c'est une courte explication  de l'objectif principal du programme et non une liste détaillée de dispositifs.

Valeur par défaut: NULL

Depuis 2.6


La propriété "copyright


  "copyright"                gchararray            : Lire / Ecrire 

Informations au sujet du copyright information pour le programme.

Valeur par défaut: NULL

Depuis 2.6


La propriété "documenters


  "documenters"              GStrv                 : Lire / Ecrire 

Les personnes qui ont documenté le programme sous forme d'un tableau terminé par  NULL de chaînes. Chaque chaîne peut contenir l'adresse électronique et l'URL qui s'afficheront sous forme de liens, voir l'introduction pour plus de détails.

Depuis 2.6

La propriété "license


  "license"                  gchararray            : Lire / Ecrire 

Licence du programme. Cette chaîne est affichée dans un visualiseur de texte dans la boîte de dialogue secondaire, donc il est simple d'utiliser un long texte avec plusieurs paragraphes. Notez que le texte sera encadré dans le visualiseur de texte uniquement si la propriété  "wrap-license" est définie à  TRUE; autrement le texte lui-même doit contenir les  coupures de texte nécessaires.

Valeur par défaut: NULL

Depuis 2.6


La propriété "logo


  "logo"                     GdkPixbuf             : Lire / Ecrire 

Logo pour la boîte "à propos de ". Si il n'y en a pas , cela fera défaut pour  gtk_window_get_default_icon_list().

Depuis 2.6


La propriété "logo-icon-name


"logo-icon-name"           gchararray            : Lire / Ecrire 

Un icône nommée à utiliser comme logo pour la boîte de dialogue "à propos de". Cette propriété a la priorité sur la propriété logo .

Valeur par défaut: NULL

Depuis 2.6


La propriété "name


  "name"                     gchararray            : Lire / Ecrire 

Le nom du programme. S'il n'est pas définit il fera défaut dans  g_get_application_name().

Valeur par défaut: NULL

Depuis 2.6


La propriété "translator-credits


  "translator-credits"       gchararray            : Lire / Ecrire 

Contributions des traducteurs. Cette chaîne doit être marquée comme traductible. Elle peut contenir des adresses électroniques et des URL qui seront afficher sous forme de liens, voir l'introduction pour plus de détails.

Valeur par défaut: NULL

Depuis 2.6


La propriété "version


  "version"                  gchararray            : Lire / Ecrire 

Version du programme.

Valeur par défaut: NULL

Depuis 2.6


La propriété "website


  "website"                  gchararray            : Lire / Ecrire 

URL pour le lien vers le site web du programme. Cela doit être une chaîne commençant par  "http://.

Valeur par défaut: NULL

Depuis 2.6


La propriété "website-label


 "website-label"            gchararray            : Lire / Ecrire 

Label pour le lien vers le site web du programme. S'il n'est pas définit, it defaults to the URL specified in the website property.

Valeur par défaut: NULL

Depuis 2.6


La propriété "wrap-license


  "wrap-license"             gboolean              : Lire / Ecrire 

Si le texte est encadré dans la boîte de dialogue pour la licence.

Valeur par défaut: FALSE

Depuis 2.8

Voir Aussi

GTK_STOCK_ABOUT