The WebPreviews are now controlled via a neat state machine
authorMarcus Eggenberger <egs@quassel-irc.org>
Wed, 4 Feb 2009 21:47:22 +0000 (22:47 +0100)
committerMarcus Eggenberger <egs@quassel-irc.org>
Wed, 4 Feb 2009 21:47:22 +0000 (22:47 +0100)
This should tame WebPreviews a bit.
New Numbers:
 - after 0.5 seconds of hover the web preview starts to load
 - after another second the preview is shown
 - 5 seconds after hover out the web preview will be deleted internaly

src/qtui/chatscene.cpp
src/qtui/chatscene.h

index 60f3f1b..c6341ec 100644 (file)
@@ -97,11 +97,8 @@ ChatScene::ChatScene(QAbstractItemModel *model, const QString &idString, qreal w
     rowsInserted(QModelIndex(), 0, model->rowCount() - 1);
 
 #ifdef HAVE_WEBKIT
     rowsInserted(QModelIndex(), 0, model->rowCount() - 1);
 
 #ifdef HAVE_WEBKIT
-  webPreview.delayTimer.setSingleShot(true);
-  connect(&webPreview.delayTimer, SIGNAL(timeout()), this, SLOT(showWebPreviewEvent()));
-  //webPreview.deleteTimer.setInterval(600000);
-  webPreview.deleteTimer.setInterval(10000);
-  connect(&webPreview.deleteTimer, SIGNAL(timeout()), this, SLOT(deleteWebPreviewEvent()));
+  webPreview.timer.setSingleShot(true);
+  connect(&webPreview.timer, SIGNAL(timeout()), this, SLOT(webPreviewNextStep()));
 #endif
   _showWebPreview = defaultSettings.showWebPreview();
   defaultSettings.notify("ShowWebPreview", this, SLOT(showWebPreviewChanged()));
 #endif
   _showWebPreview = defaultSettings.showWebPreview();
   defaultSettings.notify("ShowWebPreview", this, SLOT(showWebPreviewChanged()));
@@ -851,82 +848,129 @@ bool ChatScene::event(QEvent *e) {
   return QGraphicsScene::event(e);
 }
 
   return QGraphicsScene::event(e);
 }
 
-/******** WEB PREVIEW *****************************************************************************/
-
+// ========================================
+//  Webkit Only stuff
+// ========================================
+#ifdef HAVE_WEBKIT
 void ChatScene::loadWebPreview(ChatItem *parentItem, const QString &url, const QRectF &urlRect) {
 void ChatScene::loadWebPreview(ChatItem *parentItem, const QString &url, const QRectF &urlRect) {
-#ifndef HAVE_WEBKIT
-  Q_UNUSED(parentItem)
-  Q_UNUSED(url)
-  Q_UNUSED(urlRect)
-#else
   if(!_showWebPreview)
     return;
 
   if(!_showWebPreview)
     return;
 
+  if(webPreview.urlRect != urlRect)
+    webPreview.urlRect = urlRect;
+
   if(webPreview.parentItem != parentItem)
     webPreview.parentItem = parentItem;
 
   if(webPreview.url != url) {
     webPreview.url = url;
   if(webPreview.parentItem != parentItem)
     webPreview.parentItem = parentItem;
 
   if(webPreview.url != url) {
     webPreview.url = url;
-    // load a new web view and delete the old one (if exists)
+    // prepare to load a different URL
     if(webPreview.previewItem && webPreview.previewItem->scene()) {
       removeItem(webPreview.previewItem);
       delete webPreview.previewItem;
     if(webPreview.previewItem && webPreview.previewItem->scene()) {
       removeItem(webPreview.previewItem);
       delete webPreview.previewItem;
+      webPreview.previewItem = 0;
     }
     }
-    webPreview.previewItem = new WebPreviewItem(url);
-    webPreview.delayTimer.start(2000);
-    webPreview.deleteTimer.stop();
-  } else if(webPreview.previewItem && !webPreview.previewItem->scene()) {
-      // we just have to readd the item to the scene
-      webPreview.delayTimer.start(2000);
-      webPreview.deleteTimer.stop();
-  }
-  if(webPreview.urlRect != urlRect) {
-    webPreview.urlRect = urlRect;
-    qreal previewY = urlRect.bottom();
-    qreal previewX = urlRect.x();
-    if(previewY + webPreview.previewItem->boundingRect().height() > sceneRect().bottom())
-      previewY = urlRect.y() - webPreview.previewItem->boundingRect().height();
-
-    if(previewX + webPreview.previewItem->boundingRect().width() > sceneRect().width())
-      previewX = sceneRect().right() - webPreview.previewItem->boundingRect().width();
-
-    webPreview.previewItem->setPos(previewX, previewY);
+    webPreview.previewState = WebPreview::NoPreview;
   }
   }
-#endif
-}
 
 
-void ChatScene::showWebPreviewEvent() {
-#ifdef HAVE_WEBKIT
-  if(webPreview.previewItem)
-    addItem(webPreview.previewItem);
-#endif
-}
+  if(webPreview.url.isEmpty())
+    return;
 
 
-void ChatScene::clearWebPreview(ChatItem *parentItem) {
-#ifndef HAVE_WEBKIT
-  Q_UNUSED(parentItem)
-#else
-  if(parentItem == 0 || webPreview.parentItem == parentItem) {
-    if(webPreview.previewItem && webPreview.previewItem->scene()) {
+  // qDebug() << Q_FUNC_INFO << webPreview.previewState;
+  switch(webPreview.previewState) {
+  case WebPreview::NoPreview:
+    webPreview.previewState = WebPreview::NewPreview;
+    webPreview.timer.start(500);
+    break;
+  case WebPreview::NewPreview:
+  case WebPreview::DelayPreview:
+  case WebPreview::ShowPreview:
+    // we're already waiting for the next step or showing the preview
+    break;
+  case WebPreview::HidePreview:
+    // we still have a valid preview
+    webPreview.previewState = WebPreview::DelayPreview;
+    webPreview.timer.start(1000);
+    break;
+  }
+  // qDebug() << "  new State:" << webPreview.previewState << webPreview.timer.isActive();
+}
+
+void ChatScene::webPreviewNextStep() {
+  // qDebug() << Q_FUNC_INFO << webPreview.previewState;
+  switch(webPreview.previewState) {
+  case WebPreview::NoPreview:
+    break;
+  case WebPreview::NewPreview:
+    Q_ASSERT(!webPreview.previewItem);
+    webPreview.previewItem = new WebPreviewItem(webPreview.url);
+    webPreview.previewState = WebPreview::DelayPreview;
+    webPreview.timer.start(1000);
+    break;
+  case WebPreview::DelayPreview:
+    Q_ASSERT(webPreview.previewItem);
+    // calc position and show
+    {
+      qreal previewY = webPreview.urlRect.bottom();
+      qreal previewX = webPreview.urlRect.x();
+      if(previewY + webPreview.previewItem->boundingRect().height() > sceneRect().bottom())
+       previewY = webPreview.urlRect.y() - webPreview.previewItem->boundingRect().height();
+
+      if(previewX + webPreview.previewItem->boundingRect().width() > sceneRect().width())
+       previewX = sceneRect().right() - webPreview.previewItem->boundingRect().width();
+
+      webPreview.previewItem->setPos(previewX, previewY);
+    }
+    addItem(webPreview.previewItem);
+    webPreview.previewState = WebPreview::ShowPreview;
+    break;
+  case WebPreview::ShowPreview:
+    qWarning() << "ChatScene::webPreviewNextStep() called while in ShowPreview Step!";
+    qWarning() << "removing preview";
+    if(webPreview.previewItem && webPreview.previewItem->scene())
       removeItem(webPreview.previewItem);
       removeItem(webPreview.previewItem);
-      webPreview.deleteTimer.start();
+    // Fall through to deletion!
+  case WebPreview::HidePreview:
+    if(webPreview.previewItem) {
+      delete webPreview.previewItem;
+      webPreview.previewItem = 0;
     }
     }
-    webPreview.delayTimer.stop();
+    webPreview.parentItem = 0;
+    webPreview.url = QString();
+    webPreview.urlRect = QRectF();
+    webPreview.previewState = WebPreview::NoPreview;
   }
   }
-#endif
+  // qDebug() << "  new State:" << webPreview.previewState << webPreview.timer.isActive();
 }
 
 }
 
-void ChatScene::deleteWebPreviewEvent() {
-#ifdef HAVE_WEBKIT
-  if(webPreview.previewItem) {
-    delete webPreview.previewItem;
-    webPreview.previewItem = 0;
-  }
-  webPreview.parentItem = 0;
-  webPreview.url = QString();
-  webPreview.urlRect = QRectF();
-#endif
+void ChatScene::clearWebPreview(ChatItem *parentItem) {
+  // qDebug() << Q_FUNC_INFO << webPreview.previewState;
+  switch(webPreview.previewState) {
+  case WebPreview::NewPreview:
+    webPreview.previewState = WebPreview::NoPreview; // we haven't loaded anything yet
+    break;
+  case WebPreview::ShowPreview:
+    if(parentItem == 0 || webPreview.parentItem == parentItem) {
+      if(webPreview.previewItem && webPreview.previewItem->scene())
+       removeItem(webPreview.previewItem);
+    }
+    // fall through into to set hidden state
+  case WebPreview::DelayPreview:
+    // we're just loading, so haven't shown the preview yet.
+    webPreview.previewState = WebPreview::HidePreview;
+    webPreview.timer.start(5000);
+    break;
+  case WebPreview::NoPreview:
+  case WebPreview::HidePreview:
+    break;
+  }
+  // qDebug() << "  new State:" << webPreview.previewState << webPreview.timer.isActive();
 }
 }
+#endif
+
+// ========================================
+//  end of webkit only
+// ========================================
 
 void ChatScene::showWebPreviewChanged() {
   ChatViewSettings settings;
 
 void ChatScene::showWebPreviewChanged() {
   ChatViewSettings settings;
index 4d66f64..3ec77f5 100644 (file)
@@ -120,8 +120,10 @@ public:
 
   void requestBacklog();
 
 
   void requestBacklog();
 
+#ifdef HAVE_WEBKIT
   void loadWebPreview(ChatItem *parentItem, const QString &url, const QRectF &urlRect);
   void clearWebPreview(ChatItem *parentItem = 0);
   void loadWebPreview(ChatItem *parentItem, const QString &url, const QRectF &urlRect);
   void clearWebPreview(ChatItem *parentItem = 0);
+#endif
 
 signals:
   void lastLineChanged(QGraphicsItem *item, qreal offset);
 
 signals:
   void lastLineChanged(QGraphicsItem *item, qreal offset);
@@ -143,8 +145,9 @@ protected slots:
 private slots:
   void firstHandlePositionChanged(qreal xpos);
   void secondHandlePositionChanged(qreal xpos);
 private slots:
   void firstHandlePositionChanged(qreal xpos);
   void secondHandlePositionChanged(qreal xpos);
-  void showWebPreviewEvent();
-  void deleteWebPreviewEvent();
+#ifdef HAVE_WEBKIT
+  void webPreviewNextStep();
+#endif
   void showWebPreviewChanged();
 
   void clickTimeout();
   void showWebPreviewChanged();
 
   void clickTimeout();
@@ -187,16 +190,25 @@ private:
 
   bool _showWebPreview;
 
 
   bool _showWebPreview;
 
+#ifdef HAVE_WEBKIT
   struct WebPreview {
   struct WebPreview {
+    enum PreviewState {
+      NoPreview,
+      NewPreview,
+      DelayPreview,
+      ShowPreview,
+      HidePreview
+    };
     ChatItem *parentItem;
     QGraphicsItem *previewItem;
     QString url;
     QRectF urlRect;
     ChatItem *parentItem;
     QGraphicsItem *previewItem;
     QString url;
     QRectF urlRect;
-    QTimer delayTimer;
-    QTimer deleteTimer;
-    WebPreview() : parentItem(0), previewItem(0) {}
+    PreviewState previewState;
+    QTimer timer;
+    WebPreview() : parentItem(0), previewItem(0), previewState(NoPreview) {}
   };
   WebPreview webPreview;
   };
   WebPreview webPreview;
+#endif // HAVE_WEBKIT
 };
 
 #endif
 };
 
 #endif