kdeui/util/kpassivepopup.cpp

   1 /*
   2  *   copyright            : (C) 2001-2006 by Richard Moore
   3  *   copyright            : (C) 2004-2005 by Sascha Cunz
   4  *   License              : This file is released under the terms of the LGPL, version 2.
   5  *   email                : rich@kde.org
   6  *   email                : sascha.cunz@tiscali.de
   7  *
   8  *   This library is free software; you can redistribute it and/or
   9  *   modify it under the terms of the GNU Library General Public
  10  *   License as published by the Free Software Foundation; either
  11  *   version 2 of the License, or (at your option) any later version.
  12  *
  13  *   This library is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *   Library General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU Library General Public License
  19  *   along with this library; see the file COPYING.LIB.  If not, write to
  20  *   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  */
  22
  23 #include "kpassivepopup.h"
  24 #include "kpassivepopup.moc"
  25
  26 // Qt
  27 #include <QApplication>
  28 #include <QBitmap>
  29 #include <QLabel>
  30 #include <QLayout>
  31 #include <QMouseEvent>
  32 #include <QPainter>
  33 #include <QPainterPath>
  34 #include <QPolygonF>
  35 #include <QTimer>
  36 #include <QToolTip>
  37 #include <QSystemTrayIcon>
  38
  39 #include <kvbox.h>
  40 #include <kdebug.h>
  41 #include <kdialog.h>
  42 #include <kglobalsettings.h>
  43
  44 #include <kconfig.h>
  45
  46 #ifdef Q_WS_X11
  47 #include <qx11info_x11.h>
  48 #include <netwm.h>
  49 #endif
  50
  51 #include <config.h>
  52
  53 static const int DEFAULT_POPUP_TYPE = KPassivePopup::Boxed;
  54 static const int DEFAULT_POPUP_TIME = 6*1000;
  55 static const Qt::WindowFlags POPUP_FLAGS = Qt::Tool | Qt::X11BypassWindowManagerHint | Qt::WindowStaysOnTopHint | Qt::FramelessWindowHint;
  56
  57 class KPassivePopup::Private
  58 {
  59 public:
  60     Private()
  61         : popupStyle( DEFAULT_POPUP_TYPE ),
  62           msgView(0),
  63           topLayout(0),
  64           hideDelay( DEFAULT_POPUP_TIME ),
  65           hideTimer(0),
  66           autoDelete( false )
  67     {
  68
  69     }
  70
  71     int popupStyle;
  72     QPolygon surround;
  73     QPoint                    anchor;
  74     QPoint                    fixedPosition;
  75
  76     WId window;
  77     QWidget *msgView;
  78     QBoxLayout *topLayout;
  79     int hideDelay;
  80     QTimer *hideTimer;
  81
  82     QLabel *ttlIcon;
  83     QLabel *ttl;
  84     QLabel *msg;
  85
  86     bool autoDelete;
  87 };
  88
  89 KPassivePopup::KPassivePopup( QWidget *parent, Qt::WFlags f )
  90     : QFrame( 0, f ? f : POPUP_FLAGS ),
  91       d(new Private())
  92 {
  93     init( parent ? parent->effectiveWinId() : 0L );
  94 }
  95
  96 KPassivePopup::KPassivePopup( WId win )
  97     : QFrame( 0 ),
  98       d(new Private())
  99 {
 100     init( win );
 101 }
 102
 103 #if 0 // These break macos and win32 where the definition of WId makes them ambiguous
 104 KPassivePopup::KPassivePopup( int popupStyle, QWidget *parent, Qt::WFlags f )
 105     : QFrame( 0, f ? f : POPUP_FLAGS ),
 106       d(new Private())
 107 {
 108     init( parent ? parent->winId() : 0L );
 109     setPopupStyle( popupStyle );
 110 }
 111
 112 KPassivePopup::KPassivePopup( int popupStyle, WId win, Qt::WFlags f )
 113     : QFrame( 0, f ? f : POPUP_FLAGS ),
 114       d(new Private())
 115 {
 116     init( win );
 117     setPopupStyle( popupStyle );
 118 }
 119 #endif
 120
 121 void KPassivePopup::init( WId window )
 122 {
 123     d->window = window;
 124     d->hideTimer = new QTimer( this );
 125
 126     setWindowFlags( POPUP_FLAGS );
 127     setFrameStyle( QFrame::Box| QFrame::Plain );
 128     setLineWidth( 2 );
 129
 130     if( d->popupStyle == Boxed )
 131     {
 132         setFrameStyle( QFrame::Box| QFrame::Plain );
 133         setLineWidth( 2 );
 134     }
 135     else if( d->popupStyle == Balloon )
 136     {
 137         setPalette(QToolTip::palette());
 138         //XXX dead ? setAutoMask(true);
 139     }
 140     connect( d->hideTimer, SIGNAL( timeout() ), SLOT( hide() ) );
 141     connect( this, SIGNAL( clicked() ), SLOT( hide() ) );
 142 }
 143
 144 KPassivePopup::~KPassivePopup()
 145 {
 146     delete d;
 147 }
 148
 149 void KPassivePopup::setPopupStyle( int popupstyle )
 150 {
 151     if ( d->popupStyle == popupstyle )
 152         return;
 153
 154     d->popupStyle = popupstyle;
 155     if( d->popupStyle == Boxed )
 156     {
 157         setFrameStyle( QFrame::Box| QFrame::Plain );
 158         setLineWidth( 2 );
 159     }
 160     else if( d->popupStyle == Balloon )
 161     {
 162         setPalette(QToolTip::palette());
 163         //XXX dead ? setAutoMask(true);
 164     }
 165 }
 166
 167 void KPassivePopup::setView( QWidget *child )
 168 {
 169     delete d->msgView;
 170     d->msgView = child;
 171
 172     delete d->topLayout;
 173     d->topLayout = new QVBoxLayout( this );
 174     d->topLayout->setMargin( d->popupStyle == Balloon ? 22 : KDialog::marginHint() );
 175     d->topLayout->setSpacing( KDialog::spacingHint() );
 176     d->topLayout->addWidget( d->msgView );
 177     d->topLayout->activate();
 178 }
 179
 180 void KPassivePopup::setView( const QString &caption, const QString &text,
 181                              const QPixmap &icon )
 182 {
 183     // kDebug() << "KPassivePopup::setView " << caption << ", " << text;
 184     setView( standardView( caption, text, icon, this ) );
 185 }
 186
 187
 188 KVBox * KPassivePopup::standardView( const QString& caption,
 189                                      const QString& text,
 190                                      const QPixmap& icon,
 191                                      QWidget *parent )
 192 {
 193     KVBox *vb = new KVBox( parent ? parent : this );
 194     vb->setSpacing( KDialog::spacingHint() );
 195
 196     KHBox *hb=0;
 197     if ( !icon.isNull() ) {
 198         hb = new KHBox( vb );
 199         hb->setMargin( 0 );
 200         hb->setSpacing( KDialog::spacingHint() );
 201         d->ttlIcon = new QLabel( hb );
 202         d->ttlIcon->setPixmap( icon );
 203         d->ttlIcon->setAlignment( Qt::AlignLeft );
 204     }
 205
 206     if ( !caption.isEmpty() ) {
 207         d->ttl = new QLabel( caption, hb ? hb : vb );
 208         QFont fnt = d->ttl->font();
 209         fnt.setBold( true );
 210         d->ttl->setFont( fnt );
 211         d->ttl->setAlignment( Qt::AlignHCenter );
 212
 213         if ( hb )
 214             hb->setStretchFactor( d->ttl, 10 ); // enforce centering
 215     }
 216
 217     if ( !text.isEmpty() ) {
 218         d->msg = new QLabel( text, vb );
 219         d->msg->setAlignment( Qt::AlignLeft );
 220         d->msg->setTextInteractionFlags(Qt::LinksAccessibleByMouse);
 221         d->msg->setOpenExternalLinks(true);
 222     }
 223
 224     return vb;
 225 }
 226
 227 void KPassivePopup::setView( const QString &caption, const QString &text )
 228 {
 229     setView( caption, text, QPixmap() );
 230 }
 231
 232 QWidget *KPassivePopup::view() const
 233 {
 234     return d->msgView;
 235 }
 236
 237 int KPassivePopup::timeout() const
 238 {
 239     return d->hideDelay;
 240 }
 241
 242 void KPassivePopup::setTimeout( int delay )
 243 {
 244     d->hideDelay = delay;
 245     if( d->hideTimer->isActive() )
 246     {
 247         if( delay ) {
 248             d->hideTimer->start( delay );
 249         } else {
 250             d->hideTimer->stop();
 251         }
 252     }
 253 }
 254
 255 bool KPassivePopup::autoDelete() const
 256 {
 257     return d->autoDelete;
 258 }
 259
 260 void KPassivePopup::setAutoDelete( bool autoDelete )
 261 {
 262     d->autoDelete = autoDelete;
 263 }
 264
 265 void KPassivePopup::mouseReleaseEvent( QMouseEvent *e )
 266 {
 267     emit clicked();
 268     emit clicked( e->pos() );
 269 }
 270
 271 //
 272 // Main Implementation
 273 //
 274
 275 void KPassivePopup::setVisible( bool visible )
 276 {
 277     if (! visible ) {
 278         QFrame::setVisible( visible );
 279         return;
 280     }
 281
 282     if ( size() != sizeHint() )
 283         resize( sizeHint() );
 284
 285     if ( d->fixedPosition.isNull() )
 286         positionSelf();
 287     else {
 288         if( d->popupStyle == Balloon )
 289             setAnchor( d->fixedPosition );
 290         else
 291             move( d->fixedPosition );
 292     }
 293     QFrame::setVisible( /*visible=*/ true );
 294
 295     int delay = d->hideDelay;
 296     if ( delay < 0 ) {
 297         delay = DEFAULT_POPUP_TIME;
 298     }
 299
 300     if ( delay > 0 ) {
 301         d->hideTimer->start( delay );
 302     }
 303 }
 304
 305 void KPassivePopup::show()
 306 {
 307     QFrame::show();
 308 }
 309
 310 void KPassivePopup::show(const QPoint &p)
 311 {
 312     d->fixedPosition = p;
 313     show();
 314 }
 315
 316 void KPassivePopup::hideEvent( QHideEvent * )
 317 {
 318     d->hideTimer->stop();
 319     if ( d->autoDelete )
 320         deleteLater();
 321 }
 322
 323 QRect KPassivePopup::defaultArea() const
 324 {
 325 #ifdef Q_WS_X11
 326     NETRootInfo info( QX11Info::display(),
 327                       NET::NumberOfDesktops |
 328                       NET::CurrentDesktop |
 329                       NET::WorkArea,
 330                       -1, false );
 331     info.activate();
 332     NETRect workArea = info.workArea( info.currentDesktop() );
 333     QRect r;
 334     r.setRect( workArea.pos.x, workArea.pos.y, 0, 0 ); // top left
 335 #else
 336     // FIX IT
 337     QRect r;
 338     r.setRect( 100, 100, 200, 200 ); // top left
 339 #endif
 340     return r;
 341 }
 342
 343 void KPassivePopup::positionSelf()
 344 {
 345     QRect target;
 346
 347 #ifdef Q_WS_X11
 348     if ( !d->window ) {
 349         target = defaultArea();
 350     }
 351
 352     else {
 353         NETWinInfo ni( QX11Info::display(), d->window, QX11Info::appRootWindow(),
 354                        NET::WMIconGeometry );
 355
 356         // Figure out where to put the popup. Note that we must handle
 357         // windows that skip the taskbar cleanly
 358         if ( ni.state() & NET::SkipTaskbar ) {
 359             target = defaultArea();
 360         }
 361         else {
 362             NETRect r = ni.iconGeometry();
 363             target.setRect( r.pos.x, r.pos.y, r.size.width, r.size.height );
 364                 if ( target.isNull() ) { // bogus value, use the exact position
 365                     NETRect dummy;
 366                     ni.kdeGeometry( dummy, r );
 367                     target.setRect( r.pos.x, r.pos.y,
 368                                     r.size.width, r.size.height);
 369                 }
 370         }
 371     }
 372 #else
 373         target = defaultArea();
 374 #endif
 375     moveNear( target );
 376 }
 377
 378 void KPassivePopup::moveNear( const QRect &target )
 379 {
 380     QPoint pos = calculateNearbyPoint(target);
 381     if( d->popupStyle == Balloon )
 382         setAnchor( pos );
 383     else
 384         move( pos.x(), pos.y() );
 385 }
 386
 387 QPoint KPassivePopup::calculateNearbyPoint( const QRect &target) {
 388     QPoint pos = target.topLeft();
 389     int x = pos.x();
 390     int y = pos.y();
 391     int w = minimumSizeHint().width();
 392     int h = minimumSizeHint().height();
 393
 394     QRect r = KGlobalSettings::desktopGeometry(QPoint(x+w/2,y+h/2));
 395
 396     if( d->popupStyle == Balloon )
 397     {
 398         // find a point to anchor to
 399         if( x + w > r.width() ){
 400             x = x + target.width();
 401         }
 402
 403         if( y + h > r.height() ){
 404             y = y + target.height();
 405         }
 406     } else
 407     {
 408         if ( x < r.center().x() )
 409             x = x + target.width();
 410         else
 411             x = x - w;
 412
 413         // It's apparently trying to go off screen, so display it ALL at the bottom.
 414         if ( (y + h) > r.bottom() )
 415             y = r.bottom() - h;
 416
 417         if ( (x + w) > r.right() )
 418             x = r.right() - w;
 419     }
 420     if ( y < r.top() )
 421         y = r.top();
 422
 423     if ( x < r.left() )
 424         x = r.left();
 425
 426     return QPoint( x, y );
 427 }
 428
 429 QPoint KPassivePopup::anchor() const
 430 {
 431     return d->anchor;
 432 }
 433
 434 void KPassivePopup::setAnchor(const QPoint &anchor)
 435 {
 436     d->anchor = anchor;
 437     updateMask();
 438 }
 439
 440 void KPassivePopup::paintEvent( QPaintEvent* pe )
 441 {
 442     if( d->popupStyle == Balloon )
 443     {
 444         QPainter p;
 445         p.begin( this );
 446         p.drawPolygon( d->surround );
 447     } else
 448         QFrame::paintEvent( pe );
 449 }
 450
 451 void KPassivePopup::updateMask()
 452 {
 453     // get screen-geometry for screen our anchor is on
 454     // (geometry can differ from screen to screen!
 455     QRect deskRect = KGlobalSettings::desktopGeometry(d->anchor);
 456
 457     int xh = 70, xl = 40;
 458     if( width() < 80 )
 459         xh = xl = 40;
 460     else if( width() < 110 )
 461         xh = width() - 40;
 462
 463     bool bottom = (d->anchor.y() + height()) > ((deskRect.y() + deskRect.height()-48));
 464     bool right = (d->anchor.x() + width()) > ((deskRect.x() + deskRect.width()-48));
 465
 466     QPoint corners[4] = {
 467         QPoint( width() - 50, 10 ),
 468         QPoint( 10, 10 ),
 469         QPoint( 10, height() - 50 ),
 470         QPoint( width() - 50, height() - 50 )
 471     };
 472
 473     QBitmap mask( width(), height() );
 474     mask.clear();
 475     QPainter p( &mask );
 476     QBrush brush( Qt::color1, Qt::SolidPattern );
 477     p.setBrush( brush );
 478
 479     int i = 0, z = 0;
 480     for (; i < 4; ++i) {
 481         QPainterPath path;
 482         path.moveTo(corners[i].x(),corners[i].y());
 483         path.arcTo(corners[i].x(),corners[i].y(),40,40, i * 90 , 90);
 484         QPolygon corner = path.toFillPolygon().toPolygon();
 485
 486         d->surround.resize( z + corner.count() - 1 );
 487         for (int s = 1; s < corner.count() - 1; s++, z++) {
 488             d->surround.setPoint( z, corner[s] );
 489         }
 490
 491         if (bottom && i == 2) {
 492             if (right) {
 493                 d->surround.resize( z + 3 );
 494                 d->surround.setPoint( z++, QPoint( width() - xh, height() - 10 ) );
 495                 d->surround.setPoint( z++, QPoint( width() - 20, height() ) );
 496                 d->surround.setPoint( z++, QPoint( width() - xl, height() - 10 ) );
 497             } else {
 498                 d->surround.resize( z + 3 );
 499                 d->surround.setPoint( z++, QPoint( xl, height() - 10 ) );
 500                 d->surround.setPoint( z++, QPoint( 20, height() ) );
 501                 d->surround.setPoint( z++, QPoint( xh, height() - 10 ) );
 502             }
 503         } else if (!bottom && i == 0) {
 504             if (right) {
 505                 d->surround.resize( z + 3 );
 506                 d->surround.setPoint( z++, QPoint( width() - xl, 10 ) );
 507                 d->surround.setPoint( z++, QPoint( width() - 20, 0 ) );
 508                 d->surround.setPoint( z++, QPoint( width() - xh, 10 ) );
 509             } else {
 510                 d->surround.resize( z + 3 );
 511                 d->surround.setPoint( z++, QPoint( xh, 10 ) );
 512                 d->surround.setPoint( z++, QPoint( 20, 0 ) );
 513                 d->surround.setPoint( z++, QPoint( xl, 10 ) );
 514             }
 515         }
 516     }
 517
 518     d->surround.resize( z + 1 );
 519     d->surround.setPoint( z, d->surround[0] );
 520     p.drawPolygon( d->surround );
 521     setMask(mask);
 522
 523     move( right ? d->anchor.x() - width() + 20 : ( d->anchor.x() < 11 ? 11 : d->anchor.x() - 20 ),
 524           bottom ? d->anchor.y() - height() : ( d->anchor.y() < 11 ? 11 : d->anchor.y() ) );
 525
 526     update();
 527 }
 528
 529 //
 530 // Convenience Methods
 531 //
 532
 533 KPassivePopup *KPassivePopup::message( const QString &caption, const QString &text,
 534                                        const QPixmap &icon,
 535                                        QWidget *parent, int timeout )
 536 {
 537     return message( DEFAULT_POPUP_TYPE, caption, text, icon, parent, timeout );
 538 }
 539
 540 KPassivePopup *KPassivePopup::message( const QString &text, QWidget *parent )
 541 {
 542     return message( DEFAULT_POPUP_TYPE, QString(), text, QPixmap(), parent );
 543 }
 544
 545 KPassivePopup *KPassivePopup::message( const QString &caption, const QString &text,
 546                                        QWidget *parent )
 547 {
 548     return message( DEFAULT_POPUP_TYPE, caption, text, QPixmap(), parent );
 549 }
 550
 551 KPassivePopup *KPassivePopup::message( const QString &caption, const QString &text,
 552                                        const QPixmap &icon, WId parent, int timeout )
 553 {
 554     return message( DEFAULT_POPUP_TYPE, caption, text, icon, parent, timeout );
 555 }
 556
 557 KPassivePopup *KPassivePopup::message( const QString &caption, const QString &text,
 558                        const QPixmap &icon,
 559                        QSystemTrayIcon *parent, int timeout )
 560 {
 561     return message( DEFAULT_POPUP_TYPE, caption, text, icon, parent, timeout );
 562 }
 563
 564 KPassivePopup *KPassivePopup::message( const QString &text, QSystemTrayIcon *parent )
 565 {
 566     return message( DEFAULT_POPUP_TYPE, QString(), text, QPixmap(), parent );
 567 }
 568
 569 KPassivePopup *KPassivePopup::message( const QString &caption, const QString &text,
 570                        QSystemTrayIcon *parent )
 571 {
 572     return message( DEFAULT_POPUP_TYPE, caption, text, QPixmap(), parent );
 573 }
 574
 575
 576 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &caption, const QString &text,
 577                                        const QPixmap &icon,
 578                                        QWidget *parent, int timeout )
 579 {
 580     KPassivePopup *pop = new KPassivePopup( parent );
 581     pop->setPopupStyle( popupStyle );
 582     pop->setAutoDelete( true );
 583     pop->setView( caption, text, icon );
 584     pop->d->hideDelay = timeout;
 585     pop->show();
 586
 587     return pop;
 588 }
 589
 590 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &text, QWidget *parent )
 591 {
 592     return message( popupStyle, QString(), text, QPixmap(), parent );
 593 }
 594
 595 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &caption, const QString &text,
 596                                        QWidget *parent )
 597 {
 598     return message( popupStyle, caption, text, QPixmap(), parent );
 599 }
 600
 601 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &caption, const QString &text,
 602                                        const QPixmap &icon, WId parent, int timeout )
 603 {
 604     KPassivePopup *pop = new KPassivePopup( parent );
 605     pop->setPopupStyle( popupStyle );
 606     pop->setAutoDelete( true );
 607     pop->setView( caption, text, icon );
 608     pop->d->hideDelay = timeout;
 609     pop->show();
 610
 611     return pop;
 612 }
 613
 614 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &caption, const QString &text,
 615                        const QPixmap &icon,
 616                        QSystemTrayIcon *parent, int timeout )
 617 {
 618     KPassivePopup *pop = new KPassivePopup( );
 619     pop->setPopupStyle( popupStyle );
 620     pop->setAutoDelete( true );
 621     pop->setView( caption, text, icon );
 622     pop->d->hideDelay = timeout;
 623     QPoint pos = pop->calculateNearbyPoint(parent->geometry());
 624     pop->show(pos);
 625     pop->moveNear(parent->geometry());
 626
 627     return pop;
 628 }
 629
 630 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &text, QSystemTrayIcon *parent )
 631 {
 632     return message( popupStyle, QString(), text, QPixmap(), parent );
 633 }
 634
 635 KPassivePopup *KPassivePopup::message( int popupStyle, const QString &caption, const QString &text,
 636                        QSystemTrayIcon *parent )
 637 {
 638     return message( popupStyle, caption, text, QPixmap(), parent );
 639 }
 640
 641
 642 // Local Variables:
 643 // c-basic-offset: 4
 644 // End: