Differential D3683 Diff 9028 documentation/standarddocumentationview.cpp

Changeset View

Standalone View

View Options

documentation/standarddocumentationview.cpp

Show All 16 Lines
17 * Free Software Foundation, Inc., 17​ * Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 18​ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 */ 19​ */
20 20​
21#include "standarddocumentationview.h" 21​#include "standarddocumentationview.h"
22#include "documentationfindwidget.h" 22​#include "documentationfindwidget.h"
23#include "debug.h" 23​#include "debug.h"
24 24​
25​#include <QEvent>
25#include <QFontDatabase> 26​#include <QFontDatabase>
27​#include <QTimer>
kfunkUnsubmitted
Done

Unused include

kfunk: Unused include
28​#include <QWebFrame>
26 29​
27using namespace KDevelop; 30​using namespace KDevelop;
28 31​
32​class StandardDocumentationViewHelper : public QObject
33​{
34​ Q_OBJECT
35​public:
36​ StandardDocumentationViewHelper(StandardDocumentationView* view);
37​
38​ bool eventFilter(QObject* target, QEvent* event);
39​
40​private:
41​ void adjustPosition();
42​
43​ StandardDocumentationView* m_view;
44​};
45​
46​StandardDocumentationViewHelper::StandardDocumentationViewHelper(StandardDocumentationView* view)
47​ : QObject(view)
48​ , m_view(view)
49​{
50​ Q_ASSERT(view);
51​
52​ m_view->installEventFilter(this);
53​ m_view->settings()->setAttribute(QWebSettings::JavascriptEnabled, true);
kfunkUnsubmitted
Done

No longer needed afaics, has been introduced with a108066e644861b2756009b57c02d4b42792fead.

kfunk: No longer needed afaics, has been introduced with a108066e644861b2756009b57c02d4b42792fead.
antonanikinAuthorUnsubmitted
Not Done

Fixed, now we don't use JS for page scrolling.

antonanikin: Fixed, now we don't use JS for page scrolling.
54​
55​ // First, we disable view painter updates during load to avoid content "flickering" and
56​ // also to hide font size "jumping", which happens for example for Qt help pages with
57​ // JavaScript enabled. This JS also breaks positioning inside page:
58​ //
59​ // 1) Some page is loaded and loadFinished() signal emitted, then view set
60​ // right position inside page.
61​ //
62​ // 2) After this, page JS finishes it's work and change font settings (size).
63​ // This leads to contents "moving" inside view and as a result we have wrong position.
64​ //
65​ // Therefore secondly, we fix position after loading with simple JS code. JS allow us to
66​ // "jump" inside already loaded page without it's reloading which happens with using standard
67​ // view's methods like load() or setUrl().
68​ //
69​ // Such positioning fixing also applied on resize event - standard view's behavior breaks
70​ // position during widget resize.
71​
72​ connect(m_view, &QWebView::loadStarted, this, [this]() {
73​ m_view->setUpdatesEnabled(false);
74​ });
75​
76​ connect(m_view, &QWebView::loadFinished, this, [this](bool) {
77​ adjustPosition();
78​ m_view->setUpdatesEnabled(true);
79​ });
80​}
81​
82​bool StandardDocumentationViewHelper::eventFilter(QObject* target, QEvent* event)
83​{
84​ bool result = QObject::eventFilter(target, event);
85​
kfunkUnsubmitted
Done

I'm not sure we want to adjust the position on resize. I would just drop that whole event filter.

Steps to reproduce where this feature looks odd:

  • Scroll to random position in the documentation view
  • Resize the tool view

Actual:

  • View gets scrolled back to the last looked up item

Expected:

  • Shouldn't scroll
kfunk: I'm not sure we want to adjust the position on resize. I would just drop that whole event…
86​ if (event->type() == QEvent::Resize) {
87​ adjustPosition();
88​ }
89​
90​ return result;
91​}
92​
93​void StandardDocumentationViewHelper::adjustPosition()
94​{
95​ if (!m_view->url().isValid()) {
96​ return;
97​ }
98​
99​ QWebFrame* frame = m_view->page()->mainFrame();
100​ QString fragment = m_view->url().fragment();
101​
102​ if (fragment.isEmpty()) {
103​ frame->evaluateJavaScript(QStringLiteral("window.scrollTo(0, 0);"));
104​ }
105​ else {
106​ frame->evaluateJavaScript(QStringLiteral("window.location.href = '#%1';").arg(fragment));
kfunkUnsubmitted
Done

http://doc.qt.io/archives/qt-5.5/qwebframe.html#scrollToAnchor instead? Does that work?

kfunk: http://doc.qt.io/archives/qt-5.5/qwebframe.html#scrollToAnchor instead? Does that work?
antonanikinAuthorUnsubmitted
Not Done

Damn! How could I not notice this method??!

Thanks a lot!

antonanikin: Damn! How could I not notice this method??! Thanks a lot!
107​ }
108​}
109​
29StandardDocumentationView::StandardDocumentationView(DocumentationFindWidget* findWidget, QWidget* parent) 110​StandardDocumentationView::StandardDocumentationView(DocumentationFindWidget* findWidget, QWidget* parent)
30 : QWebView (parent) 111​ : QWebView(parent)
31{ 112​{
32 findWidget->setEnabled(true); 113​ findWidget->setEnabled(true);
33 connect(findWidget, &DocumentationFindWidget::newSearch, this, &StandardDocumentationView::search); 114​ connect(findWidget, &DocumentationFindWidget::newSearch, this, &StandardDocumentationView::search);
34 115​
35 QFont sansSerifFont = QFontDatabase::systemFont(QFontDatabase::GeneralFont); 116​ QFont sansSerifFont = QFontDatabase::systemFont(QFontDatabase::GeneralFont);
36 QFont monospaceFont = QFontDatabase::systemFont(QFontDatabase::FixedFont); 117​ QFont monospaceFont = QFontDatabase::systemFont(QFontDatabase::FixedFont);
37 QFont minimalFont = QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont); 118​ QFont minimalFont = QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont);
38 119​
39 QWebSettings* s = settings(); 120​ QWebSettings* s = settings();
40 121​
41 s->setFontFamily(QWebSettings::StandardFont, sansSerifFont.family()); 122​ s->setFontFamily(QWebSettings::StandardFont, sansSerifFont.family());
42 s->setFontFamily(QWebSettings::SerifFont, "Serif"); 123​ s->setFontFamily(QWebSettings::SerifFont, "Serif");
43 s->setFontFamily(QWebSettings::SansSerifFont, sansSerifFont.family()); 124​ s->setFontFamily(QWebSettings::SansSerifFont, sansSerifFont.family());
44 s->setFontFamily(QWebSettings::FixedFont, monospaceFont.family()); 125​ s->setFontFamily(QWebSettings::FixedFont, monospaceFont.family());
45 126​
46 s->setFontSize(QWebSettings::DefaultFontSize, QFontInfo(sansSerifFont).pixelSize()); 127​ s->setFontSize(QWebSettings::DefaultFontSize, QFontInfo(sansSerifFont).pixelSize());
47 s->setFontSize(QWebSettings::DefaultFixedFontSize, QFontInfo(monospaceFont).pixelSize()); 128​ s->setFontSize(QWebSettings::DefaultFixedFontSize, QFontInfo(monospaceFont).pixelSize());
48 s->setFontSize(QWebSettings::MinimumFontSize, QFontInfo(minimalFont).pixelSize()); 129​ s->setFontSize(QWebSettings::MinimumFontSize, QFontInfo(minimalFont).pixelSize());
130​
131​ new StandardDocumentationViewHelper(this);
49} 132​}
50 133​
51void StandardDocumentationView::search ( const QString& text, DocumentationFindWidget::FindOptions options ) 134​void StandardDocumentationView::search ( const QString& text, DocumentationFindWidget::FindOptions options )
52{ 135​{
53 //Highlighting has been commented because it doesn't let me jump around all occurrences 136​ //Highlighting has been commented because it doesn't let me jump around all occurrences
54// page()->findText(QString(), QWebPage::HighlightAllOccurrences); 137​// page()->findText(QString(), QWebPage::HighlightAllOccurrences);
55 138​
56 QWebPage::FindFlags ff=QWebPage::FindWrapsAroundDocument /*| QWebPage::HighlightAllOccurrences*/; 139​ QWebPage::FindFlags ff=QWebPage::FindWrapsAroundDocument /*| QWebPage::HighlightAllOccurrences*/;
Show All 18 Lines
75 158​
76void StandardDocumentationView::update() 159​void StandardDocumentationView::update()
77{ 160​{
78 if(m_doc) 161​ if(m_doc)
79 setHtml(m_doc->description()); 162​ setHtml(m_doc->description());
80 else 163​ else
81 qCDebug(DOCUMENTATION) << "calling StandardDocumentationView::update() on an uninitialized view"; 164​ qCDebug(DOCUMENTATION) << "calling StandardDocumentationView::update() on an uninitialized view";
82} 165​}
166​
167​#include "standarddocumentationview.moc"