Changeset 65272 in vbox for trunk/src/VBox/Frontends/VirtualBox

Timestamp:

Jan 13, 2017 7:20:17 AM (8 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:6899: Accessibility support (step 166): A bit of care for UIVMInformationDialog: Doxy/comments.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information

Files:

• UIVMInformationDialog.cpp (modified) (6 diffs)
• UIVMInformationDialog.h (modified) (5 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information/UIVMInformationDialog.cpp

@@ -61 +61 @@
 #include "CVRDEServerInfo.h"
 
+
 /* static */
 UIVMInformationDialog* UIVMInformationDialog::m_spInstance = 0;
@@ -130 +131 @@
     switch (pEvent->type())
     {
-        /* Handle every Resize and Move we keep track of the geometry. */
+        /* Handle Resize event to keep track of the geometry: */
         case QEvent::Resize:
         {
@@ -140 +141 @@
             break;
         }
+        /* Handle Move event to keep track of the geometry: */
         case QEvent::Move:
         {
@@ -183 +185 @@
 
 #ifdef VBOX_WS_MAC
-    /* No window-icon on Mac OX X, because it acts as proxy icon which isn't necessary here. */
+    /* No window-icon on Mac OS X, because it acts as proxy icon which isn't necessary here. */
     setWindowIcon(QIcon());
-#else /* !VBOX_WS_MAC */
-    /* Assign window-icon(s: */
+#else
+    /* Assign window-icons: */
     setWindowIcon(UIIconPool::iconSetFull(":/session_info_32px.png", ":/session_info_16px.png"));
-#endif /* !VBOX_WS_MAC */
+#endif
 
     /* Prepare central-widget: */
     prepareCentralWidget();
 
-    /* Configure handlers: */
+    /* Assign tab-widget page change handler: */
     connect(m_pTabWidget, SIGNAL(currentChanged(int)), this, SLOT(sltHandlePageChanged(int)));
 
@@ -235 +237 @@
         centralWidget()->layout()->addWidget(m_pTabWidget);
 
-        /* Create tabs: */
-        /* Create Configuration details tab: */
+        /* Create Configuration Details tab: */
         UIInformationConfiguration *pInformationConfigurationWidget = new UIInformationConfiguration(this, gpMachine->uisession()->machine(), gpMachine->uisession()->console());
         AssertPtrReturnVoid(pInformationConfigurationWidget);
         {
-            //pInformationWidget->setItems(items);
             m_tabs.insert(0, pInformationConfigurationWidget);
             m_pTabWidget->addTab(m_tabs.value(0), QString());
         }
 
-        /* Create Runtime information tab: */
+        /* Create Runtime Information tab: */
         UIInformationRuntime *pInformationRuntimeWidget = new UIInformationRuntime(this, gpMachine->uisession()->machine(), gpMachine->uisession()->console());
         AssertPtrReturnVoid(pInformationRuntimeWidget);
@@ -252 +252 @@
             m_pTabWidget->addTab(m_tabs.value(1), QString());
         }
-        /* Set runtime information tab as default: */
+
+        /* Set Runtime Information tab as default: */
         m_pTabWidget->setCurrentIndex(1);
     }

trunk/src/VBox/Frontends/VirtualBox/src/runtime/information/UIVMInformationDialog.h

@@ -19 +19 @@
 #define ___UIVMInformationDialog_h___
 
-/* Qt includes: */
-
 /* GUI includes: */
 #include "QIMainWindow.h"
@@ -34 +32 @@
 class QIDialogButtonBox;
 
-/** QIMainWindow based dialog providing user with VM details and statistics. */
+
+/** QIMainWindow subclass providing user
+  * with the dialog unifying VM details and statistics. */
 class UIVMInformationDialog : public QIWithRetranslateUI<QIMainWindow>
 {
@@ -47 +47 @@
 protected:
 
-    /** Information dialog constructor. */
+    /** Constructs information dialog for passed @a pMachineWindow. */
     UIVMInformationDialog(UIMachineWindow *pMachineWindow);
-    /** Information dialog destructor. */
+    /** Destructs information dialog. */
     ~UIVMInformationDialog();
 
@@ -55 +55 @@
     virtual bool shouldBeMaximized() const /* override */;
 
-    /** Translation handler. */
+    /** Handles translation event. */
     void retranslateUi();
 
-    /** Common event-handler. */
+    /** Handles any Qt @a pEvent. */
     bool event(QEvent *pEvent);
 
 private slots:
 
-    /** Slot to destroy dialog immediately. */
+    /** Destroys dialog immediately. */
     void suicide() { delete this; }
-    /** Slot to handle tab-widget page change. */
+    /** Handles tab-widget page change. */
     void sltHandlePageChanged(int iIndex);
 
 private:
 
-    /** General prepare helper. */
+    /** Prepares all. */
     void prepare();
-    /** Prepare helper for dialog itself. */
+    /** Prepares this. */
     void prepareThis();
-    /** Prepare helper for central-widget. */
+    /** Prepares central-widget. */
     void prepareCentralWidget();
-    /** Prepare helper for tab-widget. */
+    /** Prepares tab-widget. */
     void prepareTabWidget();
-    /** Prepare helper for @a iTabIndex. */
+    /** Prepares tab with @a iTabIndex. */
     void prepareTab(int iTabIndex);
-    /** Prepare helper for button-box. */
+    /** Prepares button-box. */
     void prepareButtonBox();
-    /** Load settings helper. */
+    /** Loads settings. */
     void loadSettings();
 
-    /** Save settings helper. */
+    /** Saves settings. */
     void saveSettings();
-    /** General cleanup helper. */
+    /** Cleanups all. */
     void cleanup();
 
     /** @name General variables.
      * @{ */
-    /** Dialog instance pointer. */
+    /** Holds the dialog instance. */
     static UIVMInformationDialog *m_spInstance;
     /** @} */
@@ -98 +98 @@
     /** @name Widget variables.
      * @{ */
-    /** Dialog tab-widget. */
+    /** Holds the dialog tab-widget instance. */
     QITabWidget               *m_pTabWidget;
-    /** Dialog tabs map. */
+    /** Holds the map of dialog tab instances. */
     QMap<int, QWidget*>        m_tabs;
-    /** Dialog button-box. */
+    /** Holds the dialog button-box instance. */
     QIDialogButtonBox         *m_pButtonBox;
-    /** machine-window. */
+    /** Holds the machine-window reference. */
     UIMachineWindow         *m_pMachineWindow;
     /** @} */