Code

add comment
[inkscape.git] / src / event-context.h
1 #ifndef __SP_EVENT_CONTEXT_H__
2 #define __SP_EVENT_CONTEXT_H__
4 /** \file
5  * SPEventContext: base class for event processors
6  *
7  * This is per desktop object, which (its derivatives) implements
8  * different actions bound to mouse events.
9  *
10  * Authors:
11  *   Lauris Kaplinski <lauris@kaplinski.com>
12  *   Frank Felfe <innerspace@iname.com>
13  *
14  * Copyright (C) 1999-2002 authors
15  * Copyright (C) 2001-2002 Ximian, Inc.
16  *
17  * Released under GNU GPL, read the file 'COPYING' for more information
18  */
20 #include <glib-object.h>
21 #include <gdk/gdktypes.h>
22 #include <gdk/gdkevents.h>
24 #include <libnr/nr-forward.h>
26 struct GrDrag;
27 struct SPDesktop;
28 struct SPItem;
29 class KnotHolder;
31 namespace Inkscape {
32     class MessageContext;
33     class SelCue;
34     namespace XML {
35         class Node;
36     }
37 }
39 /**
40  * Base class for Event processors.
41  */
42 struct SPEventContext : public GObject {
43     void enableSelectionCue (bool enable=true);
44     void enableGrDrag (bool enable=true);
46     /// Desktop eventcontext stack
47     SPEventContext *next;
48     unsigned key;
49     SPDesktop *desktop;
50     Inkscape::XML::Node *prefs_repr;
51     gchar const *const *cursor_shape;
52     gint hot_x, hot_y; ///< indicates the cursor's hot spot
53     GdkCursor *cursor;
55     gint xp, yp;           ///< where drag started
56     gint tolerance;
57     bool within_tolerance;  ///< are we still within tolerance of origin
59     SPItem *item_to_select; ///< the item where mouse_press occurred, to 
60                             ///< be selected if this is a click not drag
62     Inkscape::MessageContext *defaultMessageContext() {
63         return _message_context;
64     }
66     Inkscape::MessageContext *_message_context;
68     Inkscape::SelCue *_selcue;
70     GrDrag *_grdrag;
71     GrDrag *get_drag () {return _grdrag;}
73     KnotHolder *shape_knot_holder;
74     Inkscape::XML::Node *shape_repr;
76     bool space_panning;
77 };
79 /**
80  * The SPEvent vtable.
81  */
82 struct SPEventContextClass : public GObjectClass {
83     void (* setup)(SPEventContext *ec);
84     void (* finish)(SPEventContext *ec);
85     void (* set)(SPEventContext *ec, gchar const *key, gchar const *val);
86     void (* activate)(SPEventContext *ec);
87     void (* deactivate)(SPEventContext *ec);
88     gint (* root_handler)(SPEventContext *ec, GdkEvent *event);
89     gint (* item_handler)(SPEventContext *ec, SPItem *item, GdkEvent *event);
90 };
92 #define SP_EVENT_CONTEXT_DESKTOP(e) (SP_EVENT_CONTEXT(e)->desktop)
93 #define SP_EVENT_CONTEXT_DOCUMENT(e) ((SP_EVENT_CONTEXT_DESKTOP(e))->doc())
95 #define SP_EVENT_CONTEXT_STATIC 0
97 SPEventContext *sp_event_context_new(GType type, SPDesktop *desktop, Inkscape::XML::Node *prefs_repr, unsigned key);
98 void sp_event_context_finish(SPEventContext *ec);
99 void sp_event_context_read(SPEventContext *ec, gchar const *key);
100 void sp_event_context_activate(SPEventContext *ec);
101 void sp_event_context_deactivate(SPEventContext *ec);
103 gint sp_event_context_root_handler(SPEventContext *ec, GdkEvent *event);
104 gint sp_event_context_item_handler(SPEventContext *ec, SPItem *item, GdkEvent *event);
106 void sp_event_root_menu_popup(SPDesktop *desktop, SPItem *item, GdkEvent *event);
108 gint gobble_key_events(guint keyval, gint mask);
109 gint gobble_motion_events(gint mask);
111 void sp_event_context_update_cursor(SPEventContext *ec);
113 void sp_event_show_modifier_tip(Inkscape::MessageContext *message_context, GdkEvent *event,
114                                 gchar const *ctrl_tip, gchar const *shift_tip, gchar const *alt_tip);
116 guint get_group0_keyval(GdkEventKey *event);
118 SPItem *sp_event_context_find_item (SPDesktop *desktop, NR::Point const p, bool select_under, bool into_groups);
119 SPItem *sp_event_context_over_item (SPDesktop *desktop, SPItem *item, NR::Point const p);
121 void ec_shape_event_attr_changed(Inkscape::XML::Node *shape_repr,
122                                      gchar const *name, gchar const *old_value, gchar const *new_value,
123                                  bool const is_interactive, gpointer const data);
125 #endif
128 /*
129   Local Variables:
130   mode:c++
131   c-file-style:"stroustrup"
132   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
133   indent-tabs-mode:nil
134   fill-column:99
135   End:
136 */
137 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :