Changeset 107759 in vbox for trunk

Timestamp:

Jan 14, 2025 3:36:23 PM (4 weeks ago)

Author:

vboxsync

Message:

FE/Qt: bugref:9831.

• Implemented a better way of finding target html file for the go home action.
• Fixed half way broken treeview and text browser sync.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/helpbrowser

Files:

• UIHelpBrowserWidget.cpp (modified) (27 diffs)
• UIHelpBrowserWidget.h (modified) (3 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/helpbrowser/UIHelpBrowserWidget.cpp

@@ -191 +191 @@
     void sigMouseOverImage(const QString &strImageName);
     void sigZoomRequest(UIHelpViewer::ZoomOperation enmZoomOperation);
+    void sigGoHome();
 
 public:
 
-    UIHelpBrowserTab(const QHelpEngine  *pHelpEngine, const QUrl &homeUrl,
-                     const QUrl &initialUrl, QWidget *pParent = 0);
+    UIHelpBrowserTab(const QHelpEngine  *pHelpEngine, const QUrl &initialUrl, QWidget *pParent = 0);
 
     QUrl source() const;
@@ -213 +213 @@
 
     void sltFindInPageAction(bool fToggled);
-    void sltHomeAction();
     void sltForwardAction();
     void sltBackwardAction();
@@ -246 +245 @@
     UIHelpViewer *m_pContentViewer;
     const QHelpEngine* m_pHelpEngine;
-    QUrl m_homeUrl;
 };
 
@@ -270 +268 @@
     void sigHistoryChanged(bool fBackwardAvailable, bool fForwardAvailable);
     void sigMouseOverImage(const QString &strImageName);
+    void sigGoHome();
 
 public:
 
-    UIHelpBrowserTabManager(const QHelpEngine  *pHelpEngine, const QUrl &homeUrl,
-                            const QStringList &urlList, QWidget *pParent = 0);
+    UIHelpBrowserTabManager(const QHelpEngine  *pHelpEngine, const QStringList &urlList, QWidget *pParent = 0);
     /* Returns the list of urls of all open tabs as QStringList. */
     QStringList tabUrlList() const;
@@ -301 +299 @@
     void sltCloseCurrentTab();
     void sltCloseOtherTabs();
-    void sltHomeAction();
     void sltAddBookmarkAction();
     void sltForwardAction();
@@ -332 +329 @@
 
     const QHelpEngine* m_pHelpEngine;
-    QUrl m_homeUrl;
     QStringList m_savedUrlList;
     /** Immediately switch the newly created tab. Otherwise open the tab in background. */
@@ -545 +541 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserTab::UIHelpBrowserTab(const QHelpEngine  *pHelpEngine, const QUrl &homeUrl,
-                                   const QUrl &initialUrl, QWidget *pParent /* = 0 */)
+UIHelpBrowserTab::UIHelpBrowserTab(const QHelpEngine  *pHelpEngine, const QUrl &initialUrl, QWidget *pParent /* = 0 */)
     : QWidget(pParent)
     , m_pHomeAction(0)
@@ -559 +554 @@
     , m_pContentViewer(0)
     , m_pHelpEngine(pHelpEngine)
-    , m_homeUrl(homeUrl)
 {
     if (initialUrl.isValid())
         prepare(initialUrl);
     else
-        prepare(m_homeUrl);
+        prepare(QUrl());
 }
 
@@ -576 +570 @@
 void UIHelpBrowserTab::setSource(const QUrl &url)
 {
+    if (url == source())
+        return;
     if (m_pContentViewer)
-    {
-        m_pContentViewer->blockSignals(true);
         m_pContentViewer->setSource(url);
-        m_pContentViewer->blockSignals(false);
-        /* emit historyChanged signal explicitly since we have blocked the signals: */
-        m_pContentViewer->emitHistoryChangedSignal();
-    }
 }
 
@@ -685 +675 @@
             this, &UIHelpBrowserTab::sltForwardAction);
     connect(m_pContentViewer, &UIHelpViewer::sigGoHome,
-            this, &UIHelpBrowserTab::sltHomeAction);
+            this, &UIHelpBrowserTab::sigGoHome);
     connect(m_pContentViewer, &UIHelpViewer::sigAddBookmark,
             this, &UIHelpBrowserTab::sltAddBookmarkAction);
@@ -699 +689 @@
             this, &UIHelpBrowserTab::sigZoomRequest);
 
-    m_pContentViewer->setSource(initialUrl);
+    if (initialUrl.isValid())
+        m_pContentViewer->setSource(initialUrl);
+    else
+        emit sigGoHome();
 }
 
@@ -728 +721 @@
     m_pFindInPageAction->setCheckable(true);
 
-    connect(m_pHomeAction, &QAction::triggered, this, &UIHelpBrowserTab::sltHomeAction);
+    connect(m_pHomeAction, &QAction::triggered, this, &UIHelpBrowserTab::sigGoHome);
     connect(m_pAddBookmarkAction, &QAction::triggered, this, &UIHelpBrowserTab::sltAddBookmarkAction);
     connect(m_pForwardAction, &QAction::triggered, this, &UIHelpBrowserTab::sltForwardAction);
@@ -776 +769 @@
 }
 
-void UIHelpBrowserTab::sltHomeAction()
-{
-    if (!m_pContentViewer)
-        return;
-    m_pContentViewer->setSource(m_homeUrl);
-}
-
 void UIHelpBrowserTab::sltForwardAction()
 {
@@ -887 +873 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserTabManager::UIHelpBrowserTabManager(const QHelpEngine  *pHelpEngine, const QUrl &homeUrl,
+UIHelpBrowserTabManager::UIHelpBrowserTabManager(const QHelpEngine  *pHelpEngine,
                                                  const QStringList &urlList, QWidget *pParent /* = 0 */)
     : QITabWidget(pParent)
     , m_pHelpEngine(pHelpEngine)
-    , m_homeUrl(homeUrl)
     , m_savedUrlList(urlList)
     , m_fSwitchToNewTab(true)
@@ -913 +898 @@
     }
 #endif
-    UIHelpBrowserTab *pTabWidget = new  UIHelpBrowserTab(m_pHelpEngine, m_homeUrl, initialUrl);
+    UIHelpBrowserTab *pTabWidget = new  UIHelpBrowserTab(m_pHelpEngine, initialUrl);
     AssertReturnVoid(pTabWidget);
     pTabWidget->setToolBarVisible(m_fToolBarVisible);
@@ -937 +922 @@
    connect(pTabWidget, &UIHelpBrowserTab::sigZoomRequest,
             this, &UIHelpBrowserTabManager::sltHandleZoomRequest);
+   connect(pTabWidget, &UIHelpBrowserTab::sigGoHome,
+            this, &UIHelpBrowserTabManager::sigGoHome);
 
    pTabWidget->setZoomPercentage(zoomPercentage());
@@ -1226 +1213 @@
 
     menu.exec(tabBar()->mapToGlobal(pos));
-}
-
-void UIHelpBrowserTabManager::sltHomeAction()
-{
-    UIHelpBrowserTab *pTab = qobject_cast<UIHelpBrowserTab*>(currentWidget());
-    if (pTab)
-        pTab->sltHomeAction();
 }
 
@@ -1505 +1485 @@
     m_pHomeAction = new QAction(this);
     connect(m_pHomeAction, &QAction::triggered,
-            this, &UIHelpBrowserWidget::sigGoHome);
+            this, &UIHelpBrowserWidget::sltGoHome);
 
     m_pReloadPageAction = new QAction(this);
@@ -1526 +1506 @@
     if (m_pTabManager)
     {
-        connect(m_pHomeAction, &QAction::triggered, m_pTabManager, &UIHelpBrowserTabManager::sltHomeAction);
+        connect(m_pHomeAction, &QAction::triggered, m_pTabManager, &UIHelpBrowserTabManager::sigGoHome);
         connect(m_pAddBookmarkAction, &QAction::triggered, m_pTabManager, &UIHelpBrowserTabManager::sltAddBookmarkAction);
         connect(m_pForwardAction, &QAction::triggered, m_pTabManager, &UIHelpBrowserTabManager::sltForwardAction);
@@ -1542 +1522 @@
     m_pHelpEngine = new QHelpEngine(m_strHelpFilePath, this);
     m_pBookmarksWidget = new UIBookmarksListContainer(this);
+
+    m_pContentWidget = m_pHelpEngine->contentWidget();
+    m_pIndexWidget = m_pHelpEngine->indexWidget();
+    m_pContentModel = m_pHelpEngine->contentModel();
+    AssertReturnVoid(m_pContentWidget && m_pIndexWidget && m_pContentModel);
+
     m_pTabWidget = new QITabWidget;
-    m_pTabManager = new UIHelpBrowserTabManager(m_pHelpEngine, findIndexHtml(), loadSavedUrlList());
+    m_pTabManager = new UIHelpBrowserTabManager(m_pHelpEngine, loadSavedUrlList());
     m_pTabManager->setHelpFileList(m_pHelpEngine->files(m_pHelpEngine->namespaceName(m_strHelpFilePath), QStringList()));
-
     AssertReturnVoid(m_pTabWidget &&
                      m_pHelpEngine &&
@@ -1551 +1536 @@
                      m_pTabManager);
 
-    m_pContentWidget = m_pHelpEngine->contentWidget();
-    m_pIndexWidget = m_pHelpEngine->indexWidget();
-    m_pContentModel = m_pHelpEngine->contentModel();
-
-    AssertReturnVoid(m_pContentWidget && m_pIndexWidget && m_pContentModel);
     m_pSplitter->addWidget(m_pTabWidget);
     m_pContentWidget->setContextMenuPolicy(Qt::CustomContextMenu);
@@ -1592 +1572 @@
     connect(m_pTabManager, &UIHelpBrowserTabManager::sigMouseOverImage,
             this, &UIHelpBrowserWidget::sltMouseOverImage);
+    connect(m_pTabManager, &UIHelpBrowserTabManager::sigGoHome,
+            this, &UIHelpBrowserWidget::sltGoHome);
+
 
     connect(m_pHelpEngine, &QHelpEngine::setupFinished,
@@ -1752 +1735 @@
 QUrl UIHelpBrowserWidget::findIndexHtml() const
 {
+    if (m_pHelpEngine && m_pHelpEngine->contentModel())
+    {
+        QModelIndex modelIndex = m_pHelpEngine->contentModel()->index(0, 0);
+        if (modelIndex.isValid())
+        {
+            QUrl url = contentWidgetUrl(modelIndex);
+            if (url.isValid())
+                return url;
+        }
+    }
     QList<QUrl> files = m_pHelpEngine->files(m_pHelpEngine->namespaceName(m_strHelpFilePath), QStringList());
     int iIndex = -1;
     for (int i = 0; i < files.size(); ++i)
     {
-        if (QString::compare(files[i].fileName(), "preface.html", Qt::CaseInsensitive) == 0)
+        if (files[i].toString().contains(".html", Qt::CaseInsensitive) ||
+            files[i].toString().contains(".htm", Qt::CaseInsensitive))
         {
             iIndex = i;
@@ -1762 +1756 @@
         }
     }
-    if (iIndex == -1)
-    {
-        /* If index html/htm could not be found try to find a html file at least: */
-        for (int i = 0; i < files.size(); ++i)
-        {
-            if (files[i].toString().contains(".html", Qt::CaseInsensitive) ||
-                files[i].toString().contains(".htm", Qt::CaseInsensitive))
-            {
-                iIndex = i;
-                break;
-            }
-        }
-    }
+
     if (iIndex != -1 && files.size() > iIndex)
         return files[iIndex];
@@ -1781 +1763 @@
 }
 
-QUrl UIHelpBrowserWidget::contentWidgetUrl(const QModelIndex &itemIndex)
+QUrl UIHelpBrowserWidget::contentWidgetUrl(const QModelIndex &itemIndex) const
 {
     QHelpContentModel *pContentModel =
@@ -1915 +1897 @@
 }
 
+void UIHelpBrowserWidget::sltGoHome()
+{
+    QUrl homeUrl = findIndexHtml();
+    if (homeUrl.isValid() && m_pTabManager)
+        m_pTabManager->setSource(homeUrl);
+}
+
 void UIHelpBrowserWidget::sltHistoryChanged(bool fBackwardAvailable, bool fForwardAvailable)
 {
@@ -1998 +1987 @@
 }
 
+QModelIndex findItemByUrl(QHelpContentModel* model, const QModelIndex& parent, const QUrl& targetUrl)
+{
+    for (int row = 0; row < model->rowCount(parent); ++row)
+    {
+        QModelIndex index = model->index(row, 0, parent);
+        if (!index.isValid())
+            continue;
+        QHelpContentItem* item = model->contentItemAt(index);
+        if (!item)
+            continue;
+        if (item && item->url() == targetUrl)
+            return index;
+
+        QModelIndex childIndex = findItemByUrl(model, index, targetUrl);
+        if (childIndex.isValid())
+            return childIndex;
+    }
+
+    return QModelIndex();
+}
+
 void UIHelpBrowserWidget::sltViewerSourceChange(const QUrl &source)
 {
     if (m_fModelContentCreated && m_pContentWidget && source.isValid() && m_pContentModel)
     {
-        QModelIndex index = m_pContentWidget->indexOf(source);
-        QItemSelectionModel *pSelectionModel = m_pContentWidget->selectionModel();
-        if (pSelectionModel && index.isValid())
+        QModelIndex index = findItemByUrl(m_pContentModel, QModelIndex(), source);
+        if (index.isValid())
         {
             m_pContentWidget->blockSignals(true);
-            pSelectionModel->select(index, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows);
+            m_pContentWidget->setCurrentIndex(index);
             m_pContentWidget->scrollTo(index, QAbstractItemView::EnsureVisible);
             m_pContentWidget->expand(index);

trunk/src/VBox/Frontends/VirtualBox/src/helpbrowser/UIHelpBrowserWidget.h

@@ -67 +67 @@
     void sigGoBackward();
     void sigGoForward();
-    void sigGoHome();
     void sigReloadPage();
     void sigAddBookmark();
@@ -122 +121 @@
     void sltRetranslateUI();
     void sltCommitDataSignalReceived();
+    void sltGoHome();
 
 private:
@@ -142 +142 @@
     QUrl findIndexHtml() const;
     /* Returns the url of the item with @p itemIndex. */
-    QUrl contentWidgetUrl(const QModelIndex &itemIndex);
+    QUrl contentWidgetUrl(const QModelIndex &itemIndex) const;
     void openLinkSlotHandler(QObject *pSenderObject, bool fOpenInNewTab);
     void updateTabsMenu(const QStringList &titleList);