1 /* GIMP - The GNU Image Manipulation Program
2  * Copyright (C) 1995 Spencer Kimball and Peter Mattis
3  *
4  * gimpcanvasitem.h
5  * Copyright (C) 2010 Michael Natterer <mitch@gimp.org>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program 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
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __GIMP_CANVAS_ITEM_H__
22 #define __GIMP_CANVAS_ITEM_H__
23 
24 
25 #include "core/gimpobject.h"
26 
27 
28 #define GIMP_TYPE_CANVAS_ITEM            (gimp_canvas_item_get_type ())
29 #define GIMP_CANVAS_ITEM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_CANVAS_ITEM, GimpCanvasItem))
30 #define GIMP_CANVAS_ITEM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_CANVAS_ITEM, GimpCanvasItemClass))
31 #define GIMP_IS_CANVAS_ITEM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_CANVAS_ITEM))
32 #define GIMP_IS_CANVAS_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_CANVAS_ITEM))
33 #define GIMP_CANVAS_ITEM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_CANVAS_ITEM, GimpCanvasItemClass))
34 
35 
36 typedef struct _GimpCanvasItemPrivate GimpCanvasItemPrivate;
37 typedef struct _GimpCanvasItemClass   GimpCanvasItemClass;
38 
39 struct _GimpCanvasItem
40 {
41   GimpObject             parent_instance;
42 
43   GimpCanvasItemPrivate *private;
44 };
45 
46 struct _GimpCanvasItemClass
47 {
48   GimpObjectClass  parent_class;
49 
50   /*  signals  */
51   void             (* update)      (GimpCanvasItem   *item,
52                                     cairo_region_t   *region);
53 
54   /*  virtual functions  */
55   void             (* draw)        (GimpCanvasItem   *item,
56                                     cairo_t          *cr);
57   cairo_region_t * (* get_extents) (GimpCanvasItem   *item);
58 
59   void             (* stroke)      (GimpCanvasItem   *item,
60                                     cairo_t          *cr);
61   void             (* fill)        (GimpCanvasItem   *item,
62                                     cairo_t          *cr);
63 
64   gboolean         (* hit)         (GimpCanvasItem   *item,
65                                     gdouble           x,
66                                     gdouble           y);
67 };
68 
69 
70 GType            gimp_canvas_item_get_type         (void) G_GNUC_CONST;
71 
72 GimpDisplayShell * gimp_canvas_item_get_shell      (GimpCanvasItem   *item);
73 GimpImage      * gimp_canvas_item_get_image        (GimpCanvasItem   *item);
74 GtkWidget      * gimp_canvas_item_get_canvas       (GimpCanvasItem   *item);
75 
76 void             gimp_canvas_item_draw             (GimpCanvasItem   *item,
77                                                     cairo_t          *cr);
78 cairo_region_t * gimp_canvas_item_get_extents      (GimpCanvasItem   *item);
79 
80 gboolean         gimp_canvas_item_hit              (GimpCanvasItem   *item,
81                                                     gdouble           x,
82                                                     gdouble           y);
83 
84 void             gimp_canvas_item_set_visible      (GimpCanvasItem   *item,
85                                                     gboolean          visible);
86 gboolean         gimp_canvas_item_get_visible      (GimpCanvasItem   *item);
87 
88 void             gimp_canvas_item_set_line_cap     (GimpCanvasItem   *item,
89                                                     cairo_line_cap_t  line_cap);
90 
91 void             gimp_canvas_item_set_highlight    (GimpCanvasItem   *item,
92                                                     gboolean          highlight);
93 gboolean         gimp_canvas_item_get_highlight    (GimpCanvasItem   *item);
94 
95 void             gimp_canvas_item_begin_change     (GimpCanvasItem   *item);
96 void             gimp_canvas_item_end_change       (GimpCanvasItem   *item);
97 
98 void             gimp_canvas_item_suspend_stroking (GimpCanvasItem   *item);
99 void             gimp_canvas_item_resume_stroking  (GimpCanvasItem   *item);
100 
101 void             gimp_canvas_item_suspend_filling  (GimpCanvasItem   *item);
102 void             gimp_canvas_item_resume_filling   (GimpCanvasItem   *item);
103 
104 void             gimp_canvas_item_transform        (GimpCanvasItem   *item,
105                                                     cairo_t          *cr);
106 void             gimp_canvas_item_transform_xy     (GimpCanvasItem   *item,
107                                                     gdouble           x,
108                                                     gdouble           y,
109                                                     gint             *tx,
110                                                     gint             *ty);
111 void             gimp_canvas_item_transform_xy_f   (GimpCanvasItem   *item,
112                                                     gdouble           x,
113                                                     gdouble           y,
114                                                     gdouble          *tx,
115                                                     gdouble          *ty);
116 gdouble          gimp_canvas_item_transform_distance
117                                                    (GimpCanvasItem   *item,
118                                                     gdouble           x1,
119                                                     gdouble           y1,
120                                                     gdouble           x2,
121                                                     gdouble           y2);
122 gdouble          gimp_canvas_item_transform_distance_square
123                                                    (GimpCanvasItem   *item,
124                                                     gdouble           x1,
125                                                     gdouble           y1,
126                                                     gdouble           x2,
127                                                     gdouble           y2);
128 void             gimp_canvas_item_untransform_viewport
129                                                    (GimpCanvasItem   *item,
130                                                     gint             *x,
131                                                     gint             *y,
132                                                     gint             *w,
133                                                     gint             *h);
134 
135 
136 /*  protected  */
137 
138 void             _gimp_canvas_item_update          (GimpCanvasItem   *item,
139                                                     cairo_region_t   *region);
140 gboolean         _gimp_canvas_item_needs_update    (GimpCanvasItem   *item);
141 void             _gimp_canvas_item_stroke          (GimpCanvasItem   *item,
142                                                     cairo_t          *cr);
143 void             _gimp_canvas_item_fill            (GimpCanvasItem   *item,
144                                                     cairo_t          *cr);
145 
146 
147 #endif /* __GIMP_CANVAS_ITEM_H__ */
148