Changeset 75370 in vbox

Timestamp:

Nov 9, 2018 4:41:58 PM (6 years ago)

Author:

vboxsync

Message:

FE/Qt: UIScaleFactorEditor defition comments

Location:

trunk/src/VBox/Frontends/VirtualBox/src/widgets

Files:

• UIScaleFactorEditor.cpp (modified) (1 diff)
• UIScaleFactorEditor.h (modified) (5 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/widgets/UIScaleFactorEditor.cpp

@@ -100 +100 @@
     }
 
-    // Insert 0th element as the global scalar value
+    /* Insert 0th element as the global scalar value: */
     m_scaleFactors.append(m_dDefaultScaleFactor);
     m_scaleFactors.append(scaleFactors);

trunk/src/VBox/Frontends/VirtualBox/src/widgets/UIScaleFactorEditor.h

@@ -19 +19 @@
 #define ___UIScaleFactorEditor_h___
 
-/* GUI includes: */
+/** GUI includes. */
 #include "QIWithRetranslateUI.h"
 #include "UILibraryDefs.h"
 
 
-/* Forward declarations: */
+/** Forward declarations. */
 class QComboBox;
 class QGridLayout;
@@ -33 +33 @@
 
 /** QWidget reimplementation providing GUI with monitor scale factor editing functionality.
- *  It includes a combo box to select a monitor, a slider, and a spinbox to display/modify values.
- *  The first item in the combo box is used to change the scale factor of all monitors.*/
+  *  It includes a combo box to select a monitor, a slider, and a spinbox to display/modify values.
+  *  The first item in the combo box is used to change the scale factor of all monitors. */
 class SHARED_LIBRARY_STUFF UIScaleFactorEditor : public QIWithRetranslateUI<QWidget>
 {
@@ -42 +42 @@
 
     UIScaleFactorEditor(QWidget *pParent);
+    /** Configures the internal variables (m_pMonitorComboBox items , m_scaleFactors' size, etc)
+      * wrt. @p iMonitorCount. */
     void           setMonitorCount(int iMonitorCount);
     void           setScaleFactors(const QList<double> &scaleFactors);
-    /* Returns either a single global scale factor or a list of scale factor for each monitor. */
+    /** Returns either a single global scale factor or a list of scale factor for each monitor. */
     QList<double>  scaleFactors() const;
     void           setDefaultScaleFactor(double dDefaultScaleFactor);
@@ -56 +58 @@
 private slots:
 
-    void sltScaleSpinBoxValueChanged(int value);
-    void sltScaleSliderValueChanged(int value);
-    void sltMonitorComboIndexChanged(int index);
+    /** @name Internal slots handling respective widget's value update.
+      * @{ */
+        void sltScaleSpinBoxValueChanged(int value);
+        void sltScaleSliderValueChanged(int value);
+        void sltMonitorComboIndexChanged(int index);
+    /** @} */
 
 private:
@@ -65 +70 @@
     void               setIsGlobalScaleFactor(bool bFlag);
     void               setScaleFactor(int iMonitorIndex, int iScaleFactor);
-    /* Blocks slider's signals before settting the value. */
+    /** Blocks slider's signals before settting the slider value. */
     void               setSliderValue(int iValue);
-    /* Blocks slider's signals before settting the value. */
+    /** Blocks spinbox's signals before settting the value. */
     void               setSpinBoxValue(int iValue);
-    /* Set the spinbox and slider to scale factor of currently selected monitor. */
+    /** Set the spinbox and slider to scale factor of currently selected monitor. */
     void               updateValuesAfterMonitorChange();
-    QSpinBox          *m_pScaleSpinBox;
-    QGridLayout       *m_pMainLayout;
-    QComboBox         *m_pMonitorComboBox;
-    QIAdvancedSlider  *m_pScaleSlider;
-    QLabel            *m_pMaxScaleLabel;
-    QLabel            *m_pMinScaleLabel;
-    /* Stores the per-monitor scale factors. The 0th item is for all monitors (global). */
+
+    /** @name Member widgets.
+      * @{ */
+        QSpinBox          *m_pScaleSpinBox;
+        QGridLayout       *m_pMainLayout;
+        QComboBox         *m_pMonitorComboBox;
+        QIAdvancedSlider  *m_pScaleSlider;
+        QLabel            *m_pMaxScaleLabel;
+        QLabel            *m_pMinScaleLabel;
+    /** @} */
+
+    /** Stores the per-monitor scale factors. The 0th item is for all monitors (global). */
     QList<double>      m_scaleFactors;
     double             m_dDefaultScaleFactor;