Changeset 12010 in vbox for trunk/src/VBox/Frontends/VirtualBox4/include

Timestamp:

Sep 2, 2008 10:08:52 PM (17 years ago)

Author:

vboxsync

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

35922

Message:

FE/Qt4: Unified the Help menu (using the VBoxHelpActions struct).

Location:

trunk/src/VBox/Frontends/VirtualBox4/include

Files:

• VBoxConsoleWnd.h (modified) (3 diffs)
• VBoxGlobal.h (modified) (1 diff)
• VBoxProblemReporter.h (modified) (4 diffs)
• VBoxSelectorWnd.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox4/include/VBoxConsoleWnd.h

@@ -25 +25 @@
 
 #include "COMDefs.h"
+
 #include "QIWithRetranslateUI.h"
+
+#include "VBoxProblemReporter.h"
 
 /* Qt includes */
@@ -32 +35 @@
 #include <QColor>
 #include <QDialog>
-
 
 #ifdef VBOX_WITH_DEBUGGER_GUI
@@ -239 +241 @@
 
     // Help actions
-    QAction *helpContentsAction;
-    QAction *helpWebAction;
-    QAction *helpRegisterAction;
-    QAction *helpUpdateAction;
-    QAction *helpAboutAction;
-    QAction *helpResetMessagesAction;
+    VBoxHelpActions mHelpActions;
 
     // Machine popup menus

trunk/src/VBox/Frontends/VirtualBox4/include/VBoxGlobal.h

@@ -198 +198 @@
 };
 
-// VBoxGlobal
+// VBoxGlobal class
 ////////////////////////////////////////////////////////////////////////////////
 

trunk/src/VBox/Frontends/VirtualBox4/include/VBoxProblemReporter.h

@@ -30 +30 @@
 #include <QObject>
 
+class QAction;
+class QMenu;
+
+// VBoxHelpActions class
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Help Menu action container.
+ *
+ * Contains actions for all help menu items and methods to insert them to a
+ * QMenu and to perform NLS string translation.
+ *
+ * Instances of this class are to be created as members of QWidget classes that
+ * need a Help menu. The containing class usually passes itself as an argument
+ * to the #setup() method and then calls #addTo() to add actions to its Help
+ * menu. The #retranslateUi() method is called when it is necessary to
+ * re-translate all action NLS according to the current language.
+ */
+struct VBoxHelpActions
+{
+    VBoxHelpActions()
+        : contentsAction (NULL), webAction (NULL)
+        , resetMessagesAction (NULL), registerAction (NULL)
+        , updateAction (NULL), aboutAction (NULL)
+        {}
+
+    void setup (QObject *aParent);
+    void addTo (QMenu *aMenu);
+    void retranslateUi();
+
+    QAction *contentsAction;
+    QAction *webAction;
+    QAction *resetMessagesAction;
+    QAction *registerAction;
+    QAction *updateAction;
+    QAction *aboutAction;
+};
+
+// VBoxProblemReporter class
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * The VBoxProblemReporter class is a central place to handle all problem/error
+ * situations that happen during application runtime and require the user's
+ * attention.
+ *
+ * The role of this class is to describe the problem and/or the cause of the
+ * error to the user and give him the opportunity to select an action (when
+ * appropriate).
+ *
+ * Every problem sutiation has its own (correspondingly named) method in this
+ * class that takes a list of arguments necessary to describe the situation and
+ * to provide the appropriate actions. The method then returns the choice to the
+ * caller.
+ */
 class VBoxProblemReporter : public QObject
 {
@@ -36 +91 @@
 public:
 
-    enum Type {
+    enum Type
+    {
         Info = 1,
         Question,
@@ -44 +100 @@
         GuruMeditation
     };
-    enum {
+
+    enum
+    {
         AutoConfirmed = 0x8000
     };
@@ -339 +397 @@
 };
 
+/**
+ * Shortcut to the static VBoxProblemReporter::instance() method, for
+ * convenience.
+ */
 inline VBoxProblemReporter &vboxProblem() { return VBoxProblemReporter::instance(); }
 

trunk/src/VBox/Frontends/VirtualBox4/include/VBoxSelectorWnd.h

@@ -27 +27 @@
 
 #include "QIWithRetranslateUI.h"
+
 #include "VBoxGlobal.h"
+#include "VBoxProblemReporter.h"
 
 /* Qt includes */
@@ -126 +128 @@
     QAction *vmRefreshAction;
     QAction *vmShowLogsAction;
-    QAction *helpContentsAction;
-    QAction *helpWebAction;
-    QAction *helpRegisterAction;
-    QAction *helpUpdateAction;
-    QAction *helpAboutAction;
-    QAction *helpResetMessagesAction;
+
+    VBoxHelpActions mHelpActions;
 
     /* The vm list view/model */