Changeset 86913 in vbox

Timestamp:

Nov 19, 2020 10:32:18 AM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

141395

Message:

FE/Qt: bugref:9831. Adding help tags to global and machine setting dialogs. and several more improvements.

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• globals/UIMessageCenter.cpp (modified) (4 diffs)
• globals/UIMessageCenter.h (modified) (1 diff)
• helpbrowser/UIHelpBrowserDialog.cpp (modified) (5 diffs)
• helpbrowser/UIHelpBrowserDialog.h (modified) (5 diffs)
• helpbrowser/UIHelpBrowserWidget.cpp (modified) (14 diffs)
• helpbrowser/UIHelpBrowserWidget.h (modified) (3 diffs)
• settings/UISettingsDialog.cpp (modified) (4 diffs)
• settings/UISettingsDialog.h (modified) (1 diff)
• settings/UISettingsDialogSpecific.cpp (modified) (17 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIMessageCenter.cpp

@@ -615 +615 @@
 }
 
-void UIMessageCenter::cannotFindHelpFile(const QString &strFileLocation, QWidget *pParent /* = 0 */) const
-{
-    /* Show the error: */
-    error(pParent, MessageType_Error,
-          tr("Failed to find help file."),
-          QString("%1:<!--EOM-->%2").arg(tr("The following file could not found")).arg(strFileLocation));
+void UIMessageCenter::cannotFindHelpFile(const QString &strFileLocation) const
+{
+    alert(0, MessageType_Error, QString("<p>%1:</p>%2").arg(tr("Failed to find the following help file")).arg(strFileLocation));
+}
+
+void UIMessageCenter::cannotFindHelpTag() const
+{
+    alert(0, MessageType_Error, QString("<p>%1</p>").arg(tr("There is no help page for this dialog.")));
 }
 
@@ -3438 +3440 @@
     if (!QFileInfo(strHelpFilePath).exists())
     {
-        cannotFindHelpFile(strHelpFilePath, pParent);
+        cannotFindHelpFile(strHelpFilePath);
         return;
     }
     if (!m_pHelpBrowserDialog)
     {
-        UIHelpBrowserDialogFactory dialogFactory(strHelpFilePath, strKeyword);
+        UIHelpBrowserDialogFactory dialogFactory(strHelpFilePath);
         dialogFactory.prepare(m_pHelpBrowserDialog);
         AssertReturnVoid(m_pHelpBrowserDialog);
@@ -3449 +3451 @@
                 this, &UIMessageCenter::sltCloseHelpBrowser);
     }
+    if (!strKeyword.isEmpty())
+    {
+        UIHelpBrowserDialog *pWidget = qobject_cast<UIHelpBrowserDialog*>(m_pHelpBrowserDialog);
+        if (pWidget)
+            pWidget->showHelpForKeyword(strKeyword);
+    }
+
     m_pHelpBrowserDialog->show();
     m_pHelpBrowserDialog->setWindowState(m_pHelpBrowserDialog->windowState() & ~Qt::WindowMinimized);
@@ -3474 +3483 @@
     QVariant keyWordProp = pSender->property("helptag");
     if (!keyWordProp.isValid() || !keyWordProp.canConvert(QMetaType::QString))
+    {
+        cannotFindHelpTag();
         return;
+    }
     QString strKeyword = keyWordProp.toString();
+    if (strKeyword.isEmpty())
+    {
+        cannotFindHelpTag();
+        return;
+    }
+
     showHelpBrowser(uiCommon().helpFile(), strKeyword);
 # endif /* #if defined(VBOX_WITH_DOCS_QHELP) && (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0))&& (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0)) */

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIMessageCenter.h

@@ -266 +266 @@
     void cannotAcquireVirtualBoxParameter(const CVirtualBox &comVBox, QWidget *pParent = 0) const;
     void cannotAcquireMachineParameter(const CMachine &comMachine, QWidget *pParent = 0) const;
-    void cannotFindHelpFile(const QString &strFileLocation, QWidget *pParent = 0) const;
+    void cannotFindHelpFile(const QString &strFileLocation) const;
+    void cannotFindHelpTag() const;
 
     /* API: Selector warnings: */

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

@@ -44 +44 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserDialogFactory::UIHelpBrowserDialogFactory(const QString &strHelpFilePath,
-                                                       const QString &strKeyword /* = QString() */)
+UIHelpBrowserDialogFactory::UIHelpBrowserDialogFactory(const QString &strHelpFilePath)
     : m_strHelpFilePath(strHelpFilePath)
-    , m_strKeyword(strKeyword)
 {
 }
@@ -53 +51 @@
 UIHelpBrowserDialogFactory::UIHelpBrowserDialogFactory()
     : m_strHelpFilePath(QString())
-    , m_strKeyword(QString())
 {
 }
@@ -59 +56 @@
 void UIHelpBrowserDialogFactory::create(QIManagerDialog *&pDialog, QWidget *pCenterWidget)
 {
-    pDialog = new UIHelpBrowserDialog(pCenterWidget, m_strHelpFilePath, m_strKeyword);
+    pDialog = new UIHelpBrowserDialog(pCenterWidget, m_strHelpFilePath);
 }
 
@@ -67 +64 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserDialog::UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath,
-                                         const QString &strKeyword /* = QString() */)
+UIHelpBrowserDialog::UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath)
     : QIWithRetranslateUI<QIManagerDialog>(pCenterWidget)
     , m_strHelpFilePath(strHelpFilePath)
-    , m_strKeyword(strKeyword)
+    , m_pWidget(0)
 {
+}
+
+void UIHelpBrowserDialog::showHelpForKeyword(const QString &strKeyword)
+{
+    if (m_pWidget)
+        m_pWidget->showHelpForKeyword(strKeyword);
 }
 
@@ -92 +94 @@
 {
 #if defined(RT_OS_LINUX) && defined(VBOX_WITH_DOCS_QHELP) && (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0))
-    UIHelpBrowserWidget *pWidget = new UIHelpBrowserWidget(EmbedTo_Dialog, m_strHelpFilePath, m_strKeyword);
-    if (pWidget)
+    m_pWidget = new UIHelpBrowserWidget(EmbedTo_Dialog, m_strHelpFilePath);
+    if (m_pWidget)
     {
         /* Configure widget: */
-        setWidget(pWidget);
-        setWidgetMenus(pWidget->menus());
+        setWidget(m_pWidget);
+        setWidgetMenus(m_pWidget->menus());
 #ifdef VBOX_WS_MAC
-        setWidgetToolbar(pWidget->toolbar());
+        setWidgetToolbar(m_pWidget->toolbar());
 #endif
-        connect(pWidget, &UIHelpBrowserWidget::sigSetCloseButtonShortCut,
+        connect(m_pWidget, &UIHelpBrowserWidget::sigSetCloseButtonShortCut,
                 this, &UIHelpBrowserDialog::sltSetCloseButtonShortCut);
 
         /* Add into layout: */
-        centralWidget()->layout()->addWidget(pWidget);
+        centralWidget()->layout()->addWidget(m_pWidget);
     }
 #endif

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

@@ -38 +38 @@
 class QVBoxLayout;
 class UIHelpBrowserDialog;
-
+class UIHelpBrowserWidget;
 
 /** QIManagerDialogFactory extension used as a factory for Log Viewer dialog. */
@@ -46 +46 @@
 public:
 
-    /** @param strHelpFilePath: the full path of the qHelp archive file.
-      * @param strKeyword: optional keyword string. Used in context sensitive help. */
-    UIHelpBrowserDialogFactory(const QString &strHelpFilePath, const QString &strKeyword = QString());
+    /** @param strHelpFilePath: the full path of the qHelp archive file. */
+    UIHelpBrowserDialogFactory(const QString &strHelpFilePath);
     UIHelpBrowserDialogFactory();
 
@@ -60 +59 @@
 
     QString m_strHelpFilePath;
-    QString    m_strKeyword;
 };
 
@@ -69 +67 @@
 public:
 
-    UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath,
-                        const QString &strKeyword = QString());
+    UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath);
+    /** A passthru function for QHelpIndexWidget::showHelpForKeyword. */
+    void showHelpForKeyword(const QString &strKeyword);
 
 protected:
@@ -109 +108 @@
 
     QString m_strHelpFilePath;
-    QString m_strKeyword;
+    UIHelpBrowserWidget *m_pWidget;
 };
 

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

@@ -405 +405 @@
     /** Either start with a single tab showin the home url or saved tab(s). Depending on the params. passed to ctor. */
     void initializeTabs();
-    /** Initialize with a single url. Effectively disables multitab. Possibly used in context sensitive help mode. */
-    void initializeSingleTab(const QUrl &url);
     /* Url of the current tab. */
     QUrl currentSource() const;
@@ -418 +416 @@
     int fontPointSize() const;
     void setFontScaleWidgetVisible(bool fToggled);
-    void setMultiTabEnabled(bool fFlag);
 
 protected:
@@ -443 +440 @@
     /** Immediately switch the newly created tab. Otherwise open the tab in background. */
     bool m_fSwitchToNewTab;
-    bool m_fMultiTabEnabled;
     bool m_fToolBarVisible;
 };
@@ -1418 +1414 @@
     , m_savedUrlList(urlList)
     , m_fSwitchToNewTab(true)
-    , m_fMultiTabEnabled(true)
     , m_fToolBarVisible(true)
 {
@@ -1426 +1421 @@
 void UIHelpBrowserTabManager::addNewTab(const QUrl &initialUrl)
 {
-    if (!m_fMultiTabEnabled && count() >= 1)
-        return;
    UIHelpBrowserTab *pTabWidget = new  UIHelpBrowserTab(m_pHelpEngine, m_homeUrl, initialUrl);
    AssertReturnVoid(pTabWidget);
@@ -1466 +1459 @@
 }
 
-void UIHelpBrowserTabManager::initializeSingleTab(const QUrl &url)
-{
-    m_fMultiTabEnabled = false;
-    clearAndDeleteTabs();
-    addNewTab(url);
-}
-
 QUrl UIHelpBrowserTabManager::currentSource() const
 {
@@ -1640 +1626 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserWidget::UIHelpBrowserWidget(EmbedTo enmEmbedding, const QString &strHelpFilePath,
-                                         const QString &strKeyword /* = QString() */, QWidget *pParent /* = 0 */)
+UIHelpBrowserWidget::UIHelpBrowserWidget(EmbedTo enmEmbedding, const QString &strHelpFilePath, QWidget *pParent /* = 0 */)
     : QIWithRetranslateUI<QWidget>(pParent)
     , m_enmEmbedding(enmEmbedding)
@@ -1650 +1635 @@
     , m_pToolBar(0)
     , m_strHelpFilePath(strHelpFilePath)
-    , m_strKeyword(strKeyword)
-    , m_fContextSensitiveMode(strKeyword.isEmpty() ? false : true)
     , m_pHelpEngine(0)
     , m_pSplitter(0)
@@ -1673 +1656 @@
     , m_pFontSizeResetAction(0)
     , m_fModelContentCreated(false)
+    , m_fIndexingFinished(false)
 {
     qRegisterMetaType<HelpBrowserTabs>("HelpBrowserTabs");
@@ -1691 +1675 @@
         << m_pViewMenu;
     return menuList;
+}
+
+void UIHelpBrowserWidget::showHelpForKeyword(const QString &strKeyword)
+{
+    if (m_fIndexingFinished)
+        findAndShowUrlForKeyword(strKeyword);
+    else
+        m_keywordList.append(strKeyword);
 }
 
@@ -1911 +1903 @@
 void UIHelpBrowserWidget::saveOptions()
 {
-    /* dont save the url list if context sensitive mode; */
-    if (m_pTabManager && !m_fContextSensitiveMode)
+    if (m_pTabManager)
         gEDataManager->setHelpBrowserLastUrlList(m_pTabManager->tabUrlList());
 }
@@ -2016 +2007 @@
 }
 
+void UIHelpBrowserWidget::findAndShowUrlForKeyword(const QString &strKeyword)
+{
+    QMap<QString, QUrl> map = m_pHelpEngine->linksForIdentifier(strKeyword);
+    if (!map.isEmpty())
+    {
+        /* We have to a have a single url per keyword in this case: */
+        QUrl keywordUrl = map.first();
+        m_pTabManager->setSource(keywordUrl, true /* new tab */);
+    }
+}
+
 void UIHelpBrowserWidget::sltHandleWidgetVisibilityToggle(bool fToggled)
 {
@@ -2047 +2049 @@
 void UIHelpBrowserWidget::sltHandleHelpEngineSetupFinished()
 {
+    AssertReturnVoid(m_pTabManager);
+    m_fIndexingFinished = true;
+    m_pTabManager->initializeTabs();
 }
 
@@ -2098 +2103 @@
 
     m_pSearchContainerWidget->setEnabled(true);
-    if (!m_fContextSensitiveMode)
-        m_pTabManager->initializeTabs();
-    else
-    {
-        QMap<QString, QUrl> map = m_pHelpEngine->linksForIdentifier(m_strKeyword);
-        if (!map.isEmpty())
-        {
-            /* We have to a have a single url per keyword in this case: */
-            QUrl keywordUrl = map.first();
-            m_pTabManager->initializeSingleTab(keywordUrl);
-        }
-    }
+    m_fIndexingFinished = true;
+    /* Process the keyword queue. */
+    foreach (const QString strKeyword, m_keywordList)
+        findAndShowUrlForKeyword(strKeyword);
+    m_keywordList.clear();
+
 }
 

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

@@ -67 +67 @@
 public:
 
-    UIHelpBrowserWidget(EmbedTo enmEmbedding, const QString &strHelpFilePath,
-                        const QString &strKeyword = QString(), QWidget *pParent = 0);
+    UIHelpBrowserWidget(EmbedTo enmEmbedding, const QString &strHelpFilePath, QWidget *pParent = 0);
     ~UIHelpBrowserWidget();
-
     QList<QMenu*> menus() const;
-
+    void showHelpForKeyword(const QString &strKeyword);
 #ifdef VBOX_WS_MAC
     QIToolBar *toolbar() const { return m_pToolBar; }
@@ -130 +128 @@
        virtual void keyPressEvent(QKeyEvent *pEvent) /* override */;
     /** @} */
+    /* Looks for Url for the keyword using QHelpEngine API and shows it in a new tab whne successful. */
+    void findAndShowUrlForKeyword(const QString &strKeyword);
 
     /** Holds the widget's embedding type. */
     const EmbedTo m_enmEmbedding;
-    /** Hold sthe action-pool reference. */
     UIActionPool *m_pActionPool;
-
-    /** Holds whether the dialog is polished. */
     bool m_fIsPolished;
 
-    /** Holds container for log-pages. */
     QVBoxLayout         *m_pMainLayout;
     QHBoxLayout         *m_pTopLayout;
+    /** Container tab widget for content, index, bookmark widgets. Sits on a side bar. */
+    QITabWidget *m_pTabWidget;
 
-    QITabWidget *m_pTabWidget;
     /** @name Toolbar and menu variables.
      * @{ */
-    QIToolBar *m_pToolBar;
+       QIToolBar *m_pToolBar;
     /** @} */
 
     QString       m_strHelpFilePath;
     /** Start the browser with this keyword. When not empty widget is shown `only` with html viewer and single tab.*/
-    QString m_strKeyword;
-    bool    m_fContextSensitiveMode;
     QHelpEngine  *m_pHelpEngine;
     QSplitter           *m_pSplitter;
@@ -175 +170 @@
     /* This is set t true when handling QHelpContentModel::contentsCreated signal. */
     bool                 m_fModelContentCreated;
+    bool                 m_fIndexingFinished;
+    /** This queue is used in unlikely case where possibly several keywords are requested to be shown
+      *  but indexing is not yet finished. In that case we queue the keywords and process them after
+      * after indexing is finished. */
+    QStringList          m_keywordList;
 };
 

trunk/src/VBox/Frontends/VirtualBox/src/settings/UISettingsDialog.cpp

@@ -118 +118 @@
 {
     const int iIndex = m_pages.value(cId);
-    setHelpButtonHelpTag(iIndex);
+    setHelpButtonHelpTag(cId);
 #ifdef VBOX_WS_MAC
     /* If index is within the stored size list bounds: */
@@ -423 +423 @@
         pSettingsPage->setId(cId);
         assignValidator(pSettingsPage);
-    }
-}
-
-void UISettingsDialog::enableHelpButton()
-{
-    if (m_pButtonBox)
-    {
-        QPushButton *pHelpButton = m_pButtonBox->addButton(QDialogButtonBox::Help);
-        if (pHelpButton)
-            connect(pHelpButton, &QAbstractButton::pressed,
-                    &(msgCenter()), &UIMessageCenter::sltHandleDialogHelpButtonPress);
     }
 }
@@ -784 +773 @@
     m_pButtonBox = new QIDialogButtonBox(pCentralWidget);
     m_pButtonBox->setObjectName(QStringLiteral("m_pButtonBox"));
-    m_pButtonBox->setStandardButtons(QDialogButtonBox::Cancel|QDialogButtonBox::NoButton|QDialogButtonBox::Ok);
+    m_pButtonBox->setStandardButtons(QDialogButtonBox::Cancel|QDialogButtonBox::NoButton|
+                                     QDialogButtonBox::Ok| QDialogButtonBox::Help);
     pMainLayout->addWidget(m_pButtonBox, 2, 0, 1, 2);
 
@@ -791 +781 @@
     QObject::connect(m_pButtonBox, &QIDialogButtonBox::rejected, this, &UISettingsDialog::reject);
     QObject::connect(m_pButtonBox, &QIDialogButtonBox::accepted, this, &UISettingsDialog::accept);
+    connect(m_pButtonBox->button(QDialogButtonBox::Help), &QAbstractButton::pressed,
+                                 &(msgCenter()), &UIMessageCenter::sltHandleDialogHelpButtonPress);
 }
 

trunk/src/VBox/Frontends/VirtualBox/src/settings/UISettingsDialog.h

@@ -136 +136 @@
     virtual void recorrelate(UISettingsPage *pSettingsPage) { Q_UNUSED(pSettingsPage); }
 
-    /** Inserts the standard help button to the button box of the dialog and make a connection to the appropirate slot. */
-    void enableHelpButton();
     /** Set/change/reset the help tag of the help buttons help tag. Possibly used as tabs are changed. Searches the map
      * m_pageHelpTags for the help tag for the page with @iPageType (GlobalSettingsPageType or MachineSettingsPageType) */

trunk/src/VBox/Frontends/VirtualBox/src/settings/UISettingsDialogSpecific.cpp

@@ -197 +197 @@
                     addItem(":/machine_32px.png", ":/machine_24px.png", ":/machine_16px.png",
                             iPageIndex, "#general", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -205 +206 @@
                     addItem(":/keyboard_32px.png", ":/keyboard_24px.png", ":/keyboard_16px.png",
                             iPageIndex, "#input", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -214 +216 @@
                     addItem(":/refresh_32px.png", ":/refresh_24px.png", ":/refresh_16px.png",
                             iPageIndex, "#update", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -223 +226 @@
                     addItem(":/site_32px.png", ":/site_24px.png", ":/site_16px.png",
                             iPageIndex, "#language", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -231 +235 @@
                     addItem(":/vrdp_32px.png", ":/vrdp_24px.png", ":/vrdp_16px.png",
                             iPageIndex, "#display", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -239 +244 @@
                     addItem(":/nw_32px.png", ":/nw_24px.png", ":/nw_16px.png",
                             iPageIndex, "#network", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -247 +253 @@
                     addItem(":/extension_pack_32px.png", ":/extension_pack_24px.png", ":/extension_pack_16px.png",
                             iPageIndex, "#extensions", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -256 +263 @@
                     addItem(":/proxy_32px.png", ":/proxy_24px.png", ":/proxy_16px.png",
                             iPageIndex, "#proxy", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "globalsettings");
                     break;
                 }
@@ -721 +729 @@
                     addItem(":/vrdp_32px.png", ":/vrdp_24px.png", ":/vrdp_16px.png",
                             iPageIndex, "#display", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "settings-display");
                     break;
                 }
@@ -731 +740 @@
                     addItem(":/hd_32px.png", ":/hd_24px.png", ":/hd_16px.png",
                             iPageIndex, "#storage", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "settings-storage");
                     break;
                 }
@@ -739 +749 @@
                     addItem(":/sound_32px.png", ":/sound_24px.png", ":/sound_16px.png",
                             iPageIndex, "#audio", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "settings-audio");
                     break;
                 }
@@ -747 +758 @@
                     addItem(":/nw_32px.png", ":/nw_24px.png", ":/nw_16px.png",
                             iPageIndex, "#network", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "settings-network");
                     break;
                 }
@@ -762 +774 @@
                     addItem(":/serial_port_32px.png", ":/serial_port_24px.png", ":/serial_port_16px.png",
                             iPageIndex, "#serialPorts", pSettingsPage, MachineSettingsPageType_Ports);
+                    addPageHelpTag(iPageIndex, "serialports");
                     break;
                 }
@@ -770 +783 @@
                     addItem(":/usb_32px.png", ":/usb_24px.png", ":/usb_16px.png",
                             iPageIndex, "#usb", pSettingsPage, MachineSettingsPageType_Ports);
+                    addPageHelpTag(iPageIndex, "usb-support");
                     break;
                 }
@@ -778 +792 @@
                     addItem(":/sf_32px.png", ":/sf_24px.png", ":/sf_16px.png",
                             iPageIndex, "#sharedFolders", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "shared-folders");
                     break;
                 }
@@ -786 +801 @@
                     addItem(":/interface_32px.png", ":/interface_24px.png", ":/interface_16px.png",
                             iPageIndex, "#userInterface", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "user-interface");
                     break;
                 }
@@ -833 +849 @@
     else
         m_pSelector->selectById(MachineSettingsPageType_General);
-
-    /* Enabled the 'Help' button of the button box for the context senstive help: */
-    enableHelpButton();
 }