Changeset 77407 in vbox for trunk/src

Timestamp:

Feb 21, 2019 9:29:08 AM (6 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:9080. Some commenting.

Location:

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

Files:

• UIVisoBrowserBase.h (modified) (1 diff)
• UIVisoContentBrowser.h (modified) (5 diffs)
• UIVisoCreator.h (modified) (4 diffs)
• UIVisoHostBrowser.h (modified) (4 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/medium/viso/UIVisoBrowserBase.h

@@ -39 +39 @@
 class UILocationSelector;
 
+/** An abstract QWidget extension hosting a tree and table view. */
 class UIVisoBrowserBase : public QIWithRetranslateUI<QWidget>
 {

trunk/src/VBox/Frontends/VirtualBox/src/medium/viso/UIVisoContentBrowser.h

@@ -44 +44 @@
 class UIVisoContentTableView;
 
+/** A UIVisoBrowserBase extension to view content of a VISO as a file tree. */
 class UIVisoContentBrowser : public UIVisoBrowserBase
 {
@@ -58 +59 @@
     /** Adds file objests from the host file system. @p pathList consists of list of paths to there objects. */
     void addObjectsToViso(QStringList pathList);
+    /** Returns the content of the VISO as a string list. Each element of the list becomes a line in the
+      * .viso file. */
     QStringList entryList();
     virtual void showHideHiddenObjects(bool bShow) /* override */;
-
     void setVisoName(const QString &strName);
 
@@ -67 +69 @@
     void sltHandleCreateNewDirectory();
     /** Handles the signal we get from the model during setData call. Restores the old name of the file object
-     *  to @p strOldName if need be. */
+     *  to @p strOldName if need be (if rename fails for some reason). */
     void sltHandleItemRenameAttempt(UICustomFileSystemItem *pItem, QString strOldName, QString strNewName);
     void sltHandleRemoveItems();
@@ -89 +91 @@
 
     void sltHandleTableSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected);
+    /** Adds the dragged-dropped items to VISO. */
     void sltHandleDroppedItems(QStringList pathList);
 
@@ -97 +100 @@
     void                    initializeModel();
     UICustomFileSystemItem *rootItem();
-    QModelIndex             convertIndexToTableIndex(const QModelIndex &index);
-    QModelIndex             convertIndexToTreeIndex(const QModelIndex &index);
+
+
+    /** @name Index conversion functions. These are half-smart and tries to determine the source model before conversion.
+      * @{ */
+        QModelIndex         convertIndexToTableIndex(const QModelIndex &index);
+        QModelIndex         convertIndexToTreeIndex(const QModelIndex &index);
+    /** @} */
+    /** Lists the content of the host file system directory by using Qt file system API. */
     void                    scanHostDirectory(UICustomFileSystemItem *directory);
     KFsObjType              fileType(const QFileInfo &fsInfo);
+    /** Renames the starts item's name as VISO name changes. */
     void                    updateStartItemName();
     void                    renameFileObject(UICustomFileSystemItem *pItem);

trunk/src/VBox/Frontends/VirtualBox/src/medium/viso/UIVisoCreator.h

@@ -48 +48 @@
 class UIVisoConfigurationPanel;
 
+/** A QIMainDialog extension. It hosts two UIVisoBrowserBase extensions, one for host and one
+  * for VISO file system. It has the main menu, main toolbar, and a vertical toolbar and corresponding
+  * actions. */
 class UIVisoCreator : public QIWithRetranslateUI<QIMainDialog>
 {
@@ -56 +59 @@
     UIVisoCreator(QWidget *pParent = 0, const QString& strMachineName = QString());
     ~UIVisoCreator();
-    QStringList entryList() const;
-    const QString &visoName() const;
+    QStringList       entryList() const;
+    const QString     &visoName() const;
     const QStringList &customOptions() const;
     /** Returns the current path that the host browser is listing. */
     QString currentPath() const;
-    void setCurrentPath(const QString &strPath);
+    void    setCurrentPath(const QString &strPath);
 
 #ifdef VBOX_WS_MAC
@@ -86 +89 @@
 
 private:
+
     struct VisoOptions
     {
@@ -117 +121 @@
     /** Makes sure escape key is assigned to only a single widget. This is done by checking
       *  several things in the following order:
-      *  - when tree views of browser panes are visible esc. key used to close those. thus it is taken from the dialog and panels
+      *  - when (drop-down) tree views of browser panes are visible esc. key used to close those. thus it is taken from the dialog and panels
       *  - when there are no more panels visible assign it to the parent dialog
       *  - grab it from the dialog as soon as a panel becomes visible again
       *  - assign it to the most recently "unhidden" panel */
     void manageEscapeShortCut();
-    void loadSettings();
-    void saveSettings() const;
+
+    /** @name Save/Load dialog related extra data.
+     * @{ */
+       void loadSettings();
+       void saveSettings() const;
+    /** @} */
     void setDialogGeometry(const QRect &geometry);
 
-    QAction              *m_pActionConfiguration;
-    QAction              *m_pActionOptions;
-    QAction              *m_pAddAction;
-    QAction              *m_pRemoveAction;
-    QAction              *m_pNewDirectoryAction;
-    QAction              *m_pRenameAction;
-    QAction              *m_pResetAction;
+    /** @name Main toolbar (and main menu) actions
+      * @{ */
+        QAction         *m_pActionConfiguration;
+        QAction         *m_pActionOptions;
+    /** @} */
+
+    /** @name These actions are addded to vertical toolbar, context menus, and the main menu.
+      * @{ */
+        QAction              *m_pAddAction;
+        QAction              *m_pRemoveAction;
+        QAction              *m_pNewDirectoryAction;
+        QAction              *m_pRenameAction;
+        QAction              *m_pResetAction;
+    /** @} */
 
     QGridLayout          *m_pMainLayout;

trunk/src/VBox/Frontends/VirtualBox/src/medium/viso/UIVisoHostBrowser.h

@@ -34 +34 @@
 class UIVisoHostBrowserModel;
 
+/** A UIVisoBrowserBase extension to view host file system. Uses QFileSystemModel. */
 class UIVisoHostBrowser : public UIVisoBrowserBase
 {
@@ -48 +49 @@
     ~UIVisoHostBrowser();
     virtual void showHideHiddenObjects(bool bShow) /* override */;
-    QString currentPath() const;
-    void setCurrentPath(const QString &strPath);
+    QString      currentPath() const;
+    void         setCurrentPath(const QString &strPath);
 
 public slots:
@@ -57 +58 @@
 protected:
 
-    void retranslateUi();
+    virtual void retranslateUi() /* override */;
     virtual void tableViewItemDoubleClick(const QModelIndex &index) /* override */;
     virtual void setTableRootIndex(QModelIndex index = QModelIndex()) /* override */;
@@ -72 +73 @@
     void prepareConnections();
 
-    /** We have two file system models (one for each item view) since we set different filter on each of these models. */
+    /** We have two file system models (one for each item view) since we set different filters on each of these models. */
     UIVisoHostBrowserModel *m_pTreeModel;
     UIVisoHostBrowserModel *m_pTableModel;