Changeset 49462 in vbox for trunk/src/VBox/Frontends

Timestamp:

Nov 13, 2013 12:29:44 PM (11 years ago)

Author:

vboxsync

Message:

FE/Qt: Runtime UI: Menu/menubar factory cleanup/rework.

Location:

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

Files:

• UIMachineMenuBar.cpp (modified) (10 diffs)
• UIMachineMenuBar.h (modified) (2 diffs)
• UISession.cpp (modified) (3 diffs)
• UISession.h (modified) (3 diffs)
• fullscreen/UIMachineWindowFullscreen.cpp (modified) (1 diff)
• scale/UIMachineWindowScale.cpp (modified) (1 diff)
• seamless/UIMachineWindowSeamless.cpp (modified) (1 diff)

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineMenuBar.cpp

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- *
- * VBox frontends: Qt GUI ("VirtualBox"):
- * UIMachineMenuBar class implementation
+ * VBox Qt GUI - UIMachineMenuBar class implementation.
  */
 
@@ -30 +28 @@
 #include "VBoxGlobal.h"
 #include "UIMessageCenter.h"
-#include "UIExtraDataEventHandler.h"
 #include "UIImageTools.h"
 #include "UINetworkManager.h"
-#include "VBoxGlobal.h"
-#include "UISession.h"
 
 /* COM includes: */
 #include "CMachine.h"
 
-/* Helper QMenu reimplementation which allows
- * to highlight first menu item for popped up menu: */
+
+/**
+ * QMenu sub-class with extended functionality.
+ * Allows to highlight first menu item for popped up menu.
+ */
 class QIMenu : public QMenu
 {
@@ -47 +45 @@
 public:
 
+    /** Constructor. */
     QIMenu() : QMenu(0) {}
 
 private slots:
 
-    void sltSelectFirstAction()
+    /** Highlights first menu action for popped up menu. */
+    void sltHighlightFirstAction()
     {
 #ifdef Q_WS_WIN
         activateWindow();
-#endif
+#endif /* Q_WS_WIN */
         QMenu::focusNextChild();
     }
 };
 
+
+/**
+ * QMenuBar sub-class with extended functionality.
+ * Reflects BETA label when necessary.
+ */
 class UIMenuBar: public QMenuBar
 {
+    Q_OBJECT;
+
 public:
 
+    /** Constructor. */
     UIMenuBar(QWidget *pParent = 0)
-      : QMenuBar(pParent)
-      , m_fShowBetaLabel(false)
-    {
-        /* Check for beta versions */
+        : QMenuBar(pParent)
+        , m_fShowBetaLabel(false)
+    {
+        /* Check for beta versions: */
         if (vboxGlobal().isBeta())
             m_fShowBetaLabel = true;
@@ -75 +83 @@
 protected:
 
+    /** Paint-event reimplementation. */
     void paintEvent(QPaintEvent *pEvent)
     {
@@ -96 +105 @@
 private:
 
-    /* Private member vars */
+    /** Reflects whether we should show BETA label or not. */
     bool m_fShowBetaLabel;
 };
 
-UIMachineMenuBar::UIMachineMenuBar(UISession *pSession, const CMachine &machine)
-    /* On the Mac we add some items only the first time, cause otherwise they
-     * will be merged more than once to the application menu by Qt. */
+
+UIMachineMenuBar::UIMachineMenuBar(UISession *pSession)
     : m_pSession(pSession)
-    , m_machine(machine)
 {
 }
@@ -167 +174 @@
     if (fOptions & RuntimeMenuType_Debug)
     {
-        CMachine machine; /** @todo we should try get the machine here. But we'll
-                           *        probably be fine with the cached values. */
+        CMachine machine = m_pSession->session().GetMachine();
         if (vboxGlobal().isDebuggerEnabled(machine))
         {
@@ -176 +182 @@
         }
     }
-#endif
+#endif /* VBOX_WITH_DEBUGGER_GUI */
 
     /* Help submenu: */
@@ -198 +204 @@
     /* Machine submenu: */
     pMenu->addAction(gActionPool->action(UIActionIndexRuntime_Simple_SettingsDialog));
-    if (vboxGlobal().shouldWeAllowSnapshotOperations(m_machine))
+    if (m_pSession->isSnapshotOperationsAllowed())
         pMenu->addAction(gActionPool->action(UIActionIndexRuntime_Simple_TakeSnapshot));
     else
@@ -210 +216 @@
 #ifdef Q_WS_X11
     pMenu->addAction(gActionPool->action(UIActionIndexRuntime_Simple_TypeCABS));
-#endif
+#endif /* Q_WS_X11 */
     pMenu->addSeparator();
     pMenu->addAction(gActionPool->action(UIActionIndexRuntime_Toggle_Pause));
@@ -228 +234 @@
 
     /* View submenu: */
-    bool fIsAllowedFullscreen = uisession()->isVisualStateAllowedFullscreen();
-    bool fIsAllowedSeamless = uisession()->isVisualStateAllowedSeamless();
-    bool fIsAllowedScale = uisession()->isVisualStateAllowedScale();
+    bool fIsAllowedFullscreen = m_pSession->isVisualStateAllowedFullscreen();
+    bool fIsAllowedSeamless = m_pSession->isVisualStateAllowedSeamless();
+    bool fIsAllowedScale = m_pSession->isVisualStateAllowedScale();
     gActionPool->action(UIActionIndexRuntime_Toggle_Fullscreen)->setEnabled(fIsAllowedFullscreen);
     if (fIsAllowedFullscreen)

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineMenuBar.h

@@ -1 +1 @@
 /** @file
- *
- * VBox frontends: Qt GUI ("VirtualBox"):
- * UIMachineMenuBar class declaration
+ * VBox Qt GUI - UIMachineMenuBar class declaration.
  */
 
 /*
- * Copyright (C) 2010-2011 Oracle Corporation
+ * Copyright (C) 2010-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -17 +15 @@
  */
 
-#ifndef __UIMachineMenuBar_h__
-#define __UIMachineMenuBar_h__
+#ifndef ___UIMachineMenuBar_h___
+#define ___UIMachineMenuBar_h___
 
-/* Local includes */
+/* Qt includes: */
+#include <QList>
+
+/* GUI includes: */
 #include "UIDefs.h"
 
-/* Global includes */
-#include <QList>
-
-/* COM includes: */
-#include "COMEnums.h"
-#include "CMachine.h"
-
-/* Global forwards */
+/* Forward declarations: */
 class QMenu;
 class QMenuBar;
 class UISession;
 
+/**
+ * Menubar factory for virtual machine (Runtime UI).
+ * Provides client with the new menu/menubar whenever it necessary.
+ */
 class UIMachineMenuBar
 {
 public:
 
-    UIMachineMenuBar(UISession *pSession, const CMachine &machine);
+    /** Constructor. Stores UI session pointer for further needs. */
+    UIMachineMenuBar(UISession *pSession);
 
+    /** Provides client with new menu. */
     QMenu* createMenu(RuntimeMenuType fOptions = RuntimeMenuType_All);
+    /** Provides client with new menubar. */
     QMenuBar* createMenuBar(RuntimeMenuType fOptions = RuntimeMenuType_All);
 
-protected:
+private:
 
+    /** Populates all the sub-menus client need. */
     QList<QMenu*> prepareSubMenus(RuntimeMenuType fOptions = RuntimeMenuType_All);
+    /** Populates <b>Machine</b> sub-menu. */
     void prepareMenuMachine(QMenu *pMenu);
+    /** Populates <b>View</b> sub-menu. */
     void prepareMenuView(QMenu *pMenu);
+    /** Populates <b>Devices</b> sub-menu. */
     void prepareMenuDevices(QMenu *pMenu);
 #ifdef VBOX_WITH_DEBUGGER_GUI
+    /** Populates <b>Debug</b> sub-menu. */
     void prepareMenuDebug(QMenu *pMenu);
-#endif
+#endif /* VBOX_WITH_DEBUGGER_GUI */
+    /** Populates <b>Help</b> sub-menu. */
     void prepareMenuHelp(QMenu *pMenu);
 
-    /* Helper: UI session stuff: */
-    UISession* uisession() const { return m_pSession; }
-
-    /* Variables: */
+    /** Contains pointer to parent UI session. */
     UISession *m_pSession;
-    CMachine m_machine;
 };
 
-#endif /* __UIMachineMenuBar_h__ */
+#endif /* !___UIMachineMenuBar_h___ */
 

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UISession.cpp

@@ -132 +132 @@
     , m_pWatchdogDisplayChange(0)
 #endif /* Q_WS_MAC */
+    , m_fSnapshotOperationsAllowed(true)
     /* Common flags: */
     , m_fIsFirstTimeStarted(false)
@@ -1054 +1055 @@
 void UISession::prepareMenuPool()
 {
-    m_pMenuPool = new UIMachineMenuBar(this, session().GetMachine());
+    m_pMenuPool = new UIMachineMenuBar(this);
 }
 
@@ -1085 +1086 @@
         m_fReconfigurable = VBoxGlobal::shouldWeAllowMachineReconfiguration(machine);
         updateSessionSettings();
+
+        /* Should we allow snapshot operations? */
+        m_fSnapshotOperationsAllowed = vboxGlobal().shouldWeAllowSnapshotOperations(machine);
 
 #if 0 /* Disabled for now! */

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UISession.h

@@ -105 +105 @@
     QCursor cursor() const { return m_cursor; }
 
+    /** @name Snapshot Operations configuration stuff.
+     * @{ */
+    /** Returns whether we should allow snapshot operations. */
+    bool isSnapshotOperationsAllowed() const { return m_fSnapshotOperationsAllowed; }
+    /** @} */
+
     /* API: Visual-state stuff: */
     bool isVisualStateAllowedFullscreen() const;
@@ -298 +304 @@
     KMachineState m_machineState;
     QCursor m_cursor;
+
 #if defined(Q_WS_WIN)
     HCURSOR m_alphaCursor;
 #endif
+
 #ifdef Q_WS_MAC
     /** @name MacOS X: Display reconfiguration variables.
@@ -311 +319 @@
 #endif /* Q_WS_MAC */
 
+    /** @name Snapshot Operations configuration variables.
+     * @{ */
+    /** Determines whether we should allow snapshot operations. */
+    bool m_fSnapshotOperationsAllowed;
+    /** @} */
+
     /* Common flags: */
     bool m_fIsFirstTimeStarted : 1;

trunk/src/VBox/Frontends/VirtualBox/src/runtime/fullscreen/UIMachineWindowFullscreen.cpp

@@ -58 +58 @@
     {
         m_pMainMenu->popup(geometry().center());
-        QTimer::singleShot(0, m_pMainMenu, SLOT(sltSelectFirstAction()));
+        QTimer::singleShot(0, m_pMainMenu, SLOT(sltHighlightFirstAction()));
     }
 }

trunk/src/VBox/Frontends/VirtualBox/src/runtime/scale/UIMachineWindowScale.cpp

@@ -50 +50 @@
     {
         m_pMainMenu->popup(geometry().center());
-        QTimer::singleShot(0, m_pMainMenu, SLOT(sltSelectFirstAction()));
+        QTimer::singleShot(0, m_pMainMenu, SLOT(sltHighlightFirstAction()));
     }
 }

trunk/src/VBox/Frontends/VirtualBox/src/runtime/seamless/UIMachineWindowSeamless.cpp

@@ -67 +67 @@
     {
         m_pMainMenu->popup(geometry().center());
-        QTimer::singleShot(0, m_pMainMenu, SLOT(sltSelectFirstAction()));
+        QTimer::singleShot(0, m_pMainMenu, SLOT(sltHighlightFirstAction()));
     }
 }