src/event-context.h

   1 #ifndef __SP_EVENT_CONTEXT_H__
   2 #define __SP_EVENT_CONTEXT_H__
   3
   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  */
  19
  20 #include <glib-object.h>
  21 #include <gdk/gdktypes.h>
  22 #include <gdk/gdkevents.h>
  23
  24 #include "2geom/forward.h"
  25 #include "preferences.h"
  26
  27 struct GrDrag;
  28 struct SPDesktop;
  29 struct SPItem;
  30 class KnotHolder;
  31 class ShapeEditor;
  32
  33 namespace Inkscape {
  34     class MessageContext;
  35     class SelCue;
  36     namespace XML {
  37         class Node;
  38     }
  39 }
  40
  41 /**
  42  * Base class for Event processors.
  43  */
  44 struct SPEventContext : public GObject {
  45     void enableSelectionCue (bool enable=true);
  46     void enableGrDrag (bool enable=true);
  47
  48     /// Desktop eventcontext stack
  49     SPEventContext *next;
  50     unsigned key;
  51     SPDesktop *desktop;
  52     Inkscape::Preferences::Observer *pref_observer;
  53     gchar const *const *cursor_shape;
  54     gint hot_x, hot_y; ///< indicates the cursor's hot spot
  55     GdkCursor *cursor;
  56
  57     gint xp, yp;           ///< where drag started
  58     gint tolerance;
  59     bool within_tolerance;  ///< are we still within tolerance of origin
  60
  61     SPItem *item_to_select; ///< the item where mouse_press occurred, to
  62                             ///< be selected if this is a click not drag
  63
  64     Inkscape::MessageContext *defaultMessageContext() {
  65         return _message_context;
  66     }
  67
  68     Inkscape::MessageContext *_message_context;
  69
  70     Inkscape::SelCue *_selcue;
  71
  72     GrDrag *_grdrag;
  73     GrDrag *get_drag () {return _grdrag;}
  74
  75     KnotHolder *shape_knot_holder;
  76     Inkscape::XML::Node *shape_repr;
  77
  78     bool space_panning;
  79 };
  80
  81 /**
  82  * The SPEvent vtable.
  83  */
  84 struct SPEventContextClass : public GObjectClass {
  85     void (* setup)(SPEventContext *ec);
  86     void (* finish)(SPEventContext *ec);
  87     void (* set)(SPEventContext *ec, Inkscape::Preferences::Entry *val);
  88     void (* activate)(SPEventContext *ec);
  89     void (* deactivate)(SPEventContext *ec);
  90     gint (* root_handler)(SPEventContext *ec, GdkEvent *event);
  91     gint (* item_handler)(SPEventContext *ec, SPItem *item, GdkEvent *event);
  92 };
  93
  94 #define SP_EVENT_CONTEXT_DESKTOP(e) (SP_EVENT_CONTEXT(e)->desktop)
  95 #define SP_EVENT_CONTEXT_DOCUMENT(e) ((SP_EVENT_CONTEXT_DESKTOP(e))->doc())
  96
  97 #define SP_EVENT_CONTEXT_STATIC 0
  98
  99 SPEventContext *sp_event_context_new(GType type, SPDesktop *desktop, gchar const *pref_path, unsigned key);
 100 void sp_event_context_finish(SPEventContext *ec);
 101 void sp_event_context_read(SPEventContext *ec, gchar const *key);
 102 void sp_event_context_activate(SPEventContext *ec);
 103 void sp_event_context_deactivate(SPEventContext *ec);
 104
 105 gint sp_event_context_root_handler(SPEventContext *ec, GdkEvent *event);
 106 gint sp_event_context_item_handler(SPEventContext *ec, SPItem *item, GdkEvent *event);
 107
 108 void sp_event_root_menu_popup(SPDesktop *desktop, SPItem *item, GdkEvent *event);
 109
 110 gint gobble_key_events(guint keyval, gint mask);
 111 gint gobble_motion_events(gint mask);
 112
 113 void sp_event_context_update_cursor(SPEventContext *ec);
 114
 115 void sp_event_show_modifier_tip(Inkscape::MessageContext *message_context, GdkEvent *event,
 116                                 gchar const *ctrl_tip, gchar const *shift_tip, gchar const *alt_tip);
 117
 118 guint get_group0_keyval(GdkEventKey *event);
 119
 120 SPItem *sp_event_context_find_item (SPDesktop *desktop, Geom::Point const &p, bool select_under, bool into_groups);
 121 SPItem *sp_event_context_over_item (SPDesktop *desktop, SPItem *item, Geom::Point const &p);
 122
 123 ShapeEditor *sp_event_context_get_shape_editor (SPEventContext *ec);
 124
 125 void ec_shape_event_attr_changed(Inkscape::XML::Node *shape_repr,
 126                                      gchar const *name, gchar const *old_value, gchar const *new_value,
 127                                  bool const is_interactive, gpointer const data);
 128
 129 void event_context_print_event_info(GdkEvent *event, bool print_return = true);
 130
 131 #endif
 132
 133
 134 /*
 135   Local Variables:
 136   mode:c++
 137   c-file-style:"stroustrup"
 138   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 139   indent-tabs-mode:nil
 140   fill-column:99
 141   End:
 142 */
 143 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :