Pileus Git - ~andy/gtk/blob - gtk/gtkaboutdialog.h

   1 /* GTK - The GIMP Toolkit
   2
   3    Copyright (C) 2001 CodeFactory AB
   4    Copyright (C) 2001 Anders Carlsson <andersca@codefactory.se>
   5    Copyright (C) 2003, 2004 Matthias Clasen <mclasen@redhat.com>
   6
   7    This library is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU Library General Public License as
   9    published by the Free Software Foundation; either version 2 of the
  10    License, or (at your option) any later version.
  11
  12    This library is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    Library General Public License for more details.
  16
  17    You should have received a copy of the GNU Library General Public
  18    License along with the Gnome Library; see the file COPYING.LIB.  If not,
  19    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.
  21
  22    Author: Anders Carlsson <andersca@codefactory.se>
  23 */
  24
  25 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  26 #error "Only <gtk/gtk.h> can be included directly."
  27 #endif
  28
  29 #ifndef __GTK_ABOUT_DIALOG_H__
  30 #define __GTK_ABOUT_DIALOG_H__
  31
  32 #include <gtk/gtkdialog.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define GTK_TYPE_ABOUT_DIALOG            (gtk_about_dialog_get_type ())
  37 #define GTK_ABOUT_DIALOG(object)         (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ABOUT_DIALOG, GtkAboutDialog))
  38 #define GTK_ABOUT_DIALOG_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ABOUT_DIALOG, GtkAboutDialogClass))
  39 #define GTK_IS_ABOUT_DIALOG(object)      (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ABOUT_DIALOG))
  40 #define GTK_IS_ABOUT_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ABOUT_DIALOG))
  41 #define GTK_ABOUT_DIALOG_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ABOUT_DIALOG, GtkAboutDialogClass))
  42
  43 typedef struct _GtkAboutDialog        GtkAboutDialog;
  44 typedef struct _GtkAboutDialogClass   GtkAboutDialogClass;
  45 typedef struct _GtkAboutDialogPrivate GtkAboutDialogPrivate;
  46
  47 /**
  48  * GtkAboutDialog:
  49  *
  50  * The <structname>GtkAboutDialog</structname> struct contains
  51  * only private fields and should not be directly accessed.
  52  */
  53 struct _GtkAboutDialog
  54 {
  55   GtkDialog parent_instance;
  56
  57   /*< private >*/
  58   GtkAboutDialogPrivate *priv;
  59 };
  60
  61 struct _GtkAboutDialogClass
  62 {
  63   GtkDialogClass parent_class;
  64
  65   /* Padding for future expansion */
  66   void (*_gtk_reserved1) (void);
  67   void (*_gtk_reserved2) (void);
  68   void (*_gtk_reserved3) (void);
  69   void (*_gtk_reserved4) (void);
  70 };
  71
  72 GType                  gtk_about_dialog_get_type               (void) G_GNUC_CONST;
  73 GtkWidget             *gtk_about_dialog_new                    (void);
  74 void                   gtk_show_about_dialog                   (GtkWindow       *parent,
  75                                                                 const gchar     *first_property_name,
  76                                                                 ...) G_GNUC_NULL_TERMINATED;
  77 G_CONST_RETURN gchar  *gtk_about_dialog_get_program_name       (GtkAboutDialog  *about);
  78 void                   gtk_about_dialog_set_program_name       (GtkAboutDialog  *about,
  79                                                                 const gchar     *name);
  80 G_CONST_RETURN gchar  *gtk_about_dialog_get_version            (GtkAboutDialog  *about);
  81 void                   gtk_about_dialog_set_version            (GtkAboutDialog  *about,
  82                                                                 const gchar     *version);
  83 G_CONST_RETURN gchar  *gtk_about_dialog_get_copyright          (GtkAboutDialog  *about);
  84 void                   gtk_about_dialog_set_copyright          (GtkAboutDialog  *about,
  85                                                                 const gchar     *copyright);
  86 G_CONST_RETURN gchar  *gtk_about_dialog_get_comments           (GtkAboutDialog  *about);
  87 void                   gtk_about_dialog_set_comments           (GtkAboutDialog  *about,
  88                                                                 const gchar     *comments);
  89 G_CONST_RETURN gchar  *gtk_about_dialog_get_license            (GtkAboutDialog  *about);
  90 void                   gtk_about_dialog_set_license            (GtkAboutDialog  *about,
  91                                                                 const gchar     *license);
  92
  93 gboolean               gtk_about_dialog_get_wrap_license       (GtkAboutDialog  *about);
  94 void                   gtk_about_dialog_set_wrap_license       (GtkAboutDialog  *about,
  95                                                                 gboolean         wrap_license);
  96
  97 G_CONST_RETURN gchar  *gtk_about_dialog_get_website            (GtkAboutDialog  *about);
  98 void                   gtk_about_dialog_set_website            (GtkAboutDialog  *about,
  99                                                                 const gchar     *website);
 100 G_CONST_RETURN gchar  *gtk_about_dialog_get_website_label      (GtkAboutDialog  *about);
 101 void                   gtk_about_dialog_set_website_label      (GtkAboutDialog  *about,
 102                                                                 const gchar     *website_label);
 103 G_CONST_RETURN gchar* G_CONST_RETURN * gtk_about_dialog_get_authors            (GtkAboutDialog  *about);
 104 void                   gtk_about_dialog_set_authors            (GtkAboutDialog  *about,
 105                                                                 const gchar    **authors);
 106 G_CONST_RETURN gchar* G_CONST_RETURN * gtk_about_dialog_get_documenters        (GtkAboutDialog  *about);
 107 void                   gtk_about_dialog_set_documenters        (GtkAboutDialog  *about,
 108                                                                 const gchar    **documenters);
 109 G_CONST_RETURN gchar* G_CONST_RETURN * gtk_about_dialog_get_artists            (GtkAboutDialog  *about);
 110 void                   gtk_about_dialog_set_artists            (GtkAboutDialog  *about,
 111                                                                 const gchar    **artists);
 112 G_CONST_RETURN gchar  *gtk_about_dialog_get_translator_credits (GtkAboutDialog  *about);
 113 void                   gtk_about_dialog_set_translator_credits (GtkAboutDialog  *about,
 114                                                                 const gchar     *translator_credits);
 115 GdkPixbuf             *gtk_about_dialog_get_logo               (GtkAboutDialog  *about);
 116 void                   gtk_about_dialog_set_logo               (GtkAboutDialog  *about,
 117                                                                 GdkPixbuf       *logo);
 118 G_CONST_RETURN gchar  *gtk_about_dialog_get_logo_icon_name     (GtkAboutDialog  *about);
 119 void                   gtk_about_dialog_set_logo_icon_name     (GtkAboutDialog  *about,
 120                                                                 const gchar     *icon_name);
 121
 122 /**
 123  * GtkAboutDialogActivateLinkFunc:
 124  * @about: the #GtkAboutDialog in which the link was activated
 125  * @link_: the URL or email address to which the activated link points
 126  * @data: user data that was passed when the function was registered
 127  *  with gtk_about_dialog_set_email_hook() or
 128  *  gtk_about_dialog_set_url_hook()
 129  *
 130  * The type of a function which is called when a URL or email
 131  * link is activated.
 132  */
 133 typedef void (* GtkAboutDialogActivateLinkFunc) (GtkAboutDialog *about,
 134                                                  const gchar    *link_,
 135                                                  gpointer        data);
 136
 137 GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_email_hook (GtkAboutDialogActivateLinkFunc func,
 138                                                                 gpointer                       data,
 139                                                                 GDestroyNotify                 destroy);
 140 GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_url_hook   (GtkAboutDialogActivateLinkFunc func,
 141                                                                 gpointer                       data,
 142                                                                 GDestroyNotify                 destroy);
 143
 144 G_END_DECLS
 145
 146 #endif /* __GTK_ABOUT_DIALOG_H__ */
 147
 148