Ticket #31: basket-tray-screenshot.patch

kmess/kmess.cpp

@@ -138 +138 @@
   delete notificationContactStatus_;
   delete notificationNewEmail_;
   delete nowListeningClient_;
-  delete systemTrayWidget_;
   delete msnNotificationConnection_;
   CurrentAccount::destroy();
 
@@ -1305 +1304 @@
     kdDebug() << "KMess - Couldn't initialize the KMessView widget." << endl;
     return false;
   }
-  if ( !initSystemTrayWidget() )
-  {
-    kdDebug() << "KMess - Couldn't initialize the system tray widget." << endl;
-    return false;
-  }
   if ( !initNotifications() )
   {
     kdDebug() << "KMess - Couldn't initialize the notifications." << endl;
@@ -1733 +1727 @@
 }
 
 
-// Initialize the system tray widget
-bool KMess::initSystemTrayWidget()
-{
-  bool initialized;
 
-  // Create the widget
-  systemTrayWidget_ = new SystemTrayWidget( this, "systemtraywidget" ) ;
-  if ( systemTrayWidget_ == 0 )
-  {
-    kdDebug() << "KMess - Couldn't create system tray widget." << endl;
-    return false;
-  }
-
-  // Initialize the widget
-  initialized = systemTrayWidget_->initialize();
-  if ( !initialized )
-  {
-    kdDebug() << "KMess - Couldn't initialize system tray widget." << endl;
-    return false;
-  }
-
-  // Plug some of the menu actions into the system tray widget's menu.
-  connectActionMenu_-> plug( systemTrayWidget_->menu() );
-  disconnect_->        plug( systemTrayWidget_->menu() );
-  systemTrayWidget_->  menu()->insertSeparator();
-  status_->            plug( systemTrayWidget_->menu() );
-  systemTrayWidget_->  menu()->insertSeparator();
-  settingsActionMenu_->plug( systemTrayWidget_->menu() );
-
-  // Make the connections for the system tray widget
-  connect( systemTrayWidget_, SIGNAL( quitSelected() ),
-           this,              SLOT  (     menuQuit() ) );
-
-  systemTrayWidget_->show();
-#ifdef KMESSTEST
-  ASSERT( systemTrayWidget_ != 0 );
-  ASSERT( systemTrayWidget_->isVisible() );
-#endif
-  return true;
-}
-
-
-
 // Validate a contact email
 bool KMess::isValidEmail( QString email )
 {

kmess/kmess.h

@@ -46 +46 @@
 class KMessTest;
 class KMessView;
 class MsnNotificationConnection;
-class SystemTrayWidget;
 class NowListeningClient;
 
 /**
@@ -107 +106 @@
     bool               initNotifications();
     // Initialize the now listening support.
     bool               initNowListening();
-    // Initialize the system tray widget
-    bool               initSystemTrayWidget();
     // Validate a contact email
     bool               isValidEmail( QString email );
     // Set the caption
@@ -223 +220 @@
     MsnNotificationConnection *msnNotificationConnection_;
     // The menu items of the settings menu
     QDict<AccountAction> settingsMenuItems_;
-    // The system tray widget
-    SystemTrayWidget  *systemTrayWidget_;
     // The main view widget
     KMessView         *view_;
 };

kmess/systemtraywidget.cpp

@@ -17 +17 @@
 
 #include "systemtraywidget.h"
 
+#include <qdockwindow.h>
+#include <qpainter.h>
 #include <qtooltip.h>
 
 #include <kdebug.h>
 #include <klocale.h>
 #include <kpopupmenu.h>
 #include <kiconloader.h>
+#include <kmanagerselection.h>
+#include <kmessagebox.h>
 
 #include "config.h"
 #include "currentaccount.h"
@@ -35 +39 @@
 }
 
 
+/**
+ * Display an Hide On Close dialog window with a trayicon screenshot
+ *
+ * This method, taken from the Basket Note Pads project (see the related links below), is used when
+ * the user closes the main KMess contact list window. Then a custom dialog window is shown to notify
+ * that the app will still run in background. This useful method adds to it a screenshot of the system
+ * tray area of the users' desktop, highlighting the application's icons.
+ *
+ * @see http://basket.kde.org/ - Official site of the Basket Note Pads project
+ * @see http://basket.kde.org/systemtray-on-close-info.php - Specific tray dialog page
+ */
+void SystemTrayWidget::displayCloseMessage( QString /*fileMenu*/ )
+{
+#if KDE_IS_VERSION( 3, 1, 90 )
+  // Don't do all the computations if they are unneeded:
+  if ( ! KMessageBox::shouldBeShownContinue("hideOnCloseInfo") )
+      return;
+#endif
 
+  // Some values we need:
+  QPoint g = mapToGlobal(pos());
+  int desktopWidth  = kapp->desktop()->width();
+  int desktopHeight = kapp->desktop()->height();
+  int tw = width();
+  int th = height();
+
+  // We are trying to make a live screenshot of the systray icon to circle it
+  //  and show it to the user. If no systray is used or if the icon is not visible,
+  //  we should not show that screenshot but only a text!
+
+  // 1. Determine if the user use a system tray area or not:
+  QCString screenstr;
+  screenstr.setNum(qt_xscreen());
+  QCString trayatom = "_NET_SYSTEM_TRAY_S" + screenstr;
+  bool useSystray = (KSelectionWatcher(trayatom).owner() != 0L);
+
+  // 2. And then if the icon is visible too (eg. this->show() has been called):
+  useSystray = useSystray && isVisible();
+
+  // 3. Kicker (or another systray manager) can be visible but masked out of
+  //    the screen (ie. on right or on left of it). We check if the icon isn't
+  //    out of screen.
+  QRect deskRect(0, 0, desktopWidth, desktopHeight);
+  if( useSystray && ( ! deskRect.contains( g.x(), g.y() ) ) && ( ! deskRect.contains( g.x() + tw, g.y() + th ) ) )
+  {
+    useSystray = false;
+  }
+
+
+  QString message = i18n( "Closing the main window will keep KMess running in the"
+                          " system tray. Use 'Quit' from the 'File' menu to quit the application." );
+
+  // If the system tray is not visible, just show the text message
+  if( ! useSystray )
+  {
+#ifdef KMESSDEBUG_SYSTEMTRAY
+    kdDebug() << "SystemTrayWidget::displayCloseMessage() - Displaying simple dialog with no screenshot." << endl;
+#endif
+
+    KMessageBox::information( kapp->activeWindow(), message,
+                              i18n( "Docking in System Tray" ),
+                              "hideOnCloseInfo" );
+    return;
+  }
+
+  // We are sure the systray icon is visible: ouf!
+
+#ifdef KMESSDEBUG_SYSTEMTRAY
+    kdDebug() << "SystemTrayWidget::displayCloseMessage() - Displaying dialog with tray icon screenshot: generating image..." << endl;
+#endif
+
+  // Compute size and position of the pixmap to be grabbed:
+  int w = desktopWidth / 4;
+  int h = desktopHeight / 9;
+  int x = g.x() + tw/2 - w/2; // Center the rectange in the systray icon
+  int y = g.y() + th/2 - h/2;
+  if (x < 0)                 x = 0; // Move the rectangle to stay in the desktop limits
+  if (y < 0)                 y = 0;
+  if (x + w > desktopWidth)  x = desktopWidth - w;
+  if (y + h > desktopHeight) y = desktopHeight - h;
+
+  // Grab the desktop and draw a circle arround the icon:
+  const int CIRCLE_MARGINS = 6;
+  const int CIRCLE_WIDTH   = 3;
+  const int SHADOW_OFFSET  = 1;
+  const int IMAGE_BORDER   = 1;
+  int ax = g.x() - x - CIRCLE_MARGINS - 1;
+  int ay = g.y() - y - CIRCLE_MARGINS - 1;
+  QPixmap shot = QPixmap::grabWindow(qt_xrootwin(), x, y, w, h);
+  QPainter painter(&shot);
+
+  painter.setPen( QPen(KApplication::palette().active().dark(), CIRCLE_WIDTH) );
+  painter.drawArc(ax + SHADOW_OFFSET, ay + SHADOW_OFFSET,
+                  tw + 2*CIRCLE_MARGINS, th + 2*CIRCLE_MARGINS, 0, 16*360);
+  painter.setPen( QPen(Qt::red, CIRCLE_WIDTH) );
+  painter.drawArc(ax, ay, tw + 2*CIRCLE_MARGINS, th + 2*CIRCLE_MARGINS, 0, 16*360);
+
+  // Draw the pixmap over the screenshot in case a window hide the icon:
+  painter.drawPixmap(g.x(), g.y(), *pixmap());
+  painter.end();
+
+  // Then, we add a border arround the image to make it more visible:
+  QPixmap finalShot(w + 2*IMAGE_BORDER, h + 2*IMAGE_BORDER);
+  finalShot.fill(KApplication::palette().active().foreground());
+
+  painter.begin(&finalShot);
+  painter.drawPixmap(IMAGE_BORDER, IMAGE_BORDER, shot);
+  painter.end();
+
+#ifdef KMESSDEBUG_SYSTEMTRAY
+  kdDebug() << "SystemTrayWidget::displayCloseMessage() - ...Done, showing the dialog." << endl;
+#endif
+
+  // Associate source to image and show the dialog:
+  QMimeSourceFactory::defaultFactory()->setPixmap("systray_shot", finalShot);
+
+  KMessageBox::information(kapp->activeWindow(),
+      "<qt>" + message + "<p><center><img source=\"systray_shot\"></center></p></qt>",
+      i18n("Docking in System Tray"), "hideOnCloseInfo");
+
+  QMimeSourceFactory::defaultFactory()->setData("systray_shot", 0L);
+}
+
+
+
 // The destructor
 SystemTrayWidget::~SystemTrayWidget()
 {

kmess/systemtraywidget.h

@@ -37 +37 @@
 
   public:
     // The constructor
-                     SystemTrayWidget(QWidget *parent=0, const char *name=0);
+                     SystemTrayWidget(QWidget *parent=0, const char *name=0);
     // The destructor
-                    ~SystemTrayWidget();
+                    ~SystemTrayWidget();
     // Initialize the class
     bool             initialize();
+    // Display a customized close window with a screenshot of the app's tray icon
+    void             displayCloseMessage( QString fileMenu = QString::null );
     // Return the context menu
     KPopupMenu      *menu() const;
 

kmess/kmessinterface.cpp

@@ -41 +41 @@
 
 #include "kmessdebug.h"
 #include "kmessapplication.h"
+#include "systemtraywidget.h"
 
 
 // The constructor
@@ -57 +58 @@
 // The destructor
 KMessInterface::~KMessInterface()
 {
+  delete systemTrayWidget_;
+
 #ifdef KMESSDEBUG_KMESSINTERFACE
   kdDebug() << "DESTROYED KMessInterface " << endl;
 #endif
@@ -396 +399 @@
   // Create the menus
   createMenus();
 
+  if ( ! initSystemTrayWidget() )
+  {
+    kdDebug() << "KMess - Couldn't initialize the system tray widget." << endl;
+    return false;
+  }
+
 #ifdef KMESSDEBUG_KMESSINTERFACE
   kdDebug() << "KMessInterface - initialized" << endl;
 #endif
@@ -403 +412 @@
 }
 
 
+// Initialize the system tray widget
+bool KMessInterface::initSystemTrayWidget()
+{
+  bool initialized;
+
+  // Create the widget
+  systemTrayWidget_ = new SystemTrayWidget( this, "systemtraywidget" ) ;
+  if ( systemTrayWidget_ == 0 )
+  {
+    kdDebug() << "KMessInterface - Couldn't create system tray widget." << endl;
+    return false;
+  }
+
+  // Initialize the widget
+  initialized = systemTrayWidget_->initialize();
+  if ( !initialized )
+  {
+    kdDebug() << "KMessInterface - Couldn't initialize system tray widget." << endl;
+    return false;
+  }
+
+  // Plug some of the menu actions into the system tray widget's menu.
+  connectActionMenu_-> plug( systemTrayWidget_->menu() );
+  disconnect_->        plug( systemTrayWidget_->menu() );
+  systemTrayWidget_->  menu()->insertSeparator();
+  status_->            plug( systemTrayWidget_->menu() );
+  systemTrayWidget_->  menu()->insertSeparator();
+  settingsActionMenu_->plug( systemTrayWidget_->menu() );
+
+  // Make the connections for the system tray widget
+  connect( systemTrayWidget_, SIGNAL( quitSelected() ),
+           this,              SLOT  (     menuQuit() ) );
+
+  systemTrayWidget_->show();
+#ifdef KMESSTEST
+  ASSERT( systemTrayWidget_ != 0 );
+  ASSERT( systemTrayWidget_->isVisible() );
+#endif
+  return true;
+}
+
+
 // Close has been selected from the menu.
 void KMessInterface::menuClose()
 {
@@ -470 +521 @@
     applicationClosing();
     return true;
   }
-  else
-  {
-    // Tell that KMess is still visible in the tray
-    KMessageBox::information( this,
-                              i18n( "Closing the main window will keep KMess running in the "
-                                    "system tray. Use 'Quit' from the 'File' menu to quit the application." ),
-                              i18n( "Docking in System Tray" ), "hideOnCloseInfo" );
-  }
 
+  // Tell that KMess is still visible in the tray
+  systemTrayWidget_->displayCloseMessage();
+
 #ifdef KMESSDEBUG_KMESSINTERFACE
   kdDebug() << "KMessInterface::queryClose: Rejecting quit request, hiding window" << endl;
 #endif

kmess/kmessinterface.h

@@ -34 +34 @@
 class KPopupMenu;
 class KSelectAction;
 class KToggleAction;
+class SystemTrayWidget;
 
 /**
  * @brief User interface of the KMess class.
@@ -124 +125 @@
     KAction         *showTransferAction_;
     // The select action for the user's status
     KSelectAction   *status_;
+    // The system tray widget
+    SystemTrayWidget *systemTrayWidget_;
     // The menu for selecting the view mode.
     KSelectAction   *viewMode_;
 
@@ -138 +141 @@
     void             createMenus();
     // Create the "View" menu
     void             createViewMenu();
+    // Initialize the system tray widget
+    bool             initSystemTrayWidget();
     // Reject quitting unless the quit menu was pressed
     bool             queryExit();
     // Tell the user that KMess hides in the systray