Changeset 94577 in vbox

Timestamp:

Apr 12, 2022 7:55:35 PM (3 years ago)

Author:

vboxsync

Message:

FE/Qt/Ds: bugref:6899: Machine settings: Network page accessibility improvements (part 5); A bit of cleanup and doxygen.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/settings/machine/UIMachineSettingsNetwork.cpp (modified) (8 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/settings/machine/UIMachineSettingsNetwork.cpp

@@ -154 +154 @@
     Q_OBJECT;
 
+signals:
+
+    /** Notifies about tab content changed. */
+    void sigTabUpdated();
+
+    /** Notifies about advanced button state change to @a fExpanded. */
+    void sigNotifyAdvancedButtonStateChange(bool fExpanded);
+
 public:
 
-    /* Constructor: */
+    /** Constructs tab passing @a pParent to the base-class. */
     UIMachineSettingsNetwork(UIMachineSettingsNetworkPage *pParent);
 
-    /* Load / Save API: */
+    /** Loads adapter data from @a adapterCache. */
     void getAdapterDataFromCache(const UISettingsCacheMachineNetworkAdapter &adapterCache);
+    /** Saves adapter data to @a adapterCache. */
     void putAdapterDataToCache(UISettingsCacheMachineNetworkAdapter &adapterCache);
 
@@ -166 +175 @@
     bool validate(QList<UIValidationMessage> &messages);
 
-    /* Navigation stuff: */
-    QWidget *setOrderAfter(QWidget *pAfter);
-
-    /* Other public stuff: */
+    /** Configures tab order according to passed @a pWidget. */
+    QWidget *setOrderAfter(QWidget *pWidget);
+
+    /** Returns tab title. */
     QString tabTitle() const;
+    /** Returns tab attachment type. */
     KNetworkAttachmentType attachmentType() const;
+    /** Returne tab alternative name for @a enmType specified. */
     QString alternativeName(KNetworkAttachmentType enmType = KNetworkAttachmentType_Null) const;
+
+    /** Performs tab polishing. */
     void polishTab();
+    /** Reloads tab alternatives. */
     void reloadAlternatives();
 
     /** Defines whether the advanced button is @a fExpanded. */
-    void setAdvancedButtonState(bool fExpanded);
-
-signals:
-
-    /* Signal to notify listeners about tab content changed: */
-    void sigTabUpdated();
-
-    /** Notifies about the advanced button state change to @a fExpanded. */
-    void sigNotifyAdvancedButtonStateChange(bool fExpanded);
+    void setAdvancedButtonExpanded(bool fExpanded);
 
 protected:
@@ -194 +200 @@
 private slots:
 
-    /* Different handlers: */
+    /** Handles adapter activity change. */
     void sltHandleAdapterActivityChange();
+    /** Handles adapter attachment type change. */
     void sltHandleAttachmentTypeChange();
+    /** Handles adapter alternative name change. */
     void sltHandleAlternativeNameChange();
 
@@ -208 +216 @@
     void prepareConnections();
 
-    /* Parent page: */
+    /** Holds parent page reference. */
     UIMachineSettingsNetworkPage *m_pParent;
 
-    /* Other variables: */
-    int m_iSlot;
+    /** Holds tab slot number. */
+    int  m_iSlot;
 
     /** @name Widgets
@@ -476 +484 @@
 }
 
-QWidget *UIMachineSettingsNetwork::setOrderAfter(QWidget *pAfter)
-{
-    setTabOrder(pAfter, m_pCheckBoxAdapter);
+QWidget *UIMachineSettingsNetwork::setOrderAfter(QWidget *pWidget)
+{
+    setTabOrder(pWidget, m_pCheckBoxAdapter);
     setTabOrder(m_pCheckBoxAdapter, m_pEditorAttachmentType);
     setTabOrder(m_pEditorAttachmentType, m_pEditorNetworkFeatures);
@@ -534 +542 @@
 }
 
-void UIMachineSettingsNetwork::setAdvancedButtonState(bool fExpanded)
+void UIMachineSettingsNetwork::setAdvancedButtonExpanded(bool fExpanded)
 {
     m_pEditorNetworkFeatures->setAdvancedButtonExpanded(fExpanded);
@@ -679 +687 @@
     connect(m_pEditorNetworkFeatures, &UIMachineNetworkFeaturesEditor::sigMACAddressChanged,
             m_pParent, &UIMachineSettingsNetworkPage::revalidate);
-    connect(this, &UIMachineSettingsNetwork::sigTabUpdated, m_pParent,
-            &UIMachineSettingsNetworkPage::sltHandleTabUpdate);
+    connect(this, &UIMachineSettingsNetwork::sigTabUpdated,
+            m_pParent, &UIMachineSettingsNetworkPage::sltHandleTabUpdate);
 }
 
@@ -927 +935 @@
         UIMachineSettingsNetwork *pTab = qobject_cast<UIMachineSettingsNetwork*>(m_pTabWidget->widget(iSlot));
         AssertPtrReturnVoid(pTab);
-        pTab->setAdvancedButtonState(fExpanded);
+        pTab->setAdvancedButtonExpanded(fExpanded);
     }
 }