Changeset 86906 in vbox

Timestamp:

Nov 18, 2020 7:06:07 AM (4 years ago)

Author:

vboxsync

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

141386

Message:

FE/Qt: bugref:9831. Enabling context sensitive help

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• globals/UIMessageCenter.cpp (modified) (5 diffs)
• globals/UIMessageCenter.h (modified) (3 diffs)
• helpbrowser/UIHelpBrowserDialog.cpp (modified) (4 diffs)
• helpbrowser/UIHelpBrowserDialog.h (modified) (4 diffs)
• helpbrowser/UIHelpBrowserWidget.cpp (modified) (22 diffs)
• helpbrowser/UIHelpBrowserWidget.h (modified) (3 diffs)
• wizards/UIWizard.cpp (modified) (3 diffs)
• wizards/newvm/UIWizardNewVM.cpp (modified) (2 diffs)

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

@@ -17 +17 @@
 
 /* Qt includes: */
+#include <QAbstractButton>
 #include <QDir>
 #include <QFileInfo>
@@ -612 +613 @@
     error(pParent, MessageType_Error,
           tr("Failed to acquire machine parameter."), UIErrorString::formatErrorInfo(comMachine));
+}
+
+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));
 }
 
@@ -3225 +3234 @@
 #elif defined (VBOX_WS_X11)
 # if defined(VBOX_WITH_DOCS_QHELP) && (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0))
-    showHelpBrowser(strLocation);
-# endif /* #if defined(VBOX_WITH_DOCS_QHELP) && (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0))&& (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0)) */
-# ifndef VBOX_OSE
+    showHelpBrowser(strLocation, QString());
+# elif !defined(VBOX_OSE)
     char szViewerPath[RTPATH_MAX];
     int rc;
@@ -3425 +3433 @@
 }
 
-void UIMessageCenter::showHelpBrowser(const QString strHelpFilePath, QWidget *pParent /* = 0 */)
+void UIMessageCenter::showHelpBrowser(const QString &strHelpFilePath, const QString &strKeyword, QWidget *pParent /* = 0 */)
 {
     Q_UNUSED(pParent);
+    if (!QFileInfo(strHelpFilePath).exists())
+    {
+        cannotFindHelpFile(strHelpFilePath, pParent);
+        return;
+    }
     if (!m_pHelpBrowserDialog)
     {
-
-        UIHelpBrowserDialogFactory dialogFactory(strHelpFilePath);
+        UIHelpBrowserDialogFactory dialogFactory(strHelpFilePath, strKeyword);
         dialogFactory.prepare(m_pHelpBrowserDialog);
         AssertReturnVoid(m_pHelpBrowserDialog);
@@ -3452 +3464 @@
     UIHelpBrowserDialogFactory().cleanup(pDialog);
 }
+
+void UIMessageCenter::sltHandleDialogHelpButtonPress()
+{
+# if defined(VBOX_WITH_DOCS_QHELP) && (QT_VERSION >= QT_VERSION_CHECK(5, 9, 0))
+
+    QAbstractButton *pSender = qobject_cast<QAbstractButton*>(sender());
+    if (!pSender)
+        return;
+    QVariant keyWordProp = pSender->property("helptag");
+    if (!keyWordProp.isValid() || !keyWordProp.canConvert(QMetaType::QString))
+        return;
+    QString strKeyword = keyWordProp.toString();
+    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;
 
     /* API: Selector warnings: */
@@ -552 +553 @@
     void sltShowUserManual(const QString &strLocation);
     void sltCloseHelpBrowser();
+    void sltHandleDialogHelpButtonPress();
 
 private slots:
@@ -602 +604 @@
                        const QString &strButtonText1, const QString &strButtonText2, const QString &strButtonText3,
                        const QString &strAutoConfirmId) const;
-
-    void showHelpBrowser(const QString strHelpFilePath, QWidget *pParent = 0);
+    /** @param strKeyword is passed possbily from a hrlp button and used by QHelpEngine infrastructure to find a
+      * corresponding Url. */
+    void showHelpBrowser(const QString &strHelpFilePath, const QString &strKeyword, QWidget *pParent = 0);
 
     /** Holds the list of shown warnings. */

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

@@ -44 +44 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserDialogFactory::UIHelpBrowserDialogFactory(const QString &strHelpFilePath /*  = QString() */)
-    :m_strHelpFilePath(strHelpFilePath)
+UIHelpBrowserDialogFactory::UIHelpBrowserDialogFactory(const QString &strHelpFilePath,
+                                                       const QString &strKeyword /* = QString() */)
+    : m_strHelpFilePath(strHelpFilePath)
+    , m_strKeyword(strKeyword)
+{
+}
+
+UIHelpBrowserDialogFactory::UIHelpBrowserDialogFactory()
+    : m_strHelpFilePath(QString())
+    , m_strKeyword(QString())
 {
 }
@@ -51 +59 @@
 void UIHelpBrowserDialogFactory::create(QIManagerDialog *&pDialog, QWidget *pCenterWidget)
 {
-    pDialog = new UIHelpBrowserDialog(pCenterWidget, m_strHelpFilePath);
+    pDialog = new UIHelpBrowserDialog(pCenterWidget, m_strHelpFilePath, m_strKeyword);
 }
 
@@ -59 +67 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserDialog::UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath)
+UIHelpBrowserDialog::UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath,
+                                         const QString &strKeyword /* = QString() */)
     : QIWithRetranslateUI<QIManagerDialog>(pCenterWidget)
     , m_strHelpFilePath(strHelpFilePath)
+    , m_strKeyword(strKeyword)
 {
 }
@@ -82 +92 @@
 {
 #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, true /* show toolbar */, this);
+    UIHelpBrowserWidget *pWidget = new UIHelpBrowserWidget(EmbedTo_Dialog, m_strHelpFilePath, m_strKeyword);
     if (pWidget)
     {

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

@@ -43 +43 @@
 class SHARED_LIBRARY_STUFF UIHelpBrowserDialogFactory : public QIManagerDialogFactory
 {
+
 public:
 
-    UIHelpBrowserDialogFactory(const QString &strHelpFilePath = QString());
+    /** @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());
+    UIHelpBrowserDialogFactory();
 
 protected:
@@ -56 +60 @@
 
     QString m_strHelpFilePath;
+    QString    m_strKeyword;
 };
-
-
 
 class SHARED_LIBRARY_STUFF UIHelpBrowserDialog : public QIWithRetranslateUI<QIManagerDialog>
@@ -66 +69 @@
 public:
 
-    UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath);
+    UIHelpBrowserDialog(QWidget *pCenterWidget, const QString &strHelpFilePath,
+                        const QString &strKeyword = QString());
 
 protected:
@@ -105 +109 @@
 
     QString m_strHelpFilePath;
+    QString m_strKeyword;
 };
 

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

@@ -277 +277 @@
     virtual QVariant loadResource(int type, const QUrl &name) /* override */;
     void emitHistoryChangedSignal();
-    void setSource(const QUrl &url, const QString &strError);
+    void setSource(const QUrl &url) /* override */;
     void toggleFindInPageWidget(bool fVisible);
     int initialFontPointSize() const;
@@ -381 +381 @@
     UIHelpBrowserViewer *m_pContentViewer;
     const QHelpEngine* m_pHelpEngine;
-    QString              m_strPageNotFoundText;
     QUrl m_homeUrl;
 };
@@ -404 +403 @@
                             const QStringList &urlList, QWidget *pParent = 0);
     QStringList tabUrlList() const;
-    void initilizeTabs();
+    /** 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;
@@ -416 +418 @@
     int fontPointSize() const;
     void setFontScaleWidgetVisible(bool fToggled);
+    void setMultiTabEnabled(bool fFlag);
 
 protected:
@@ -438 +441 @@
     QUrl m_homeUrl;
     QStringList m_savedUrlList;
+    /** Immediately switch the newly created tab. Otherwise open the tab in background. */
     bool m_fSwitchToNewTab;
+    bool m_fMultiTabEnabled;
+    bool m_fToolBarVisible;
 };
 
@@ -832 +838 @@
     {
         m_pContentViewer->blockSignals(true);
-        m_pContentViewer->setSource(url, m_strPageNotFoundText);
+        m_pContentViewer->setSource(url);
         m_pContentViewer->blockSignals(false);
         /* emit historyChanged signal explicitly since we have blocked the signals: */
@@ -925 +931 @@
             this, &UIHelpBrowserTab::sltHandleAddBookmarkAction);
 
-    m_pContentViewer->setSource(initialUrl, m_strPageNotFoundText);
+    m_pContentViewer->setSource(initialUrl);
 }
 
@@ -985 +991 @@
 void UIHelpBrowserTab::retranslateUi()
 {
-    m_strPageNotFoundText = tr("<div><p><h3>404. Not found.</h3>The page <b>%1</b> could not be found.</p></div>");
-
     setActionTextAndToolTip(m_pHomeAction, tr("Home"), tr("Return to start page"));
     setActionTextAndToolTip(m_pBackwardAction, tr("Backward"), tr("Navigate to previous page"));
@@ -998 +1002 @@
     if (!m_pContentViewer)
         return;
-    m_pContentViewer->setSource(m_homeUrl, m_strPageNotFoundText);
+    m_pContentViewer->setSource(m_homeUrl);
 }
 
@@ -1126 +1130 @@
 }
 
-void UIHelpBrowserViewer::setSource(const QUrl &url, const QString &strError)
-{
-    if (!url.isValid())
-        setText(strError.arg(url.toString()));
-    else
-        QTextBrowser::setSource(url);
+void UIHelpBrowserViewer::setSource(const QUrl &url)
+{
+    QTextBrowser::setSource(url);
+    QTextDocument *pDocument = document();
+    if (!pDocument || pDocument->isEmpty())
+    {
+        setText(tr("<div><p><h3>404. Not found.</h3>The page <b>%1</b> could not be found.</p></div>").arg(url.toString()));
+    }
 }
 
@@ -1412 +1418 @@
     , m_savedUrlList(urlList)
     , m_fSwitchToNewTab(true)
+    , m_fMultiTabEnabled(true)
+    , m_fToolBarVisible(true)
 {
     prepare();
@@ -1418 +1426 @@
 void UIHelpBrowserTabManager::addNewTab(const QUrl &initialUrl)
 {
+    if (!m_fMultiTabEnabled && count() >= 1)
+        return;
    UIHelpBrowserTab *pTabWidget = new  UIHelpBrowserTab(m_pHelpEngine, m_homeUrl, initialUrl);
    AssertReturnVoid(pTabWidget);
+   pTabWidget->setToolBarVisible(m_fToolBarVisible);
    int index = addTab(pTabWidget, pTabWidget->documentTitle());
    connect(pTabWidget, &UIHelpBrowserTab::sigSourceChanged,
@@ -1443 +1454 @@
 }
 
-void UIHelpBrowserTabManager::initilizeTabs()
+void UIHelpBrowserTabManager::initializeTabs()
 {
     clearAndDeleteTabs();
+    /* Start with a single tab showing the home URL: */
     if (m_savedUrlList.isEmpty())
         addNewTab(QUrl());
+    /* Start with saved tab(s): */
     else
         for (int i = 0; i < m_savedUrlList.size(); ++i)
             addNewTab(m_savedUrlList[i]);
+}
+
+void UIHelpBrowserTabManager::initializeSingleTab(const QUrl &url)
+{
+    m_fMultiTabEnabled = false;
+    clearAndDeleteTabs();
+    addNewTab(url);
 }
 
@@ -1489 +1509 @@
 void UIHelpBrowserTabManager::setToolBarVisible(bool fVisible)
 {
+    /* Make sure existing tabs are configured: */
     for (int i = 0; i < count(); ++i)
     {
@@ -1496 +1517 @@
         pTab->setToolBarVisible(fVisible);
     }
+    /* This is for the tabs that will be created later: */
+    m_fToolBarVisible = fVisible;
 }
 
@@ -1617 +1640 @@
 *********************************************************************************************************************************/
 
-UIHelpBrowserWidget::UIHelpBrowserWidget(EmbedTo enmEmbedding,
-                                         const QString &strHelpFilePath,
-                                         bool fShowToolbar /* = true */,
-                                         QWidget *pParent /* = 0 */)
+UIHelpBrowserWidget::UIHelpBrowserWidget(EmbedTo enmEmbedding, const QString &strHelpFilePath,
+                                         const QString &strKeyword /* = QString() */, QWidget *pParent /* = 0 */)
     : QIWithRetranslateUI<QWidget>(pParent)
     , m_enmEmbedding(enmEmbedding)
-    , m_fShowToolbar(fShowToolbar)
     , m_fIsPolished(false)
     , m_pMainLayout(0)
@@ -1630 +1650 @@
     , m_pToolBar(0)
     , m_strHelpFilePath(strHelpFilePath)
+    , m_strKeyword(strKeyword)
+    , m_fContextSensitiveMode(strKeyword.isEmpty() ? false : true)
     , m_pHelpEngine(0)
     , m_pSplitter(0)
@@ -1763 +1785 @@
 
     m_pSplitter->addWidget(m_pTabManager);
-
-    m_pSplitter->setStretchFactor(0, 1);
-    m_pSplitter->setStretchFactor(1, 4);
+    m_pSplitter->setStretchFactor(0,0);
+    m_pSplitter->setStretchFactor(1,1);
+
     m_pSplitter->setChildrenCollapsible(false);
 
@@ -1796 +1818 @@
     m_pTabWidget->insertTab(HelpBrowserTabs_Search, m_pSearchContainerWidget, QString());
     m_pTabWidget->setTabPosition(QTabWidget::South);
+
+
     m_pSearchEngine = m_pHelpEngine->searchEngine();
     AssertReturnVoid(m_pSearchEngine);
@@ -1887 +1911 @@
 void UIHelpBrowserWidget::saveOptions()
 {
-    if (m_pTabManager)
+    /* dont save the url list if context sensitive mode; */
+    if (m_pTabManager && !m_fContextSensitiveMode)
         gEDataManager->setHelpBrowserLastUrlList(m_pTabManager->tabUrlList());
 }
@@ -2022 +2047 @@
 void UIHelpBrowserWidget::sltHandleHelpEngineSetupFinished()
 {
-    AssertReturnVoid(m_pTabManager && m_pHelpEngine);
-    m_pTabManager->initilizeTabs();
 }
 
@@ -2070 +2093 @@
 void UIHelpBrowserWidget::sltHandleIndexingFinished()
 {
-    if (m_pSearchContainerWidget)
-        m_pSearchContainerWidget->setEnabled(true);
+    AssertReturnVoid(m_pTabManager &&
+                     m_pHelpEngine &&
+                     m_pSearchContainerWidget);
+
+    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);
+        }
+    }
 }
 

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

@@ -68 +68 @@
 
     UIHelpBrowserWidget(EmbedTo enmEmbedding, const QString &strHelpFilePath,
-                        bool fShowToolbar = true, QWidget *pParent = 0);
+                        const QString &strKeyword = QString(), QWidget *pParent = 0);
     ~UIHelpBrowserWidget();
 
@@ -135 +135 @@
     /** Hold sthe action-pool reference. */
     UIActionPool *m_pActionPool;
-    /** Holds whether we should create/show toolbar. */
-    const bool    m_fShowToolbar;
 
     /** Holds whether the dialog is polished. */
@@ -152 +150 @@
 
     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;

trunk/src/VBox/Frontends/VirtualBox/src/wizards/UIWizard.cpp

@@ -26 +26 @@
 #include "UIWizardPage.h"
 #include "UICommon.h"
+#include "UIMessageCenter.h"
 #include "QIRichTextLabel.h"
 #include "UIExtraDataManager.h"
@@ -50 +51 @@
     /* Make sure custom buttons shown even if final page is first to show: */
     sltCurrentIdChanged(startId());
+
+    /* If help button is enabled by the subclass, connect it to proper slot: */
+    if (button(QWizard::HelpButton))
+        connect(button(QWizard::HelpButton), &QAbstractButton::pressed,
+                &(msgCenter()), &UIMessageCenter::sltHandleDialogHelpButtonPress);
 }
 
@@ -533 +539 @@
 }
 #endif /* !VBOX_WS_MAC */
-

trunk/src/VBox/Frontends/VirtualBox/src/wizards/newvm/UIWizardNewVM.cpp

@@ -16 +16 @@
  */
 
+/* Qt includes: */
+#include <QAbstractButton>
+
 /* GUI includes: */
 #include "UICommon.h"
@@ -54 +57 @@
     , m_iUSBCount(0)
 {
+    setOptions(options() | QWizard::HaveHelpButton);
+    if (button(QWizard::HelpButton))
+        button(QWizard::HelpButton)->setProperty("helptag", "gui-createvm");
 #ifndef VBOX_WS_MAC
     /* Assign watermark: */