1 #ifndef SEEN_SP_CANVAS_H
2 #define SEEN_SP_CANVAS_H
4 /** \file
5 * SPCanvas, SPCanvasBuf, and SPCanvasItem.
6 *
7 * Authors:
8 * Federico Mena <federico@nuclecu.unam.mx>
9 * Raph Levien <raph@gimp.org>
10 * Lauris Kaplinski <lauris@kaplinski.com>
11 *
12 * Copyright (C) 1998 The Free Software Foundation
13 * Copyright (C) 2002 Lauris Kaplinski
14 *
15 * Released under GNU GPL, read the file 'COPYING' for more information
16 */
18 #ifdef HAVE_CONFIG_H
19 # include "config.h"
20 #endif
22 #ifdef HAVE_INTTYPES_H
23 # include <inttypes.h>
24 #else
25 # ifdef HAVE_STDINT_H
26 # include <stdint.h>
27 # endif
28 #endif
30 #include <glib/gtypes.h>
31 #include <gdk/gdkevents.h>
32 #include <gdk/gdkgc.h>
33 #include <gtk/gtkobject.h>
34 #include <gtk/gtkwidget.h>
36 #include <glibmm/ustring.h>
38 #include <libnr/nr-matrix.h>
39 #include <libnr/nr-rect.h>
40 #include <libnr/nr-rect-l.h>
42 G_BEGIN_DECLS
44 struct SPCanvas;
45 struct SPCanvasGroup;
46 typedef struct _SPCanvasItemClass SPCanvasItemClass;
48 enum {
49 SP_CANVAS_UPDATE_REQUESTED = 1 << 0,
50 SP_CANVAS_UPDATE_AFFINE = 1 << 1
51 };
53 /**
54 * The canvas buf contains the actual pixels.
55 */
56 struct SPCanvasBuf{
57 guchar *buf;
58 int buf_rowstride;
59 NRRectL rect;
60 NRRectL visible_rect;
61 /// Background color, given as 0xrrggbb
62 guint32 bg_color;
63 // If empty, ignore contents of buffer and use a solid area of bg_color
64 bool is_empty;
65 };
67 /**
68 * An SPCanvasItem refers to a SPCanvas and to its parent item; it has
69 * four coordinates, a bounding rectangle, and a transformation matrix.
70 */
71 struct SPCanvasItem : public GtkObject {
72 SPCanvas *canvas;
73 SPCanvasItem *parent;
75 double x1, y1, x2, y2;
76 NR::Rect bounds;
77 NR::Matrix xform;
78 };
80 /**
81 * The vtable of an SPCanvasItem.
82 */
83 struct _SPCanvasItemClass : public GtkObjectClass {
84 void (* update) (SPCanvasItem *item, NR::Matrix const &affine, unsigned int flags);
86 void (* render) (SPCanvasItem *item, SPCanvasBuf *buf);
87 double (* point) (SPCanvasItem *item, NR::Point p, SPCanvasItem **actual_item);
89 int (* event) (SPCanvasItem *item, GdkEvent *event);
90 };
92 SPCanvasItem *sp_canvas_item_new(SPCanvasGroup *parent, GtkType type, const gchar *first_arg_name, ...);
94 G_END_DECLS
96 #define sp_canvas_item_set gtk_object_set
98 void sp_canvas_item_affine_absolute(SPCanvasItem *item, NR::Matrix const &aff);
100 void sp_canvas_item_raise(SPCanvasItem *item, int positions);
101 void sp_canvas_item_lower(SPCanvasItem *item, int positions);
102 void sp_canvas_item_show(SPCanvasItem *item);
103 void sp_canvas_item_hide(SPCanvasItem *item);
104 int sp_canvas_item_grab(SPCanvasItem *item, unsigned int event_mask, GdkCursor *cursor, guint32 etime);
105 void sp_canvas_item_ungrab(SPCanvasItem *item, guint32 etime);
107 NR::Matrix sp_canvas_item_i2w_affine(SPCanvasItem const *item);
109 void sp_canvas_item_grab_focus(SPCanvasItem *item);
111 void sp_canvas_item_request_update(SPCanvasItem *item);
113 /* get item z-order in parent group */
115 gint sp_canvas_item_order(SPCanvasItem * item);
118 // SPCanvas -------------------------------------------------
119 /**
120 * Port of GnomeCanvas for inkscape needs.
121 */
122 struct SPCanvas {
123 GtkWidget widget;
125 guint idle_id;
127 SPCanvasItem *root;
129 double dx0, dy0;
130 int x0, y0;
132 /* Area that needs redrawing, stored as a microtile array */
133 int tLeft,tTop,tRight,tBottom;
134 int tileH,tileV;
135 uint8_t *tiles;
137 /* Last known modifier state, for deferred repick when a button is down */
138 int state;
140 /* The item containing the mouse pointer, or NULL if none */
141 SPCanvasItem *current_item;
143 /* Item that is about to become current (used to track deletions and such) */
144 SPCanvasItem *new_current_item;
146 /* Item that holds a pointer grab, or NULL if none */
147 SPCanvasItem *grabbed_item;
149 /* Event mask specified when grabbing an item */
150 guint grabbed_event_mask;
152 /* If non-NULL, the currently focused item */
153 SPCanvasItem *focused_item;
155 /* Event on which selection of current item is based */
156 GdkEvent pick_event;
158 int close_enough;
160 /* GC for temporary draw pixmap */
161 GdkGC *pixmap_gc;
163 unsigned int need_update : 1;
164 unsigned int need_redraw : 1;
165 unsigned int need_repick : 1;
167 int forced_redraw_count;
168 int forced_redraw_limit;
170 /* For use by internal pick_current_item() function */
171 unsigned int left_grabbed_item : 1;
172 /* For use by internal pick_current_item() function */
173 unsigned int in_repick : 1;
175 // In most tools Inkscape only generates enter and leave events
176 // on the current item, but no other enter events if a mouse button
177 // is depressed -- see function pick_current_item(). Some tools
178 // may wish the canvas to generate to all enter events, (e.g., the
179 // connector tool). If so, they may temporarily set this flag to
180 // 'true'.
181 bool gen_all_enter_events;
183 int rendermode;
185 #if ENABLE_LCMS
186 bool enable_cms_display_adj;
187 Glib::ustring* cms_key;
188 #endif // ENABLE_LCMS
190 bool is_scrolling;
192 NR::Rect getViewbox() const;
193 NR::IRect getViewboxIntegers() const;
194 };
196 GtkWidget *sp_canvas_new_aa();
198 SPCanvasGroup *sp_canvas_root(SPCanvas *canvas);
200 void sp_canvas_scroll_to(SPCanvas *canvas, double cx, double cy, unsigned int clear, bool is_scrolling = false);
201 void sp_canvas_update_now(SPCanvas *canvas);
203 void sp_canvas_request_redraw(SPCanvas *canvas, int x1, int y1, int x2, int y2);
204 void sp_canvas_force_full_redraw_after_interruptions(SPCanvas *canvas, unsigned int count);
205 void sp_canvas_end_forced_full_redraws(SPCanvas *canvas);
207 bool sp_canvas_world_pt_inside_window(SPCanvas const *canvas, NR::Point const &world);
209 void sp_canvas_window_to_world(SPCanvas const *canvas, double winx, double winy, double *worldx, double *worldy);
210 void sp_canvas_world_to_window(SPCanvas const *canvas, double worldx, double worldy, double *winx, double *winy);
212 NR::Point sp_canvas_window_to_world(SPCanvas const *canvas, NR::Point const win);
213 NR::Point sp_canvas_world_to_window(SPCanvas const *canvas, NR::Point const world);
215 #endif // SEEN_SP_CANVAS_H
217 /*
218 Local Variables:
219 mode:c++
220 c-file-style:"stroustrup"
221 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
222 indent-tabs-mode:nil
223 fill-column:99
224 End:
225 */
226 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :