ksnapshot/ksnapshot.cpp

   1 /*
   2  *  Copyright (C) 1997-2008 Richard J. Moore <rich@kde.org>
   3  *  Copyright (C) 2000 Matthias Ettrich <ettrich@troll.no>
   4  *  Copyright (C) 2002 Aaron J. Seigo <aseigo@kde.org>
   5  *  Copyright (C) 2003 Nadeem Hasan <nhasan@kde.org>
   6  *  Copyright (C) 2004 Bernd Brandstetter <bbrand@freenet.de>
   7  *  Copyright (C) 2006 Urs Wolfer <uwolfer @ kde.org>
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU Lesser General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU Lesser General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22  *  Boston, MA 02110-1301, USA.
  23  */
  24
  25 #include "ksnapshot.h"
  26
  27 #include <QClipboard>
  28 #include <QShortcut>
  29 #include <QMenu>
  30 #include <QDesktopWidget>
  31
  32 #include <klocale.h>
  33
  34 #include <KDebug>
  35 #include <kglobal.h>
  36 #include <kicon.h>
  37 #include <kimageio.h>
  38 #include <kcomponentdata.h>
  39 #include <kfiledialog.h>
  40 #include <kmessagebox.h>
  41 #include <kio/netaccess.h>
  42 #include <ksavefile.h>
  43 #include <kstandardshortcut.h>
  44 #include <ktemporaryfile.h>
  45 #include <knotification.h>
  46 #include <khelpmenu.h>
  47 #include <kmenu.h>
  48 #include <kmimetypetrader.h>
  49 #include <kopenwithdialog.h>
  50 #include <krun.h>
  51 #include <kstandarddirs.h>
  52 #include <kstartupinfo.h>
  53 #include <kvbox.h>
  54 #include <qdebug.h>
  55
  56 #include "regiongrabber.h"
  57 #include "windowgrabber.h"
  58 #include "ui_ksnapshotwidget.h"
  59
  60
  61 class KSnapshotWidget : public QWidget, public Ui::KSnapshotWidget
  62 {
  63     public:
  64         KSnapshotWidget(QWidget *parent = 0)
  65         : QWidget(parent)
  66         {
  67             setupUi(this);
  68             btnNew->setIcon(KIcon("ksnapshot"));
  69             btnSave->setIcon(KIcon("document-save"));
  70             btnOpen->setIcon(KIcon("document-open"));
  71             btnCopy->setIcon(KIcon("edit-copy"));
  72
  73         }
  74 };
  75
  76 KSnapshot::KSnapshot(QWidget *parent,  KSnapshotObject::CaptureMode mode )
  77   : KDialog(parent), KSnapshotObject(), modified(false)
  78 {
  79     setCaption( "" );
  80     setModal( true );
  81     showButtonSeparator( true );
  82     setDefaultButton( User1 );
  83     setButtons(Help|User1);
  84     setButtonGuiItem( User1, KStandardGuiItem::quit() );
  85     grabber = new QWidget( 0,  Qt::X11BypassWindowManagerHint );
  86     grabber->move( -1000, -1000 );
  87     grabber->installEventFilter( this );
  88
  89     KStartupInfo::appStarted();
  90
  91     KVBox *vbox = new KVBox( this );
  92     vbox->setSpacing( spacingHint() );
  93     setMainWidget( vbox );
  94
  95     mainWidget = new KSnapshotWidget( vbox );
  96
  97     connect( mainWidget->lblImage, SIGNAL( startDrag() ), SLOT( slotDragSnapshot() ) );
  98     connect( mainWidget->btnNew, SIGNAL( clicked() ), SLOT( slotGrab() ) );
  99     connect( mainWidget->btnSave, SIGNAL( clicked() ), SLOT( slotSaveAs() ) );
 100     connect( mainWidget->btnCopy, SIGNAL( clicked() ), SLOT( slotCopy() ) );
 101 //    connect( mainWidget->btnOpen, SIGNAL( clicked() ), SLOT( slotOpen() ) );
 102     connect( mainWidget->comboMode, SIGNAL( activated(int) ), SLOT( slotModeChanged(int) ) );
 103
 104     openMenu = new QMenu(this);
 105     mainWidget->btnOpen->setMenu(openMenu);
 106     connect(openMenu, SIGNAL(aboutToShow()),
 107             this, SLOT(slotPopulateOpenMenu()));
 108     connect(openMenu, SIGNAL(triggered(QAction*)),
 109             this, SLOT(slotOpen(QAction*)));
 110
 111     grabber->show();
 112     grabber->grabMouse( Qt::WaitCursor );
 113
 114     qDebug() << "Mode = " << mode;
 115     if ( mode == KSnapshotObject::FullScreen )
 116         snapshot = QPixmap::grabWindow( QApplication::desktop()->winId() );
 117     else if ( mode == KSnapshotObject::CurrentScreen ) {
 118         qDebug() << "Desktop Geom = " << QApplication::desktop()->geometry();
 119         QDesktopWidget *desktop = QApplication::desktop();
 120         int screenId = desktop->screenNumber( QCursor::pos() );
 121         qDebug() << "Screenid = " << screenId;
 122         QRect geom = desktop->screenGeometry( screenId );
 123         qDebug() << "Geometry = " << screenId;
 124         snapshot = QPixmap::grabWindow( desktop->winId(),
 125                                         geom.x(), geom.y(), geom.width(), geom.height() );
 126
 127     }
 128     else {
 129         setMode( mode );
 130         switch(mode)
 131         {
 132             case KSnapshotObject::WindowUnderCursor:
 133            {
 134                 setIncludeDecorations( true );
 135                 performGrab();
 136                 break;
 137            }
 138            case  KSnapshotObject::ChildWindow:
 139            {
 140                 slotGrab();
 141                 break;
 142            }
 143            case KSnapshotObject::Region:
 144            {
 145                 grabRegion();
 146                 break;
 147            }
 148            default:
 149                 break;
 150           }
 151     }
 152
 153     //When we use argument to take snapshot we mustn't hide it.
 154     if(mode !=  KSnapshotObject::ChildWindow)
 155     {
 156        grabber->releaseMouse();
 157        grabber->hide();
 158     }
 159
 160     KConfigGroup conf(KGlobal::config(), "GENERAL");
 161     setDelay( conf.readEntry("delay", 0) );
 162     setMode( conf.readEntry("mode", 0) );
 163     setIncludeDecorations(conf.readEntry("includeDecorations",true));
 164     filename = KUrl( conf.readPathEntry( "filename", QDir::currentPath()+'/'+i18n("snapshot")+"1.png" ));
 165
 166     // Make sure the name is not already being used
 167     while(KIO::NetAccess::exists( filename, KIO::NetAccess::DestinationSide, this )) {
 168         autoincFilename();
 169     }
 170
 171     connect( &grabTimer, SIGNAL( timeout() ), this, SLOT(  grabTimerDone() ) );
 172     connect( &updateTimer, SIGNAL( timeout() ), this, SLOT(  updatePreview() ) );
 173     QTimer::singleShot( 0, this, SLOT( updateCaption() ) );
 174
 175     KHelpMenu *helpMenu = new KHelpMenu(this, KGlobal::mainComponent().aboutData(), true);
 176     setButtonMenu( Help, helpMenu->menu() );
 177 #if 0
 178     accel->insert( "QuickSave", i18n("Quick Save Snapshot &As..."),
 179                    i18n("Save the snapshot to the file specified by the user without showing the file dialog."),
 180                    Qt::CTRL+Qt::SHIFT+Qt::Key_S, this, SLOT(slotSave()));
 181     accel->insert( "SaveAs", i18n("Save Snapshot &As..."),
 182                    i18n("Save the snapshot to the file specified by the user."),
 183                    Qt::CTRL+Qt::Key_A, this, SLOT(slotSaveAs()));
 184 #endif
 185
 186     new QShortcut( KStandardShortcut::shortcut( KStandardShortcut::Quit ).primary(), this, SLOT(reject()));
 187
 188     new QShortcut( Qt::Key_Q, this, SLOT(slotSave()));
 189
 190     new QShortcut( KStandardShortcut::shortcut( KStandardShortcut::Copy ).primary(), mainWidget->btnCopy, SLOT(animateClick()));
 191
 192     new QShortcut( KStandardShortcut::shortcut( KStandardShortcut::Save ).primary(), mainWidget->btnSave, SLOT(animateClick()));
 193     new QShortcut( Qt::Key_S, mainWidget->btnSave, SLOT(animateClick()));
 194
 195     new QShortcut( KStandardShortcut::shortcut( KStandardShortcut::New ).primary(), mainWidget->btnNew, SLOT(animateClick()) );
 196     new QShortcut( Qt::Key_N, mainWidget->btnNew, SLOT(animateClick()) );
 197     new QShortcut( Qt::Key_Space, mainWidget->btnNew, SLOT(animateClick()) );
 198
 199     setEscapeButton( User1 );
 200     connect( this, SIGNAL( user1Clicked() ), SLOT( reject() ) );
 201
 202     mainWidget->btnNew->setFocus();
 203 }
 204
 205 KSnapshot::~KSnapshot()
 206 {
 207     delete mainWidget;
 208 }
 209
 210 void KSnapshot::resizeEvent( QResizeEvent * )
 211 {
 212     updateTimer.setSingleShot( true );
 213     updateTimer.start( 200 );
 214 }
 215
 216 void KSnapshot::slotSave()
 217 {
 218     if ( save(filename, this) ) {
 219         modified = false;
 220         autoincFilename();
 221         updateCaption();
 222     }
 223 }
 224
 225 void KSnapshot::slotSaveAs()
 226 {
 227     QStringList mimetypes = KImageIO::mimeTypes( KImageIO::Writing );
 228     KFileDialog dlg( filename.url(), mimetypes.join(" "), this);
 229
 230     dlg.setOperationMode( KFileDialog::Saving );
 231     dlg.setCaption( i18n("Save As") );
 232     dlg.setSelection( filename.url() );
 233
 234     dlg.setInlinePreviewShown(true);
 235
 236     if ( !dlg.exec() )
 237         return;
 238
 239     KUrl url = dlg.selectedUrl();
 240     if ( !url.isValid() )
 241         return;
 242
 243     if ( save(url,this) ) {
 244         filename = url;
 245         modified = false;
 246         autoincFilename();
 247         updateCaption();
 248     }
 249 }
 250
 251 void KSnapshot::slotCopy()
 252 {
 253     QClipboard *cb = QApplication::clipboard();
 254     cb->setPixmap( snapshot );
 255 }
 256
 257 void KSnapshot::slotDragSnapshot()
 258 {
 259     QDrag *drag = new QDrag(this);
 260
 261     drag->setMimeData(new QMimeData);
 262     drag->mimeData()->setImageData(snapshot);
 263     drag->setPixmap(preview());
 264     drag->start();
 265 }
 266
 267 void KSnapshot::slotGrab()
 268 {
 269     hide();
 270
 271     if ( delay() ) {
 272         //kDebug() << "starting timer with time of" << delay();
 273         grabTimer.start( delay());
 274     }
 275     else {
 276         if ( mode() == Region ) {
 277             grabRegion();
 278         }
 279         else {
 280             grabber->show();
 281             grabber->grabMouse( Qt::CrossCursor );
 282         }
 283     }
 284 }
 285
 286 void KSnapshot::slotOpen(const QString& application)
 287 {
 288     QString fileopen = KStandardDirs::locateLocal("tmp", filename.fileName());
 289
 290     if (!saveEqual(fileopen,this))
 291     {
 292         return;
 293     }
 294
 295     KUrl::List list;
 296     list.append(fileopen);
 297     KRun::run(application, list, this);
 298 }
 299
 300 void KSnapshot::slotOpen(QAction* action)
 301 {
 302     KSnapshotServiceAction* serviceAction =
 303                                   qobject_cast<KSnapshotServiceAction*>(action);
 304
 305     if (!serviceAction)
 306     {
 307         return;
 308     }
 309
 310     KService::Ptr service = serviceAction->service;
 311     QString fileopen = KStandardDirs::locateLocal("tmp", filename.fileName());
 312
 313     if (!saveEqual(fileopen,this))
 314     {
 315         return;
 316     }
 317
 318     KUrl::List list;
 319     list.append(fileopen);
 320
 321     if (!service)
 322     {
 323         KOpenWithDialog dlg(list, this);
 324         if (!dlg.exec())
 325         {
 326             return;
 327         }
 328
 329         service = dlg.service();
 330
 331         if (!service && !dlg.text().isEmpty())
 332         {
 333              KRun::run(dlg.text(), list, this);
 334              return;
 335         }
 336     }
 337
 338     // we have an action with a service, run it!
 339     KRun::run(*service, list, this, true);
 340 }
 341
 342 void KSnapshot::slotPopulateOpenMenu()
 343 {
 344     QList<QAction*> currentActions = openMenu->actions();
 345     foreach (QAction* currentAction, currentActions)
 346     {
 347         openMenu->removeAction(currentAction);
 348         currentAction->deleteLater();
 349     }
 350
 351     KService::List services = KMimeTypeTrader::self()->query( "image/png");
 352     QMap<QString, KService::Ptr> apps;
 353
 354     foreach (const KService::Ptr &service, services)
 355     {
 356         apps.insert(service->name(), service);
 357     }
 358
 359     foreach (const KService::Ptr &service, apps)
 360     {
 361         QString name = service->name().replace( "&", "&&" );
 362         openMenu->addAction(new KSnapshotServiceAction(service,
 363                                                        KIcon(service->icon()),
 364                                                        name, this));
 365     }
 366
 367     openMenu->addSeparator();
 368     KService::Ptr none;
 369     openMenu->addAction(new KSnapshotServiceAction(none,
 370                                                    i18n("Other Application..."),
 371                                                    this));
 372 }
 373
 374 void KSnapshot::slotRegionGrabbed( const QPixmap &pix )
 375 {
 376   if ( !pix.isNull() )
 377   {
 378     snapshot = pix;
 379     updatePreview();
 380     modified = true;
 381     updateCaption();
 382   }
 383
 384   rgnGrab->deleteLater();
 385   QApplication::restoreOverrideCursor();
 386   show();
 387 }
 388
 389 void KSnapshot::slotWindowGrabbed( const QPixmap &pix )
 390 {
 391     if ( !pix.isNull() )
 392     {
 393         snapshot = pix;
 394         updatePreview();
 395         modified = true;
 396         updateCaption();
 397     }
 398
 399     QApplication::restoreOverrideCursor();
 400     show();
 401 }
 402
 403 void KSnapshot::closeEvent( QCloseEvent * e )
 404 {
 405     KConfigGroup conf(KGlobal::config(), "GENERAL");
 406     conf.writeEntry("delay",delay());
 407     conf.writeEntry("mode",mode());
 408     conf.writeEntry("includeDecorations",includeDecorations());
 409     KUrl url = filename;
 410     url.setPass( QString::null );       //krazy:exclude=nullstrassign for old broken gcc
 411     conf.writePathEntry("filename",url.url());
 412
 413     conf.sync();
 414     e->accept();
 415 }
 416
 417 bool KSnapshot::eventFilter( QObject* o, QEvent* e)
 418 {
 419     if ( o == grabber && e->type() == QEvent::MouseButtonPress ) {
 420         QMouseEvent* me = (QMouseEvent*) e;
 421         if ( QWidget::mouseGrabber() != grabber )
 422             return false;
 423         if ( me->button() == Qt::LeftButton )
 424             performGrab();
 425     }
 426     return false;
 427 }
 428
 429 void KSnapshot::updatePreview()
 430 {
 431     setPreview( snapshot );
 432 }
 433
 434 void KSnapshot::grabRegion()
 435 {
 436    rgnGrab = new RegionGrabber();
 437    connect( rgnGrab, SIGNAL( regionGrabbed( const QPixmap & ) ),
 438                      SLOT( slotRegionGrabbed( const QPixmap & ) ) );
 439
 440 }
 441
 442 void KSnapshot::grabTimerDone()
 443 {
 444     if ( mode() == Region ) {
 445        grabRegion();
 446     }
 447     else {
 448         performGrab();
 449     }
 450     KNotification::beep(i18n("The screen has been successfully grabbed."));
 451 }
 452
 453 void KSnapshot::performGrab()
 454 {
 455     grabber->releaseMouse();
 456     grabber->hide();
 457     grabTimer.stop();
 458
 459     title = QString();
 460     windowClass = QString();
 461
 462     if ( mode() == ChildWindow ) {
 463         WindowGrabber wndGrab;
 464         connect( &wndGrab, SIGNAL( windowGrabbed( const QPixmap & ) ),
 465                            SLOT( slotWindowGrabbed( const QPixmap & ) ) );
 466         wndGrab.exec();
 467     }
 468     else if ( mode() == WindowUnderCursor ) {
 469         snapshot = WindowGrabber::grabCurrent( includeDecorations() );
 470
 471         // If we're showing decorations anyway then we'll add the title and window
 472         // class to the output image meta data.
 473         if ( includeDecorations() ) {
 474             title = WindowGrabber::lastWindowTitle();
 475             windowClass = WindowGrabber::lastWindowClass();
 476         }
 477     }
 478     else if ( mode() == CurrentScreen ) {
 479         kDebug() << "Desktop Geom2 = " << QApplication::desktop()->geometry();
 480         QDesktopWidget *desktop = QApplication::desktop();
 481         int screenId = desktop->screenNumber( QCursor::pos() );
 482         kDebug() << "Screenid2 = " << screenId;
 483         QRect geom = desktop->screenGeometry( screenId );
 484         kDebug() << "Geometry2 = " << geom;
 485         snapshot = QPixmap::grabWindow( desktop->winId(),
 486                                         geom.x(), geom.y(), geom.width(), geom.height() );
 487     }
 488     else {
 489         snapshot = QPixmap::grabWindow( QApplication::desktop()->winId() );
 490     }
 491     updatePreview();
 492     QApplication::restoreOverrideCursor();
 493     modified = true;
 494     updateCaption();
 495     show();
 496 }
 497
 498 void KSnapshot::setTime(int newTime)
 499 {
 500     setDelay(newTime);
 501 }
 502
 503 int KSnapshot::timeout() const
 504 {
 505     return delay();
 506 }
 507
 508 void KSnapshot::setURL( const QString &url )
 509 {
 510     changeUrl( url );
 511 }
 512
 513 void KSnapshot::setGrabMode( int m )
 514 {
 515     setMode( m );
 516 }
 517
 518 int KSnapshot::grabMode() const
 519 {
 520     return mode();
 521 }
 522
 523 void KSnapshot::refreshCaption()
 524 {
 525     updateCaption();
 526 }
 527
 528 void KSnapshot::updateCaption()
 529 {
 530     setCaption( filename.fileName(), modified );
 531 }
 532
 533 void KSnapshot::slotMovePointer(int x, int y)
 534 {
 535     QCursor::setPos( x, y );
 536 }
 537
 538 void KSnapshot::exit()
 539 {
 540     reject();
 541 }
 542
 543 void KSnapshot::slotModeChanged( int mode )
 544 {
 545     switch ( mode )
 546     {
 547     case 0:
 548         mainWidget->cbIncludeDecorations->setEnabled(false);
 549         break;
 550     case 1:
 551         mainWidget->cbIncludeDecorations->setEnabled(true);
 552         break;
 553     case 2:
 554         mainWidget->cbIncludeDecorations->setEnabled(false);
 555         break;
 556     case 3:
 557         mainWidget->cbIncludeDecorations->setEnabled(false);
 558         break;
 559     default:
 560         break;
 561     }
 562 }
 563
 564 void KSnapshot::setPreview( const QPixmap &pm )
 565 {
 566     QPixmap pmScaled = pm.scaled( previewWidth(), previewHeight(), Qt::KeepAspectRatio, Qt::SmoothTransformation );
 567
 568     mainWidget->lblImage->setToolTip(
 569         i18n( "Preview of the snapshot image (%1 x %2)" ,
 570           pm.width(), pm.height() ) );
 571
 572     mainWidget->lblImage->setPreview( pmScaled );
 573     mainWidget->lblImage->adjustSize();
 574 }
 575
 576 void KSnapshot::setDelay( int i )
 577 {
 578     mainWidget->spinDelay->setValue(i);
 579 }
 580
 581 void KSnapshot::setIncludeDecorations( bool b )
 582 {
 583     mainWidget->cbIncludeDecorations->setChecked(b);
 584 }
 585
 586 void KSnapshot::setMode( int mode )
 587 {
 588     mainWidget->comboMode->setCurrentIndex(mode);
 589     slotModeChanged(mode);
 590 }
 591
 592 int KSnapshot::delay() const
 593 {
 594     return mainWidget->spinDelay->value();
 595 }
 596
 597 bool KSnapshot::includeDecorations() const
 598 {
 599     return mainWidget->cbIncludeDecorations->isChecked();
 600 }
 601
 602 int KSnapshot::mode() const
 603 {
 604     return mainWidget->comboMode->currentIndex();
 605 }
 606
 607 QPixmap KSnapshot::preview()
 608 {
 609     return *mainWidget->lblImage->pixmap();
 610 }
 611
 612 int KSnapshot::previewWidth() const
 613 {
 614     return mainWidget->lblImage->width();
 615 }
 616
 617 int KSnapshot::previewHeight() const
 618 {
 619     return mainWidget->lblImage->height();
 620 }
 621
 622 #include "ksnapshot.moc"