File: gimpitem.h

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (257 lines) | stat: -rw-r--r-- 13,722 bytes parent folder | download | duplicates (3)
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
248
249
250
251
252
253
254
255
256
257
/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __GIMP_ITEM_H__
#define __GIMP_ITEM_H__


#include "gimpviewable.h"


#define GIMP_TYPE_ITEM            (gimp_item_get_type ())
#define GIMP_ITEM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_ITEM, GimpItem))
#define GIMP_ITEM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_ITEM, GimpItemClass))
#define GIMP_IS_ITEM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_ITEM))
#define GIMP_IS_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_ITEM))
#define GIMP_ITEM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_ITEM, GimpItemClass))


typedef struct _GimpItemClass GimpItemClass;

struct _GimpItem
{
  GimpViewable      parent_instance;

  gint              ID;                 /*  provides a unique ID     */
  guint32           tattoo;             /*  provides a permanent ID  */

  GimpImage        *gimage;             /*  gimage owner             */

  GimpParasiteList *parasites;          /*  Plug-in parasite data    */

  gint              width, height;      /*  size in pixels           */
  gint              offset_x, offset_y; /*  pixel offset in image    */

  gboolean          visible;            /*  control visibility       */
  gboolean          linked;             /*  control linkage          */

  gboolean          floating;           /*  added to an image?       */
  gboolean          removed;            /*  removed from the image?  */
};

struct _GimpItemClass
{
  GimpViewableClass  parent_class;

  /*  signals  */
  void       (* removed)            (GimpItem      *item);
  void       (* visibility_changed) (GimpItem      *item);
  void       (* linked_changed)     (GimpItem      *item);

  /*  virtual functions  */
  gboolean   (* is_attached)  (GimpItem               *item);
  GimpItem * (* duplicate)    (GimpItem               *item,
                               GType                   new_type,
                               gboolean                add_alpha);
  void       (* convert)      (GimpItem               *item,
                               GimpImage              *dest_image);
  gboolean   (* rename)       (GimpItem               *item,
                               const gchar            *new_name,
                               const gchar            *undo_desc);
  void       (* translate)    (GimpItem               *item,
                               gint                    offset_x,
                               gint                    offset_y,
                               gboolean                push_undo);
  void       (* scale)        (GimpItem               *item,
                               gint                    new_width,
                               gint                    new_height,
                               gint                    new_offset_x,
                               gint                    new_offset_y,
                               GimpInterpolationType   interpolation_type,
                               GimpProgress           *progress);
  void       (* resize)       (GimpItem               *item,
                               GimpContext            *context,
                               gint                    new_width,
                               gint                    new_height,
                               gint                    offset_x,
                               gint                    offset_y);
  void       (* flip)         (GimpItem               *item,
                               GimpContext            *context,
                               GimpOrientationType     flip_type,
                               gdouble                 axis,
                               gboolean                clip_result);
  void       (* rotate)       (GimpItem               *item,
                               GimpContext            *context,
                               GimpRotationType        rotate_type,
                               gdouble                 center_x,
                               gdouble                 center_y,
                               gboolean                clip_result);
  void       (* transform)    (GimpItem               *item,
                               GimpContext            *context,
                               const GimpMatrix3      *matrix,
                               GimpTransformDirection  direction,
                               GimpInterpolationType   interpolation_type,
                               gboolean                supersample,
                               gint                    recursion_level,
                               gboolean                clip_result,
                               GimpProgress           *progress);
  gboolean   (* stroke)       (GimpItem               *item,
                               GimpDrawable           *drawable,
                               GimpContext            *context,
                               GimpStrokeDesc         *stroke_desc);

  const gchar *default_name;
  const gchar *rename_desc;
  const gchar *translate_desc;
  const gchar *scale_desc;
  const gchar *resize_desc;
  const gchar *flip_desc;
  const gchar *rotate_desc;
  const gchar *transform_desc;
  const gchar *stroke_desc;
};


GType           gimp_item_get_type         (void) G_GNUC_CONST;

gboolean        gimp_item_is_floating      (const GimpItem *item);
void            gimp_item_sink             (GimpItem       *item);

void            gimp_item_removed          (GimpItem       *item);
gboolean        gimp_item_is_removed       (const GimpItem *item);

gboolean        gimp_item_is_attached      (GimpItem       *item);

void            gimp_item_configure        (GimpItem       *item,
                                            GimpImage      *gimage,
                                            gint            offset_x,
                                            gint            offset_y,
                                            gint            width,
                                            gint            height,
                                            const gchar    *name);
GimpItem      * gimp_item_duplicate        (GimpItem       *item,
                                            GType           new_type,
                                            gboolean        add_alpha);
GimpItem      * gimp_item_convert          (GimpItem       *item,
                                            GimpImage      *dest_image,
                                            GType           new_type,
                                            gboolean        add_alpha);

gboolean        gimp_item_rename           (GimpItem       *item,
                                            const gchar    *new_name);

gint            gimp_item_width            (const GimpItem *item);
gint            gimp_item_height           (const GimpItem *item);
void            gimp_item_offsets          (const GimpItem *item,
                                            gint           *offset_x,
                                            gint           *offset_y);

void            gimp_item_translate        (GimpItem       *item,
                                            gint            offset_x,
                                            gint            offset_y,
                                            gboolean        push_undo);

gboolean        gimp_item_check_scaling    (const GimpItem *item,
                                            gint            new_width,
                                            gint            new_height);
void            gimp_item_scale            (GimpItem       *item,
                                            gint            new_width,
                                            gint            new_height,
                                            gint            new_offset_x,
                                            gint            new_offset_y,
                                            GimpInterpolationType  interpolation,
                                            GimpProgress   *progress);
gboolean        gimp_item_scale_by_factors (GimpItem       *item,
                                            gdouble         w_factor,
                                            gdouble         h_factor,
                                            GimpInterpolationType interpolation,
                                            GimpProgress   *progress);
void            gimp_item_scale_by_origin  (GimpItem       *item,
                                            gint            new_width,
                                            gint            new_height,
                                            GimpInterpolationType interpolation,
                                            GimpProgress   *progress,
                                            gboolean        local_origin);
void            gimp_item_resize           (GimpItem       *item,
                                            GimpContext    *context,
                                            gint            new_width,
                                            gint            new_height,
                                            gint            offset_x,
                                            gint            offset_y);
void            gimp_item_resize_to_image  (GimpItem       *item);

void            gimp_item_flip             (GimpItem       *item,
                                            GimpContext    *context,
                                            GimpOrientationType flip_type,
                                            gdouble         axis,
                                            gboolean        flip_result);
void            gimp_item_rotate           (GimpItem       *item,
                                            GimpContext    *context,
                                            GimpRotationType rotate_type,
                                            gdouble         center_x,
                                            gdouble         center_y,
                                            gboolean        flip_result);
void            gimp_item_transform        (GimpItem       *item,
                                            GimpContext    *context,
                                            const GimpMatrix3 *matrix,
                                            GimpTransformDirection direction,
                                            GimpInterpolationType interpolation_type,
                                            gboolean        supersample,
                                            gint            recursion_level,
                                            gboolean        clip_result,
                                            GimpProgress   *progress);

gboolean        gimp_item_stroke           (GimpItem       *item,
                                            GimpDrawable   *drawable,
                                            GimpContext    *context,
                                            GimpStrokeDesc *stroke_desc,
                                            gboolean        use_default_values);

gint            gimp_item_get_ID           (GimpItem       *item);
GimpItem      * gimp_item_get_by_ID        (Gimp           *gimp,
                                            gint            id);

GimpTattoo      gimp_item_get_tattoo       (const GimpItem *item);
void            gimp_item_set_tattoo       (GimpItem       *item,
                                            GimpTattoo      tattoo);

GimpImage     * gimp_item_get_image        (const GimpItem *item);
void            gimp_item_set_image        (GimpItem       *item,
                                            GimpImage      *gimage);

void            gimp_item_parasite_attach  (GimpItem       *item,
                                            GimpParasite   *parasite);
void            gimp_item_parasite_detach  (GimpItem       *item,
                                            const gchar    *name);
GimpParasite  * gimp_item_parasite_find    (const GimpItem *item,
                                            const gchar    *name);
gchar        ** gimp_item_parasite_list    (const GimpItem *item,
                                            gint           *count);

gboolean	gimp_item_get_visible      (const GimpItem *item);
void            gimp_item_set_visible      (GimpItem       *item,
                                            gboolean        visible,
                                            gboolean        push_undo);

void            gimp_item_set_linked       (GimpItem       *item,
                                            gboolean        linked,
                                            gboolean        push_undo);
gboolean        gimp_item_get_linked       (const GimpItem *item);


#endif /* __GIMP_ITEM_H__ */