Changeset 72018 in vbox for trunk

Timestamp:

Apr 25, 2018 1:47:29 PM (7 years ago)

Author:

vboxsync

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

122279

Message:

FE/Qt: bugref:9049: Full and heavy cleanup for UIWizardPage and move it to VBoxGlobal library.

Location:

trunk/src/VBox/Frontends/VirtualBox

Files:

• Makefile.kmk (modified) (6 diffs)
• src/wizards/UIWizardPage.cpp (modified) (6 diffs)
• src/wizards/UIWizardPage.h (modified) (4 diffs)

trunk/src/VBox/Frontends/VirtualBox/Makefile.kmk

@@ -568 +568 @@
         src/widgets/graphics/UIGraphicsToolBar.h \
         src/widgets/graphics/UIGraphicsTextPane.h \
-        src/wizards/UIWizardPage.h \
         src/wizards/newvm/UIWizardNewVM.h \
         src/wizards/newvm/UIWizardNewVMPageBasic1.h \
@@ -675 +674 @@
         src/selector/UIVirtualBoxEventHandler.h \
         src/wizards/UIWizard.h \
+        src/wizards/UIWizardPage.h \
         src/widgets/UIBootTable.h \
         src/widgets/UIFilePathSelector.h \
@@ -775 +775 @@
         src/selector/UIVirtualBoxEventHandler.h \
         src/wizards/UIWizard.h \
+        src/wizards/UIWizardPage.h \
         src/widgets/UIBootTable.h \
         src/widgets/UIFilePathSelector.h \
@@ -1068 +1069 @@
         src/widgets/graphics/UIGraphicsToolBar.cpp \
         src/widgets/graphics/UIGraphicsTextPane.cpp \
-        src/wizards/UIWizardPage.cpp \
         src/wizards/newvm/UIWizardNewVM.cpp \
         src/wizards/newvm/UIWizardNewVMPageBasic1.cpp \
@@ -1214 +1214 @@
         src/settings/UISettingsDefs.cpp \
         src/wizards/UIWizard.cpp \
+        src/wizards/UIWizardPage.cpp \
         src/widgets/UIBootTable.cpp \
         src/widgets/UIFilePathSelector.cpp \
@@ -1340 +1341 @@
         src/settings/UISettingsDefs.cpp \
         src/wizards/UIWizard.cpp \
+        src/wizards/UIWizardPage.cpp \
         src/widgets/UIBootTable.cpp \
         src/widgets/UIFilePathSelector.cpp \

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2009-2017 Oracle Corporation
+ * Copyright (C) 2009-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -20 +20 @@
 #else  /* !VBOX_WITH_PRECOMPILED_HEADERS */
 
-/* Global includes: */
+/* Qt includes: */
 # include <QAbstractButton>
 
-/* Local includes: */
+/* GUI includes: */
+# include "VBoxGlobal.h"
+# include "UIWizard.h"
 # include "UIWizardPage.h"
-# include "UIWizard.h"
-# include "VBoxGlobal.h"
 
 #endif /* !VBOX_WITH_PRECOMPILED_HEADERS */
 
 
-UIWizard* UIWizardPageBase::wizardImp()
+/*********************************************************************************************************************************
+*   Class UIWizardPageBase implementation.                                                                                       *
+*********************************************************************************************************************************/
+
+UIWizard *UIWizardPageBase::wizardImp()
 {
     /* Should be reimplemented in sub-class to enable access to wizard! */
@@ -38 +42 @@
 }
 
-UIWizardPage* UIWizardPageBase::thisImp()
+UIWizardPage *UIWizardPageBase::thisImp()
 {
     /* Should be reimplemented in sub-class to enable access to wizard page! */
@@ -51 +55 @@
     return QVariant();
 }
+
+
+/*********************************************************************************************************************************
+*   Class UIWizardPage implementation.                                                                                           *
+*********************************************************************************************************************************/
 
 UIWizardPage::UIWizardPage()
@@ -70 +79 @@
 }
 
-UIWizard* UIWizardPage::wizard() const
+UIWizard *UIWizardPage::wizard() const
 {
     return qobject_cast<UIWizard*>(QWizardPage::wizard());
@@ -86 +95 @@
         wizard()->button(QWizard::FinishButton)->setEnabled(true);
 }
-

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2009-2017 Oracle Corporation
+ * Copyright (C) 2009-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -19 +19 @@
 #define ___UIWizardPage_h___
 
-/* Global includes: */
+/* Qt includes: */
 #include <QVariant>
 #include <QWizardPage>
 
-/* Local includes: */
+/* GUI includes: */
 #include "QIWithRetranslateUI.h"
+#include "UILibraryDefs.h"
 
 /* Forward declarations: */
@@ -30 +31 @@
 class UIWizardPage;
 
-/* One of interfaces for wizard page,
- * providing API for basic/expert pages. */
-class UIWizardPageBase
+
+/** One of two interfaces for wizard page.
+  * This is page-BASE providing access API for basic/expert pages. */
+class SHARED_LIBRARY_STUFF UIWizardPageBase
 {
 public:
+
+    /** Destructs wizard page-base. */
     virtual ~UIWizardPageBase() { /* Makes MSC happy. */ }
 
 protected:
 
-    /* Helpers: */
-    virtual UIWizard* wizardImp();
-    virtual UIWizardPage* thisImp();
+    /** Returns wizard this page-base belongs to. */
+    virtual UIWizard *wizardImp();
+
+    /** Returns wizard page this page-base belongs to. */
+    virtual UIWizardPage *thisImp();
+
+    /** Returns page field with certain @a strFieldName. */
     virtual QVariant fieldImp(const QString &strFieldName) const;
 };
 
-/* One of interfaces for wizard page,
- * QWizardPage class reimplementation with extended funtionality. */
-class UIWizardPage : public QIWithRetranslateUI<QWizardPage>
+
+/** One of two interfaces for wizard page.
+  * This is page-BODY based on QWizardPage with advanced functionality. */
+class SHARED_LIBRARY_STUFF UIWizardPage : public QIWithRetranslateUI<QWizardPage>
 {
     Q_OBJECT;
@@ -53 +62 @@
 public:
 
-    /* Constructor: */
+    /** Constructs wizard page. */
     UIWizardPage();
 
-    /* Translation stuff: */
+    /** Redirects the translation call to actual handler. */
     void retranslate() { retranslateUi(); }
 
-    /* Prepare stuff: */
+    /** Marks page ready. */
     void markReady();
 
-    /* Title stuff: */
+    /** Defines page @a strTitle. */
     void setTitle(const QString &strTitle);
 
 protected:
 
-    /* Helpers: */
-    UIWizard* wizard() const;
+    /** Returns wizard this page belongs to. */
+    UIWizard *wizard() const;
+
+    /** Starts page processing.  */
     void startProcessing();
+    /** Ends page processing.  */
     void endProcessing();
 
-    /* Variables: */
+    /** Holds whether page is ready. */
     bool m_fReady;
+    /** Holds the page title. */
     QString m_strTitle;
 };
 
+
 #endif
-