gtkaboutdialog.h 9.08 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Matthias Clasen's avatar
Matthias Clasen committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

   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
Javier Jardón's avatar
Javier Jardón committed
18
   License along with this library. If not, see <http://www.gnu.org/licenses/>.
Matthias Clasen's avatar
Matthias Clasen committed
19
20
21
22

   Author: Anders Carlsson <andersca@codefactory.se>
*/

23
24
25
#ifndef __GTK_ABOUT_DIALOG_H__
#define __GTK_ABOUT_DIALOG_H__

26
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
27
28
29
#error "Only <gtk/gtk.h> can be included directly."
#endif

30
#include <gtk/gtkwindow.h>
Matthias Clasen's avatar
Matthias Clasen committed
31
32
33
34
35
36
37
38
39

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_IS_ABOUT_DIALOG(object)      (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ABOUT_DIALOG))

typedef struct _GtkAboutDialog        GtkAboutDialog;

40
41
42
43
44
/**
 * GtkLicense:
 * @GTK_LICENSE_UNKNOWN: No license specified
 * @GTK_LICENSE_CUSTOM: A license text is going to be specified by the
 *   developer
45
46
47
48
 * @GTK_LICENSE_GPL_2_0: The GNU General Public License, version 2.0 or later
 * @GTK_LICENSE_GPL_3_0: The GNU General Public License, version 3.0 or later
 * @GTK_LICENSE_LGPL_2_1: The GNU Lesser General Public License, version 2.1 or later
 * @GTK_LICENSE_LGPL_3_0: The GNU Lesser General Public License, version 3.0 or later
49
50
51
 * @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
Matthias Clasen's avatar
Matthias Clasen committed
52
53
54
55
56
57
 * @GTK_LICENSE_GPL_2_0_ONLY: The GNU General Public License, version 2.0 only
 * @GTK_LICENSE_GPL_3_0_ONLY: The GNU General Public License, version 3.0 only
 * @GTK_LICENSE_LGPL_2_1_ONLY: The GNU Lesser General Public License, version 2.1 only
 * @GTK_LICENSE_LGPL_3_0_ONLY: The GNU Lesser General Public License, version 3.0 only
 * @GTK_LICENSE_AGPL_3_0: The GNU Affero General Public License, version 3.0 or later
 * @GTK_LICENSE_AGPL_3_0_ONLY: The GNU Affero General Public License, version 3.0 only
Matthias Clasen's avatar
Matthias Clasen committed
58
59
60
 * @GTK_LICENSE_BSD_3: The 3-clause BSD licence
 * @GTK_LICENSE_APACHE_2_0: The Apache License, version 2.0
 * @GTK_LICENSE_MPL_2_0: The Mozilla Public License, version 2.0
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 *
 * The type of license for an application.
 *
 * This enumeration can be expanded at later date.
 */
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,

79
80
81
82
83
  GTK_LICENSE_ARTISTIC,

  GTK_LICENSE_GPL_2_0_ONLY,
  GTK_LICENSE_GPL_3_0_ONLY,
  GTK_LICENSE_LGPL_2_1_ONLY,
84
85
  GTK_LICENSE_LGPL_3_0_ONLY,

GN's avatar
GN committed
86
  GTK_LICENSE_AGPL_3_0,
87
88
89
90
91
  GTK_LICENSE_AGPL_3_0_ONLY,

  GTK_LICENSE_BSD_3,
  GTK_LICENSE_APACHE_2_0,
  GTK_LICENSE_MPL_2_0
92
93
} GtkLicense;

Matthias Clasen's avatar
Matthias Clasen committed
94

95
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
96
GType                  gtk_about_dialog_get_type               (void) G_GNUC_CONST;
97
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
98
GtkWidget             *gtk_about_dialog_new                    (void);
99
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
100
void                   gtk_show_about_dialog                   (GtkWindow       *parent,
Benjamin Otte's avatar
Benjamin Otte committed
101
                                                                const char      *first_property_name,
102
                                                                ...) G_GNUC_NULL_TERMINATED;
103
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
104
const char *          gtk_about_dialog_get_program_name       (GtkAboutDialog  *about);
105
GDK_AVAILABLE_IN_ALL
106
void                   gtk_about_dialog_set_program_name       (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
107
                                                                const char      *name);
108
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
109
const char *          gtk_about_dialog_get_version            (GtkAboutDialog  *about);
110
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
111
void                   gtk_about_dialog_set_version            (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
112
                                                                const char      *version);
113
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
114
const char *          gtk_about_dialog_get_copyright          (GtkAboutDialog  *about);
115
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
116
void                   gtk_about_dialog_set_copyright          (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
117
                                                                const char      *copyright);
118
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
119
const char *          gtk_about_dialog_get_comments           (GtkAboutDialog  *about);
120
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
121
void                   gtk_about_dialog_set_comments           (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
122
                                                                const char      *comments);
123
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
124
const char *          gtk_about_dialog_get_license            (GtkAboutDialog  *about);
125
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
126
void                   gtk_about_dialog_set_license            (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
127
                                                                const char      *license);
128
GDK_AVAILABLE_IN_ALL
129
130
void                   gtk_about_dialog_set_license_type       (GtkAboutDialog  *about,
                                                                GtkLicense       license_type);
131
GDK_AVAILABLE_IN_ALL
132
GtkLicense             gtk_about_dialog_get_license_type       (GtkAboutDialog  *about);
133

134
GDK_AVAILABLE_IN_ALL
135
gboolean               gtk_about_dialog_get_wrap_license       (GtkAboutDialog  *about);
136
GDK_AVAILABLE_IN_ALL
137
138
139
void                   gtk_about_dialog_set_wrap_license       (GtkAboutDialog  *about,
                                                                gboolean         wrap_license);

140
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
141
const char *          gtk_about_dialog_get_system_information (GtkAboutDialog  *about);
142
143
GDK_AVAILABLE_IN_ALL
void                   gtk_about_dialog_set_system_information (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
144
                                                                const char      *system_information);
145
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
146
const char *          gtk_about_dialog_get_website            (GtkAboutDialog  *about);
147
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
148
void                   gtk_about_dialog_set_website            (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
149
                                                                const char      *website);
150
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
151
const char *          gtk_about_dialog_get_website_label      (GtkAboutDialog  *about);
152
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
153
void                   gtk_about_dialog_set_website_label      (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
154
                                                                const char      *website_label);
155
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
156
const char * const *   gtk_about_dialog_get_authors            (GtkAboutDialog  *about);
157
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
158
void                   gtk_about_dialog_set_authors            (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
159
                                                                const char     **authors);
160
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
161
const char * const *   gtk_about_dialog_get_documenters        (GtkAboutDialog  *about);
162
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
163
void                   gtk_about_dialog_set_documenters        (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
164
                                                                const char     **documenters);
165
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
166
const char * const *   gtk_about_dialog_get_artists            (GtkAboutDialog  *about);
167
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
168
void                   gtk_about_dialog_set_artists            (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
169
                                                                const char     **artists);
170
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
171
const char *          gtk_about_dialog_get_translator_credits (GtkAboutDialog  *about);
172
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
173
void                   gtk_about_dialog_set_translator_credits (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
174
                                                                const char      *translator_credits);
175
GDK_AVAILABLE_IN_ALL
176
GdkPaintable          *gtk_about_dialog_get_logo               (GtkAboutDialog  *about);
177
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
178
void                   gtk_about_dialog_set_logo               (GtkAboutDialog  *about,
179
                                                                GdkPaintable    *logo);
180
GDK_AVAILABLE_IN_ALL
Benjamin Otte's avatar
Benjamin Otte committed
181
const char *          gtk_about_dialog_get_logo_icon_name     (GtkAboutDialog  *about);
182
GDK_AVAILABLE_IN_ALL
183
void                   gtk_about_dialog_set_logo_icon_name     (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
184
                                                                const char      *icon_name);
Matthias Clasen's avatar
Matthias Clasen committed
185
GDK_AVAILABLE_IN_ALL
186
void                  gtk_about_dialog_add_credit_section      (GtkAboutDialog  *about,
Benjamin Otte's avatar
Benjamin Otte committed
187
188
                                                                const char      *section_name,
                                                                const char     **people);
Matthias Clasen's avatar
Matthias Clasen committed
189

190
191
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkAboutDialog, g_object_unref)

Matthias Clasen's avatar
Matthias Clasen committed
192
193
194
195
196
G_END_DECLS

#endif /* __GTK_ABOUT_DIALOG_H__ */