Changeset 90882 in vbox for trunk/src

Timestamp:

Aug 25, 2021 1:45:57 PM (3 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:9831. Adding some comments.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/helpbrowser/UIHelpViewer.h (modified) (4 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/helpbrowser/UIHelpViewer.h

@@ -36 +36 @@
 #ifdef VBOX_WITH_QHELP_VIEWER
 
+/** A QTextBrowser extension used as poor man's html viewer. Since we were not happy with the quality of QTextBrowser's image
+  * rendering and didn't want to use WebKit module, this extension redraws the document images as overlays with improved QPainter
+  * parameters. There is also a small hack to render clicked image 1:1 (and the rest of the document blurred)
+  * for a zoom-in-image functionality. This extension can also scale the images while scaling the document. In contrast
+  * QTextBrowser scales only fonts. */
 class UIHelpViewer : public QIWithRetranslateUI<QTextBrowser>
 {
@@ -123 +128 @@
     void highlightFinds(int iSearchTermLength);
     void selectMatch(int iMatchIndex, int iSearchStringLength);
+    /** Scans the document and finds all the images, whose pixmap data is retrieved from QHelp system to be used in overlay draw. */
     void iterateDocumentImages();
     void scaleFont();
@@ -146 +152 @@
     /** As percentage. */
     int m_iZoomPercentage;
+    /** Used to change th document cursor back from m_handCursor. */
     QCursor m_defaultCursor;
     QCursor m_handCursor;
+    /** We need this list from th QHelp system to obtain information of images. */
     QList<QUrl> m_helpFileList;
     QPixmap m_overlayPixmap;
@@ -154 +162 @@
     QLabel *m_pOverlayLabel;
     QGraphicsBlurEffect *m_pOverlayBlurEffect;
-
 };