gtk2/gtk/gtkaboutdialog.h
Matthias Clasen d00368cac9 GtkAboutDialog: Make credits section extensible
This commit adds API that allows to add new named sections
to the Credits part of GtkAboutDialog, in addition to the
hardcoded sections for authors, documenters, artists and
translators.

https://bugzilla.gnome.org/show_bug.cgi?id=484693
2012-01-25 18:25:43 -05:00

171 lines
8.2 KiB
C

/* GTK - The GIMP Toolkit
Copyright (C) 2001 CodeFactory AB
Copyright (C) 2001 Anders Carlsson <andersca@codefactory.se>
Copyright (C) 2003, 2004 Matthias Clasen <mclasen@redhat.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with the Gnome Library; see the file COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
Author: Anders Carlsson <andersca@codefactory.se>
*/
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#ifndef __GTK_ABOUT_DIALOG_H__
#define __GTK_ABOUT_DIALOG_H__
#include <gtk/gtkdialog.h>
G_BEGIN_DECLS
#define GTK_TYPE_ABOUT_DIALOG (gtk_about_dialog_get_type ())
#define GTK_ABOUT_DIALOG(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ABOUT_DIALOG, GtkAboutDialog))
#define GTK_ABOUT_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ABOUT_DIALOG, GtkAboutDialogClass))
#define GTK_IS_ABOUT_DIALOG(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ABOUT_DIALOG))
#define GTK_IS_ABOUT_DIALOG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ABOUT_DIALOG))
#define GTK_ABOUT_DIALOG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ABOUT_DIALOG, GtkAboutDialogClass))
typedef struct _GtkAboutDialog GtkAboutDialog;
typedef struct _GtkAboutDialogClass GtkAboutDialogClass;
typedef struct _GtkAboutDialogPrivate GtkAboutDialogPrivate;
/**
* GtkLicense:
* @GTK_LICENSE_UNKNOWN: No license specified
* @GTK_LICENSE_CUSTOM: A license text is going to be specified by the
* developer
* @GTK_LICENSE_GPL_2_0: The GNU General Public License, version 2.0
* @GTK_LICENSE_GPL_3_0: The GNU General Public License, version 3.0
* @GTK_LICENSE_LGPL_2_1: The GNU Lesser General Public License, version 2.1
* @GTK_LICENSE_LGPL_3_0: The GNU Lesser General Public License, version 3.0
* @GTK_LICENSE_BSD: The BSD standard license
* @GTK_LICENSE_MIT_X11: The MIT/X11 standard license
* @GTK_LICENSE_ARTISTIC: The Artistic License, version 2.0
*
* The type of license for an application.
*
* This enumeration can be expanded at later date.
*
* Since: 3.0
*/
typedef enum {
GTK_LICENSE_UNKNOWN,
GTK_LICENSE_CUSTOM,
GTK_LICENSE_GPL_2_0,
GTK_LICENSE_GPL_3_0,
GTK_LICENSE_LGPL_2_1,
GTK_LICENSE_LGPL_3_0,
GTK_LICENSE_BSD,
GTK_LICENSE_MIT_X11,
GTK_LICENSE_ARTISTIC
} GtkLicense;
/**
* GtkAboutDialog:
*
* The <structname>GtkAboutDialog</structname> struct contains
* only private fields and should not be directly accessed.
*/
struct _GtkAboutDialog
{
GtkDialog parent_instance;
/*< private >*/
GtkAboutDialogPrivate *priv;
};
struct _GtkAboutDialogClass
{
GtkDialogClass parent_class;
gboolean (*activate_link) (GtkAboutDialog *dialog,
const gchar *uri);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
};
GType gtk_about_dialog_get_type (void) G_GNUC_CONST;
GtkWidget *gtk_about_dialog_new (void);
void gtk_show_about_dialog (GtkWindow *parent,
const gchar *first_property_name,
...) G_GNUC_NULL_TERMINATED;
const gchar * gtk_about_dialog_get_program_name (GtkAboutDialog *about);
void gtk_about_dialog_set_program_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);
void gtk_about_dialog_set_license_type (GtkAboutDialog *about,
GtkLicense license_type);
GtkLicense gtk_about_dialog_get_license_type (GtkAboutDialog *about);
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_documenters (GtkAboutDialog *about);
void gtk_about_dialog_set_documenters (GtkAboutDialog *about,
const gchar **documenters);
const gchar* const * gtk_about_dialog_get_artists (GtkAboutDialog *about);
void gtk_about_dialog_set_artists (GtkAboutDialog *about,
const gchar **artists);
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 gtk_about_dialog_add_credit_section (GtkAboutDialog *about,
const gchar *section_name,
const gchar **people);
G_END_DECLS
#endif /* __GTK_ABOUT_DIALOG_H__ */