Changeset 86907 in vbox for trunk/src/VBox/Frontends

Timestamp:

Nov 18, 2020 10:41:44 AM (4 years ago)

Author:

vboxsync

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

141387

Message:

FE/Qt: bugref:9831. Working on context sensitive help of machine settings dialog

Location:

trunk/src/VBox/Frontends/VirtualBox/src

Files:

• settings/UISettingsDialog.cpp (modified) (3 diffs)
• settings/UISettingsDialog.h (modified) (2 diffs)
• settings/UISettingsDialogSpecific.cpp (modified) (3 diffs)
• wizards/UIWizard.cpp (modified) (2 diffs)
• wizards/UIWizard.h (modified) (1 diff)
• wizards/newvm/UIWizardNewVM.cpp (modified) (2 diffs)

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

@@ -118 +118 @@
 {
     const int iIndex = m_pages.value(cId);
-
+    setHelpButtonHelpTag(iIndex);
 #ifdef VBOX_WS_MAC
     /* If index is within the stored size list bounds: */
@@ -426 +426 @@
 }
 
+void UISettingsDialog::enableHelpButton()
+{
+    if (m_pButtonBox)
+    {
+        QPushButton *pHelpButton = m_pButtonBox->addButton(QDialogButtonBox::Help);
+        if (pHelpButton)
+            connect(pHelpButton, &QAbstractButton::pressed,
+                    &(msgCenter()), &UIMessageCenter::sltHandleDialogHelpButtonPress);
+    }
+}
+
+void UISettingsDialog::setHelpButtonHelpTag(int iPageType)
+{
+    if (m_pButtonBox && m_pButtonBox->button(QDialogButtonBox::Help))
+        m_pButtonBox->button(QDialogButtonBox::Help)->setProperty("helptag", m_pageHelpTags[iPageType]);
+}
+
+void UISettingsDialog::addPageHelpTag(int iPageType, const QString &strHelpTag)
+{
+    m_pageHelpTags[iPageType] = strHelpTag;
+}
+
 void UISettingsDialog::revalidate(UIPageValidator *pValidator)
 {
@@ -667 +689 @@
     {
         m_pButtonBox->button(QDialogButtonBox::Ok)->setDefault(true);
-        connect(m_pButtonBox, &QIDialogButtonBox::helpRequested,
-                &msgCenter(), &UIMessageCenter::sltShowHelpHelpDialog);
 
         /* Create status-bar: */

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) */
+    void setHelpButtonHelpTag(int iPageType);
+    /** Inserts an item to the map m_pageHelpTags. */
+    void addPageHelpTag(int iPageType, const QString &strHelpTag);
+
     /** Validates data correctness using certain @a pValidator. */
     void revalidate(UIPageValidator *pValidator);
@@ -203 +211 @@
     /** Holds the map of settings pages. */
     QMap<int, int>  m_pages;
+    /** Stores the help tag per page. Key is the page type (either GlobalSettingsPageType or MachineSettingsPageType)
+      * and value is the help tag. Used in context sensitive help: */
+    QMap<int, QString> m_pageHelpTags;
 
 #ifdef VBOX_WS_MAC

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

@@ -703 +703 @@
                     addItem(":/machine_32px.png", ":/machine_24px.png", ":/machine_16px.png",
                             iPageIndex, "#general", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "generalsettings");
                     break;
                 }
@@ -711 +712 @@
                     addItem(":/chipset_32px.png", ":/chipset_24px.png", ":/chipset_16px.png",
                             iPageIndex, "#system", pSettingsPage);
+                    addPageHelpTag(iPageIndex, "settings-system");
                     break;
                 }
@@ -831 +833 @@
     else
         m_pSelector->selectById(MachineSettingsPageType_General);
+
+    /* Enabled the 'Help' button of the button box for the context senstive help: */
+    enableHelpButton();
 }
 

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

@@ -51 +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);
 }
 
@@ -273 +268 @@
 #endif
 
+void UIWizard::enableHelpButton(const QString &strHelpTag /* = QString() */)
+{
+    setOptions(options() | QWizard::HaveHelpButton);
+    if (button(QWizard::HelpButton))
+    {
+        button(QWizard::HelpButton)->setProperty("helptag", strHelpTag);
+        connect(button(QWizard::HelpButton), &QAbstractButton::pressed,
+                &(msgCenter()), &UIMessageCenter::sltHandleDialogHelpButtonPress);
+    }
+}
+
+void UIWizard::setHelpButtonHelpTag(const QString &strHelpTag /* = QString() */)
+{
+    if (button(QWizard::HelpButton))
+        button(QWizard::HelpButton)->setProperty("helptag", strHelpTag);
+}
+
 void UIWizard::sltCurrentIdChanged(int iId)
 {

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

@@ -78 +78 @@
     void assignBackground(const QString &strBackground);
 #endif
+    /** Inserts the standard help button to the button box of the wizard. Optional @param strHelpTag
+      * is set as property. This is used for context sensitive help. */
+    void enableHelpButton(const QString &strHelpTag = QString());
+    void setHelpButtonHelpTag(const QString &strHelpTag = QString());
 
 protected slots:

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

@@ -57 +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: */
@@ -97 +94 @@
         }
     }
+    enableHelpButton("gui-createvm");
     /* Call to base-class: */
     UIWizard::prepare();