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

Timestamp:

Oct 24, 2016 4:35:58 PM (8 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:6899: Accessibility support (step 101): Doxy for QITreeView.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/extensions

Files:

• QITreeView.cpp (modified) (7 diffs)
• QITreeView.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/extensions/QITreeView.cpp

@@ -20 +20 @@
 #else  /* !VBOX_WITH_PRECOMPILED_HEADERS */
 
-/* Global includes */
+/* Qt includes: */
 # include <QMouseEvent>
 # include <QPainter>
 
-/* Local includes */
+/* GUI includes: */
 # include "QITreeView.h"
 
@@ -33 +33 @@
     : QTreeView (aParent)
 {
+    /* Mark header hidden: */
     setHeaderHidden (true);
+    /* Mark root hidden: */
     setRootIsDecorated (false);
 }
@@ -39 +41 @@
 void QITreeView::currentChanged (const QModelIndex &aCurrent, const QModelIndex &aPrevious)
 {
+    /* Notify listeners about it: */
     emit currentItemChanged (aCurrent, aPrevious);
+    /* Call to base-class: */
     QTreeView::currentChanged (aCurrent, aPrevious);
 }
@@ -45 +49 @@
 void QITreeView::drawBranches (QPainter *aPainter, const QRect &aRect, const QModelIndex &aIndex) const
 {
+    /* Notify listeners about it: */
     emit drawItemBranches (aPainter, aRect, aIndex);
+    /* Call to base-class: */
     QTreeView::drawBranches (aPainter, aRect, aIndex);
 }
@@ -51 +57 @@
 void QITreeView::mouseMoveEvent (QMouseEvent *aEvent)
 {
+    /* Reject event initially: */
     aEvent->setAccepted (false);
+    /* Notify listeners about event allowing them to handle it: */
     emit mouseMoved (aEvent);
+    /* Call to base-class only if event was not yet accepted: */
     if (!aEvent->isAccepted())
         QTreeView::mouseMoveEvent (aEvent);
@@ -59 +68 @@
 void QITreeView::mousePressEvent (QMouseEvent *aEvent)
 {
+    /* Reject event initially: */
     aEvent->setAccepted (false);
+    /* Notify listeners about event allowing them to handle it: */
     emit mousePressed (aEvent);
+    /* Call to base-class only if event was not yet accepted: */
     if (!aEvent->isAccepted())
         QTreeView::mousePressEvent (aEvent);
@@ -67 +79 @@
 void QITreeView::mouseDoubleClickEvent (QMouseEvent *aEvent)
 {
+    /* Reject event initially: */
     aEvent->setAccepted (false);
+    /* Notify listeners about event allowing them to handle it: */
     emit mouseDoubleClicked (aEvent);
+    /* Call to base-class only if event was not yet accepted: */
     if (!aEvent->isAccepted())
         QTreeView::mouseDoubleClickEvent (aEvent);

trunk/src/VBox/Frontends/VirtualBox/src/extensions/QITreeView.h

@@ -19 +19 @@
 #define __QITreeView_h__
 
-/* Global includes */
+/* Qt includes: */
 #include <QTreeView>
 
-/*
- * QITreeView class which extends standard QITreeView's functionality.
- */
+
+/** QTreeView subclass extending standard functionality. */
 class QITreeView: public QTreeView
 {
@@ -31 +30 @@
 public:
 
+    /** Constructs table-view passing @a aParent to the base-class. */
     QITreeView (QWidget *aParent = 0);
 
 signals:
 
+    /** Notifies listeners about index changed from @a aPrevious to @a aCurrent.*/
     void currentItemChanged (const QModelIndex &aCurrent, const QModelIndex &aPrevious);
+
+    /** Notifies listeners about painting of item branches.
+      * @param  aPainter  Brings the painter to draw branches.
+      * @param  aRect     Brings the rectangle embedding branches.
+      * @param  aIndex    Brings the index of the item for which branches will be painted. */
     void drawItemBranches (QPainter *aPainter, const QRect &aRect, const QModelIndex &aIndex) const;
+
+    /** Notifies listeners about mouse moved @a aEvent. */
     void mouseMoved (QMouseEvent *aEvent);
+    /** Notifies listeners about mouse pressed @a aEvent. */
     void mousePressed (QMouseEvent *aEvent);
+    /** Notifies listeners about mouse double-clicked @a aEvent. */
     void mouseDoubleClicked (QMouseEvent *aEvent);
 
 protected slots:
 
+    /** Handles index changed from @a aPrevious to @a aCurrent.*/
     void currentChanged (const QModelIndex &aCurrent, const QModelIndex &aPrevious);
 
 protected:
 
+    /** Handles painting of item branches.
+      * @param  aPainter  Brings the painter to draw branches.
+      * @param  aRect     Brings the rectangle embedding branches.
+      * @param  aIndex    Brings the index of the item for which branches will be painted. */
     void drawBranches (QPainter *aPainter, const QRect &aRect, const QModelIndex &aIndex) const;
+
+    /** Handles mouse move @a aEvent. */
     void mouseMoveEvent (QMouseEvent *aEvent);
+    /** Handles mouse press @a aEvent. */
     void mousePressEvent (QMouseEvent *aEvent);
+    /** Handles mouse double-click @a aEvent. */
     void mouseDoubleClickEvent (QMouseEvent *aEvent);
 };
 
-#endif /* __QITreeView_h__ */
+#endif /* !__QITreeView_h__ */