Changeset 71870 in vbox for trunk/src/VBox/Frontends/VirtualBox/src/extensions/QIMainDialog.h

Timestamp:

Apr 17, 2018 11:25:31 AM (7 years ago)

Author:

vboxsync

Message:

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

File:

• trunk/src/VBox/Frontends/VirtualBox/src/extensions/QIMainDialog.h (modified) (7 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/extensions/QIMainDialog.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBox Qt GUI - Qt extensions: QIMainDialog class implementation.
+ * VBox Qt GUI - Qt extensions: QIMainDialog class declaration.
  */
 
 /*
- * Copyright (C) 2008-2017 Oracle Corporation
+ * Copyright (C) 2008-2018 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -20 +20 @@
 
 /* Qt includes: */
+#include <QDialog>
 #include <QMainWindow>
 #include <QPointer>
-#include <QDialog>
+
+/* GUI includes: */
+#include "UILibraryDefs.h"
 
 /* Forward declarations: */
@@ -30 +33 @@
 
 /** QDialog analog based on QMainWindow. */
-class QIMainDialog: public QMainWindow
+class SHARED_LIBRARY_STUFF QIMainDialog : public QMainWindow
 {
     Q_OBJECT;
@@ -36 +39 @@
 public:
 
-    /** Constructor.
-      * @param pParent           holds the parent widget passed to the base-class,
-      * @param enmFlags          holds the cumulative window flags passed to the base-class,
-      * @param fIsAutoCentering  defines whether this dialog should be centered according it's parent. */
+    /** Constructs main-dialog passing @a pParent and @a fFlags to the base-class.
+      * @param  fIsAutoCentering  Brigs whether this dialog should be centered according it's parent. */
     QIMainDialog(QWidget *pParent = 0,
-                 Qt::WindowFlags enmFlags = Qt::Dialog,
+                 Qt::WindowFlags fFlags = Qt::Dialog,
                  bool fIsAutoCentering = true);
 
@@ -51 +52 @@
     QDialog::DialogCode exec(bool fApplicationModal = true);
 
-    /** Returns dialog's default-button. */
-    QPushButton* defaultButton() const;
-    /** Defines dialog's default-button. */
+    /** Returns dialog's default button. */
+    QPushButton *defaultButton() const;
+    /** Defines dialog's default @a pButton. */
     void setDefaultButton(QPushButton *pButton);
 
@@ -68 +69 @@
 protected:
 
-    /** General event handler. */
-    virtual bool event(QEvent *pEvent);
-    /** Show event handler. */
-    virtual void showEvent(QShowEvent *pEvent);
-    /** Our own polish event handler. */
+    /** Preprocesses any Qt @a pEvent for passed @a pObject. */
+    virtual bool eventFilter(QObject *pObject, QEvent *pEvent) /* override */;
+    /** Handles any Qt @a pEvent. */
+    virtual bool event(QEvent *pEvent) /* override */;
+
+    /** Handles show @a pEvent. */
+    virtual void showEvent(QShowEvent *pEvent) /* override */;
+    /** Handles first show @a pEvent. */
     virtual void polishEvent(QShowEvent *pEvent);
-    /** Resize event handler. */
-    virtual void resizeEvent(QResizeEvent *pEvent);
-    /** Key-press event handler. */
-    virtual void keyPressEvent(QKeyEvent *pEvent);
-    /** General event filter. */
-    virtual bool eventFilter(QObject *aObject, QEvent *pEvent);
 
-    /** Function to search for dialog's default-button. */
-    QPushButton* searchDefaultButton() const;
+    /** Handles resize @a pEvent. */
+    virtual void resizeEvent(QResizeEvent *pEvent) /* override */;
+
+    /** Handles key-press @a pEvent. */
+    virtual void keyPressEvent(QKeyEvent *pEvent) /* override */;
+
+    /** Searches for dialog's default button. */
+    QPushButton *searchDefaultButton() const;
 
 protected slots:
@@ -101 +105 @@
 
     /** Holds whether this dialog should be centered according it's parent. */
-    const bool m_fIsAutoCentering;
+    const bool  m_fIsAutoCentering;
     /** Holds whether this dialog is polished. */
-    bool m_fPolished;
+    bool        m_fPolished;
 
     /** Holds modal dialog's result code. */
-    QDialog::DialogCode m_enmResult;
+    QDialog::DialogCode   m_enmResult;
     /** Holds modal dialog's event-loop. */
-    QPointer<QEventLoop> m_pEventLoop;
+    QPointer<QEventLoop>  m_pEventLoop;
 
-    /** Holds dialog's default-button. */
-    QPointer<QPushButton> m_pDefaultButton;
+    /** Holds dialog's default button. */
+    QPointer<QPushButton>  m_pDefaultButton;
     /** Holds dialog's size-grip. */
-    QPointer<QSizeGrip> m_pSizeGrip;
+    QPointer<QSizeGrip>    m_pSizeGrip;
 };