Changeset 77723 in vbox

Timestamp:

Mar 15, 2019 12:52:07 PM (6 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:9378. Implementing search resul navigation.

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• manager/chooser/UIChooserItem.cpp (modified) (1 diff)
• manager/chooser/UIChooserItemGroup.cpp (modified) (2 diffs)
• manager/chooser/UIChooserItemGroup.h (modified) (2 diffs)
• manager/chooser/UIChooserModel.cpp (modified) (10 diffs)
• manager/chooser/UIChooserModel.h (modified) (4 diffs)
• manager/chooser/UIChooserSearchWidget.cpp (modified) (6 diffs)
• manager/chooser/UIChooserSearchWidget.h (modified) (4 diffs)
• manager/chooser/UIChooserView.cpp (modified) (6 diffs)
• manager/chooser/UIChooserView.h (modified) (3 diffs)
• widgets/UISearchLineEdit.cpp (modified) (2 diffs)
• widgets/UISearchLineEdit.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserItem.cpp

@@ -463 +463 @@
 void UIChooserItem::makeSureItsVisible()
 {
-    /* If item is not visible: */
+    /* Get parrent item: */
+    UIChooserItemGroup *pParentItem = parentItem()->toGroupItem();
+    if (!pParentItem)
+        return;
+    /* If item is not visible. That is all the parent group(s) are opened (expanded): */
     if (!isVisible())
     {
-        /* Get parrent item, assert if can't: */
-        if (UIChooserItemGroup *pParentItem = parentItem()->toGroupItem())
-        {
-            /* We should make parent visible: */
-            pParentItem->makeSureItsVisible();
-            /* And make sure its opened: */
-            if (pParentItem->isClosed())
-                pParentItem->open(false);
-        }
-    }
+        /* We should make parent visible: */
+        pParentItem->makeSureItsVisible();
+        /* And make sure its opened: */
+        if (pParentItem->isClosed())
+            pParentItem->open(false);
+    }
+    /* Make sure we scroll to the item's rectangle: */
+    pParentItem->makeSureItemIsVisible(this);
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserItemGroup.cpp

@@ -142 +142 @@
 {
     return "UIChooserItemGroup";
+}
+
+void UIChooserItemGroup::makeSureItemIsVisible(UIChooserItem *pItem)
+{
+    /* Make sure item exists: */
+    AssertPtrReturnVoid(pItem);
+
+    /* Convert child rectangle to local coordinates for this group. This also
+     * works for a child at any sub-level, doesn't necessary of this group. */
+    const QPointF positionInScene = pItem->mapToScene(QPointF(0, 0));
+    const QPointF positionInGroup = mapFromScene(positionInScene);
+    const QRectF itemRectInGroup = QRectF(positionInGroup, pItem->size());
+    m_pScrollArea->makeSureRectIsVisible(itemRectInGroup);
 }
 
@@ -695 +708 @@
     /* Else call to base-class: */
     return UIChooserItem::sizeHint(enmWhich, constraint);
-}
-
-void UIChooserItemGroup::makeSureItemIsVisible(UIChooserItem *pItem)
-{
-    /* Make sure item exists: */
-    AssertPtrReturnVoid(pItem);
-
-    /* Convert child rectangle to local coordinates for this group. This also
-     * works for a child at any sub-level, doesn't necessary of this group. */
-    const QPointF positionInScene = pItem->mapToScene(QPointF(0, 0));
-    const QPointF positionInGroup = mapFromScene(positionInScene);
-    const QRectF itemRectInGroup = QRectF(positionInGroup, pItem->size());
-    m_pScrollArea->makeSureRectIsVisible(itemRectInGroup);
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserItemGroup.h

@@ -86 +86 @@
         /** Class-name used for drag&drop mime-data format. */
         static QString className();
+        /** Makes sure passed child @a pItem is visible. */
+        virtual void makeSureItemIsVisible(UIChooserItem *pItem) /* override */;
     /** @} */
 
@@ -168 +170 @@
     /** @name Navigation stuff.
       * @{ */
-        /** Makes sure passed child @a pItem is visible. */
-        virtual void makeSureItemIsVisible(UIChooserItem *pItem) /* override */;
-
         /** Returns pixmap item representation. */
         virtual QPixmap toPixmap() /* override */;

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserModel.cpp

@@ -68 +68 @@
     , m_pContextMenuGroup(0)
     , m_pContextMenuMachine(0)
+    , m_iCurrentScrolledIndex(-1)
     , m_pInvisibleRootNode(0)
     , m_iScrollingTokenSize(30)
@@ -131 +132 @@
 {
     return m_pScene;
+}
+
+UIChooserView *UIChooserModel::view()
+{
+    if (!scene())
+        return 0;
+    UIChooserView *pChooserView = qobject_cast<UIChooserView*>(scene()->views()[0]);
+    return pChooserView;
 }
 
@@ -426 +435 @@
 
     /* If dialog is visible and item exists => make it visible as well: */
-    if (scene()->views()[0]->window()->isVisible() && pItem)
-        root()->makeSureItemIsVisible(pItem);
+    if (view() && view()->window() && root())
+        if (view()->window()->isVisible() && pItem)
+            root()->makeSureItemIsVisible(pItem);
 }
 
@@ -459 +469 @@
     /* Currently we perform the search only for machines. when this to be changed make sure the disabled flags
        of the other item types are also managed correctly: */
+
+    QList<UIChooserNode*> allNodes = resetSearch();
+    if (strSearchTerm.isEmpty())
+        return;
+
+    m_pInvisibleRootNode->searchForNodes(strSearchTerm, iItemSearchFlags, m_searchResults);
+
+    foreach (UIChooserNode* pNode, allNodes)
+    {
+        if (!pNode)
+            continue;
+        pNode->setDisabled(!m_searchResults.contains(pNode));
+    }
+
+    scrollToSearchResult(true);
+}
+
+QList<UIChooserNode*> UIChooserModel::resetSearch()
+{
     QList<UIChooserNode*> allNodes;
     /* Calling UIChooserNode::searchForNodes with an empty search string returns a list all nodes (of the whole treee) of the required type: */
-    m_pInvisibleRootNode->searchForNodes(QString(), iItemSearchFlags, allNodes);
+    m_pInvisibleRootNode->searchForNodes(QString(), UIChooserItemSearchFlag_Machine, allNodes);
 
     /* Reset the disabled flag of the node items first. */
@@ -470 +499 @@
         pNode->setDisabled(false);
     }
-
-    if (strSearchTerm.isEmpty())
-        return;
-
-    QList<UIChooserNode*> matchedNodes;
-    m_pInvisibleRootNode->searchForNodes(strSearchTerm, iItemSearchFlags, matchedNodes);
-
-    foreach (UIChooserNode* pNode, allNodes)
-    {
-        if (!pNode)
-            continue;
-        pNode->setDisabled(!matchedNodes.contains(pNode));
-    }
+    /* Reset the search result relate data: */
+    m_searchResults.clear();
+    m_iCurrentScrolledIndex = -1;
+    return allNodes;
+}
+
+void UIChooserModel::scrollToSearchResult(bool fIsNext)
+{
+    if (m_searchResults.isEmpty())
+    {
+        m_iCurrentScrolledIndex = -1;
+        if (view())
+            view()->setSearchResultsCount(m_searchResults.size(), m_iCurrentScrolledIndex);
+        return;
+    }
+
+    if (fIsNext)
+    {
+        if (++m_iCurrentScrolledIndex >= m_searchResults.size())
+            m_iCurrentScrolledIndex = 0;
+    }
+    else
+    {
+        if (m_iCurrentScrolledIndex < 0)
+            m_iCurrentScrolledIndex = m_searchResults.size() - 1;
+    }
+
+    if (m_searchResults.at(m_iCurrentScrolledIndex))
+    {
+        UIChooserItem *pItem = m_searchResults.at(m_iCurrentScrolledIndex)->item();
+        if (pItem)
+        {
+            pItem->makeSureItsVisible();
+        }
+    }
+
+
+    /* Update the search widget's match count(s): */
+    if (view())
+        view()->setSearchResultsCount(m_searchResults.size(), m_iCurrentScrolledIndex);
+
 }
 
@@ -619 +676 @@
 void UIChooserModel::updateLayout()
 {
+    if (!view() || !root())
+        return;
+
     /* Initialize variables: */
-    const QSize viewportSize = scene()->views()[0]->size();
+    const QSize viewportSize = view()->size();
     const int iViewportWidth = viewportSize.width();
     const int iViewportHeight = viewportSize.height();
@@ -814 +874 @@
 void UIChooserModel::sltShowHideSearchWidget()
 {
-    UIChooserView *pChooserView = qobject_cast<UIChooserView*>(scene()->views()[0]);
+    UIChooserView *pChooserView = view();
     if (!pChooserView)
         return;
@@ -1182 +1242 @@
 
     /* Get view/scrollbar: */
-    QGraphicsView *pView = scene()->views()[0];
+    QGraphicsView *pView = view();
     QScrollBar *pVerticalScrollBar = pView->verticalScrollBar();
 
@@ -1947 +2007 @@
     /* Install root as event-filter for scene view,
      * we need QEvent::Scroll events from it: */
-    root()->installEventFilterHelper(scene()->views()[0]);
+    root()->installEventFilterHelper(view());
 }
 
@@ -2049 +2109 @@
 
     /* Get view: */
-    QGraphicsView *pView = scene()->views()[0];
+    QGraphicsView *pView = view();
 
     /* Check scroll-area: */

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserModel.h

@@ -42 +42 @@
 class UIChooserItem;
 class UIChooserNode;
+class UIChooserView;
 class UIVirtualMachineItem;
 class CMachine;
@@ -191 +192 @@
         /** Performs a search starting from the m_pInvisibleRootNode. */
         void performSearch(const QString &strSearchTerm, int iItemSearchFlags);
+        /** Clean the search result data members and disables item's visual effects. Also returns a list of
+          * all nodes which may be utilized by the calling code. */
+        QList<UIChooserNode*> resetSearch();
+        void scrollToSearchResult(bool fIsNext);
     /** @} */
 
@@ -359 +364 @@
         /** Popups context-menu of certain @a enmType in specified @a point. */
         void popupContextMenu(UIGraphicsSelectorContextMenuType enmType, QPoint point);
+        /** Returns the reference of the first view of the scene(). */
+        UIChooserView *view();
     /** @} */
 
@@ -464 +471 @@
     /** @} */
 
+    /** @name Virtual Machine/Group search stuff.
+      * @{ */
+        /** Stores the results of the current search. */
+        QList<UIChooserNode*> m_searchResults;
+        /** Stores the index (within the m_searchResults) of the currently scrolled item. */
+        int m_iCurrentScrolledIndex;
+    /** @} */
+
     /** @name Children stuff.
       * @{ */

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserSearchWidget.cpp

@@ -21 +21 @@
 /* GUI includes: */
 #include "QILineEdit.h"
+#include "QIToolButton.h"
 #include "UIChooserDefs.h"
 #include "UIChooserSearchWidget.h"
+#include "UIIconPool.h"
+#include "UISearchLineEdit.h"
 
 UIChooserSearchWidget::UIChooserSearchWidget(QWidget *pParent)
@@ -28 +31 @@
     , m_pLineEdit(0)
     , m_pMainLayout(0)
-
+    , m_pScrollToNextMatchButton(0)
+    , m_pScrollToPreviousMatchButton(0)
 {
     prepareWidgets();
     prepareConnections();
+}
+
+void UIChooserSearchWidget::setMatchCount(int iMatchCount)
+{
+    if (!m_pLineEdit)
+        return;
+    m_pLineEdit->setMatchCount(iMatchCount);
+}
+
+void UIChooserSearchWidget::setScroolToIndex(int iScrollToIndex)
+{
+    if (!m_pLineEdit)
+        return;
+    m_pLineEdit->setScroolToIndex(iScrollToIndex);
 }
 
@@ -41 +59 @@
     m_pMainLayout->setSpacing(2);
     m_pMainLayout->setContentsMargins(0, 0, 0, 0);
-    m_pLineEdit = new QILineEdit;
+    m_pLineEdit = new UISearchLineEdit;
     if (m_pLineEdit)
     {
         m_pMainLayout->addWidget(m_pLineEdit);
+        m_pLineEdit->installEventFilter(this);
+    }
+
+    m_pScrollToPreviousMatchButton = new QIToolButton;
+    if (m_pScrollToPreviousMatchButton)
+    {
+        m_pScrollToPreviousMatchButton->setIcon(UIIconPool::iconSet(":/log_viewer_search_backward_16px.png", ":/log_viewer_search_backward_disabled_16px.png"));
+        m_pMainLayout->addWidget(m_pScrollToPreviousMatchButton);
+    }
+    m_pScrollToNextMatchButton = new QIToolButton;
+    if (m_pScrollToNextMatchButton)
+    {
+        m_pScrollToNextMatchButton->setIcon(UIIconPool::iconSet(":/log_viewer_search_forward_16px.png", ":/log_viewer_search_forward_disabled_16px.png"));
+        m_pMainLayout->addWidget(m_pScrollToNextMatchButton);
     }
 
@@ -57 +89 @@
                 this, &UIChooserSearchWidget::sltHandleSearchTermChange);
     }
+    if (m_pScrollToPreviousMatchButton)
+        connect(m_pScrollToPreviousMatchButton, &QIToolButton::clicked, this, &UIChooserSearchWidget::sltHandleScroolToButtonClick);
+    if (m_pScrollToNextMatchButton)
+        connect(m_pScrollToNextMatchButton, &QIToolButton::clicked, this, &UIChooserSearchWidget::sltHandleScroolToButtonClick);
 }
 
@@ -66 +102 @@
 }
 
+void UIChooserSearchWidget::hideEvent(QHideEvent *pEvent)
+{
+    Q_UNUSED(pEvent);
+    if (m_pLineEdit)
+        m_pLineEdit->clear();
+}
+
 void UIChooserSearchWidget::retranslateUi()
 {
+}
+
+bool UIChooserSearchWidget::eventFilter(QObject *pWatched, QEvent *pEvent)
+{
+    Q_UNUSED(pWatched);
+    if (pEvent->type() == QEvent::KeyPress)
+    {
+        QKeyEvent *pKeyEvent = dynamic_cast<QKeyEvent*>(pEvent);
+        if (pKeyEvent)
+        {
+            if (pKeyEvent->key() == Qt::Key_Escape)
+                emit sigToggleVisibility(false);
+        }
+    }
+    return false;
 }
 
@@ -74 +132 @@
     emit sigRedoSearch(strSearchTerm, UIChooserItemSearchFlag_Machine);
 }
+
+void UIChooserSearchWidget::sltHandleScroolToButtonClick()
+{
+    if (sender() == m_pScrollToNextMatchButton)
+        emit sigScrollToMatch(true);
+    else if (sender() == m_pScrollToPreviousMatchButton)
+        emit sigScrollToMatch(false);
+}

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserSearchWidget.h

@@ -31 +31 @@
 class QHBoxLayout;
 class QILineEdit;
+class QIToolButton;
+class UISearchLineEdit;
 
 /** QWidget extension used as virtual machine search widget in the VM Chooser-pane. */
@@ -40 +42 @@
 
     void sigRedoSearch(const QString &strSearchTerm, int iItemSearchFlags);
+    /** Is being signalled as next/prev tool buttons are pressed. @a fIsNext is true
+      * for the next and false for the previous case. */
+    void sigScrollToMatch(bool fIsNext);
+    /** Is used for signalling show/hide event from this to parent. */
+    void sigToggleVisibility(bool fIsVisible);
 
 public:
 
     UIChooserSearchWidget(QWidget *pParent);
+    void setMatchCount(int iMatchCount);
+    void setScroolToIndex(int iScrollToIndex);
 
 protected:
 
-    void showEvent(QShowEvent *pEvent);
+    virtual void showEvent(QShowEvent *pEvent) /* override */;
+    virtual void hideEvent(QHideEvent *pEvent) /* override */;
     virtual void retranslateUi() /* override */;
+    virtual bool eventFilter(QObject *pWatched, QEvent *pEvent) /* override */;
 
 public slots:
@@ -55 +66 @@
 
     void sltHandleSearchTermChange(const QString &strSearchTerm);
+    void sltHandleScroolToButtonClick();
 
 private:
@@ -61 +73 @@
     void prepareConnections();
 
-    QILineEdit  *m_pLineEdit;
-    QHBoxLayout *m_pMainLayout;
+    UISearchLineEdit  *m_pLineEdit;
+    QHBoxLayout       *m_pMainLayout;
+    QIToolButton      *m_pScrollToNextMatchButton;
+    QIToolButton      *m_pScrollToPreviousMatchButton;
 };
 

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserView.cpp

@@ -108 +108 @@
     m_pSearchWidget->setVisible(!m_pSearchWidget->isVisible());
     if (m_pSearchWidget->isVisible())
-        updateSearchWidget();
+        updateSearchWidgetGeometry();
+}
+
+void UIChooserView::setSearchResultsCount(int iTotalMacthCount, int iCurrentlyScrolledItemIndex)
+{
+    if (!m_pSearchWidget)
+        return;
+    m_pSearchWidget->setMatchCount(iTotalMacthCount);
+    m_pSearchWidget->setScroolToIndex(iCurrentlyScrolledItemIndex);
 }
 
@@ -135 +143 @@
     if (!pModel)
         return;
-
     pModel->performSearch(strSearchTerm, iItemSearchFlags);
+}
+
+void UIChooserView::sltHandleScrollToSearchResult(bool fIsNext)
+{
+    UIChooserModel *pModel =  m_pChooser->model();
+    if (!pModel)
+        return;
+    pModel->scrollToSearchResult(fIsNext);
+}
+
+void UIChooserView::sltHandleSearchWidgetVisibilityToggle(bool fIsVisible)
+{
+    if (!m_pSearchWidget)
+        return;
+    if (m_pSearchWidget->isVisible() == fIsVisible)
+        return;
+    m_pSearchWidget->setVisible(fIsVisible);
+    UIChooserModel *pModel =  m_pChooser->model();
+    if (!pModel)
+        return;
+    pModel->resetSearch();
 }
 
@@ -169 +197 @@
     connect(m_pSearchWidget, &UIChooserSearchWidget::sigRedoSearch,
                 this, &UIChooserView::sltRedoSearch);
+    connect(m_pSearchWidget, &UIChooserSearchWidget::sigScrollToMatch,
+                this, &UIChooserView::sltHandleScrollToSearchResult);
+    connect(m_pSearchWidget, &UIChooserSearchWidget::sigToggleVisibility,
+                this, &UIChooserView::sltHandleSearchWidgetVisibilityToggle);
 
     /* Update scene-rect: */
@@ -174 +206 @@
 
     /* Update the location and size of the search widget: */
-    updateSearchWidget();
+    updateSearchWidgetGeometry();
 
     /* Apply language settings: */
@@ -198 +230 @@
     /* Update scene-rect: */
     updateSceneRect();
-    updateSearchWidget();
+    updateSearchWidgetGeometry();
 }
 
@@ -206 +238 @@
 }
 
-void UIChooserView::updateSearchWidget()
+void UIChooserView::updateSearchWidgetGeometry()
 {
     if (!m_pSearchWidget || !m_pSearchWidget->isVisible())

trunk/src/VBox/Frontends/VirtualBox/src/manager/chooser/UIChooserView.h

@@ -50 +50 @@
         /** Returns the chooser reference. */
         UIChooser *chooser() const { return m_pChooser; }
+    /** @} */
+
+    /** @name Virtual Machine search stuff.
+      * @{ */
         /** Shows/hides machine search widget. */
         void toggleSearchWidget();
+        /** Updates the search widget's counts. */
+        void setSearchResultsCount(int iTotalMacthCount, int iCurrentlyScrolledItemIndex);
     /** @} */
 
@@ -75 +81 @@
 private slots:
 
+    /** Is connected to search widget's signal for a new search. */
     void sltRedoSearch(const QString &strSearchTerm, int iItemSearchFlags);
+    /** Is connected to search widget's scroll to next/prev search result signal. */
+    void sltHandleScrollToSearchResult(bool fIsNext);
+    void sltHandleSearchWidgetVisibilityToggle(bool fIsVisible);
 
 private:
@@ -91 +101 @@
         /** Updates scene rectangle. */
         void updateSceneRect();
-        /** Updates search widget's geometry. */
-        void updateSearchWidget();
     /** @} */
 
+    /** @name Virtual Machine search stuff.
+      * @{ */
+        /** Updates search widget's geometry. */
+        void updateSearchWidgetGeometry();
+    /** @} */
 
     /** @name General stuff.

trunk/src/VBox/Frontends/VirtualBox/src/widgets/UISearchLineEdit.cpp

@@ -34 +34 @@
     QLineEdit::paintEvent(pEvent);
 
-    /* No search terms. no search. nothing to show here. mone along please: */
+    /* No search terms. no search. nothing to show here: */
     if (text().isEmpty())
         return;
 
+    /* Draw the total match count and the current scrolled item's index on the right hand side of the line edit: */
     QPainter painter(this);
     QFont pfont = font();
@@ -49 +50 @@
     int iTopMargin = (height() - textSize.height()) / 2;
     int iRightMargin = iTopMargin;
-
 
     QColor fontColor(Qt::darkGray);

trunk/src/VBox/Frontends/VirtualBox/src/widgets/UISearchLineEdit.h

@@ -32 +32 @@
   * mostly used for entering a search term and then label show total number of matched items
   * and currently selected, scrolled item. */
-class SHARED_LIBRARY_STUFF
-UISearchLineEdit : public QLineEdit
+class SHARED_LIBRARY_STUFF UISearchLineEdit : public QLineEdit
 {
 
@@ -50 +49 @@
 private:
 
+    /** Stores the total number of matched items. */
     int m_iMatchCount;
+    /** Stores the index of the currently scrolled/made-visible item withing the list of search results.
+      * Must be smaller that or equal to m_iMatchCount. */
     int m_iScrollToIndex;
 };