summaryrefslogtreecommitdiffstats
path: root/app/core/gimp.h
blob: f221351387ead66082658cdd7e8fc6e2018f4015 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995-1997 Spencer Kimball and Peter Mattis
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef __GIMP_H__
#define __GIMP_H__


#include "gimpobject.h"
#include "gimp-gui.h"


#define GIMP_TYPE_GIMP            (gimp_get_type ())
#define GIMP(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_GIMP, Gimp))
#define GIMP_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_GIMP, GimpClass))
#define GIMP_IS_GIMP(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_GIMP))
#define GIMP_IS_GIMP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_GIMP))


typedef struct _GimpClass GimpClass;

struct _Gimp
{
  GimpObject              parent_instance;

  GimpCoreConfig         *config;
  GimpCoreConfig         *edit_config; /* don't use this one, it's just
                                        * for the preferences dialog
                                        */
  gchar                  *session_name;
  GFile                  *default_folder;

  gboolean                be_verbose;
  gboolean                no_data;
  gboolean                no_fonts;
  gboolean                no_interface;
  gboolean                show_gui;
  gboolean                use_shm;
  gboolean                use_cpu_accel;
  GimpMessageHandlerType  message_handler;
  gboolean                console_messages;
  gboolean                show_playground;
  gboolean                show_debug_menu;
  GimpStackTraceMode      stack_trace_mode;
  GimpPDBCompatMode       pdb_compat_mode;

  GimpGui                 gui;         /* gui vtable */

  gboolean                restored;    /* becomes TRUE in gimp_restore() */

  gint                    busy;
  guint                   busy_idle_id;

  GList                  *user_units;
  gint                    n_user_units;

  GimpParasiteList       *parasites;

  GimpContainer          *paint_info_list;
  GimpPaintInfo          *standard_paint_info;

  GimpModuleDB           *module_db;
  gboolean                write_modulerc;

  GimpPlugInManager      *plug_in_manager;

  GList                  *filter_history;

  GimpContainer          *images;
  guint32                 next_guide_ID;
  guint32                 next_sample_point_ID;
  GimpIdTable            *image_table;
  GimpIdTable            *item_table;

  GimpContainer          *displays;
  gint                    next_display_ID;

  GList                  *image_windows;

  GimpImage              *clipboard_image;
  GimpBuffer             *clipboard_buffer;
  GimpContainer          *named_buffers;

  GimpDataFactory        *brush_factory;
  GimpDataFactory        *dynamics_factory;
  GimpDataFactory        *mybrush_factory;
  GimpDataFactory        *pattern_factory;
  GimpDataFactory        *gradient_factory;
  GimpDataFactory        *palette_factory;
  GimpDataFactory        *font_factory;
  GimpDataFactory        *tool_preset_factory;

  GimpTagCache           *tag_cache;

  GimpPDB                *pdb;

  GimpContainer          *tool_info_list;
  GimpToolInfo           *standard_tool_info;

  GimpContainer          *tool_item_list;
  GimpContainer          *tool_item_ui_list;

  /*  the opened and saved images in MRU order  */
  GimpContainer          *documents;

  /*  image_new values  */
  GimpContainer          *templates;
  GimpTemplate           *image_new_last_template;

  /*  the list of all contexts  */
  GList                  *context_list;

  /*  the default context which is initialized from gimprc  */
  GimpContext            *default_context;

  /*  the context used by the interface  */
  GimpContext            *user_context;
};

struct _GimpClass
{
  GimpObjectClass  parent_class;

  void     (* initialize)             (Gimp               *gimp,
                                       GimpInitStatusFunc  status_callback);
  void     (* restore)                (Gimp               *gimp,
                                       GimpInitStatusFunc  status_callback);
  gboolean (* exit)                   (Gimp               *gimp,
                                       gboolean            force);

  void     (* clipboard_changed)      (Gimp               *gimp);

  void     (* filter_history_changed) (Gimp               *gimp);

  /*  emitted if an image is loaded and opened with a display  */
  void     (* image_opened)           (Gimp               *gimp,
                                       GFile              *file);
};


GType          gimp_get_type               (void) G_GNUC_CONST;

Gimp         * gimp_new                    (const gchar         *name,
                                            const gchar         *session_name,
                                            GFile               *default_folder,
                                            gboolean             be_verbose,
                                            gboolean             no_data,
                                            gboolean             no_fonts,
                                            gboolean             no_interface,
                                            gboolean             use_shm,
                                            gboolean             use_cpu_accel,
                                            gboolean             console_messages,
                                            gboolean             show_playground,
                                            gboolean             show_debug_menu,
                                            GimpStackTraceMode   stack_trace_mode,
                                            GimpPDBCompatMode    pdb_compat_mode);
void           gimp_set_show_gui           (Gimp                *gimp,
                                            gboolean             show_gui);
gboolean       gimp_get_show_gui           (Gimp                *gimp);

void           gimp_load_config            (Gimp                *gimp,
                                            GFile               *alternate_system_gimprc,
                                            GFile               *alternate_gimprc);
void           gimp_initialize             (Gimp                *gimp,
                                            GimpInitStatusFunc   status_callback);
void           gimp_restore                (Gimp                *gimp,
                                            GimpInitStatusFunc   status_callback,
                                            GError             **error);
gboolean       gimp_is_restored            (Gimp                *gimp);

void           gimp_exit                   (Gimp                *gimp,
                                            gboolean             force);

GList        * gimp_get_image_iter         (Gimp                *gimp);
GList        * gimp_get_display_iter       (Gimp                *gimp);
GList        * gimp_get_image_windows      (Gimp                *gimp);
GList        * gimp_get_paint_info_iter    (Gimp                *gimp);
GList        * gimp_get_tool_info_iter     (Gimp                *gimp);
GList        * gimp_get_tool_item_iter     (Gimp                *gimp);
GList        * gimp_get_tool_item_ui_iter  (Gimp                *gimp);

GimpObject   * gimp_get_clipboard_object   (Gimp                *gimp);

void           gimp_set_clipboard_image    (Gimp                *gimp,
                                            GimpImage           *image);
GimpImage    * gimp_get_clipboard_image    (Gimp                *gimp);

void           gimp_set_clipboard_buffer   (Gimp                *gimp,
                                            GimpBuffer          *buffer);
GimpBuffer   * gimp_get_clipboard_buffer   (Gimp                *gimp);

GimpImage    * gimp_create_image           (Gimp                *gimp,
                                            gint                 width,
                                            gint                 height,
                                            GimpImageBaseType    type,
                                            GimpPrecision        precision,
                                            gboolean             attach_comment);

void           gimp_set_default_context    (Gimp                *gimp,
                                            GimpContext         *context);
GimpContext  * gimp_get_default_context    (Gimp                *gimp);

void           gimp_set_user_context       (Gimp                *gimp,
                                            GimpContext         *context);
GimpContext  * gimp_get_user_context       (Gimp                *gimp);

GimpToolInfo * gimp_get_tool_info          (Gimp                *gimp,
                                            const gchar         *tool_name);

void           gimp_message                (Gimp                *gimp,
                                            GObject             *handler,
                                            GimpMessageSeverity  severity,
                                            const gchar         *format,
                                            ...) G_GNUC_PRINTF (4, 5);
void           gimp_message_valist         (Gimp                *gimp,
                                            GObject             *handler,
                                            GimpMessageSeverity  severity,
                                            const gchar         *format,
                                            va_list              args) G_GNUC_PRINTF (4, 0);
void           gimp_message_literal        (Gimp                *gimp,
                                            GObject             *handler,
                                            GimpMessageSeverity  severity,
                                            const gchar         *message);

void           gimp_filter_history_changed (Gimp                *gimp);

void           gimp_image_opened           (Gimp                *gimp,
                                            GFile               *file);

GFile        * gimp_get_temp_file          (Gimp                *gimp,
                                            const gchar         *extension);


#endif  /* __GIMP_H__ */