kolourpaint/mainWindow/kpMainWindow_View_Thumbnail.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 #include <kpMainWindow.h>
  30 #include <kpMainWindowPrivate.h>
  31
  32 #include <qdatetime.h>
  33 #include <qpainter.h>
  34 #include <qtimer.h>
  35
  36 #include <kapplication.h>
  37 #include <kconfig.h>
  38 #include <kconfiggroup.h>
  39 #include <kdebug.h>
  40 #include <kglobal.h>
  41 #include <klocale.h>
  42 #include <kselectaction.h>
  43 #include <kstandardaction.h>
  44 #include <ktoggleaction.h>
  45 #include <kactioncollection.h>
  46
  47 #include <kpDefs.h>
  48 #include <kpDocument.h>
  49 #include <kpThumbnail.h>
  50 #include <kpTool.h>
  51 #include <kpToolToolBar.h>
  52 #include <kpUnzoomedThumbnailView.h>
  53 #include <kpViewManager.h>
  54 #include <kpViewScrollableContainer.h>
  55 #include <kpWidgetMapper.h>
  56 #include <kpZoomedView.h>
  57 #include <kpZoomedThumbnailView.h>
  58
  59
  60 // private
  61 void kpMainWindow::setupViewMenuThumbnailActions ()
  62 {
  63     d->thumbnailSaveConfigTimer = 0;
  64
  65     KActionCollection *ac = actionCollection ();
  66
  67
  68     d->actionShowThumbnail = ac->add <KToggleAction> ("view_show_thumbnail");
  69     d->actionShowThumbnail->setText (i18n ("Show T&humbnail"));
  70     // TODO: This doesn't work when the thumbnail has focus.
  71     //       Testcase: Press CTRL+H twice on a fresh KolourPaint.
  72     //                 The second CTRL+H doesn't close the thumbnail.
  73     d->actionShowThumbnail->setShortcut (Qt::CTRL + Qt::Key_H);
  74     //d->actionShowThumbnail->setCheckedState (KGuiItem(i18n ("Hide T&humbnail")));
  75     connect (d->actionShowThumbnail, SIGNAL (triggered (bool)),
  76         SLOT (slotShowThumbnailToggled ()));
  77
  78     // Please do not use setCheckedState() here - it wouldn't make sense
  79     d->actionZoomedThumbnail = ac->add <KToggleAction> ("view_zoomed_thumbnail");
  80     d->actionZoomedThumbnail->setText (i18n ("Zoo&med Thumbnail Mode"));
  81     connect (d->actionZoomedThumbnail, SIGNAL (triggered (bool)),
  82         SLOT (slotZoomedThumbnailToggled ()));
  83
  84     // For consistency with the above action, don't use setCheckedState()
  85     //
  86     // Also, don't use "Show Thumbnail Rectangle" because if entire doc
  87     // can be seen in scrollView, checking option won't "Show" anything
  88     // since rect _surrounds_ entire doc (hence, won't be rendered).
  89     d->actionShowThumbnailRectangle = ac->add <KToggleAction> ("view_show_thumbnail_rectangle");
  90     d->actionShowThumbnailRectangle->setText (i18n ("Enable Thumbnail &Rectangle"));
  91     connect (d->actionShowThumbnailRectangle, SIGNAL (triggered (bool)),
  92         SLOT (slotThumbnailShowRectangleToggled ()));
  93 }
  94
  95 // private
  96 void kpMainWindow::enableViewMenuThumbnailDocumentActions (bool enable)
  97 {
  98     d->actionShowThumbnail->setEnabled (enable);
  99     enableThumbnailOptionActions (enable);
 100 }
 101
 102 // private slot
 103 void kpMainWindow::slotDestroyThumbnail ()
 104 {
 105 #if DEBUG_KP_MAIN_WINDOW
 106     kDebug () << "kpMainWindow::slotDestroyThumbnail()";
 107 #endif
 108
 109     d->actionShowThumbnail->setChecked (false);
 110     enableThumbnailOptionActions (false);
 111     updateThumbnail ();
 112 }
 113
 114 // private slot
 115 void kpMainWindow::slotDestroyThumbnailInitatedByUser ()
 116 {
 117 #if DEBUG_KP_MAIN_WINDOW
 118     kDebug () << "kpMainWindow::slotDestroyThumbnailInitiatedByUser()";
 119 #endif
 120
 121     d->actionShowThumbnail->setChecked (false);
 122     slotShowThumbnailToggled ();
 123 }
 124
 125 // private slot
 126 void kpMainWindow::slotCreateThumbnail ()
 127 {
 128 #if DEBUG_KP_MAIN_WINDOW
 129     kDebug () << "kpMainWindow::slotCreateThumbnail()";
 130 #endif
 131
 132     d->actionShowThumbnail->setChecked (true);
 133     enableThumbnailOptionActions (true);
 134     updateThumbnail ();
 135 }
 136
 137 // public
 138 void kpMainWindow::notifyThumbnailGeometryChanged ()
 139 {
 140 #if DEBUG_KP_MAIN_WINDOW
 141     kDebug () << "kpMainWindow::notifyThumbnailGeometryChanged()";
 142 #endif
 143
 144     if (!d->thumbnailSaveConfigTimer)
 145     {
 146         d->thumbnailSaveConfigTimer = new QTimer (this);
 147         d->thumbnailSaveConfigTimer->setSingleShot (true);
 148         connect (d->thumbnailSaveConfigTimer, SIGNAL (timeout ()),
 149                  this, SLOT (slotSaveThumbnailGeometry ()));
 150     }
 151
 152     // (single shot)
 153     d->thumbnailSaveConfigTimer->start (500/*msec*/);
 154 }
 155
 156 // private slot
 157 void kpMainWindow::slotSaveThumbnailGeometry ()
 158 {
 159 #if DEBUG_KP_MAIN_WINDOW
 160     kDebug () << "kpMainWindow::saveThumbnailGeometry()";
 161 #endif
 162
 163     if (!d->thumbnail)
 164         return;
 165
 166     QRect rect (d->thumbnail->x (), d->thumbnail->y (),
 167                 d->thumbnail->width (), d->thumbnail->height ());
 168 #if DEBUG_KP_MAIN_WINDOW
 169     kDebug () << "\tthumbnail relative geometry=" << rect;
 170 #endif
 171
 172     d->configThumbnailGeometry = mapFromGlobal (rect);
 173
 174 #if DEBUG_KP_MAIN_WINDOW
 175     kDebug () << "\tCONFIG: saving thumbnail geometry "
 176                 << d->configThumbnailGeometry
 177                 << endl;
 178 #endif
 179
 180     KConfigGroup cfg (KGlobal::config (), kpSettingsGroupThumbnail);
 181
 182     cfg.writeEntry (kpSettingThumbnailGeometry, d->configThumbnailGeometry);
 183     cfg.sync ();
 184 }
 185
 186 // private slot
 187 void kpMainWindow::slotShowThumbnailToggled ()
 188 {
 189 #if DEBUG_KP_MAIN_WINDOW
 190     kDebug () << "kpMainWindow::slotShowThumbnailToggled()";
 191 #endif
 192
 193     d->configThumbnailShown = d->actionShowThumbnail->isChecked ();
 194
 195     KConfigGroup cfg (KGlobal::config (), kpSettingsGroupThumbnail);
 196
 197     cfg.writeEntry (kpSettingThumbnailShown, d->configThumbnailShown);
 198     cfg.sync ();
 199
 200
 201     enableThumbnailOptionActions (d->actionShowThumbnail->isChecked ());
 202     updateThumbnail ();
 203 }
 204
 205 // private slot
 206 void kpMainWindow::updateThumbnailZoomed ()
 207 {
 208 #if DEBUG_KP_MAIN_WINDOW
 209     kDebug () << "kpMainWindow::updateThumbnailZoomed() zoomed="
 210                << d->actionZoomedThumbnail->isChecked () << endl;
 211 #endif
 212
 213     if (!d->thumbnailView)
 214         return;
 215
 216     destroyThumbnailView ();
 217     createThumbnailView ();
 218 }
 219
 220 // private slot
 221 void kpMainWindow::slotZoomedThumbnailToggled ()
 222 {
 223 #if DEBUG_KP_MAIN_WINDOW
 224     kDebug () << "kpMainWindow::slotZoomedThumbnailToggled()";
 225 #endif
 226
 227     d->configZoomedThumbnail = d->actionZoomedThumbnail->isChecked ();
 228
 229     KConfigGroup cfg (KGlobal::config (), kpSettingsGroupThumbnail);
 230
 231     cfg.writeEntry (kpSettingThumbnailZoomed, d->configZoomedThumbnail);
 232     cfg.sync ();
 233
 234
 235     updateThumbnailZoomed ();
 236 }
 237
 238 // private slot
 239 void kpMainWindow::slotThumbnailShowRectangleToggled ()
 240 {
 241 #if DEBUG_KP_MAIN_WINDOW
 242     kDebug () << "kpMainWindow::slotThumbnailShowRectangleToggled()";
 243 #endif
 244
 245     d->configThumbnailShowRectangle = d->actionShowThumbnailRectangle->isChecked ();
 246
 247     KConfigGroup cfg (KGlobal::config (), kpSettingsGroupThumbnail);
 248
 249     cfg.writeEntry (kpSettingThumbnailShowRectangle, d->configThumbnailShowRectangle);
 250     cfg.sync ();
 251
 252
 253     if (d->thumbnailView)
 254     {
 255         d->thumbnailView->showBuddyViewScrollableContainerRectangle (
 256             d->actionShowThumbnailRectangle->isChecked ());
 257     }
 258 }
 259
 260 // private
 261 void kpMainWindow::enableViewZoomedThumbnail (bool enable)
 262 {
 263 #if DEBUG_KP_MAIN_WINDOW
 264     kDebug () << "kpMainWindow::enableSettingsViewZoomedThumbnail()";
 265 #endif
 266
 267     d->actionZoomedThumbnail->setEnabled (enable &&
 268         d->actionShowThumbnail->isChecked ());
 269
 270     // Note: Don't uncheck if disabled - being able to see the zoomed state
 271     //       before turning on the thumbnail can be useful.
 272     d->actionZoomedThumbnail->setChecked (d->configZoomedThumbnail);
 273 }
 274
 275 // private
 276 void kpMainWindow::enableViewShowThumbnailRectangle (bool enable)
 277 {
 278 #if DEBUG_KP_MAIN_WINDOW
 279     kDebug () << "kpMainWindow::enableViewShowThumbnailRectangle()";
 280 #endif
 281
 282     d->actionShowThumbnailRectangle->setEnabled (enable &&
 283         d->actionShowThumbnail->isChecked ());
 284
 285     // Note: Don't uncheck if disabled for consistency with
 286     //       enableViewZoomedThumbnail()
 287     d->actionShowThumbnailRectangle->setChecked (
 288         d->configThumbnailShowRectangle);
 289 }
 290
 291 // private
 292 void kpMainWindow::enableThumbnailOptionActions (bool enable)
 293 {
 294     enableViewZoomedThumbnail (enable);
 295     enableViewShowThumbnailRectangle (enable);
 296 }
 297
 298
 299 // private
 300 void kpMainWindow::createThumbnailView ()
 301 {
 302 #if DEBUG_KP_MAIN_WINDOW
 303     kDebug () << "\t\tcreating new kpView:";
 304 #endif
 305
 306     if (d->thumbnailView)
 307     {
 308         kDebug () << "kpMainWindow::createThumbnailView() had to destroy view";
 309         destroyThumbnailView ();
 310     }
 311
 312     if (d->actionZoomedThumbnail->isChecked ())
 313     {
 314         d->thumbnailView = new kpZoomedThumbnailView (
 315             d->document, d->toolToolBar, d->viewManager,
 316             d->mainView,
 317             0/*scrollableContainer*/,
 318             d->thumbnail);
 319         d->thumbnailView->setObjectName ("thumbnailView");
 320     }
 321     else
 322     {
 323         d->thumbnailView = new kpUnzoomedThumbnailView (
 324             d->document, d->toolToolBar, d->viewManager,
 325             d->mainView,
 326             0/*scrollableContainer*/,
 327             d->thumbnail);
 328         d->thumbnailView->setObjectName ("thumbnailView");
 329     }
 330
 331     d->thumbnailView->showBuddyViewScrollableContainerRectangle (
 332         d->actionShowThumbnailRectangle->isChecked ());
 333
 334
 335 #if DEBUG_KP_MAIN_WINDOW
 336     kDebug () << "\t\tgive kpThumbnail the kpView:";
 337 #endif
 338     if (d->thumbnail)
 339         d->thumbnail->setView (d->thumbnailView);
 340     else
 341         kError () << "kpMainWindow::createThumbnailView() no thumbnail" << endl;
 342
 343 #if DEBUG_KP_MAIN_WINDOW
 344     kDebug () << "\t\tregistering the kpView:";
 345 #endif
 346     if (d->viewManager)
 347         d->viewManager->registerView (d->thumbnailView);
 348 }
 349
 350 // private
 351 void kpMainWindow::destroyThumbnailView ()
 352 {
 353     if (!d->thumbnailView)
 354         return;
 355
 356     if (d->viewManager)
 357         d->viewManager->unregisterView (d->thumbnailView);
 358
 359     if (d->thumbnail)
 360         d->thumbnail->setView (0);
 361
 362     d->thumbnailView->deleteLater (); d->thumbnailView = 0;
 363 }
 364
 365
 366 // private
 367 void kpMainWindow::updateThumbnail ()
 368 {
 369 #if DEBUG_KP_MAIN_WINDOW
 370     kDebug () << "kpMainWindow::updateThumbnail()";
 371 #endif
 372     bool enable = d->actionShowThumbnail->isChecked ();
 373
 374 #if DEBUG_KP_MAIN_WINDOW
 375     kDebug () << "\tthumbnail="
 376                << bool (d->thumbnail)
 377                << " action_isChecked="
 378                << enable
 379                << endl;
 380 #endif
 381
 382     if (bool (d->thumbnail) == enable)
 383         return;
 384
 385     if (!d->thumbnail)
 386     {
 387     #if DEBUG_KP_MAIN_WINDOW
 388         kDebug () << "\tcreating thumbnail";
 389     #endif
 390
 391         // Read last saved geometry before creating thumbnail & friends
 392         // in case they call notifyThumbnailGeometryChanged()
 393         QRect thumbnailGeometry = d->configThumbnailGeometry;
 394     #if DEBUG_KP_MAIN_WINDOW
 395         kDebug () << "\t\tlast used geometry=" << thumbnailGeometry;
 396     #endif
 397
 398         d->thumbnail = new kpThumbnail (this);
 399
 400         createThumbnailView ();
 401
 402     #if DEBUG_KP_MAIN_WINDOW
 403         kDebug () << "\t\tmoving thumbnail to right place";
 404     #endif
 405         if (!thumbnailGeometry.isEmpty () &&
 406             QRect (0, 0, width (), height ()).intersects (thumbnailGeometry))
 407         {
 408             const QRect geometry = mapToGlobal (thumbnailGeometry);
 409             d->thumbnail->resize (geometry.size ());
 410             d->thumbnail->move (geometry.topLeft ());
 411         }
 412         else
 413         {
 414             if (d->scrollView)
 415             {
 416                 const int margin = 20;
 417                 const int initialWidth = 160, initialHeight = 120;
 418
 419                 QRect geometryRect (width () - initialWidth - margin * 2,
 420                                     d->scrollView->y () + margin,
 421                                     initialWidth,
 422                                     initialHeight);
 423
 424             #if DEBUG_KP_MAIN_WINDOW
 425                 kDebug () << "\t\tcreating geometry=" << geometryRect;
 426             #endif
 427
 428                 geometryRect = mapToGlobal (geometryRect);
 429             #if DEBUG_KP_MAIN_WINDOW
 430                 kDebug () << "\t\tmap to global=" << geometryRect;
 431             #endif
 432                 d->thumbnail->resize (geometryRect.size ());
 433                 d->thumbnail->move (geometryRect.topLeft ());
 434             }
 435         }
 436
 437     #if DEBUG_KP_MAIN_WINDOW
 438         kDebug () << "\t\tshowing thumbnail";
 439     #endif
 440         d->thumbnail->show ();
 441
 442     #if DEBUG_KP_MAIN_WINDOW
 443         kDebug () << "\t\tconnecting signal thumbnail::windowClosed to destroy slot";
 444     #endif
 445         connect (d->thumbnail, SIGNAL (windowClosed ()),
 446                  this, SLOT (slotDestroyThumbnailInitatedByUser ()));
 447     #if DEBUG_KP_MAIN_WINDOW
 448         kDebug () << "\t\tDONE";
 449     #endif
 450     }
 451     else
 452     {
 453     #if DEBUG_KP_MAIN_WINDOW
 454         kDebug () << "\tdestroying thumbnail d->thumbnail="
 455             << d->thumbnail << endl;
 456     #endif
 457
 458         if (d->thumbnailSaveConfigTimer && d->thumbnailSaveConfigTimer->isActive ())
 459         {
 460             d->thumbnailSaveConfigTimer->stop ();
 461             slotSaveThumbnailGeometry ();
 462         }
 463
 464         // Must be done before hiding the thumbnail to avoid triggering
 465         // this signal - re-entering this code.
 466         disconnect (d->thumbnail, SIGNAL (windowClosed ()),
 467                     this, SLOT (slotDestroyThumbnailInitatedByUser ()));
 468
 469         // Avoid change/flicker of caption due to view delete
 470         // (destroyThumbnailView())
 471         d->thumbnail->hide ();
 472
 473         destroyThumbnailView ();
 474
 475         d->thumbnail->deleteLater (); d->thumbnail = 0;
 476     }
 477 }