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          GdkDisplay *display=gdk_display_get_default();
 176
 177          if (ec->cursor)
 178              gdk_cursor_unref(ec->cursor);
 179
 180          ec->cursor=sp_cursor_new(
 181                  display,
 182                  ec->cursor_pixbuf,
 183                  ec->cursor_shape,
 184                  ec->hot_x,
 185                  ec->hot_y);
 186         gdk_window_set_cursor(w->window, ec->cursor);
 187     }
 188 }
 189
 190 /**
 191  * Callback that gets called on initialization of SPEventContext object.
 192  * Redraws mouse cursor, at the moment.
 193  */
 194 static void
 195 sp_event_context_private_setup(SPEventContext *ec)
 196 {
 197     sp_event_context_update_cursor(ec);
 198 }
 199
 200 /**
 201  * \brief   Gobbles next key events on the queue with the same keyval and mask. Returns the number of events consumed.
 202  */
 203 gint gobble_key_events(guint keyval, gint mask)
 204 {
 205     GdkEvent *event_next;
 206     gint i = 0;
 207
 208     event_next = gdk_event_get();
 209     // while the next event is also a key notify with the same keyval and mask,
 210     while (event_next && event_next->type == GDK_KEY_PRESS
 211            && event_next->key.keyval == keyval
 212            && (event_next->key.state & mask)) {
 213         // kill it
 214         gdk_event_free(event_next);
 215         // get next
 216         event_next = gdk_event_get();
 217         i ++;
 218     }
 219     // otherwise, put it back onto the queue
 220     if (event_next) gdk_event_put(event_next);
 221
 222     return i;
 223 }
 224
 225 /**
 226  * \brief   Gobbles next motion notify events on the queue with the same mask. Returns the number of events consumed.
 227 */
 228 gint gobble_motion_events(gint mask)
 229 {
 230     GdkEvent *event_next;
 231     gint i = 0;
 232
 233     event_next = gdk_event_get();
 234     // while the next event is also a key notify with the same keyval and mask,
 235     while (event_next && event_next->type == GDK_MOTION_NOTIFY
 236            && (event_next->motion.state & mask)) {
 237         // kill it
 238         gdk_event_free(event_next);
 239         // get next
 240         event_next = gdk_event_get();
 241         i ++;
 242     }
 243     // otherwise, put it back onto the queue
 244     if (event_next) gdk_event_put(event_next);
 245
 246     return i;
 247 }
 248
 249 /**
 250  * Toggles current tool between active tool and selector tool.
 251  * Subroutine of sp_event_context_private_root_handler().
 252  */
 253 static void
 254 sp_toggle_selector(SPDesktop *dt)
 255 {
 256     if (!dt->event_context) return;
 257
 258     if (tools_isactive(dt, TOOLS_SELECT)) {
 259         if (selector_toggled) {
 260             if (switch_selector_to) tools_switch (dt, switch_selector_to);
 261             selector_toggled = FALSE;
 262         } else return;
 263     } else {
 264         selector_toggled = TRUE;
 265         switch_selector_to = tools_active(dt);
 266         tools_switch (dt, TOOLS_SELECT);
 267     }
 268 }
 269
 270 /**
 271  * Calculates and keeps track of scroll acceleration.
 272  * Subroutine of sp_event_context_private_root_handler().
 273  */
 274 static gdouble accelerate_scroll(GdkEvent *event, gdouble acceleration)
 275 {
 276     guint32 time_diff = ((GdkEventKey *) event)->time - scroll_event_time;
 277
 278     /* key pressed within 500ms ? (1/2 second) */
 279     if (time_diff > 500 || event->key.keyval != scroll_keyval) {
 280         scroll_multiply = 1;
 281     } else {
 282         scroll_multiply += acceleration;
 283     }
 284
 285     scroll_event_time = ((GdkEventKey *) event)->time;
 286     scroll_keyval = event->key.keyval;
 287
 288     return scroll_multiply;
 289 }
 290
 291 // This is a hack that is necessary because when middle-clicking too fast,
 292 // button_press events come for all clicks but there's button_release only
 293 // for the first one. So after a release, we must prohibit the next grab for
 294 // some time, or the grab will be stuck.  Perhaps this is caused by some
 295 // wrong handling of events among contexts and not by a GDK bug;
 296 // if someone can fix this properly this would be great.
 297 static gint dontgrab = 0;
 298 static bool
 299 grab_allow_again()
 300 {
 301     dontgrab--;
 302     if (dontgrab < 0) dontgrab = 0;
 303     return FALSE; // so that it is only called once
 304 }
 305
 306 /**
 307  * Main event dispatch, gets called from Gdk.
 308  */
 309 static gint sp_event_context_private_root_handler(SPEventContext *event_context, GdkEvent *event)
 310 {
 311     static NR::Point button_w;
 312     static unsigned int panning = 0;
 313     static unsigned int zoom_rb = 0;
 314
 315     SPDesktop *desktop = event_context->desktop;
 316
 317     tolerance = prefs_get_int_attribute_limited(
 318             "options.dragtolerance","value", 0, 0, 100);
 319     double const zoom_inc = prefs_get_double_attribute_limited(
 320             "options.zoomincrement", "value", M_SQRT2, 1.01, 10);
 321     double const acceleration = prefs_get_double_attribute_limited(
 322             "options.scrollingacceleration", "value", 0, 0, 6);
 323     int const key_scroll = prefs_get_int_attribute_limited(
 324             "options.keyscroll", "value", 10, 0, 1000);
 325     int const wheel_scroll = prefs_get_int_attribute_limited(
 326             "options.wheelscroll", "value", 40, 0, 1000);
 327
 328     gint ret = FALSE;
 329
 330     switch (event->type) {
 331         case GDK_2BUTTON_PRESS:
 332             if (panning) {
 333                 panning = 0;
 334                 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 335                         event->button.time);
 336                 ret = TRUE;
 337             } else {
 338                 /* sp_desktop_dialog(); */
 339             }
 340             break;
 341         case GDK_BUTTON_PRESS:
 342
 343             // save drag origin
 344             xp = (gint) event->button.x;
 345             yp = (gint) event->button.y;
 346             within_tolerance = true;
 347
 348             switch (event->button.button) {
 349                 case 2:
 350
 351                     if (dontgrab)
 352                         // double-click, still not permitted to grab;
 353                         // increase the counter to guard against triple click
 354                     {
 355                         dontgrab ++;
 356                         gtk_timeout_add(250, (GtkFunction) grab_allow_again, NULL);
 357                         break;
 358                     }
 359
 360                     button_w = NR::Point(event->button.x,
 361                                          event->button.y);
 362                     if (event->button.state == GDK_SHIFT_MASK) {
 363                         zoom_rb = 2;
 364                     } else {
 365                         panning = 2;
 366                         sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
 367                             GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK,
 368                             NULL, event->button.time-1);
 369                     }
 370                     ret = TRUE;
 371                     break;
 372                 case 3:
 373                     if (event->button.state & GDK_SHIFT_MASK
 374                             || event->button.state & GDK_CONTROL_MASK) {
 375                         button_w = NR::Point(event->button.x,
 376                                              event->button.y);
 377                         panning = 3;
 378                         sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
 379                                 GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK,
 380                                 NULL, event->button.time);
 381                         ret = TRUE;
 382                     } else {
 383                         sp_event_root_menu_popup(desktop, NULL, event);
 384                     }
 385                     break;
 386                 default:
 387                     break;
 388             }
 389             break;
 390         case GDK_MOTION_NOTIFY:
 391             if (panning) {
 392                 if ((panning == 2 && !(event->motion.state & GDK_BUTTON2_MASK))
 393                         || (panning == 3 && !(event->motion.state & GDK_BUTTON3_MASK))) {
 394                     /* Gdk seems to lose button release for us sometimes :-( */
 395                     panning = 0;
 396                     dontgrab = 0;
 397                     sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 398                             event->button.time);
 399                     ret = TRUE;
 400                 } else {
 401                     if ( within_tolerance
 402                          && ( abs( (gint) event->motion.x - xp ) < tolerance )
 403                          && ( abs( (gint) event->motion.y - yp ) < tolerance ))
 404                     {
 405                         // do not drag if we're within tolerance from origin
 406                         break;
 407                     }
 408                     // Once the user has moved farther than tolerance from
 409                     // the original location (indicating they intend to move
 410                     // the object, not click), then always process the motion
 411                     // notify coordinates as given (no snapping back to origin)
 412                     within_tolerance = false;
 413
 414                     // gobble subsequent motion events to prevent "sticking"
 415                     // when scrolling is slow
 416                     gobble_motion_events(panning == 2 ?
 417                             GDK_BUTTON2_MASK : GDK_BUTTON3_MASK);
 418
 419                     NR::Point const motion_w(event->motion.x,
 420                                              event->motion.y);
 421                     NR::Point const moved_w( motion_w - button_w );
 422                     event_context->desktop->scroll_world(moved_w);
 423                     ret = TRUE;
 424                 }
 425             } else if (zoom_rb) {
 426                 NR::Point const motion_w(event->motion.x, event->motion.y);
 427                 NR::Point const motion_dt(desktop->w2d(motion_w));
 428
 429                 if ( within_tolerance
 430                      && ( abs( (gint) event->motion.x - xp ) < tolerance )
 431                      && ( abs( (gint) event->motion.y - yp ) < tolerance ) ) {
 432                     break; // do not drag if we're within tolerance from origin
 433                 }
 434
 435                 if (within_tolerance) {
 436                     Inkscape::Rubberband::get()->start(desktop, motion_dt);
 437                 } else {
 438                     Inkscape::Rubberband::get()->move(motion_dt);
 439                 }
 440
 441                 // Once the user has moved farther than tolerance from the original location
 442                 // (indicating they intend to move the object, not click), then always process the
 443                 // motion notify coordinates as given (no snapping back to origin)
 444                 within_tolerance = false;
 445             }
 446             break;
 447         case GDK_BUTTON_RELEASE:
 448             if (within_tolerance && (panning || zoom_rb)) {
 449                 dontgrab ++;
 450                 NR::Point const event_w(event->button.x, event->button.y);
 451                 NR::Point const event_dt(desktop->w2d(event_w));
 452                 double const zoom_power = ( (event->button.state & GDK_SHIFT_MASK)
 453                                             ? -dontgrab : dontgrab );
 454                 desktop->zoom_relative_keep_point(event_dt,
 455                                                   pow(zoom_inc, zoom_power));
 456                 gtk_timeout_add(250, (GtkFunction) grab_allow_again, NULL);
 457                 desktop->updateNow();
 458             }
 459             if (panning == event->button.button) {
 460                 panning = 0;
 461                 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate),
 462                                       event->button.time);
 463                 desktop->updateNow();
 464                 ret = TRUE;
 465             } else if (zoom_rb == event->button.button) {
 466                 zoom_rb = 0;
 467                 NR::Maybe<NR::Rect> const b = Inkscape::Rubberband::get()->getRectangle();
 468                 if (b != NR::Nothing() && !within_tolerance) {
 469                     desktop->set_display_area(b.assume(), 10);
 470                 }
 471                 Inkscape::Rubberband::get()->stop();
 472             }
 473             xp = yp = 0;
 474             break;
 475         case GDK_KEY_PRESS:
 476             switch (get_group0_keyval(&event->key)) {
 477                 unsigned int shortcut;
 478                 case GDK_F1:
 479                     /* Grab it away from Gtk */
 480                     shortcut = get_group0_keyval(&event->key);
 481                     if (event->key.state & GDK_SHIFT_MASK)
 482                         shortcut |= SP_SHORTCUT_SHIFT_MASK;
 483                     if (event->key.state & GDK_CONTROL_MASK)
 484                         shortcut |= SP_SHORTCUT_CONTROL_MASK;
 485                     if (event->key.state & GDK_MOD1_MASK)
 486                         shortcut |= SP_SHORTCUT_ALT_MASK;
 487                     ret = sp_shortcut_invoke(shortcut, desktop);
 488                     break;
 489
 490                 case GDK_Tab: // disable tab/shift-tab which cycle widget focus
 491                 case GDK_ISO_Left_Tab: // they will get different functions
 492                     if (!(MOD__CTRL_ONLY || (MOD__CTRL && MOD__SHIFT))) {
 493                         ret = TRUE;
 494                     } else {
 495                         /* Grab it away from Gtk */
 496                         shortcut = get_group0_keyval(&event->key);
 497                         if (event->key.state & GDK_SHIFT_MASK)
 498                             shortcut |= SP_SHORTCUT_SHIFT_MASK;
 499                         if (event->key.state & GDK_CONTROL_MASK)
 500                             shortcut |= SP_SHORTCUT_CONTROL_MASK;
 501                         if (event->key.state & GDK_MOD1_MASK)
 502                             shortcut |= SP_SHORTCUT_ALT_MASK;
 503                         ret = sp_shortcut_invoke(shortcut, desktop);
 504                     }
 505                     break;
 506                 case GDK_W:
 507                 case GDK_w:
 508                 case GDK_F4:
 509                     /* Close view */
 510                     if (MOD__CTRL_ONLY) {
 511                         sp_ui_close_view(NULL);
 512                         ret = TRUE;
 513                     }
 514                     break;
 515                 case GDK_Left: // Ctrl Left
 516                 case GDK_KP_Left:
 517                 case GDK_KP_4:
 518                     if (MOD__CTRL_ONLY) {
 519                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 520                         gobble_key_events(get_group0_keyval(&event->key),
 521                                 GDK_CONTROL_MASK);
 522                         event_context->desktop->scroll_world(i, 0);
 523                         ret = TRUE;
 524                     }
 525                     break;
 526                 case GDK_Up: // Ctrl Up
 527                 case GDK_KP_Up:
 528                 case GDK_KP_8:
 529                     if (MOD__CTRL_ONLY) {
 530                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 531                         gobble_key_events(get_group0_keyval(&event->key),
 532                                 GDK_CONTROL_MASK);
 533                         event_context->desktop->scroll_world(0, i);
 534                         ret = TRUE;
 535                     }
 536                     break;
 537                 case GDK_Right: // Ctrl Right
 538                 case GDK_KP_Right:
 539                 case GDK_KP_6:
 540                     if (MOD__CTRL_ONLY) {
 541                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 542                         gobble_key_events(get_group0_keyval(&event->key),
 543                                 GDK_CONTROL_MASK);
 544                         event_context->desktop->scroll_world(-i, 0);
 545                         ret = TRUE;
 546                     }
 547                     break;
 548                 case GDK_Down: // Ctrl Down
 549                 case GDK_KP_Down:
 550                 case GDK_KP_2:
 551                     if (MOD__CTRL_ONLY) {
 552                         int i = (int) floor(key_scroll * accelerate_scroll(event, acceleration));
 553                         gobble_key_events(get_group0_keyval(&event->key),
 554                                 GDK_CONTROL_MASK);
 555                         event_context->desktop->scroll_world(0, -i);
 556                         ret = TRUE;
 557                     }
 558                     break;
 559                 case GDK_F10:
 560                     if (MOD__SHIFT_ONLY) {
 561                         sp_event_root_menu_popup(desktop, NULL, event);
 562                         ret= TRUE;
 563                     }
 564                     break;
 565                 case GDK_space:
 566                     sp_toggle_selector(desktop);
 567                     ret= TRUE;
 568                     break;
 569                 case GDK_z:
 570                 case GDK_Z:
 571                     if (MOD__ALT_ONLY) {
 572                         desktop->zoom_grab_focus();
 573                         ret = TRUE;
 574                     }
 575                     break;
 576                 default:
 577                     break;
 578             }
 579             break;
 580         case GDK_SCROLL:
 581             /* shift + wheel, pan left--right */
 582             if (event->scroll.state & GDK_SHIFT_MASK) {
 583                 switch (event->scroll.direction) {
 584                     case GDK_SCROLL_UP:
 585                         desktop->scroll_world(wheel_scroll, 0);
 586                         break;
 587                     case GDK_SCROLL_DOWN:
 588                         desktop->scroll_world(-wheel_scroll, 0);
 589                         break;
 590                     default:
 591                         break;
 592                 }
 593
 594                 /* ctrl + wheel, zoom in--out */
 595             } else if (event->scroll.state & GDK_CONTROL_MASK) {
 596                 double rel_zoom;
 597                 switch (event->scroll.direction) {
 598                     case GDK_SCROLL_UP:
 599                         rel_zoom = zoom_inc;
 600                         break;
 601                     case GDK_SCROLL_DOWN:
 602                         rel_zoom = 1 / zoom_inc;
 603                         break;
 604                     default:
 605                         rel_zoom = 0.0;
 606                         break;
 607                 }
 608                 if (rel_zoom != 0.0) {
 609                     NR::Point const scroll_dt = desktop->point();
 610                     desktop->zoom_relative_keep_point(scroll_dt, rel_zoom);
 611                 }
 612
 613                 /* no modifier, pan up--down (left--right on multiwheel mice?) */
 614             } else {
 615                 switch (event->scroll.direction) {
 616                     case GDK_SCROLL_UP:
 617                         desktop->scroll_world(0, wheel_scroll);
 618                         break;
 619                     case GDK_SCROLL_DOWN:
 620                         desktop->scroll_world(0, -wheel_scroll);
 621                         break;
 622                     case GDK_SCROLL_LEFT:
 623                         desktop->scroll_world(wheel_scroll, 0);
 624                         break;
 625                     case GDK_SCROLL_RIGHT:
 626                         desktop->scroll_world(-wheel_scroll, 0);
 627                         break;
 628                 }
 629             }
 630             break;
 631         default:
 632             break;
 633     }
 634
 635     return ret;
 636 }
 637
 638 /**
 639  * Handles item specific events. Gets called from Gdk.
 640  *
 641  * Only reacts to right mouse button at the moment.
 642  * \todo Fixme: do context sensitive popup menu on items.
 643  */
 644 gint
 645 sp_event_context_private_item_handler(SPEventContext *ec, SPItem *item, GdkEvent *event)
 646 {
 647     int ret = FALSE;
 648
 649     switch (event->type) {
 650         case GDK_BUTTON_PRESS:
 651             if ((event->button.button == 3)
 652                     && !(event->button.state & GDK_SHIFT_MASK || event->button.state & GDK_CONTROL_MASK)) {
 653                 sp_event_root_menu_popup(ec->desktop, item, event);
 654                 ret = TRUE;
 655             }
 656             break;
 657         default:
 658             break;
 659     }
 660
 661     return ret;
 662 }
 663
 664 /**
 665  * Gets called when attribute changes value.
 666  */
 667 static void
 668 sp_ec_repr_attr_changed(Inkscape::XML::Node *prefs_repr, gchar const *key, gchar const *oldval, gchar const *newval,
 669                         bool is_interactive, gpointer data)
 670 {
 671     SPEventContext *ec;
 672
 673     ec = SP_EVENT_CONTEXT(data);
 674
 675     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set) {
 676         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set(ec, key, newval);
 677     }
 678 }
 679
 680 Inkscape::XML::NodeEventVector sp_ec_event_vector = {
 681     NULL, /* Child added */
 682     NULL, /* Child removed */
 683     sp_ec_repr_attr_changed,
 684     NULL, /* Content changed */
 685     NULL /* Order changed */
 686 };
 687
 688 /**
 689  * Creates new SPEventContext object and calls its virtual setup() function.
 690  */
 691 SPEventContext *
 692 sp_event_context_new(GType type, SPDesktop *desktop, Inkscape::XML::Node *prefs_repr, unsigned int key)
 693 {
 694     g_return_val_if_fail(g_type_is_a(type, SP_TYPE_EVENT_CONTEXT), NULL);
 695     g_return_val_if_fail(desktop != NULL, NULL);
 696
 697     SPEventContext *const ec = (SPEventContext*)g_object_new(type, NULL);
 698
 699     ec->desktop = desktop;
 700     ec->_message_context = new Inkscape::MessageContext(desktop->messageStack());
 701     ec->key = key;
 702     ec->prefs_repr = prefs_repr;
 703     if (ec->prefs_repr) {
 704         Inkscape::GC::anchor(ec->prefs_repr);
 705         sp_repr_add_listener(ec->prefs_repr, &sp_ec_event_vector, ec);
 706     }
 707
 708     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->setup)
 709         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->setup(ec);
 710
 711     return ec;
 712 }
 713
 714 /**
 715  * Finishes SPEventContext.
 716  */
 717 void
 718 sp_event_context_finish(SPEventContext *ec)
 719 {
 720     g_return_if_fail(ec != NULL);
 721     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 722
 723     ec->enableSelectionCue(false);
 724
 725     if (ec->next) {
 726         g_warning("Finishing event context with active link\n");
 727     }
 728
 729     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->finish)
 730         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->finish(ec);
 731 }
 732
 733 //-------------------------------member functions
 734
 735 /**
 736  * Enables/disables the SPEventContext's SelCue.
 737  */
 738 void SPEventContext::enableSelectionCue(bool enable) {
 739     if (enable) {
 740         if (!_selcue) {
 741             _selcue = new Inkscape::SelCue(desktop);
 742         }
 743     } else {
 744         delete _selcue;
 745         _selcue = NULL;
 746     }
 747 }
 748
 749 /**
 750  * Enables/disables the SPEventContext's GrDrag.
 751  */
 752 void SPEventContext::enableGrDrag(bool enable) {
 753     if (enable) {
 754         if (!_grdrag) {
 755             _grdrag = new GrDrag(desktop);
 756         }
 757     } else {
 758         if (_grdrag) {
 759             delete _grdrag;
 760             _grdrag = NULL;
 761         }
 762     }
 763 }
 764
 765 /**
 766  * Calls virtual set() function of SPEventContext.
 767  */
 768 void
 769 sp_event_context_read(SPEventContext *ec, gchar const *key)
 770 {
 771     g_return_if_fail(ec != NULL);
 772     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 773     g_return_if_fail(key != NULL);
 774
 775     if (ec->prefs_repr) {
 776         gchar const *val = ec->prefs_repr->attribute(key);
 777         if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set)
 778             ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->set(ec, key, val);
 779     }
 780 }
 781
 782 /**
 783  * Calls virtual activate() function of SPEventContext.
 784  */
 785 void
 786 sp_event_context_activate(SPEventContext *ec)
 787 {
 788     g_return_if_fail(ec != NULL);
 789     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 790
 791     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->activate)
 792         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->activate(ec);
 793 }
 794
 795 /**
 796  * Calls virtual deactivate() function of SPEventContext.
 797  */
 798 void
 799 sp_event_context_deactivate(SPEventContext *ec)
 800 {
 801     g_return_if_fail(ec != NULL);
 802     g_return_if_fail(SP_IS_EVENT_CONTEXT(ec));
 803
 804     if (((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->activate)
 805         ((SPEventContextClass *) G_OBJECT_GET_CLASS(ec))->activate(ec);
 806 }
 807
 808 /**
 809  * Calls virtual root_handler(), the main event handling function.
 810  */
 811 gint
 812 sp_event_context_root_handler(SPEventContext * event_context, GdkEvent * event)
 813 {
 814     gint ret;
 815
 816     ret = ((SPEventContextClass *) G_OBJECT_GET_CLASS(event_context))->root_handler(event_context, event);
 817
 818     set_event_location(event_context->desktop, event);
 819
 820     return ret;
 821 }
 822
 823 /**
 824  * Calls virtual item_handler(), the item event handling function.
 825  */
 826 gint
 827 sp_event_context_item_handler(SPEventContext * event_context, SPItem * item, GdkEvent * event)
 828 {
 829     gint ret;
 830
 831     ret = ((SPEventContextClass *) G_OBJECT_GET_CLASS(event_context))->item_handler(event_context, item, event);
 832
 833     if (! ret) {
 834         ret = sp_event_context_root_handler(event_context, event);
 835     } else {
 836         set_event_location(event_context->desktop, event);
 837     }
 838
 839     return ret;
 840 }
 841
 842 /**
 843  * Emits 'position_set' signal on desktop and shows coordinates on status bar.
 844  */
 845 static void set_event_location(SPDesktop *desktop, GdkEvent *event)
 846 {
 847     if (event->type != GDK_MOTION_NOTIFY) {
 848         return;
 849     }
 850
 851     NR::Point const button_w(event->button.x, event->button.y);
 852     NR::Point const button_dt(desktop->w2d(button_w));
 853     desktop-> setPosition (button_dt);
 854     desktop->set_coordinate_status(button_dt);
 855 }
 856
 857 //-------------------------------------------------------------------
 858 /**
 859  * Create popup menu and tell Gtk to show it.
 860  */
 861 void
 862 sp_event_root_menu_popup(SPDesktop *desktop, SPItem *item, GdkEvent *event)
 863 {
 864     GtkWidget *menu;
 865
 866     /* fixme: This is not what I want but works for now (Lauris) */
 867     if (event->type == GDK_KEY_PRESS) {
 868         item = sp_desktop_selection(desktop)->singleItem();
 869     }
 870     menu = sp_ui_context_menu(desktop, item);
 871     gtk_widget_show(menu);
 872
 873     switch (event->type) {
 874         case GDK_BUTTON_PRESS:
 875             gtk_menu_popup(GTK_MENU(menu), NULL, NULL, 0, NULL, event->button.button, event->button.time);
 876             break;
 877         case GDK_KEY_PRESS:
 878             gtk_menu_popup(GTK_MENU(menu), NULL, NULL, 0, NULL, 0, event->key.time);
 879             break;
 880         default:
 881             break;
 882     }
 883 }
 884
 885 /**
 886  * Show tool context specific modifier tip.
 887  */
 888 void
 889 sp_event_show_modifier_tip(Inkscape::MessageContext *message_context,
 890         GdkEvent *event, gchar const *ctrl_tip, gchar const *shift_tip,
 891         gchar const *alt_tip)
 892 {
 893     guint keyval = get_group0_keyval(&event->key);
 894
 895     bool ctrl = ctrl_tip && (MOD__CTRL
 896             || (keyval == GDK_Control_L)
 897             || (keyval == GDK_Control_R));
 898     bool shift = shift_tip
 899         && (MOD__SHIFT || (keyval == GDK_Shift_L) || (keyval == GDK_Shift_R));
 900     bool alt = alt_tip
 901         && (MOD__ALT
 902                 || (keyval == GDK_Alt_L)
 903                 || (keyval == GDK_Alt_R)
 904                 || (keyval == GDK_Meta_L)
 905                 || (keyval == GDK_Meta_R));
 906
 907     gchar *tip = g_strdup_printf("%s%s%s%s%s",
 908                                  ( ctrl ? ctrl_tip : "" ),
 909                                  ( ctrl && (shift || alt) ? "; " : "" ),
 910                                  ( shift ? shift_tip : "" ),
 911                                  ( (ctrl || shift) && alt ? "; " : "" ),
 912                                  ( alt ? alt_tip : "" ));
 913
 914     if (strlen(tip) > 0) {
 915         message_context->flash(Inkscape::INFORMATION_MESSAGE, tip);
 916     }
 917
 918     g_free(tip);
 919 }
 920
 921 /**
 922  * Return the keyval corresponding to the key event in group 0, i.e.,
 923  * in the main (English) layout.
 924  *
 925  * Use this instead of simply event->keyval, so that your keyboard shortcuts
 926  * work regardless of layouts (e.g., in Cyrillic).
 927  */
 928 guint
 929 get_group0_keyval(GdkEventKey *event)
 930 {
 931     guint keyval = 0;
 932     gdk_keymap_translate_keyboard_state(
 933             gdk_keymap_get_for_display(gdk_display_get_default()),
 934             event->hardware_keycode,
 935             (GdkModifierType) event->state,
 936             0   /*event->key.group*/,
 937             &keyval, NULL, NULL, NULL);
 938     return keyval;
 939 }
 940
 941 /**
 942  * Returns item at point p in desktop.
 943  *
 944  * If state includes alt key mask, cyclically selects under; honors
 945  * into_groups.
 946  */
 947 SPItem *
 948 sp_event_context_find_item (SPDesktop *desktop, NR::Point const p,
 949         bool select_under, bool into_groups)
 950 {
 951     SPItem *item;
 952
 953     if (select_under) {
 954         SPItem *selected_at_point =
 955             desktop->item_from_list_at_point_bottom (desktop->selection->itemList(), p);
 956         item = desktop->item_at_point(p, into_groups, selected_at_point);
 957         if (item == NULL) { // we may have reached bottom, flip over to the top
 958             item = desktop->item_at_point(p, into_groups, NULL);
 959         }
 960     } else
 961         item = desktop->item_at_point(p, into_groups, NULL);
 962
 963     return item;
 964 }
 965
 966 /**
 967  * Returns item if it is under point p in desktop, at any depth; otherwise returns NULL.
 968  *
 969  * Honors into_groups.
 970  */
 971 SPItem *
 972 sp_event_context_over_item (SPDesktop *desktop, SPItem *item, NR::Point const p)
 973 {
 974     GSList *temp = NULL;
 975     temp = g_slist_prepend (temp, item);
 976     SPItem *item_at_point = desktop->item_from_list_at_point_bottom (temp, p);
 977     g_slist_free (temp);
 978
 979     return item_at_point;
 980 }
 981
 982 /**
 983  * Called when SPEventContext subclass node attribute changed.
 984  */
 985 void
 986 ec_shape_event_attr_changed(Inkscape::XML::Node *shape_repr, gchar const *name,
 987         gchar const *old_value, gchar const *new_value,
 988         bool const is_interactive, gpointer const data)
 989 {
 990     if (!name
 991             || !strcmp(name, "style")
 992             || SP_ATTRIBUTE_IS_CSS(sp_attribute_lookup(name))) {
 993         // no need to regenrate knotholder if only style changed
 994         return;
 995     }
 996
 997     SPEventContext *ec = SP_EVENT_CONTEXT(data);
 998
 999     if (ec->shape_knot_holder) {
1000         sp_knot_holder_destroy(ec->shape_knot_holder);
1001     }
1002     ec->shape_knot_holder = NULL;
1003
1004     SPDesktop *desktop = ec->desktop;
1005
1006     SPItem *item = sp_desktop_selection(desktop)->singleItem();
1007
1008     if (item) {
1009         ec->shape_knot_holder = sp_item_knot_holder(item, desktop);
1010     }
1011 }
1012
1013
1014 /*
1015   Local Variables:
1016   mode:c++
1017   c-file-style:"stroustrup"
1018   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1019   indent-tabs-mode:nil
1020   fill-column:99
1021   End:
1022 */
1023 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :