src/event-context.cpp

   1 #define __SP_EVENT_CONTEXT_C__
   2
   3 /** \file
   4  * Main event handling, and related helper functions.
   5  *
   6  * Authors:
   7  *   Lauris Kaplinski <lauris@kaplinski.com>
   8  *   Frank Felfe <innerspace@iname.com>
   9  *   bulia byak <buliabyak@users.sf.net>
  10  *
  11  * Copyright (C) 1999-2005 authors
  12  * Copyright (C) 2001-2002 Ximian, Inc.
  13  *
  14  * Released under GNU GPL, read the file 'COPYING' for more information
  15  */
  16
  17 /** \class SPEventContext
  18  * SPEventContext is an abstract base class of all tools. As the name
  19  * indicates, event context implementations process UI events (mouse
  20  * movements and keypresses) and take actions (like creating or modifying
  21  * objects).  There is one event context implementation for each tool,
  22  * plus few abstract base classes. Writing a new tool involves
  23  * subclassing SPEventContext.
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #include <gdk/gdkkeysyms.h>
  31 #include <gtk/gtkmain.h>
  32 #include <gtk/gtkmenu.h>
  33
  34 #include "display/sp-canvas.h"
  35 #include "xml/node-event-vector.h"
  36 #include "sp-cursor.h"
  37 #include "shortcuts.h"
  38 #include "desktop.h"
  39 #include "desktop-handles.h"
  40 #include "selection.h"
  41 #include "file.h"
  42 #include "interface.h"
  43 #include "macros.h"
  44 #include "tools-switch.h"
  45 #include "prefs-utils.h"
  46 #include "message-context.h"
  47 #include "gradient-drag.h"
  48 #include "object-edit.h"
  49 #include "attributes.h"
  50 #include "rubberband.h"
  51 #include "selcue.h"
  52
  53 #include "event-context.h"
  54
  55 static void sp_event_context_class_init(SPEventContextClass *klass);
  56 static void sp_event_context_init(SPEventContext *event_context);
  57 static void sp_event_context_dispose(GObject *object);
  58
  59 static void sp_event_context_private_setup(SPEventContext *ec);
  60 static gint sp_event_context_private_root_handler(SPEventContext *event_context, GdkEvent *event);
  61 static gint sp_event_context_private_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event);
  62
  63 static void set_event_location(SPDesktop * desktop, GdkEvent * event);
  64
  65 static GObjectClass *parent_class;
  66
  67 // globals for temporary switching to selector by space
  68 static bool selector_toggled = FALSE;
  69 static int switch_selector_to = 0;
  70
  71 static gint xp = 0, yp = 0; // where drag started
  72 static gint tolerance = 0;
  73 static bool within_tolerance = false;
  74
  75 // globals for keeping track of keyboard scroll events in order to accelerate
  76 static guint32 scroll_event_time = 0;
  77 static gdouble scroll_multiply = 1;
  78 static guint scroll_keyval = 0;
  79
  80 /**
  81  * Registers the SPEventContext class with Glib and returns its type number.
  82  */
  83 GType
  84 sp_event_context_get_type(void)
  85 {
  86     static GType type = 0;
  87     if (!type) {
  88         GTypeInfo info = {
  89             sizeof(SPEventContextClass),
  90             NULL, NULL,
  91             (GClassInitFunc) sp_event_context_class_init,
  92             NULL, NULL,
  93             sizeof(SPEventContext),
  94             4,
  95             (GInstanceInitFunc) sp_event_context_init,
  96             NULL,    /* value_table */
  97         };
  98         type = g_type_register_static(G_TYPE_OBJECT, "SPEventContext", &info, (GTypeFlags)0);
  99     }
 100     return type;
 101 }
 102
 103 /**
 104  * Callback to set up the SPEventContext vtable.
 105  */
 106 static void
 107 sp_event_context_class_init(SPEventContextClass *klass)
 108 {
 109     GObjectClass *object_class;
 110
 111     object_class = (GObjectClass *) klass;
 112
 113     parent_class = (GObjectClass*)g_type_class_peek_parent(klass);
 114
 115     object_class->dispose = sp_event_context_dispose;
 116
 117     klass->setup = sp_event_context_private_setup;
 118     klass->root_handler = sp_event_context_private_root_handler;
 119     klass->item_handler = sp_event_context_private_item_handler;
 120 }
 121
 122 /**
 123  * Clears all SPEventContext object members.
 124  */
 125 static void
 126 sp_event_context_init(SPEventContext *event_context)
 127 {
 128     event_context->desktop = NULL;
 129     event_context->cursor = NULL;
 130     event_context->_message_context = NULL;
 131     event_context->_selcue = NULL;
 132     event_context->_grdrag = NULL;
 133 }
 134
 135 /**
 136  * Callback to free and null member variables of SPEventContext object.
 137  */
 138 static void
 139 sp_event_context_dispose(GObject *object)
 140 {
 141     SPEventContext *ec;
 142
 143     ec = SP_EVENT_CONTEXT(object);
 144
 145     if (ec->_message_context) {
 146         delete ec->_message_context;
 147     }
 148
 149     if (ec->cursor != NULL) {
 150         gdk_cursor_unref(ec->cursor);
 151         ec->cursor = NULL;
 152     }
 153
 154     if (ec->desktop) {
 155         ec->desktop = NULL;
 156     }
 157
 158     if (ec->prefs_repr) {
 159         sp_repr_remove_listener_by_data(ec->prefs_repr, ec);
 160         Inkscape::GC::release(ec->prefs_repr);
 161         ec->prefs_repr = NULL;
 162     }
 163
 164     G_OBJECT_CLASS(parent_class)->dispose(object);
 165 }
 166
 167 /**
 168  * Recreates and draws cursor on desktop related to SPEventContext.
 169  */
 170 void
 171 sp_event_context_update_cursor(SPEventContext *ec)
 172 {
 173     GtkWidget *w = GTK_WIDGET(sp_desktop_canvas(ec->desktop));
 174     if (w->window) {
 175         /* fixme: */
 176         if (ec->cursor_shape) {
 177             GdkBitmap *bitmap = NULL;
 178             GdkBitmap *mask = NULL;
 179             sp_cursor_bitmap_and_mask_from_xpm(&bitmap, &mask, ec->cursor_shape);
 180             if ((bitmap != NULL) && (mask != NULL)) {
 181                 if (ec->cursor)
 182                     gdk_cursor_unref (ec->cursor);
 183                 ec->cursor = gdk_cursor_new_from_pixmap(bitmap, mask,
 184                                                         &w->style->black,
 185                                                         &w->style->white,
 186                                                         ec->hot_x, ec->hot_y);
 187                 g_object_unref (bitmap);
 188                 g_object_unref (mask);
 189             }
 190         }
 191         gdk_window_set_cursor(w->window, ec->cursor);
 192     }
 193 }
 194
 195 /**
 196  * Callback that gets called on initialization of SPEventContext object.
 197  * Redraws mouse cursor, at the moment.
 198  */
 199 static void
 200 sp_event_context_private_setup(SPEventContext *ec)
 201 {
 202     sp_event_context_update_cursor(ec);
 203 }
 204
 205 /**
 206  * \brief   Gobbles next key events on the queue with the same keyval and mask. Returns the number of events consumed.
 207  */
 208 gint gobble_key_events(guint keyval, gint mask)
 209 {
 210     GdkEvent *event_next;
 211     gint i = 0;
 212
 213     event_next = gdk_event_get();
 214     // while the next event is also a key notify with the same keyval and mask,
 215     while (event_next && event_next->type == GDK_KEY_PRESS
 216            && event_next->key.keyval == keyval
 217            && (event_next->key.state & mask)) {
 218         // kill it
 219         gdk_event_free(event_next);
 220         // get next
 221         event_next = gdk_event_get();
 222         i ++;
 223     }
 224     // otherwise, put it back onto the queue
 225     if (event_next) gdk_event_put(event_next);
 226
 227     return i;
 228 }
 229
 230 /**
 231  * \brief   Gobbles next motion notify events on the queue with the same mask. Returns the number of events consumed.
 232 */
 233 gint gobble_motion_events(gint mask)
 234 {
 235     GdkEvent *event_next;
 236     gint i = 0;
 237
 238     event_next = gdk_event_get();
 239     // while the next event is also a key notify with the same keyval and mask,
 240     while (event_next && event_next->type == GDK_MOTION_NOTIFY
 241            && (event_next->motion.state & mask)) {
 242         // kill it
 243         gdk_event_free(event_next);
 244         // get next
 245         event_next = gdk_event_get();
 246         i ++;
 247     }
 248     // otherwise, put it back onto the queue
 249     if (event_next) gdk_event_put(event_next);
 250
 251     return i;
 252 }
 253
 254 /**
 255  * Toggles current tool between active tool and selector tool.
 256  * Subroutine of sp_event_context_private_root_handler().
 257  */
 258 static void
 259 sp_toggle_selector(SPDesktop *dt)
 260 {
 261     if (!dt->event_context) return;
 262
 263     if (tools_isactive(dt, TOOLS_SELECT)) {
 264         if (selector_toggled) {
 265             if (switch_selector_to) tools_switch (dt, switch_selector_to);
 266             selector_toggled = FALSE;
 267         } else return;
 268     } else {
 269         selector_toggled = TRUE;
 270         switch_selector_to = tools_active(dt);
 271         tools_switch (dt, TOOLS_SELECT);
 272     }
 273 }
 274
 275 /**
 276  * Calculates and keeps track of scroll acceleration.
 277  * Subroutine of sp_event_context_private_root_handler().
 278  */
 279 static gdouble accelerate_scroll(GdkEvent *event, gdouble acceleration)
 280 {
 281     guint32 time_diff = ((GdkEventKey *) event)->time - scroll_event_time;
 282
 283     /* key pressed within 500ms ? (1/2 second) */
 284     if (time_diff > 500 || event->key.keyval != scroll_keyval) {
 285         scroll_multiply = 1;
 286     } else {
 287         scroll_multiply += acceleration;
 288     }
 289
 290     scroll_event_time = ((GdkEventKey *) event)->time;
 291     scroll_keyval = event->key.keyval;
 292
 293     return scroll_multiply;
 294 }
 295
 296 /**
 297  * Main event dispatch, gets called from Gdk.
 298  */
 299 static gint sp_event_context_private_root_handler(SPEventContext *event_context, GdkEvent *event)
 300 {
 301     static NR::Point button_w;
 302     static unsigned int panning = 0;
 303     static unsigned int zoom_rb = 0;
 304
 305     SPDesktop *desktop = event_context->desktop;
 306
 307     tolerance = prefs_get_int_attribute_limited(
 308             "options.dragtolerance","value", 0, 0, 100);
 309     double const zoom_inc = prefs_get_double_attribute_limited(
 310             "options.zoomincrement", "value", M_SQRT2, 1.01, 10);
 311     double const acceleration = prefs_get_double_attribute_limited(
 312             "options.scrollingacceleration", "value", 0, 0, 6);
 313     int const key_scroll = prefs_get_int_attribute_limited(
 314             "options.keyscroll", "value", 10, 0, 1000);
 315     int const wheel_scroll = prefs_get_int_attribute_limited(
 316             "options.wheelscroll", "value", 40, 0, 1000);
 317
 318     gint ret = FALSE;
 319
 320     switch (event->type) {
 321         case GDK_2BUTTON_PRESS:
 322             if (panning) {
 323                 panning = 0;
 324                 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 325                         event->button.time);
 326                 ret = TRUE;
 327             } else {
 328                 /* sp_desktop_dialog(); */
 329             }
 330             break;
 331         case GDK_BUTTON_PRESS:
 332
 333             // save drag origin
 334             xp = (gint) event->button.x;
 335             yp = (gint) event->button.y;
 336             within_tolerance = true;
 337
 338             switch (event->button.button) {
 339                 case 2:
 340                     button_w = NR::Point(event->button.x,
 341                                          event->button.y);
 342                     if (event->button.state == GDK_SHIFT_MASK) {
 343                         zoom_rb = 2;
 344                     } else {
 345                         panning = 2;
 346                         sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
 347                             GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK,
 348                             NULL, event->button.time-1);
 349                     }
 350                     ret = TRUE;
 351                     break;
 352                 case 3:
 353                     if (event->button.state & GDK_SHIFT_MASK
 354                             || event->button.state & GDK_CONTROL_MASK) {
 355                         button_w = NR::Point(event->button.x,
 356                                              event->button.y);
 357                         panning = 3;
 358                         sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
 359                                 GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK,
 360                                 NULL, event->button.time);
 361                         ret = TRUE;
 362                     } else {
 363                         sp_event_root_menu_popup(desktop, NULL, event);
 364                     }
 365                     break;
 366                 default:
 367                     break;
 368             }
 369             break;
 370         case GDK_MOTION_NOTIFY:
 371             if (panning) {
 372                 if ((panning == 2 && !(event->motion.state & GDK_BUTTON2_MASK))
 373                         || (panning == 3 && !(event->motion.state & GDK_BUTTON3_MASK))) {
 374                     /* Gdk seems to lose button release for us sometimes :-( */
 375                     panning = 0;
 376                     sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 377                             event->button.time);
 378                     ret = TRUE;
 379                 } else {
 380                     if ( within_tolerance
 381                          && ( abs( (gint) event->motion.x - xp ) < tolerance )
 382                          && ( abs( (gint) event->motion.y - yp ) < tolerance ))
 383                     {
 384                         // do not drag if we're within tolerance from origin
 385                         break;
 386                     }
 387                     // Once the user has moved farther than tolerance from
 388                     // the original location (indicating they intend to move
 389                     // the object, not click), then always process the motion
 390                     // notify coordinates as given (no snapping back to origin)
 391                     within_tolerance = false;
 392
 393                     // gobble subsequent motion events to prevent "sticking"
 394                     // when scrolling is slow
 395                     gobble_motion_events(panning == 2 ?
 396                             GDK_BUTTON2_MASK : GDK_BUTTON3_MASK);
 397
 398                     NR::Point const motion_w(event->motion.x,
 399                                              event->motion.y);
 400                     NR::Point const moved_w( motion_w - button_w );
 401                     event_context->desktop->scroll_world(moved_w);
 402                     ret = TRUE;
 403                 }
 404             } else if (zoom_rb) {
 405                 NR::Point const motion_w(event->motion.x, event->motion.y);
 406                 NR::Point const motion_dt(desktop->w2d(motion_w));
 407
 408                 if ( within_tolerance
 409                      && ( abs( (gint) event->motion.x - xp ) < tolerance )
 410                      && ( abs( (gint) event->motion.y - yp ) < tolerance ) ) {
 411                     break; // do not drag if we're within tolerance from origin
 412                 }
 413
 414                 if (within_tolerance) {
 415                     Inkscape::Rubberband::get()->start(desktop, motion_dt);
 416                 } else {
 417                     Inkscape::Rubberband::get()->move(motion_dt);
 418                 }
 419
 420                 // Once the user has moved farther than tolerance from the original location
 421                 // (indicating they intend to move the object, not click), then always process the
 422                 // motion notify coordinates as given (no snapping back to origin)
 423                 within_tolerance = false;
 424             }
 425             break;
 426         case GDK_BUTTON_RELEASE:
 427             xp = yp = 0;
 428             if (within_tolerance && (panning || zoom_rb)) {
 429                 zoom_rb = 0;
 430                 NR::Point const event_w(event->button.x, event->button.y);
 431                 NR::Point const event_dt(desktop->w2d(event_w));
 432                 desktop->zoom_relative_keep_point(event_dt,
 433                           (event->button.state & GDK_SHIFT_MASK) ? 1/zoom_inc : zoom_inc);
 434                 desktop->updateNow();
 435             }
 436             if (panning == event->button.button) {
 437                 panning = 0;
 438                 ret = TRUE;
 439                 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 440                                       event->button.time);
 441                 desktop->updateNow();
 442             } else if (zoom_rb == event->button.button) {
 443                 zoom_rb = 0;
 444                 NR::Maybe<NR::Rect> const b = Inkscape::Rubberband::get()->getRectangle();
 445                 Inkscape::Rubberband::get()->stop();
 446                 if (b != NR::Nothing() && !within_tolerance) {
 447                     desktop->set_display_area(b.assume(), 10);
 448                 }
 449             }
 450             break;
 451         case GDK_KEY_PRESS:
 452             switch (get_group0_keyval(&event->key)) {
 453                 // GDK insists on stealing these keys (F1 for no idea what, tab for cycling widgets
 454                 // in the editing window). So we resteal them back and run our regular shortcut
 455                 // invoker on them.
 456                 unsigned int shortcut;
 457                 case GDK_Tab:
 458                 case GDK_ISO_Left_Tab:
 459                 case GDK_F1:
 460                     shortcut = get_group0_keyval(&event->key);
 461                     if (event->key.state & GDK_SHIFT_MASK)
 462                         shortcut |= SP_SHORTCUT_SHIFT_MASK;
 463                     if (event->key.state & GDK_CONTROL_MASK)
 464                         shortcut |= SP_SHORTCUT_CONTROL_MASK;
 465                     if (event->key.state & GDK_MOD1_MASK)
 466                         shortcut |= SP_SHORTCUT_ALT_MASK;
 467                     ret = sp_shortcut_invoke(shortcut, desktop);
 468                     break;
 469
 470                 case GDK_W:
 471                 case GDK_w:
 472                 case GDK_F4:
 473                     /* Close view */
 474                     if (MOD__CTRL_ONLY) {
 475                         sp_ui_close_view(NULL);
 476                         ret = TRUE;
 477                     }
 478                     break;
 479                 case GDK_Left: // Ctrl Left
 480                 case GDK_KP_Left:
 481                 case GDK_KP_4:
 482                     if (MOD__CTRL_ONLY) {
 483                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 484                         gobble_key_events(get_group0_keyval(&event->key),
 485                                 GDK_CONTROL_MASK);
 486                         event_context->desktop->scroll_world(i, 0);
 487                         ret = TRUE;
 488                     }
 489                     break;
 490                 case GDK_Up: // Ctrl Up
 491                 case GDK_KP_Up:
 492                 case GDK_KP_8:
 493                     if (MOD__CTRL_ONLY) {
 494                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 495                         gobble_key_events(get_group0_keyval(&event->key),
 496                                 GDK_CONTROL_MASK);
 497                         event_context->desktop->scroll_world(0, i);
 498                         ret = TRUE;
 499                     }
 500                     break;
 501                 case GDK_Right: // Ctrl Right
 502                 case GDK_KP_Right:
 503                 case GDK_KP_6:
 504                     if (MOD__CTRL_ONLY) {
 505                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 506                         gobble_key_events(get_group0_keyval(&event->key),
 507                                 GDK_CONTROL_MASK);
 508                         event_context->desktop->scroll_world(-i, 0);
 509                         ret = TRUE;
 510                     }
 511                     break;
 512                 case GDK_Down: // Ctrl Down
 513                 case GDK_KP_Down:
 514                 case GDK_KP_2:
 515                     if (MOD__CTRL_ONLY) {
 516                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 517                         gobble_key_events(get_group0_keyval(&event->key),
 518                                 GDK_CONTROL_MASK);
 519                         event_context->desktop->scroll_world(0, -i);
 520                         ret = TRUE;
 521                     }
 522                     break;
 523                 case GDK_F10:
 524                     if (MOD__SHIFT_ONLY) {
 525                         sp_event_root_menu_popup(desktop, NULL, event);
 526                         ret= TRUE;
 527                     }
 528                     break;
 529                 case GDK_space:
 530                     sp_toggle_selector(desktop);
 531                     ret= TRUE;
 532                     break;
 533                 case GDK_z:
 534                 case GDK_Z:
 535                     if (MOD__ALT_ONLY) {
 536                         desktop->zoom_grab_focus();
 537                         ret = TRUE;
 538                     }
 539                     break;
 540                 default:
 541                     break;
 542             }
 543             break;
 544         case GDK_SCROLL:
 545             /* shift + wheel, pan left--right */
 546             if (event->scroll.state & GDK_SHIFT_MASK) {
 547                 switch (event->scroll.direction) {
 548                     case GDK_SCROLL_UP:
 549                         desktop->scroll_world(wheel_scroll, 0);
 550                         break;
 551                     case GDK_SCROLL_DOWN:
 552                         desktop->scroll_world(-wheel_scroll, 0);
 553                         break;
 554                     default:
 555                         break;
 556                 }
 557
 558                 /* ctrl + wheel, zoom in--out */
 559             } else if (event->scroll.state & GDK_CONTROL_MASK) {
 560                 double rel_zoom;
 561                 switch (event->scroll.direction) {
 562                     case GDK_SCROLL_UP:
 563                         rel_zoom = zoom_inc;
 564                         break;
 565                     case GDK_SCROLL_DOWN:
 566                         rel_zoom = 1 / zoom_inc;
 567                         break;
 568                     default:
 569                         rel_zoom = 0.0;
 570                         break;
 571                 }
 572                 if (rel_zoom != 0.0) {
 573                     NR::Point const scroll_dt = desktop->point();
 574                     desktop->zoom_relative_keep_point(scroll_dt, rel_zoom);
 575                 }
 576
 577                 /* no modifier, pan up--down (left--right on multiwheel mice?) */
 578             } else {
 579                 switch (event->scroll.direction) {
 580                     case GDK_SCROLL_UP:
 581                         desktop->scroll_world(0, wheel_scroll);
 582                         break;
 583                     case GDK_SCROLL_DOWN:
 584                         desktop->scroll_world(0, -wheel_scroll);
 585                         break;
 586                     case GDK_SCROLL_LEFT:
 587                         desktop->scroll_world(wheel_scroll, 0);
 588                         break;
 589                     case GDK_SCROLL_RIGHT:
 590                         desktop->scroll_world(-wheel_scroll, 0);
 591                         break;
 592                 }
 593             }
 594             break;
 595         default:
 596             break;
 597     }
 598
 599     return ret;
 600 }
 601
 602 /**
 603  * Handles item specific events. Gets called from Gdk.
 604  *
 605  * Only reacts to right mouse button at the moment.
 606  * \todo Fixme: do context sensitive popup menu on items.
 607  */
 608 gint
 609 sp_event_context_private_item_handler(SPEventContext *ec, SPItem *item, GdkEvent *event)
 610 {
 611     int ret = FALSE;
 612
 613     switch (event->type) {
 614         case GDK_BUTTON_PRESS:
 615             if ((event->button.button == 3)
 616                     && !(event->button.state & GDK_SHIFT_MASK || event->button.state & GDK_CONTROL_MASK)) {
 617                 sp_event_root_menu_popup(ec->desktop, item, event);
 618                 ret = TRUE;
 619             }
 620             break;
 621         default:
 622             break;
 623     }
 624
 625     return ret;
 626 }
 627
 628 /**
 629  * Gets called when attribute changes value.
 630  */
 631 static void
 632 sp_ec_repr_attr_changed(Inkscape::XML::Node *prefs_repr, gchar const *key, gchar const *oldval, gchar const *newval,
 633                         bool is_interactive, gpointer data)
 634 {
 635     SPEventContext *ec;
 636
 637     ec = SP_EVENT_CONTEXT(data);
 638
 639     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set) {
 640         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set(ec, key, newval);
 641     }
 642 }
 643
 644 Inkscape::XML::NodeEventVector sp_ec_event_vector = {
 645     NULL, /* Child added */
 646     NULL, /* Child removed */
 647     sp_ec_repr_attr_changed,
 648     NULL, /* Content changed */
 649     NULL /* Order changed */
 650 };
 651
 652 /**
 653  * Creates new SPEventContext object and calls its virtual setup() function.
 654  */
 655 SPEventContext *
 656 sp_event_context_new(GType type, SPDesktop *desktop, Inkscape::XML::Node *prefs_repr, unsigned int key)
 657 {
 658     g_return_val_if_fail(g_type_is_a(type, SP_TYPE_EVENT_CONTEXT), NULL);
 659     g_return_val_if_fail(desktop != NULL, NULL);
 660
 661     SPEventContext *const ec = (SPEventContext*)g_object_new(type, NULL);
 662
 663     ec->desktop = desktop;
 664     ec->_message_context = new Inkscape::MessageContext(desktop->messageStack());
 665     ec->key = key;
 666     ec->prefs_repr = prefs_repr;
 667     if (ec->prefs_repr) {
 668         Inkscape::GC::anchor(ec->prefs_repr);
 669         sp_repr_add_listener(ec->prefs_repr, &sp_ec_event_vector, ec);
 670     }
 671
 672     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->setup)
 673         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->setup(ec);
 674
 675     return ec;
 676 }
 677
 678 /**
 679  * Finishes SPEventContext.
 680  */
 681 void
 682 sp_event_context_finish(SPEventContext *ec)
 683 {
 684     g_return_if_fail(ec != NULL);
 685     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 686
 687     ec->enableSelectionCue(false);
 688
 689     if (ec->next) {
 690         g_warning("Finishing event context with active link\n");
 691     }
 692
 693     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->finish)
 694         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->finish(ec);
 695 }
 696
 697 //-------------------------------member functions
 698
 699 /**
 700  * Enables/disables the SPEventContext's SelCue.
 701  */
 702 void SPEventContext::enableSelectionCue(bool enable) {
 703     if (enable) {
 704         if (!_selcue) {
 705             _selcue = new Inkscape::SelCue(desktop);
 706         }
 707     } else {
 708         delete _selcue;
 709         _selcue = NULL;
 710     }
 711 }
 712
 713 /**
 714  * Enables/disables the SPEventContext's GrDrag.
 715  */
 716 void SPEventContext::enableGrDrag(bool enable) {
 717     if (enable) {
 718         if (!_grdrag) {
 719             _grdrag = new GrDrag(desktop);
 720         }
 721     } else {
 722         if (_grdrag) {
 723             delete _grdrag;
 724             _grdrag = NULL;
 725         }
 726     }
 727 }
 728
 729 /**
 730  * Calls virtual set() function of SPEventContext.
 731  */
 732 void
 733 sp_event_context_read(SPEventContext *ec, gchar const *key)
 734 {
 735     g_return_if_fail(ec != NULL);
 736     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 737     g_return_if_fail(key != NULL);
 738
 739     if (ec->prefs_repr) {
 740         gchar const *val = ec->prefs_repr->attribute(key);
 741         if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set)
 742             ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set(ec, key, val);
 743     }
 744 }
 745
 746 /**
 747  * Calls virtual activate() function of SPEventContext.
 748  */
 749 void
 750 sp_event_context_activate(SPEventContext *ec)
 751 {
 752     g_return_if_fail(ec != NULL);
 753     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 754
 755     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->activate)
 756         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->activate(ec);
 757 }
 758
 759 /**
 760  * Calls virtual deactivate() function of SPEventContext.
 761  */
 762 void
 763 sp_event_context_deactivate(SPEventContext *ec)
 764 {
 765     g_return_if_fail(ec != NULL);
 766     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 767
 768     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->deactivate)
 769         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->deactivate(ec);
 770 }
 771
 772 /**
 773  * Calls virtual root_handler(), the main event handling function.
 774  */
 775 gint
 776 sp_event_context_root_handler(SPEventContext * event_context, GdkEvent * event)
 777 {
 778     gint ret;
 779
 780     ret = ((SPEventContextClass *) G_OBJECT_GET_CLASS(event_context))->root_handler(event_context, event);
 781
 782     set_event_location(event_context->desktop, event);
 783
 784     return ret;
 785 }
 786
 787 /**
 788  * Calls virtual item_handler(), the item event handling function.
 789  */
 790 gint
 791 sp_event_context_item_handler(SPEventContext * event_context, SPItem * item, GdkEvent * event)
 792 {
 793     gint ret;
 794
 795     ret = ((SPEventContextClass *) G_OBJECT_GET_CLASS(event_context))->item_handler(event_context, item, event);
 796
 797     if (! ret) {
 798         ret = sp_event_context_root_handler(event_context, event);
 799     } else {
 800         set_event_location(event_context->desktop, event);
 801     }
 802
 803     return ret;
 804 }
 805
 806 /**
 807  * Emits 'position_set' signal on desktop and shows coordinates on status bar.
 808  */
 809 static void set_event_location(SPDesktop *desktop, GdkEvent *event)
 810 {
 811     if (event->type != GDK_MOTION_NOTIFY) {
 812         return;
 813     }
 814
 815     NR::Point const button_w(event->button.x, event->button.y);
 816     NR::Point const button_dt(desktop->w2d(button_w));
 817     desktop-> setPosition (button_dt);
 818     desktop->set_coordinate_status(button_dt);
 819 }
 820
 821 //-------------------------------------------------------------------
 822 /**
 823  * Create popup menu and tell Gtk to show it.
 824  */
 825 void
 826 sp_event_root_menu_popup(SPDesktop *desktop, SPItem *item, GdkEvent *event)
 827 {
 828     GtkWidget *menu;
 829
 830     /* fixme: This is not what I want but works for now (Lauris) */
 831     if (event->type == GDK_KEY_PRESS) {
 832         item = sp_desktop_selection(desktop)->singleItem();
 833     }
 834     menu = sp_ui_context_menu(desktop, item);
 835     gtk_widget_show(menu);
 836
 837     switch (event->type) {
 838         case GDK_BUTTON_PRESS:
 839             gtk_menu_popup(GTK_MENU(menu), NULL, NULL, 0, NULL, event->button.button, event->button.time);
 840             break;
 841         case GDK_KEY_PRESS:
 842             gtk_menu_popup(GTK_MENU(menu), NULL, NULL, 0, NULL, 0, event->key.time);
 843             break;
 844         default:
 845             break;
 846     }
 847 }
 848
 849 /**
 850  * Show tool context specific modifier tip.
 851  */
 852 void
 853 sp_event_show_modifier_tip(Inkscape::MessageContext *message_context,
 854         GdkEvent *event, gchar const *ctrl_tip, gchar const *shift_tip,
 855         gchar const *alt_tip)
 856 {
 857     guint keyval = get_group0_keyval(&event->key);
 858
 859     bool ctrl = ctrl_tip && (MOD__CTRL
 860             || (keyval == GDK_Control_L)
 861             || (keyval == GDK_Control_R));
 862     bool shift = shift_tip
 863         && (MOD__SHIFT || (keyval == GDK_Shift_L) || (keyval == GDK_Shift_R));
 864     bool alt = alt_tip
 865         && (MOD__ALT
 866                 || (keyval == GDK_Alt_L)
 867                 || (keyval == GDK_Alt_R)
 868                 || (keyval == GDK_Meta_L)
 869                 || (keyval == GDK_Meta_R));
 870
 871     gchar *tip = g_strdup_printf("%s%s%s%s%s",
 872                                  ( ctrl ? ctrl_tip : "" ),
 873                                  ( ctrl && (shift || alt) ? "; " : "" ),
 874                                  ( shift ? shift_tip : "" ),
 875                                  ( (ctrl || shift) && alt ? "; " : "" ),
 876                                  ( alt ? alt_tip : "" ));
 877
 878     if (strlen(tip) > 0) {
 879         message_context->flash(Inkscape::INFORMATION_MESSAGE, tip);
 880     }
 881
 882     g_free(tip);
 883 }
 884
 885 /**
 886  * Return the keyval corresponding to the key event in group 0, i.e.,
 887  * in the main (English) layout.
 888  *
 889  * Use this instead of simply event->keyval, so that your keyboard shortcuts
 890  * work regardless of layouts (e.g., in Cyrillic).
 891  */
 892 guint
 893 get_group0_keyval(GdkEventKey *event)
 894 {
 895     guint keyval = 0;
 896     gdk_keymap_translate_keyboard_state(
 897             gdk_keymap_get_for_display(gdk_display_get_default()),
 898             event->hardware_keycode,
 899             (GdkModifierType) event->state,
 900             0   /*event->key.group*/,
 901             &keyval, NULL, NULL, NULL);
 902     return keyval;
 903 }
 904
 905 /**
 906  * Returns item at point p in desktop.
 907  *
 908  * If state includes alt key mask, cyclically selects under; honors
 909  * into_groups.
 910  */
 911 SPItem *
 912 sp_event_context_find_item (SPDesktop *desktop, NR::Point const p,
 913         bool select_under, bool into_groups)
 914 {
 915     SPItem *item;
 916
 917     if (select_under) {
 918         SPItem *selected_at_point =
 919             desktop->item_from_list_at_point_bottom (desktop->selection->itemList(), p);
 920         item = desktop->item_at_point(p, into_groups, selected_at_point);
 921         if (item == NULL) { // we may have reached bottom, flip over to the top
 922             item = desktop->item_at_point(p, into_groups, NULL);
 923         }
 924     } else
 925         item = desktop->item_at_point(p, into_groups, NULL);
 926
 927     return item;
 928 }
 929
 930 /**
 931  * Returns item if it is under point p in desktop, at any depth; otherwise returns NULL.
 932  *
 933  * Honors into_groups.
 934  */
 935 SPItem *
 936 sp_event_context_over_item (SPDesktop *desktop, SPItem *item, NR::Point const p)
 937 {
 938     GSList *temp = NULL;
 939     temp = g_slist_prepend (temp, item);
 940     SPItem *item_at_point = desktop->item_from_list_at_point_bottom (temp, p);
 941     g_slist_free (temp);
 942
 943     return item_at_point;
 944 }
 945
 946 /**
 947  * Called when SPEventContext subclass node attribute changed.
 948  */
 949 void
 950 ec_shape_event_attr_changed(Inkscape::XML::Node *shape_repr, gchar const *name,
 951         gchar const *old_value, gchar const *new_value,
 952         bool const is_interactive, gpointer const data)
 953 {
 954     if (!name
 955             || !strcmp(name, "style")
 956             || SP_ATTRIBUTE_IS_CSS(sp_attribute_lookup(name))) {
 957         // no need to regenrate knotholder if only style changed
 958         return;
 959     }
 960
 961     SPEventContext *ec = SP_EVENT_CONTEXT(data);
 962
 963     if (ec->shape_knot_holder) {
 964         sp_knot_holder_destroy(ec->shape_knot_holder);
 965     }
 966     ec->shape_knot_holder = NULL;
 967
 968     SPDesktop *desktop = ec->desktop;
 969
 970     SPItem *item = sp_desktop_selection(desktop)->singleItem();
 971
 972     if (item) {
 973         ec->shape_knot_holder = sp_item_knot_holder(item, desktop);
 974     }
 975 }
 976
 977
 978 /*
 979   Local Variables:
 980   mode:c++
 981   c-file-style:"stroustrup"
 982   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 983   indent-tabs-mode:nil
 984   fill-column:99
 985   End:
 986 */
 987 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :