kolourpaint/tools/kpTool_KeyboardEvents.cpp

   1
   2 /*
   3    Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27
  28 //
  29 // Tool reaction to view keyboard input.
  30 //
  31
  32
  33 #define DEBUG_KP_TOOL 0
  34
  35
  36 // TODO: reduce number of includes
  37 #include <kpTool.h>
  38 #include <kpToolPrivate.h>
  39
  40 #include <limits.h>
  41
  42 #include <qapplication.h>
  43 #include <qclipboard.h>
  44 #include <qcursor.h>
  45 #include <qevent.h>
  46 #include <qlayout.h>
  47 #include <qpainter.h>
  48 #include <qpixmap.h>
  49
  50 #include <kactioncollection.h>
  51 #include <kapplication.h>
  52 #include <kdebug.h>
  53 #include <kiconloader.h>
  54 #include <klocale.h>
  55 #include <kmessagebox.h>
  56
  57 #include <kpBug.h>
  58 #include <kpColor.h>
  59 #include <kpColorToolBar.h>
  60 #include <kpDefs.h>
  61 #include <kpPixmapFX.h>
  62 #include <kpToolAction.h>
  63 #include <kpToolEnvironment.h>
  64 #include <kpToolToolBar.h>
  65 #include <kpView.h>
  66 #include <kpViewManager.h>
  67
  68
  69 void kpTool::seeIfAndHandleModifierKey (QKeyEvent *e)
  70 {
  71     switch (e->key ())
  72     {
  73     case 0:
  74     case Qt::Key_unknown:
  75     #if DEBUG_KP_TOOL && 0
  76         kDebug () << "kpTool::seeIfAndHandleModifierKey() picked up unknown key!";
  77     #endif
  78         // HACK: around Qt bug: if you hold a modifier before you start the
  79         //                      program and then release it over the view,
  80         //                      Qt reports it as the release of an unknown key
  81         //       Qt4 update: I don't think this happens anymore...
  82         // --- fall thru and update all modifiers ---
  83
  84     case Qt::Key_Alt:
  85     case Qt::Key_Shift:
  86     case Qt::Key_Control:
  87     #if DEBUG_KP_TOOL && 0
  88         kDebug () << "kpTool::setIfAndHandleModifierKey() accepting";
  89     #endif
  90         keyUpdateModifierState (e);
  91
  92         e->accept ();
  93         break;
  94     }
  95 }
  96
  97
  98 // Returns in <dx> and <dy> the direction the arrow key "e->key()" is
  99 // pointing in or (0,0) if it's not a recognised arrow key.
 100 void kpTool::arrowKeyPressDirection (const QKeyEvent *e, int *dx, int *dy)
 101 {
 102     int dxLocal = 0, dyLocal = 0;
 103
 104     switch (e->key ())
 105     {
 106     case Qt::Key_Home:     dxLocal = -1, dyLocal = -1;    break;
 107     case Qt::Key_Up:                     dyLocal = -1;    break;
 108     case Qt::Key_PageUp:   dxLocal = +1, dyLocal = -1;    break;
 109
 110     case Qt::Key_Left:     dxLocal = -1;                  break;
 111     case Qt::Key_Right:    dxLocal = +1;                  break;
 112
 113     case Qt::Key_End:      dxLocal = -1, dyLocal = +1;    break;
 114     case Qt::Key_Down:                   dyLocal = +1;    break;
 115     case Qt::Key_PageDown: dxLocal = +1, dyLocal = +1;    break;
 116     }
 117
 118     if (dx)
 119         *dx = dxLocal;
 120     if (dy)
 121         *dy = dyLocal;
 122 }
 123
 124 void kpTool::seeIfAndHandleArrowKeyPress (QKeyEvent *e)
 125 {
 126     int dx, dy;
 127
 128     arrowKeyPressDirection (e, &dx, &dy);
 129     if (dx == 0 && dy == 0)
 130         return;
 131
 132
 133     kpView * const view = viewUnderCursor ();
 134     if (!view)
 135         return;
 136
 137
 138     const QPoint oldPoint = view->mapFromGlobal (QCursor::pos ());
 139 #if DEBUG_KP_TOOL && 0
 140     kDebug () << "\toldPoint=" << oldPoint
 141                 << " dx=" << dx << " dy=" << dy << endl;
 142 #endif
 143
 144
 145     const int viewIncX = (dx ? qMax (1, view->zoomLevelX () / 100) * dx : 0);
 146     const int viewIncY = (dy ? qMax (1, view->zoomLevelY () / 100) * dy : 0);
 147
 148     int newViewX = oldPoint.x () + viewIncX;
 149     int newViewY = oldPoint.y () + viewIncY;
 150
 151
 152 #if DEBUG_KP_TOOL && 0
 153     kDebug () << "\tnewPoint=" << QPoint (newViewX, newViewY);
 154 #endif
 155
 156     // Make sure we really moved at least one doc point (needed due to
 157     // rounding error).
 158
 159     if (view->transformViewToDoc (QPoint (newViewX, newViewY)) ==
 160         view->transformViewToDoc (oldPoint))
 161     {
 162         newViewX += viewIncX, newViewY += viewIncY;
 163
 164     #if DEBUG_KP_TOOL && 0
 165         kDebug () << "\tneed adjust for doc - newPoint="
 166                     << QPoint (newViewX, newViewY) << endl;
 167     #endif
 168     }
 169
 170
 171     // TODO: visible width/height (e.g. with scrollbars)
 172     const int x = qMin (qMax (newViewX, 0), view->width () - 1);
 173     const int y = qMin (qMax (newViewY, 0), view->height () - 1);
 174
 175     // QCursor::setPos conveniently causes mouseMoveEvents
 176     QCursor::setPos (view->mapToGlobal (QPoint (x, y)));
 177     e->accept ();
 178 }
 179
 180
 181 bool kpTool::isDrawKey (int key)
 182 {
 183     return (key == Qt::Key_Enter ||
 184             key == Qt::Key_Return ||
 185             key == Qt::Key_Insert ||
 186             key == Qt::Key_Clear/*Numpad 5 Key*/ ||
 187             key == Qt::Key_L);
 188 }
 189
 190 void kpTool::seeIfAndHandleBeginDrawKeyPress (QKeyEvent *e)
 191 {
 192     if (e->isAutoRepeat ())
 193         return;
 194
 195     if (!isDrawKey (e->key ()))
 196         return;
 197
 198 #if DEBUG_KP_TOOL && 0
 199     kDebug () << "kpTool::seeIfAndHandleBeginDrawKeyPress() accept";
 200 #endif
 201
 202
 203     // TODO: wrong for dragging lines outside of view (for e.g.)
 204     kpView * const view = viewUnderCursor ();
 205     if (!view)
 206         return;
 207
 208
 209     // TODO: what about the modifiers?
 210     QMouseEvent me (QEvent::MouseButtonPress,
 211                     view->mapFromGlobal (QCursor::pos ()),
 212                     Qt::LeftButton,
 213                     Qt::LeftButton/*button state after event*/,
 214                     Qt::NoModifier);
 215     mousePressEvent (&me);
 216     e->accept ();
 217 }
 218
 219 void kpTool::seeIfAndHandleEndDrawKeyPress (QKeyEvent *e)
 220 {
 221 #if DEBUG_KP_TOOL && 0
 222     kDebug () << "kpTool::setIfAndHandleEndDrawKeyPress() key=" << e->key ()
 223                << " isAutoRepeat=" << e->isAutoRepeat ()
 224                << " isDrawKey=" << isDrawKey (e->key ())
 225                << " view=" << viewUnderCursor ()
 226                << endl;
 227 #endif
 228
 229     if (e->isAutoRepeat ())
 230         return;
 231
 232     if (!isDrawKey (e->key ()))
 233         return;
 234
 235 #if DEBUG_KP_TOOL && 0
 236     kDebug () << "kpTool::seeIfAndHandleEndDrawKeyPress() accept";
 237 #endif
 238
 239
 240     kpView * const view = viewUnderCursor ();
 241     if (!view)
 242         return;
 243
 244
 245     // TODO: what about the modifiers?
 246     QMouseEvent me (QEvent::MouseButtonRelease,
 247                     view->mapFromGlobal (QCursor::pos ()),
 248                     Qt::LeftButton,
 249                     Qt::NoButton/*button state after event*/,
 250                     Qt::NoModifier);
 251     mouseReleaseEvent (&me);
 252
 253     e->accept ();
 254 }
 255
 256
 257 void kpTool::keyPressEvent (QKeyEvent *e)
 258 {
 259 #if DEBUG_KP_TOOL && 0
 260     kDebug () << "kpTool::keyPressEvent() key=" << (int *) e->key ()
 261               << " stateAfter: modifiers=" << (int *) (int) e->modifiers ()
 262               << " isAutoRep=" << e->isAutoRepeat ()
 263               << endl;
 264 #endif
 265
 266     e->ignore ();
 267
 268
 269     seeIfAndHandleModifierKey (e);
 270     if (e->isAccepted ())
 271         return;
 272
 273     seeIfAndHandleArrowKeyPress (e);
 274     if (e->isAccepted ())
 275         return;
 276
 277     seeIfAndHandleBeginDrawKeyPress (e);
 278     if (e->isAccepted ())
 279         return;
 280
 281
 282     switch (e->key ())
 283     {
 284     case Qt::Key_Delete:
 285         d->environ->deleteSelection ();
 286         break;
 287
 288     case Qt::Key_Escape:
 289         if (hasBegunDraw ())
 290         {
 291             cancelShapeInternal ();
 292             e->accept ();
 293         }
 294
 295         break;
 296     }
 297 }
 298
 299 void kpTool::keyReleaseEvent (QKeyEvent *e)
 300 {
 301 #if DEBUG_KP_TOOL && 0
 302     kDebug () << "kpTool::keyReleaseEvent() key=" << (int *) e->key ()
 303               << " stateAfter: modifiers=" << (int *) (int) e->modifiers ()
 304               << " isAutoRep=" << e->isAutoRepeat ()
 305               << endl;
 306 #endif
 307
 308     e->ignore ();
 309
 310
 311     seeIfAndHandleModifierKey (e);
 312     if (e->isAccepted ())
 313         return;
 314
 315     seeIfAndHandleEndDrawKeyPress (e);
 316     if (e->isAccepted ())
 317         return;
 318 }
 319
 320
 321 // private
 322 void kpTool::keyUpdateModifierState (QKeyEvent *e)
 323 {
 324 #if DEBUG_KP_TOOL && 0
 325     kDebug () << "kpTool::keyUpdateModifierState() e->key=" << (int *) e->key ();
 326     kDebug () << "\tshift="
 327                << (e->modifiers () & Qt::ShiftModifier)
 328                << " control="
 329                << (e->modifiers () & Qt::ControlModifier)
 330                << " alt="
 331                << (e->modifiers () & Qt::AltModifier)
 332                << endl;
 333 #endif
 334     if (e->key () & (Qt::Key_Alt | Qt::Key_Shift | Qt::Key_Control))
 335     {
 336     #if DEBUG_KP_TOOL && 0
 337         kDebug () << "\t\tmodifier changed - use e's claims";
 338     #endif
 339         setShiftPressed (e->modifiers () & Qt::ShiftModifier);
 340         setControlPressed (e->modifiers () & Qt::ControlModifier);
 341         setAltPressed (e->modifiers () & Qt::AltModifier);
 342     }
 343     // See seeIfAndHandleModifierKey() for why this code path exists.
 344     else
 345     {
 346     #if DEBUG_KP_TOOL && 0
 347         kDebug () << "\t\tmodifiers not changed - figure out the truth";
 348     #endif
 349         const Qt::KeyboardModifiers keyState = QApplication::keyboardModifiers ();
 350
 351         setShiftPressed (keyState & Qt::ShiftModifier);
 352         setControlPressed (keyState & Qt::ControlModifier);
 353         setAltPressed (keyState & Qt::AltModifier);
 354     }
 355 }
 356
 357
 358 void kpTool::notifyModifierStateChanged ()
 359 {
 360     if (careAboutModifierState ())
 361     {
 362         if (d->beganDraw)
 363             draw (d->currentPoint, d->lastPoint, normalizedRect ());
 364         else
 365         {
 366             d->currentPoint = calculateCurrentPoint ();
 367             d->currentViewPoint = calculateCurrentPoint (false/*view point*/);
 368             hover (d->currentPoint);
 369         }
 370     }
 371 }
 372
 373 void kpTool::setShiftPressed (bool pressed)
 374 {
 375     if (pressed == d->shiftPressed)
 376         return;
 377
 378     d->shiftPressed = pressed;
 379
 380     notifyModifierStateChanged ();
 381 }
 382
 383 void kpTool::setControlPressed (bool pressed)
 384 {
 385     if (pressed == d->controlPressed)
 386         return;
 387
 388     d->controlPressed = pressed;
 389
 390     notifyModifierStateChanged ();
 391 }
 392
 393 void kpTool::setAltPressed (bool pressed)
 394 {
 395     if (pressed == d->altPressed)
 396         return;
 397
 398     d->altPressed = pressed;
 399
 400     notifyModifierStateChanged ();
 401 }