Changeset 43590 in vbox for trunk

Timestamp:

Oct 10, 2012 1:13:15 PM (12 years ago)

Author:

vboxsync

Message:

FE/Qt: VM group feature UI: Few comments cleanup.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/selector/graphics/chooser/UIGChooserModel.cpp (modified) (43 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/selector/graphics/chooser/UIGChooserModel.cpp

@@ -168 +168 @@
     int iViewportWidth = viewportSize.width() - 2 * iSceneMargin;
     int iViewportHeight = viewportSize.height() - 2 * iSceneMargin;
-    /* Set root item position: */
+    /* Set root-item position: */
     root()->setPos(iSceneMargin, iSceneMargin);
-    /* Set root item size: */
+    /* Set root-item size: */
     root()->resize(iViewportWidth, iViewportHeight);
-    /* Relayout root item: */
+    /* Relayout root-item: */
     root()->updateLayout();
-    /* Make sure root is shown: */
+    /* Make sure root-item is shown: */
     root()->show();
     /* Notify listener about root-item relayouted: */
@@ -198 +198 @@
 void UIGChooserModel::updateNavigation()
 {
-    /* Recreate navigation list: */
     clearNavigationList();
     m_navigationList = createNavigationList(root());
@@ -211 +210 @@
 QList<UIVMItem*> UIGChooserModel::currentMachineItems() const
 {
-    /* Populate list of selected machines: */
+    /* Populate list of selected machine-items: */
     QList<UIVMItem*> currentMachineItemList;
     enumerateCurrentItems(currentItems(), currentMachineItemList);
@@ -352 +351 @@
 bool UIGChooserModel::isAllItemsOfOneGroupSelected() const
 {
-    /* Make sure at least on item selected: */
+    /* Make sure at least one item selected: */
     if (currentItems().isEmpty())
         return false;
@@ -359 +358 @@
     UIGChooserItem *pFirstParent = currentItem()->parentItem();
 
-    /* Make sure this parent is not main root item: */
+    /* Make sure this parent is not main root-item: */
     if (pFirstParent == mainRoot())
         return false;
@@ -400 +399 @@
     if (pOldFocusItem)
         disconnect(pOldFocusItem, SIGNAL(destroyed(QObject*)), this, SLOT(sltFocusItemDestroyed()));
-    /* Connect new focus item (if any): */
+    /* Connect new focus-item (if any): */
     if (m_pFocusItem)
         connect(m_pFocusItem, SIGNAL(destroyed(QObject*)), this, SLOT(sltFocusItemDestroyed()));
@@ -420 +419 @@
 void UIGChooserModel::indentRoot(UIGChooserItem *pNewRootItem)
 {
-    /* Do nothing is sliding already: */
+    /* Do nothing if sliding already: */
     if (m_fSliding)
         return;
@@ -453 +452 @@
 void UIGChooserModel::unindentRoot()
 {
-    /* Do nothing is sliding already: */
+    /* Do nothing if sliding already: */
     if (m_fSliding)
         return;
@@ -580 +579 @@
 void UIGChooserModel::sltMachineStateChanged(QString strId, KMachineState)
 {
-    /* Update machine items with passed id: */
+    /* Update machine-items with passed id: */
     updateMachineItems(strId, mainRoot());
 }
@@ -586 +585 @@
 void UIGChooserModel::sltMachineDataChanged(QString strId)
 {
-    /* Update machine items with passed id: */
+    /* Update machine-items with passed id: */
     updateMachineItems(strId, mainRoot());
 }
@@ -630 +629 @@
 void UIGChooserModel::sltSessionStateChanged(QString strId, KSessionState)
 {
-    /* Update machine items with passed id: */
+    /* Update machine-items with passed id: */
     updateMachineItems(strId, mainRoot());
 }
@@ -636 +635 @@
 void UIGChooserModel::sltSnapshotChanged(QString strId, QString)
 {
-    /* Update machine items with passed id: */
+    /* Update machine-items with passed id: */
     updateMachineItems(strId, mainRoot());
 }
@@ -764 +763 @@
 {
     /* Make sure focus item is of group type! */
-    AssertMsg(focusItem()->type() == UIGChooserItemType_Group, ("This is not group item!"));
+    AssertMsg(focusItem()->type() == UIGChooserItemType_Group, ("This is not group-item!"));
 
     /* Check if we have collisions with our siblings: */
@@ -913 +912 @@
 void UIGChooserModel::sltRemoveCurrentlySelectedMachine()
 {
-    /* Enumerate all the selected machine items: */
+    /* Enumerate all the selected machine-items: */
     QList<UIGChooserItem*> selectedMachineItemList = gatherMachineItems(currentItems());
-    /* Enumerate all the existing machine items: */
+    /* Enumerate all the existing machine-items: */
     QList<UIGChooserItem*> existingMachineItemList = gatherMachineItems(mainRoot()->items());
 
@@ -922 +921 @@
     QMap<QString, QString> namesMap;
 
-    /* For each selected machine item: */
+    /* For each selected machine-item: */
     foreach (UIGChooserItem *pItem, selectedMachineItemList)
     {
@@ -1019 +1018 @@
 void UIGChooserModel::sltCurrentDragObjectDestroyed()
 {
-    /* Reset drag tokens starting from the root item: */
     root()->resetDragToken();
 }
@@ -1083 +1081 @@
 void UIGChooserModel::prepareContextMenu()
 {
-    /* Context menu for group: */
+    /* Context menu for group(s): */
     m_pContextMenuGroup = new QMenu;
     m_pContextMenuGroup->addAction(gActionPool->action(UIActionIndexSelector_Simple_Group_New));
@@ -1262 +1260 @@
         return QObject::eventFilter(pWatched, pEvent);
 
-    /* Process only item is focused by model, not by scene: */
+    /* Process only item focused by model: */
     if (scene()->focusItem())
         return QObject::eventFilter(pWatched, pEvent);
@@ -1281 +1279 @@
         case QEvent::GraphicsSceneMouseDoubleClick:
             return m_pMouseHandler->handle(static_cast<QGraphicsSceneMouseEvent*>(pEvent), UIMouseEventType_DoubleClick);
-        /* Context menu: */
+        /* Context-menu handler: */
         case QEvent::GraphicsSceneContextMenu:
             return processContextMenuEvent(static_cast<QGraphicsSceneContextMenuEvent*>(pEvent));
-        /* Improvised scroll event: */
+        /* Drag&drop scroll-event handler: */
         case QEvent::GraphicsSceneDragMove:
             return processDragMoveEvent(static_cast<QGraphicsSceneDragDropEvent*>(pEvent));
@@ -1298 +1296 @@
     QList<UIGChooserItem*> navigationItems;
 
-    /* Iterate over all the group items: */
+    /* Iterate over all the group-items: */
     foreach (UIGChooserItem *pGroupItem, pItem->items(UIGChooserItemType_Group))
     {
@@ -1305 +1303 @@
             navigationItems << createNavigationList(pGroupItem);
     }
-    /* Iterate over all the machine items: */
+    /* Iterate over all the machine-items: */
     foreach (UIGChooserItem *pMachineItem, pItem->items(UIGChooserItemType_Machine))
         navigationItems << pMachineItem;
@@ -1318 +1316 @@
     foreach (UIGChooserItem *pItem, list)
     {
-        /* If that is machine-item, just return it: */
+        /* If that is machine-item: */
         if (pItem->type() == UIGChooserItemType_Machine)
         {
@@ -1374 +1372 @@
 void UIGChooserModel::clearRealFocus()
 {
-    /* Set real focus to null: */
+    /* Set the real focus to null: */
     scene()->setFocusItem(0);
 }
@@ -1418 +1416 @@
 UIGChooserItem* UIGChooserModel::findGroupItem(const QString &strName, UIGChooserItem *pParent)
 {
-    /* Search among all the group items of passed parent: */
+    /* Search among all the group-items of passed parent: */
     foreach (UIGChooserItem *pGroupItem, pParent->items(UIGChooserItemType_Group))
         if (pGroupItem->name() == strName)
             return pGroupItem;
-    /* Recursively iterate into each the group item of the passed parent: */
+    /* Recursively iterate into each the group-item of the passed parent: */
     foreach (UIGChooserItem *pGroupItem, pParent->items(UIGChooserItemType_Group))
         if (UIGChooserItem *pSubGroupItem = findGroupItem(strName, pGroupItem))
@@ -1432 +1430 @@
 void UIGChooserModel::cleanupGroupTree(UIGChooserItem *pGroupItem)
 {
-    /* Cleanup all the group items first: */
+    /* Cleanup all the group-items first: */
     foreach (UIGChooserItem *pSubGroupItem, pGroupItem->items(UIGChooserItemType_Group))
         cleanupGroupTree(pSubGroupItem);
@@ -1440 +1438 @@
         if (!pGroupItem->isRoot())
             delete pGroupItem;
-        /* Unindent root items: */
+        /* Unindent root-items: */
         else if (root() != mainRoot())
             unindentRoot();
@@ -1448 +1446 @@
 UIGChooserItem* UIGChooserModel::findMachineItem(const QString &strName, UIGChooserItem *pParent)
 {
-    /* Search among all the machine items of passed parent: */
+    /* Search among all the machine-items of passed parent: */
     foreach (UIGChooserItem *pMachineItem, pParent->items(UIGChooserItemType_Machine))
         if (pMachineItem->name() == strName)
             return pMachineItem;
-    /* Recursively iterate into each the group item of the passed parent: */
+    /* Recursively iterate into each the group-item of the passed parent: */
     foreach (UIGChooserItem *pGroupItem, pParent->items(UIGChooserItemType_Group))
         if (UIGChooserItem *pSubMachineItem = findMachineItem(strName, pGroupItem))
@@ -1508 +1506 @@
 void UIGChooserModel::sortItems(UIGChooserItem *pParent, bool fRecursively /* = false */)
 {
-    /* Sort group items: */
+    /* Sort group-items: */
     QMap<QString, UIGChooserItem*> sorter;
     foreach (UIGChooserItem *pItem, pParent->items(UIGChooserItemType_Group))
@@ -1518 +1516 @@
     pParent->setItems(sorter.values(), UIGChooserItemType_Group);
 
-    /* Sort machine items: */
+    /* Sort machine-items: */
     sorter.clear();
     foreach (UIGChooserItem *pItem, pParent->items(UIGChooserItemType_Machine))
@@ -1531 +1529 @@
 void UIGChooserModel::updateMachineItems(const QString &strId, UIGChooserItem *pParent)
 {
-    /* For each group item in passed parent: */
+    /* For each group-item in passed parent: */
     foreach (UIGChooserItem *pItem, pParent->items(UIGChooserItemType_Group))
         updateMachineItems(strId, pItem->toGroupItem());
-    /* For each machine item in passed parent: */
+    /* For each machine-item in passed parent: */
     foreach (UIGChooserItem *pItem, pParent->items(UIGChooserItemType_Machine))
         if (UIGChooserItemMachine *pMachineItem = pItem->toMachineItem())
             if (pMachineItem->id() == strId)
             {
-                /* Update machine item: */
+                /* Update machine-item: */
                 pMachineItem->recache();
                 pMachineItem->updateToolTip();
                 pMachineItem->update();
-                /* Update parent group item: */
+                /* Update parent group-item: */
                 UIGChooserItemGroup *pParentGroupItem = pMachineItem->parentItem()->toGroupItem();
                 pParentGroupItem->updateToolTip();
@@ -1552 +1550 @@
 void UIGChooserModel::removeMachineItems(const QString &strId, UIGChooserItem *pParent)
 {
-    /* For each group item in passed parent: */
+    /* For each group-item in passed parent: */
     foreach (UIGChooserItem *pItem, pParent->items(UIGChooserItemType_Group))
         removeMachineItems(strId, pItem->toGroupItem());
-    /* For each machine item in passed parent: */
+    /* For each machine-item in passed parent: */
     foreach (UIGChooserItem *pItem, pParent->items(UIGChooserItemType_Machine))
         if (pItem->toMachineItem()->id() == strId)
@@ -1563 +1561 @@
 void UIGChooserModel::removeMachineItems(const QStringList &names, QList<UIGChooserItem*> &selectedItems)
 {
-    /* Show machine items remove dialog: */
+    /* Show machine-items remove dialog: */
     int rc = msgCenter().confirmMachineItemRemoval(names);
     if (rc == QIMessageBox::Cancel)
@@ -1647 +1645 @@
                     case UIGChooserItemType_Group:
                     {
-                        /* Get group item: */
+                        /* Get group-item: */
                         UIGChooserItem *pGroupItem = qgraphicsitem_cast<UIGChooserItemGroup*>(pItem);
                         /* Make sure thats not root: */
                         if (pGroupItem->isRoot())
                             return false;
-                        /* Is this group item only the one selected? */
+                        /* Is this group-item only the one selected? */
                         if (currentItems().contains(pGroupItem) && currentItems().size() == 1)
                         {
@@ -1682 +1680 @@
                     case UIGChooserItemType_Group:
                     {
-                        /* Is this group item only the one selected? */
+                        /* Is this group-item only the one selected? */
                         if (currentItems().size() == 1)
                         {
@@ -1740 +1738 @@
     QGraphicsView *pView = scene()->views()[0];
 
-    /* Check scroll area: */
+    /* Check scroll-area: */
     QPoint eventPoint = pView->mapFromGlobal(pEvent->screenPos());
     if ((eventPoint.y() < m_iScrollingTokenSize) ||
@@ -1806 +1804 @@
             if (strGroup.right(1) == "/")
                 strGroup.truncate(strGroup.size() - 1);
-            /* Create machine item with found group item as parent: */
+            /* Create machine-item with found group-item as parent: */
             LogRel(("  Creating item for VM {%s}, group {%s}.\n", strName.toAscii().constData(),
                                                                   strGroup.toAscii().constData()));
@@ -1819 +1817 @@
         /* VM is accessible: */
         LogRel((" VM {%s} is inaccessible.\n", machine.GetId().toAscii().constData()));
-        /* Create machine item with main-root group item as parent: */
+        /* Create machine-item with main-root group-item as parent: */
         createMachineItem(machine, mainRoot());
     }
@@ -1841 +1839 @@
         /* Make sure first-suffix is NOT empty: */
         AssertMsg(!strFirstSuffix.isEmpty(), ("Invalid group name!"));
-        /* Trying to get group item among our children: */
+        /* Trying to get group-item among our children: */
         foreach (UIGChooserItem *pGroupItem, pParentItem->items(UIGChooserItemType_Group))
         {
@@ -1861 +1859 @@
                                     /* Should be new group opened when created? */
                                     fAllGroupsOpened || shouldBeGroupOpened(pParentItem, strSecondSubName),
-                                    /* Which position new group item should be placed in? */
+                                    /* Which position new group-item should be placed in? */
                                     getDesiredPosition(pParentItem, UIGChooserItemType_Group, strSecondSubName));
     return strSecondSuffix.isEmpty() ? pNewGroupItem : getGroupItem(strFirstSuffix, pNewGroupItem, fAllGroupsOpened);
@@ -1990 +1988 @@
     new UIGChooserItemMachine(/* Parent item and corresponding machine: */
                               pParentItem, machine,
-                              /* Which position new group item should be placed in? */
+                              /* Which position new group-item should be placed in? */
                               getDesiredPosition(pParentItem, UIGChooserItemType_Machine, machine.GetId()));
 }
@@ -2034 +2032 @@
                                              UIGChooserItem *pParentGroup)
 {
-    /* Iterate over all the machine items: */
+    /* Iterate over all the machine-items: */
     foreach (UIGChooserItem *pItem, pParentGroup->items(UIGChooserItemType_Machine))
         if (UIGChooserItemMachine *pMachineItem = pItem->toMachineItem())
             if (pMachineItem->accessible())
                 groups[pMachineItem->id()] << fullName(pParentGroup);
-    /* Iterate over all the group items: */
+    /* Iterate over all the group-items: */
     foreach (UIGChooserItem *pItem, pParentGroup->items(UIGChooserItemType_Group))
         gatherGroupDefinitions(groups, pItem);
@@ -2049 +2047 @@
     /* Prepare extra-data key for current group: */
     QString strExtraDataKey = UIDefs::GUI_GroupDefinitions + fullName(pParentItem);
-    /* Iterate over all the group items: */
+    /* Iterate over all the group-items: */
     foreach (UIGChooserItem *pItem, pParentItem->items(UIGChooserItemType_Group))
     {
@@ -2056 +2054 @@
         gatherGroupOrders(groups, pItem);
     }
-    /* Iterate over all the machine items: */
+    /* Iterate over all the machine-items: */
     foreach (UIGChooserItem *pItem, pParentItem->items(UIGChooserItemType_Machine))
         groups[strExtraDataKey] << QString("m=%1").arg(pItem->toMachineItem()->id());