Changeset 55099 in vbox

Timestamp:

Apr 3, 2015 6:15:39 PM (10 years ago)

Author:

vboxsync

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

99394

Message:

FE/Qt: 7127: Medium-enumeration improvements: UIMedium source doxy and coding style fixes.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/medium

Files:

• UIMedium.cpp (modified) (16 diffs)
• UIMedium.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/medium/UIMedium.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2009-2013 Oracle Corporation
+ * Copyright (C) 2009-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -19 +19 @@
 # include <precomp.h>
 #else  /* !VBOX_WITH_PRECOMPILED_HEADERS */
-
 /* Qt includes: */
 # include <QDir>
-
 /* GUI includes: */
 # include "UIMedium.h"
@@ -30 +28 @@
 # include "UIExtraDataManager.h"
 # include "UIIconPool.h"
-
 /* COM includes: */
 # include "CMachine.h"
 # include "CSnapshot.h"
-
 #endif /* !VBOX_WITH_PRECOMPILED_HEADERS */
-
 
 QString UIMedium::m_sstrNullID = QUuid().toString().remove('{').remove('}');
@@ -44 +39 @@
 UIMedium::UIMedium()
     : m_type(UIMediumType_Invalid)
+    , m_medium(CMedium())
     , m_state(KMediumState_NotCreated)
 {
     refresh();
-//    printf("UIMedium: New NULL medium created.\n");
 }
 
 UIMedium::UIMedium(const CMedium &medium, UIMediumType type)
-    : m_medium(medium)
-    , m_type(type)
+    : m_type(type)
+    , m_medium(medium)
     , m_state(KMediumState_NotCreated)
 {
     refresh();
-//    printf("UIMedium: New medium with ID={%s} created.\n", id().toAscii().constData());
 }
 
 UIMedium::UIMedium(const CMedium &medium, UIMediumType type, KMediumState state)
-    : m_medium(medium)
-    , m_type(type)
+    : m_type(type)
+    , m_medium(medium)
     , m_state(state)
 {
     refresh();
-//    printf("UIMedium: New medium with ID={%s} created (with known state).\n", id().toAscii().constData());
 }
 
@@ -75 +68 @@
 UIMedium& UIMedium::operator=(const UIMedium &other)
 {
+    m_type = other.type();
+
     m_medium = other.medium();
-    m_type = other.type();
+
     m_state = other.state();
+    m_result = other.result();
     m_strLastAccessError = other.lastAccessError();
-    m_result = other.result();
+
+    m_strId = other.id();
+    m_strRootId = other.rootID();
+    m_strParentId = other.parentID();
 
     m_strKey = other.key();
-    m_strId = other.id();
+
     m_strName = other.name();
     m_strLocation = other.location();
@@ -89 +88 @@
     m_strLogicalSize = other.logicalSize();
 
+    m_strHardDiskType = other.hardDiskType();
     m_strHardDiskFormat = other.hardDiskFormat();
-    m_strHardDiskType = other.hardDiskType();
-
     m_strStorageDetails = other.storageDetails();
 
     m_strUsage = other.usage();
     m_strToolTip = other.tip();
+    m_machineIds = other.machineIds();
+    m_curStateMachineIds = other.curStateMachineIds();
+
+    m_noDiffs = other.cache();
 
     m_fHidden = other.m_fHidden;
@@ -103 +105 @@
     m_fHostDrive = other.isHostDrive();
 
-    m_machineIds = other.machineIds();
-    m_curStateMachineIds = other.curStateMachineIds();
-
-    m_strParentID = other.parentID();
-    m_strRootID = other.rootID();
-
-    m_noDiffs = other.cache();
-
     return *this;
 }
 
-/**
- * Queries the medium state. Call this and then read the state field instead
- * of calling GetState() on medium directly as it will properly handle the
- * situation when GetState() itself fails by setting state to Inaccessible
- * and memorizing the error info describing why GetState() failed.
- *
- * As the last step, this method calls #refresh() to refresh all precomposed
- * strings.
- *
- * @note This method blocks for the duration of the state check. Since this
- *       check may take quite a while (e.g. for a medium located on a
- *       network share), the calling thread must not be the UI thread. You
- *       have been warned.
- */
 void UIMedium::blockAndQueryState()
 {
@@ -149 +129 @@
 }
 
-/**
- * Refreshes the precomposed strings containing such media parameters as
- * location, size by querying the respective data from the associated
- * media object.
- *
- * Note that some string such as #size() are meaningless if the media state is
- * KMediumState_NotCreated (i.e. the medium has not yet been checked for
- * accessibility).
- */
 void UIMedium::refresh()
 {
@@ -199 +170 @@
 
     /* Initialize parent/root IDs: */
-    m_strParentID = nullID();
-    m_strRootID = m_strId;
+    m_strParentId = nullID();
+    m_strRootId = m_strId;
     if (m_type == UIMediumType_HardDisk)
     {
@@ -217 +188 @@
         CMedium parentMedium = m_medium.GetParent();
         if (!parentMedium.isNull())
-            m_strParentID = parentMedium.GetId();
+            m_strParentId = parentMedium.GetId();
         while (!parentMedium.isNull())
         {
-            m_strRootID = parentMedium.GetId();
+            m_strRootId = parentMedium.GetId();
             parentMedium = parentMedium.GetParent();
         }
@@ -369 +340 @@
 void UIMedium::updateParentID()
 {
-    m_strParentID = nullID();
+    m_strParentId = nullID();
     if (m_type == UIMediumType_HardDisk)
     {
         CMedium parentMedium = m_medium.GetParent();
         if (!parentMedium.isNull())
-            m_strParentID = parentMedium.GetId();
+            m_strParentId = parentMedium.GetId();
     }
 }
@@ -381 +352 @@
 {
     /* Redirect call to VBoxGlobal: */
-    return vboxGlobal().medium(m_strParentID);
+    return vboxGlobal().medium(m_strParentId);
 }
 
@@ -387 +358 @@
 {
     /* Redirect call to VBoxGlobal: */
-    return vboxGlobal().medium(m_strRootID);
-}
-
-/**
- * Returns generated tooltip for this medium.
- *
- * In "don't show diffs" mode (where the attributes of the base hard disk are
- * shown instead of the attributes of the differencing hard disk), extra
- * information will be added to the tooltip to give the user a hint that the
- * medium is actually a differencing hard disk.
- *
- * @param fNoDiffs  @c true to enable user-friendly "don't show diffs" mode.
- * @param fCheckRO  @c true to perform the #readOnly() check and add a notice
- *                  accordingly.
- */
-QString UIMedium::toolTip (bool fNoDiffs /* = false */, bool fCheckRO /* = false */, bool fNullAllowed /* = false */) const
+    return vboxGlobal().medium(m_strRootId);
+}
+
+QString UIMedium::toolTip(bool fNoDiffs /* = false */, bool fCheckRO /* = false */, bool fNullAllowed /* = false */) const
 {
     QString strTip;
@@ -428 +387 @@
 }
 
-/**
- * Returns an icon corresponding to the media state. Distinguishes between
- * the Inaccessible state and the situation when querying the state itself
- * failed.
- *
- * In "don't show diffs" mode (where the attributes of the base hard disk are
- * shown instead of the attributes of the differencing hard disk), the most
- * worst media state on the given hard disk chain will be used to select the
- * media icon.
- *
- * @param fNoDiffs  @c true to enable user-friendly "don't show diffs" mode.
- * @param fCheckRO  @c true to perform the #readOnly() check and change the icon
- *                  accordingly.
- */
 QPixmap UIMedium::icon(bool fNoDiffs /* = false */, bool fCheckRO /* = false */) const
 {
@@ -458 +403 @@
 }
 
-/**
- * Returns the details of this medium as a single-line string
- *
- * For hard disks, the details include the location, type and the logical size
- * of the hard disk. Note that if @a fNoDiffs is @c true, these properties are
- * queried on the root hard disk of the given hard disk because the primary
- * purpose of the returned string is to be human readable (so that seeing a
- * complex diff hard disk name is usually not desirable).
- *
- * For other media types, the location and the actual size are returned.
- * Arguments @a fPredictDiff and @a aNoRoot are ignored in this case.
- *
- * @param fNoDiffs      @c true to enable user-friendly "don't show diffs" mode.
- * @param fPredictDiff  @c true to mark the hard disk as differencing if
- *                      attaching it would create a differencing hard disk (not
- *                      used when @a aNoRoot is true).
- * @param fUseHTML      @c true to allow for emphasizing using bold and italics.
- *
- * @note Use #detailsHTML() instead of passing @c true for @a fUseHTML.
- *
- * @note The media object may become uninitialized by a third party while this
- *       method is reading its properties. In this case, the method will return
- *       an empty string.
- */
 QString UIMedium::details(bool fNoDiffs /* = false */,
                           bool fPredictDiff /* = false */,
@@ -583 +504 @@
 }
 
-/**
- * Checks if m_noDiffs is filled in and does it if not.
- *
- * @param fNoDiffs  @if false, this method immediately returns.
- */
 void UIMedium::checkNoDiffs(bool fNoDiffs)
 {

trunk/src/VBox/Frontends/VirtualBox/src/medium/UIMedium.h

@@ -151 +151 @@
 
     /** Returns the medium root ID. */
-    QString rootID() const { return m_strRootID; }
+    QString rootID() const { return m_strRootId; }
     /** Returns the medium parent ID. */
-    QString parentID() const { return m_strParentID; }
+    QString parentID() const { return m_strParentId; }
 
     /** Returns medium root. */
@@ -309 +309 @@
     QString m_strId;
     /** Holds the medium root ID. */
-    QString m_strRootID;
+    QString m_strRootId;
     /** Holds the medium parent ID. */
-    QString m_strParentID;
+    QString m_strParentId;
 
     /** Holds the medium cache key. */