UIHelpViewer.cpp@ 100108

Last change on this file since 100108 was 100108, checked in by vboxsync, 21 months ago
*: Fix build issues when setting VBOX_WITH_WARNINGS_AS_ERRORS=1 on darwin.arm64 and make it a default, bugref:10469
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 35.4 KB

Line
1	/* $Id: UIHelpViewer.cpp 100108 2023-06-07 20:05:13Z vboxsync $ */
2	/** @file
3	* VBox Qt GUI - UIHelpViewer class implementation.
4	*/
5
6	/*
7	* Copyright (C) 2010-2023 Oracle and/or its affiliates.
8	*
9	* This file is part of VirtualBox base platform packages, as
10	* available from https://www.virtualbox.org.
11	*
12	* This program is free software; you can redistribute it and/or
13	* modify it under the terms of the GNU General Public License
14	* as published by the Free Software Foundation, in version 3 of the
15	* License.
16	*
17	* This program is distributed in the hope that it will be useful, but
18	* WITHOUT ANY WARRANTY; without even the implied warranty of
19	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20	* General Public License for more details.
21	*
22	* You should have received a copy of the GNU General Public License
23	* along with this program; if not, see <https://www.gnu.org/licenses>.
24	*
25	* SPDX-License-Identifier: GPL-3.0-only
26	*/
27
28	/* Qt includes: */
29	#include <QClipboard>
30	#include <QtGlobal>
31	#include <QtHelp/QHelpEngine>
32	#include <QtHelp/QHelpContentWidget>
33	#include <QtHelp/QHelpIndexWidget>
34	#include <QtHelp/QHelpSearchEngine>
35	#include <QtHelp/QHelpSearchQueryWidget>
36	#include <QtHelp/QHelpSearchResultWidget>
37	#include <QLabel>
38	#include <QMenu>
39	#include <QHBoxLayout>
40	#include <QGraphicsBlurEffect>
41	#include <QLabel>
42	#include <QMimeDatabase>
43	#include <QPainter>
44	#include <QScrollBar>
45	#include <QTextBlock>
46	#include <QWidgetAction>
47	#ifdef RT_OS_SOLARIS
48	# include <QFontDatabase>
49	#endif
50
51	/* GUI includes: */
52	#include "QIToolButton.h"
53	#include "UICursor.h"
54	#include "UICommon.h"
55	#include "UIHelpViewer.h"
56	#include "UIHelpBrowserWidget.h"
57	#include "UIIconPool.h"
58	#include "UISearchLineEdit.h"
59
60	/* COM includes: */
61	#include "COMEnums.h"
62	#include "CSystemProperties.h"
63
64
65	/*********************************************************************************************************************************
66	* UIContextMenuNavigationAction definition. *
67	*********************************************************************************************************************************/
68	class UIContextMenuNavigationAction : public QWidgetAction
69	{
70
71	Q_OBJECT;
72
73	signals:
74
75	void sigGoBackward();
76	void sigGoForward();
77	void sigGoHome();
78	void sigReloadPage();
79	void sigAddBookmark();
80
81	public:
82
83	UIContextMenuNavigationAction(QObject *pParent = 0);
84	void setBackwardAvailable(bool fAvailable);
85	void setForwardAvailable(bool fAvailable);
86
87	private slots:
88
89	void sltGoBackward();
90	void sltGoForward();
91	void sltGoHome();
92	void sltReloadPage();
93	void sltAddBookmark();
94
95	private:
96
97	void prepare();
98	QIToolButton *m_pBackwardButton;
99	QIToolButton *m_pForwardButton;
100	QIToolButton *m_pHomeButton;
101	QIToolButton *m_pReloadPageButton;
102	QIToolButton *m_pAddBookmarkButton;
103	};
104
105	/*********************************************************************************************************************************
106	* UIFindInPageWidget definition. *
107	*********************************************************************************************************************************/
108	class UIFindInPageWidget : public QIWithRetranslateUI<QWidget>
109	{
110
111	Q_OBJECT;
112
113	signals:
114
115	void sigDragging(const QPoint &delta);
116	void sigSearchTextChanged(const QString &strSearchText);
117	void sigSelectNextMatch();
118	void sigSelectPreviousMatch();
119	void sigClose();
120
121	public:
122
123	UIFindInPageWidget(QWidget *pParent = 0);
124	void setMatchCountAndCurrentIndex(int iTotalMatchCount, int iCurrentlyScrolledIndex);
125	void clearSearchField();
126
127	protected:
128
129	virtual bool eventFilter(QObject pObject, QEvent pEvent) RT_OVERRIDE;
130	virtual void keyPressEvent(QKeyEvent *pEvent) RT_OVERRIDE;
131
132	private:
133
134	void prepare();
135	void retranslateUi();
136	UISearchLineEdit *m_pSearchLineEdit;
137	QIToolButton *m_pNextButton;
138	QIToolButton *m_pPreviousButton;
139	QIToolButton *m_pCloseButton;
140	QLabel *m_pDragMoveLabel;
141	QPoint m_previousMousePosition;
142	};
143
144
145	/*********************************************************************************************************************************
146	* UIContextMenuNavigationAction implementation. *
147	*********************************************************************************************************************************/
148	UIContextMenuNavigationAction::UIContextMenuNavigationAction(QObject pParent / = 0 */)
149	:QWidgetAction(pParent)
150	, m_pBackwardButton(0)
151	, m_pForwardButton(0)
152	, m_pHomeButton(0)
153	, m_pReloadPageButton(0)
154	, m_pAddBookmarkButton(0)
155	{
156	prepare();
157	}
158
159	void UIContextMenuNavigationAction::setBackwardAvailable(bool fAvailable)
160	{
161	if (m_pBackwardButton)
162	m_pBackwardButton->setEnabled(fAvailable);
163	}
164
165	void UIContextMenuNavigationAction::setForwardAvailable(bool fAvailable)
166	{
167	if (m_pForwardButton)
168	m_pForwardButton->setEnabled(fAvailable);
169	}
170
171	void UIContextMenuNavigationAction::sltGoBackward()
172	{
173	emit sigGoBackward();
174	emit triggered();
175	}
176
177	void UIContextMenuNavigationAction::sltGoForward()
178	{
179	emit sigGoForward();
180	emit triggered();
181	}
182
183	void UIContextMenuNavigationAction::sltGoHome()
184	{
185	emit sigGoHome();
186	emit triggered();
187	}
188
189	void UIContextMenuNavigationAction::sltReloadPage()
190	{
191	emit sigReloadPage();
192	emit triggered();
193	}
194
195	void UIContextMenuNavigationAction::sltAddBookmark()
196	{
197	emit sigAddBookmark();
198	emit triggered();
199	}
200
201	void UIContextMenuNavigationAction::prepare()
202	{
203	QWidget *pWidget = new QWidget;
204	setDefaultWidget(pWidget);
205	QHBoxLayout *pMainLayout = new QHBoxLayout(pWidget);
206	AssertReturnVoid(pMainLayout);
207
208	m_pBackwardButton = new QIToolButton;
209	m_pForwardButton = new QIToolButton;
210	m_pHomeButton = new QIToolButton;
211	m_pReloadPageButton = new QIToolButton;
212	m_pAddBookmarkButton = new QIToolButton;
213
214	AssertReturnVoid(m_pBackwardButton &&
215	m_pForwardButton &&
216	m_pHomeButton &&
217	m_pReloadPageButton);
218
219	m_pForwardButton->setEnabled(false);
220	m_pBackwardButton->setEnabled(false);
221	m_pHomeButton->setIcon(UIIconPool::iconSet(":/help_browser_home_16px.png", ":/help_browser_home_disabled_16px.png"));
222	m_pReloadPageButton->setIcon(UIIconPool::iconSet(":/help_browser_reload_16px.png", ":/help_browser_reload_disabled_16px.png"));
223	m_pForwardButton->setIcon(UIIconPool::iconSet(":/help_browser_forward_16px.png", ":/help_browser_forward_disabled_16px.png"));
224	m_pBackwardButton->setIcon(UIIconPool::iconSet(":/help_browser_backward_16px.png", ":/help_browser_backward_disabled_16px.png"));
225	m_pAddBookmarkButton->setIcon(UIIconPool::iconSet(":/help_browser_add_bookmark_16px.png", ":/help_browser_add_bookmark_disabled_16px.png"));
226
227	m_pHomeButton->setToolTip(UIHelpBrowserWidget::tr("Return to Start Page"));
228	m_pReloadPageButton->setToolTip(UIHelpBrowserWidget::tr("Reload the Current Page"));
229	m_pForwardButton->setToolTip(UIHelpBrowserWidget::tr("Go Forward to Next Page"));
230	m_pBackwardButton->setToolTip(UIHelpBrowserWidget::tr("Go Back to Previous Page"));
231	m_pAddBookmarkButton->setToolTip(UIHelpBrowserWidget::tr("Add a New Bookmark"));
232
233	pMainLayout->addWidget(m_pBackwardButton);
234	pMainLayout->addWidget(m_pForwardButton);
235	pMainLayout->addWidget(m_pHomeButton);
236	pMainLayout->addWidget(m_pReloadPageButton);
237	pMainLayout->addWidget(m_pAddBookmarkButton);
238	pMainLayout->setContentsMargins(0, 0, 0, 0);
239
240	connect(m_pBackwardButton, &QIToolButton::pressed,
241	this, &UIContextMenuNavigationAction::sltGoBackward);
242	connect(m_pForwardButton, &QIToolButton::pressed,
243	this, &UIContextMenuNavigationAction::sltGoForward);
244	connect(m_pHomeButton, &QIToolButton::pressed,
245	this, &UIContextMenuNavigationAction::sltGoHome);
246	connect(m_pReloadPageButton, &QIToolButton::pressed,
247	this, &UIContextMenuNavigationAction::sltReloadPage);
248	connect(m_pAddBookmarkButton, &QIToolButton::pressed,
249	this, &UIContextMenuNavigationAction::sltAddBookmark);
250	connect(m_pReloadPageButton, &QIToolButton::pressed,
251	this, &UIContextMenuNavigationAction::sltAddBookmark);
252	}
253
254
255	/*********************************************************************************************************************************
256	* UIFindInPageWidget implementation. *
257	*********************************************************************************************************************************/
258	UIFindInPageWidget::UIFindInPageWidget(QWidget pParent / = 0 */)
259	: QIWithRetranslateUI<QWidget>(pParent)
260	, m_pSearchLineEdit(0)
261	, m_pNextButton(0)
262	, m_pPreviousButton(0)
263	, m_pCloseButton(0)
264	, m_previousMousePosition(-1, -1)
265	{
266	prepare();
267	}
268
269	void UIFindInPageWidget::setMatchCountAndCurrentIndex(int iTotalMatchCount, int iCurrentlyScrolledIndex)
270	{
271	if (!m_pSearchLineEdit)
272	return;
273	m_pSearchLineEdit->setMatchCount(iTotalMatchCount);
274	m_pSearchLineEdit->setScrollToIndex(iCurrentlyScrolledIndex);
275	}
276
277	void UIFindInPageWidget::clearSearchField()
278	{
279	if (!m_pSearchLineEdit)
280	return;
281	m_pSearchLineEdit->blockSignals(true);
282	m_pSearchLineEdit->reset();
283	m_pSearchLineEdit->blockSignals(false);
284	}
285
286	bool UIFindInPageWidget::eventFilter(QObject pObject, QEvent pEvent)
287	{
288	if (pObject == m_pDragMoveLabel)
289	{
290	if (pEvent->type() == QEvent::Enter)
291	UICursor::setCursor(m_pDragMoveLabel, Qt::CrossCursor);
292	else if (pEvent->type() == QEvent::Leave)
293	{
294	if (parentWidget())
295	UICursor::setCursor(m_pDragMoveLabel, parentWidget()->cursor());
296	}
297	else if (pEvent->type() == QEvent::MouseMove)
298	{
299	QMouseEvent pMouseEvent = static_cast<QMouseEvent>(pEvent);
300	#ifndef VBOX_IS_QT6_OR_LATER /* QMouseEvent::globalPos was replaced with QSinglePointEvent::globalPosition in Qt6 */
301	const QPoint gPos = pMouseEvent->globalPos();
302	#else
303	const QPoint gPos = pMouseEvent->globalPosition().toPoint();
304	#endif
305	if (pMouseEvent->buttons() == Qt::LeftButton)
306	{
307	if (m_previousMousePosition != QPoint(-1, -1))
308	emit sigDragging(gPos - m_previousMousePosition);
309	m_previousMousePosition = gPos;
310	UICursor::setCursor(m_pDragMoveLabel, Qt::ClosedHandCursor);
311	}
312	}
313	else if (pEvent->type() == QEvent::MouseButtonRelease)
314	{
315	m_previousMousePosition = QPoint(-1, -1);
316	UICursor::setCursor(m_pDragMoveLabel, Qt::CrossCursor);
317	}
318	}
319	return QIWithRetranslateUI<QWidget>::eventFilter(pObject, pEvent);
320	}
321
322	void UIFindInPageWidget::keyPressEvent(QKeyEvent *pEvent)
323	{
324	switch (pEvent->key())
325	{
326	case Qt::Key_Escape:
327	emit sigClose();
328	return;
329	break;
330	case Qt::Key_Down:
331	emit sigSelectNextMatch();
332	return;
333	break;
334	case Qt::Key_Up:
335	emit sigSelectPreviousMatch();
336	return;
337	break;
338	default:
339	QIWithRetranslateUI<QWidget>::keyPressEvent(pEvent);
340	break;
341	}
342	}
343
344	void UIFindInPageWidget::prepare()
345	{
346	setAutoFillBackground(true);
347	setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Maximum);
348
349	QHBoxLayout *pLayout = new QHBoxLayout(this);
350	m_pSearchLineEdit = new UISearchLineEdit;
351	AssertReturnVoid(pLayout && m_pSearchLineEdit);
352	setFocusProxy(m_pSearchLineEdit);
353	QFontMetrics fontMetric(m_pSearchLineEdit->font());
354	#if QT_VERSION >= QT_VERSION_CHECK(5, 11, 0)
355	setMinimumSize(40 * fontMetric.horizontalAdvance("x"),
356	fontMetric.height() +
357	qApp->style()->pixelMetric(QStyle::PM_LayoutBottomMargin) +
358	qApp->style()->pixelMetric(QStyle::PM_LayoutTopMargin));
359
360	#else
361	setMinimumSize(40 * fontMetric.width("x"),
362	fontMetric.height() +
363	qApp->style()->pixelMetric(QStyle::PM_LayoutBottomMargin) +
364	qApp->style()->pixelMetric(QStyle::PM_LayoutTopMargin));
365	#endif
366	connect(m_pSearchLineEdit, &UISearchLineEdit::textChanged,
367	this, &UIFindInPageWidget::sigSearchTextChanged);
368
369	m_pDragMoveLabel = new QLabel;
370	AssertReturnVoid(m_pDragMoveLabel);
371	m_pDragMoveLabel->installEventFilter(this);
372	m_pDragMoveLabel->setPixmap(QPixmap(":/drag_move_16px.png"));
373	pLayout->addWidget(m_pDragMoveLabel);
374
375
376	pLayout->setSpacing(0);
377	pLayout->addWidget(m_pSearchLineEdit);
378
379	m_pPreviousButton = new QIToolButton;
380	m_pNextButton = new QIToolButton;
381	m_pCloseButton = new QIToolButton;
382
383	pLayout->addWidget(m_pPreviousButton);
384	pLayout->addWidget(m_pNextButton);
385	pLayout->addWidget(m_pCloseButton);
386
387	m_pPreviousButton->setIcon(UIIconPool::iconSet(":/arrow_up_10px.png"));
388	m_pNextButton->setIcon(UIIconPool::iconSet(":/arrow_down_10px.png"));
389	m_pCloseButton->setIcon(UIIconPool::iconSet(":/close_16px.png"));
390
391	connect(m_pPreviousButton, &QIToolButton::pressed, this, &UIFindInPageWidget::sigSelectPreviousMatch);
392	connect(m_pNextButton, &QIToolButton::pressed, this, &UIFindInPageWidget::sigSelectNextMatch);
393	connect(m_pCloseButton, &QIToolButton::pressed, this, &UIFindInPageWidget::sigClose);
394	}
395
396	void UIFindInPageWidget::retranslateUi()
397	{
398	}
399
400
401	/*********************************************************************************************************************************
402	* UIHelpViewer implementation. *
403	*********************************************************************************************************************************/
404
405	UIHelpViewer::UIHelpViewer(const QHelpEngine pHelpEngine, QWidget pParent /* = 0 */)
406	:QIWithRetranslateUI<QTextBrowser>(pParent)
407	, m_pHelpEngine(pHelpEngine)
408	, m_pFindInPageWidget(new UIFindInPageWidget(this))
409	, m_fFindWidgetDragged(false)
410	, m_iMarginForFindWidget(qApp->style()->pixelMetric(QStyle::PM_LayoutLeftMargin))
411	, m_iSelectedMatchIndex(0)
412	, m_iSearchTermLength(0)
413	, m_fOverlayMode(false)
414	, m_pOverlayLabel(0)
415	, m_iZoomPercentage(100)
416	{
417	m_iInitialFontPointSize = font().pointSize();
418	setUndoRedoEnabled(true);
419	connect(m_pFindInPageWidget, &UIFindInPageWidget::sigDragging,
420	this, &UIHelpViewer::sltFindWidgetDrag);
421	connect(m_pFindInPageWidget, &UIFindInPageWidget::sigSearchTextChanged,
422	this, &UIHelpViewer::sltFindInPageSearchTextChange);
423
424	connect(m_pFindInPageWidget, &UIFindInPageWidget::sigSelectPreviousMatch,
425	this, &UIHelpViewer::sltSelectPreviousMatch);
426	connect(m_pFindInPageWidget, &UIFindInPageWidget::sigSelectNextMatch,
427	this, &UIHelpViewer::sltSelectNextMatch);
428	connect(m_pFindInPageWidget, &UIFindInPageWidget::sigClose,
429	this, &UIHelpViewer::sltCloseFindInPageWidget);
430
431	m_pFindInPageWidget->setVisible(false);
432
433	m_pOverlayLabel = new QLabel(this);
434	if (m_pOverlayLabel)
435	{
436	m_pOverlayLabel->hide();
437	m_pOverlayLabel->installEventFilter(this);
438	}
439
440	m_pOverlayBlurEffect = new QGraphicsBlurEffect(this);
441	if (m_pOverlayBlurEffect)
442	{
443	viewport()->setGraphicsEffect(m_pOverlayBlurEffect);
444	m_pOverlayBlurEffect->setEnabled(false);
445	m_pOverlayBlurEffect->setBlurRadius(8);
446	}
447	retranslateUi();
448	}
449
450	QVariant UIHelpViewer::loadResource(int type, const QUrl &name)
451	{
452	if (name.scheme() == "qthelp" && m_pHelpEngine)
453	return QVariant(m_pHelpEngine->fileData(name));
454	else
455	return QTextBrowser::loadResource(type, name);
456	}
457
458	void UIHelpViewer::emitHistoryChangedSignal()
459	{
460	emit historyChanged();
461	emit backwardAvailable(true);
462	}
463
464	#ifdef VBOX_IS_QT6_OR_LATER /* it was setSource before 6.0 */
465	void UIHelpViewer::doSetSource(const QUrl &url, QTextDocument::ResourceType type)
466	#else
467	void UIHelpViewer::setSource(const QUrl &url)
468	#endif
469	{
470	clearOverlay();
471	if (url.scheme() != "qthelp")
472	return;
473	#ifdef VBOX_IS_QT6_OR_LATER /* it was setSource before 6.0 */
474	QTextBrowser::doSetSource(url, type);
475	#else
476	QTextBrowser::setSource(url);
477	#endif
478	QTextDocument *pDocument = document();
479	if (!pDocument \|\| pDocument->isEmpty())
480	{
481	setText(UIHelpBrowserWidget::tr("<div><p><h3>Not found.</h3>The page <b>%1</b> could not be found.</p></div>").arg(url.toString()));
482	setDocumentTitle(UIHelpBrowserWidget::tr("Not Found"));
483	}
484	if (m_pFindInPageWidget && m_pFindInPageWidget->isVisible())
485	{
486	document()->undo();
487	m_pFindInPageWidget->clearSearchField();
488	}
489	iterateDocumentImages();
490	scaleImages();
491	}
492
493	void UIHelpViewer::toggleFindInPageWidget(bool fVisible)
494	{
495	if (!m_pFindInPageWidget)
496	return;
497
498	/* Closing the find in page widget causes QTextBrowser to jump to the top of the document. This hack puts it back into position: */
499	int iPosition = verticalScrollBar()->value();
500	m_iMarginForFindWidget = verticalScrollBar()->width() +
501	qApp->style()->pixelMetric(QStyle::PM_LayoutLeftMargin);
502	/* Try to position the widget somewhere meaningful initially: */
503	if (!m_fFindWidgetDragged)
504	m_pFindInPageWidget->move(width() - m_iMarginForFindWidget - m_pFindInPageWidget->width(),
505	m_iMarginForFindWidget);
506
507	m_pFindInPageWidget->setVisible(fVisible);
508
509	if (!fVisible)
510	{
511	/* Clear highlights: */
512	setExtraSelections(QList<QTextEdit::ExtraSelection>());
513	m_pFindInPageWidget->clearSearchField();
514	verticalScrollBar()->setValue(iPosition);
515	}
516	else
517	m_pFindInPageWidget->setFocus();
518	emit sigFindInPageWidgetToogle(fVisible);
519	}
520
521	void UIHelpViewer::reload()
522	{
523	setSource(source());
524	}
525
526	void UIHelpViewer::sltToggleFindInPageWidget(bool fVisible)
527	{
528	clearOverlay();
529	toggleFindInPageWidget(fVisible);
530	}
531
532	void UIHelpViewer::sltCloseFindInPageWidget()
533	{
534	sltToggleFindInPageWidget(false);
535	}
536
537	void UIHelpViewer::setFont(const QFont &font)
538	{
539	QIWithRetranslateUI<QTextBrowser>::setFont(font);
540	/* Make sure the font size of the find in widget stays constant: */
541	if (m_pFindInPageWidget)
542	{
543	QFont wFont(font);
544	wFont.setPointSize(m_iInitialFontPointSize);
545	m_pFindInPageWidget->setFont(wFont);
546	}
547	}
548
549	bool UIHelpViewer::isFindInPageWidgetVisible() const
550	{
551	if (m_pFindInPageWidget)
552	return m_pFindInPageWidget->isVisible();
553	return false;
554	}
555
556	void UIHelpViewer::setZoomPercentage(int iZoomPercentage)
557	{
558	m_iZoomPercentage = iZoomPercentage;
559	clearOverlay();
560	scaleFont();
561	scaleImages();
562	}
563
564	void UIHelpViewer::setHelpFileList(const QList<QUrl> &helpFileList)
565	{
566	m_helpFileList = helpFileList;
567	/* File list necessary to get the image data from the help engine: */
568	iterateDocumentImages();
569	scaleImages();
570	}
571
572	bool UIHelpViewer::hasSelectedText() const
573	{
574	return textCursor().hasSelection();
575	}
576
577	void UIHelpViewer::contextMenuEvent(QContextMenuEvent *event)
578	{
579	QMenu menu;
580
581	if (textCursor().hasSelection())
582	{
583	QAction *pCopySelectedTextAction = new QAction(UIHelpBrowserWidget::tr("Copy Selected Text"));
584	connect(pCopySelectedTextAction, &QAction::triggered,
585	this, &UIHelpViewer::copy);
586	menu.addAction(pCopySelectedTextAction);
587	menu.addSeparator();
588	}
589
590	UIContextMenuNavigationAction *pNavigationActions = new UIContextMenuNavigationAction;
591	pNavigationActions->setBackwardAvailable(isBackwardAvailable());
592	pNavigationActions->setForwardAvailable(isForwardAvailable());
593
594	connect(pNavigationActions, &UIContextMenuNavigationAction::sigGoBackward,
595	this, &UIHelpViewer::sigGoBackward);
596	connect(pNavigationActions, &UIContextMenuNavigationAction::sigGoForward,
597	this, &UIHelpViewer::sigGoForward);
598	connect(pNavigationActions, &UIContextMenuNavigationAction::sigGoHome,
599	this, &UIHelpViewer::sigGoHome);
600	connect(pNavigationActions, &UIContextMenuNavigationAction::sigReloadPage,
601	this, &UIHelpViewer::reload);
602	connect(pNavigationActions, &UIContextMenuNavigationAction::sigAddBookmark,
603	this, &UIHelpViewer::sigAddBookmark);
604
605	QAction *pOpenLinkAction = new QAction(UIHelpBrowserWidget::tr("Open Link"));
606	connect(pOpenLinkAction, &QAction::triggered,
607	this, &UIHelpViewer::sltOpenLink);
608
609	QAction *pOpenInNewTabAction = new QAction(UIHelpBrowserWidget::tr("Open Link in New Tab"));
610	connect(pOpenInNewTabAction, &QAction::triggered,
611	this, &UIHelpViewer::sltOpenLinkInNewTab);
612
613	QAction *pCopyLink = new QAction(UIHelpBrowserWidget::tr("Copy Link"));
614	connect(pCopyLink, &QAction::triggered,
615	this, &UIHelpViewer::sltCopyLink);
616
617	QAction *pFindInPage = new QAction(UIHelpBrowserWidget::tr("Find in Page"));
618	pFindInPage->setCheckable(true);
619	if (m_pFindInPageWidget)
620	pFindInPage->setChecked(m_pFindInPageWidget->isVisible());
621	connect(pFindInPage, &QAction::toggled, this, &UIHelpViewer::sltToggleFindInPageWidget);
622
623	menu.addAction(pNavigationActions);
624	menu.addAction(pOpenLinkAction);
625	menu.addAction(pOpenInNewTabAction);
626	menu.addAction(pCopyLink);
627	menu.addAction(pFindInPage);
628
629	QString strAnchor = anchorAt(event->pos());
630	if (!strAnchor.isEmpty())
631	{
632	QString strLink = source().resolved(anchorAt(event->pos())).toString();
633	pOpenLinkAction->setData(strLink);
634	pOpenInNewTabAction->setData(strLink);
635	pCopyLink->setData(strLink);
636	}
637	else
638	{
639	pOpenLinkAction->setEnabled(false);
640	pOpenInNewTabAction->setEnabled(false);
641	pCopyLink->setEnabled(false);
642	}
643
644	menu.exec(event->globalPos());
645	}
646
647	void UIHelpViewer::resizeEvent(QResizeEvent *pEvent)
648	{
649	if (m_fOverlayMode)
650	clearOverlay();
651	/* Make sure the widget stays inside the parent during parent resize: */
652	if (m_pFindInPageWidget)
653	{
654	if (!isRectInside(m_pFindInPageWidget->geometry(), m_iMarginForFindWidget))
655	moveFindWidgetIn(m_iMarginForFindWidget);
656	}
657	QIWithRetranslateUI<QTextBrowser>::resizeEvent(pEvent);
658	}
659
660	void UIHelpViewer::wheelEvent(QWheelEvent *pEvent)
661	{
662	if (m_fOverlayMode && !pEvent)
663	return;
664	/* QTextBrowser::wheelEvent scales font when some modifiers are pressed. We dont want that: */
665	if (pEvent->modifiers() == Qt::NoModifier)
666	QTextBrowser::wheelEvent(pEvent);
667	else if (pEvent->modifiers() & Qt::ControlModifier)
668	{
669	if (pEvent->angleDelta().y() > 0)
670	emit sigZoomRequest(ZoomOperation_In);
671	else if (pEvent->angleDelta().y() < 0)
672	emit sigZoomRequest(ZoomOperation_Out);
673	}
674	}
675
676	void UIHelpViewer::mouseReleaseEvent(QMouseEvent *pEvent)
677	{
678	/* If overlay mode is active just clear it and return: */
679	bool fOverlayMode = m_fOverlayMode;
680	clearOverlay();
681	if (fOverlayMode)
682	return;
683	QString strAnchor = anchorAt(pEvent->pos());
684
685	if (!strAnchor.isEmpty())
686	{
687	QString strLink = source().resolved(strAnchor).toString();
688	QFileInfo fInfo(strLink);
689	QMimeDatabase base;
690	QMimeType type = base.mimeTypeForFile(fInfo);
691	if (type.isValid() && type.inherits("image/png"))
692	{
693	if (!fOverlayMode)
694	loadImage(source().resolved(strAnchor));
695	return;
696	}
697	if (source().resolved(strAnchor).scheme() != "qthelp" && pEvent->button() == Qt::LeftButton)
698	{
699	uiCommon().openURL(strLink);
700	return;
701	}
702
703	if ((pEvent->modifiers() & Qt::ControlModifier) \|\|
704	pEvent->button() == Qt::MiddleButton)
705	{
706
707	emit sigOpenLinkInNewTab(strLink, true);
708	return;
709	}
710	}
711	QIWithRetranslateUI<QTextBrowser>::mousePressEvent(pEvent);
712	}
713
714	void UIHelpViewer::mousePressEvent(QMouseEvent *pEvent)
715	{
716	QIWithRetranslateUI<QTextBrowser>::mousePressEvent(pEvent);
717	}
718
719	void UIHelpViewer::mouseMoveEvent(QMouseEvent *pEvent)
720	{
721	/*if (m_fOverlayMode)
722	return;*/
723	QIWithRetranslateUI<QTextBrowser>::mouseMoveEvent(pEvent);
724	}
725
726	void UIHelpViewer::mouseDoubleClickEvent(QMouseEvent *pEvent)
727	{
728	clearOverlay();
729	QIWithRetranslateUI<QTextBrowser>::mouseDoubleClickEvent(pEvent);
730	}
731
732	void UIHelpViewer::paintEvent(QPaintEvent *pEvent)
733	{
734	QIWithRetranslateUI<QTextBrowser>::paintEvent(pEvent);
735	QPainter painter(viewport());
736	foreach(const DocumentImage &image, m_imageMap)
737	{
738	QRect rect = cursorRect(image.m_textCursor);
739	QPixmap newPixmap = image.m_pixmap.scaledToWidth(image.m_fScaledWidth, Qt::SmoothTransformation);
740	QRectF imageRect(rect.x() - newPixmap.width(), rect.y(), newPixmap.width(), newPixmap.height());
741
742	int iMargin = 3;
743	QRectF fillRect(imageRect.x() - iMargin, imageRect.y() - iMargin,
744	imageRect.width() + 2 * iMargin, imageRect.height() + 2 * iMargin);
745	/** @todo I need to find the default color somehow and replace hard coded Qt::white. */
746	painter.fillRect(fillRect, Qt::white);
747	painter.drawPixmap(imageRect, newPixmap, newPixmap.rect());
748	}
749	}
750
751	bool UIHelpViewer::eventFilter(QObject pObject, QEvent pEvent)
752	{
753	if (pObject == m_pOverlayLabel)
754	{
755	if (pEvent->type() == QEvent::MouseButtonPress \|\|
756	pEvent->type() == QEvent::MouseButtonDblClick)
757	clearOverlay();
758	}
759	return QIWithRetranslateUI<QTextBrowser>::eventFilter(pObject, pEvent);
760	}
761
762	void UIHelpViewer::keyPressEvent(QKeyEvent *pEvent)
763	{
764	if (pEvent && pEvent->key() == Qt::Key_Escape)
765	clearOverlay();
766	if (pEvent && pEvent->modifiers() &Qt::ControlModifier)
767	{
768	switch (pEvent->key())
769	{
770	case Qt::Key_Equal:
771	emit sigZoomRequest(ZoomOperation_In);
772	break;
773	case Qt::Key_Minus:
774	emit sigZoomRequest(ZoomOperation_Out);
775	break;
776	case Qt::Key_0:
777	emit sigZoomRequest(ZoomOperation_Reset);
778	break;
779	default:
780	break;
781	}
782	}
783	QIWithRetranslateUI<QTextBrowser>::keyPressEvent(pEvent);
784	}
785
786	void UIHelpViewer::retranslateUi()
787	{
788	}
789
790	void UIHelpViewer::moveFindWidgetIn(int iMargin)
791	{
792	if (!m_pFindInPageWidget)
793	return;
794
795	QRect rect = m_pFindInPageWidget->geometry();
796	if (rect.left() < iMargin)
797	rect.translate(-rect.left() + iMargin, 0);
798	if (rect.right() > width() - iMargin)
799	rect.translate((width() - iMargin - rect.right()), 0);
800	if (rect.top() < iMargin)
801	rect.translate(0, -rect.top() + iMargin);
802
803	if (rect.bottom() > height() - iMargin)
804	rect.translate(0, (height() - iMargin - rect.bottom()));
805	m_pFindInPageWidget->setGeometry(rect);
806	m_pFindInPageWidget->update();
807	}
808
809	bool UIHelpViewer::isRectInside(const QRect &rect, int iMargin) const
810	{
811	if (rect.left() < iMargin \|\| rect.top() < iMargin)
812	return false;
813	if (rect.right() > width() - iMargin \|\| rect.bottom() > height() - iMargin)
814	return false;
815	return true;
816	}
817
818	void UIHelpViewer::findAllMatches(const QString &searchString)
819	{
820	QTextDocument *pDocument = document();
821	AssertReturnVoid(pDocument);
822
823	m_matchedCursorPosition.clear();
824	if (searchString.isEmpty())
825	return;
826	QTextCursor cursor(pDocument);
827	QTextDocument::FindFlags flags;
828	while (!cursor.isNull() && !cursor.atEnd())
829	{
830	cursor = pDocument->find(searchString, cursor, flags);
831	if (!cursor.isNull())
832	m_matchedCursorPosition << cursor.position() - searchString.length();
833	}
834	}
835
836	void UIHelpViewer::highlightFinds(int iSearchTermLength)
837	{
838	QList<QTextEdit::ExtraSelection> extraSelections;
839	for (int i = 0; i < m_matchedCursorPosition.size(); ++i)
840	{
841	QTextEdit::ExtraSelection selection;
842	QTextCursor cursor = textCursor();
843	cursor.setPosition(m_matchedCursorPosition[i]);
844	cursor.setPosition(m_matchedCursorPosition[i] + iSearchTermLength, QTextCursor::KeepAnchor);
845	QTextCharFormat format = cursor.charFormat();
846	format.setBackground(Qt::yellow);
847
848	selection.cursor = cursor;
849	selection.format = format;
850	extraSelections.append(selection);
851	}
852	setExtraSelections(extraSelections);
853	}
854
855	void UIHelpViewer::selectMatch(int iMatchIndex, int iSearchStringLength)
856	{
857	QTextCursor cursor = textCursor();
858	/* Move the cursor to the beginning of the matched string: */
859	cursor.setPosition(m_matchedCursorPosition.at(iMatchIndex), QTextCursor::MoveAnchor);
860	/* Move the cursor to the end of the matched string while keeping the anchor at the begining thus selecting the text: */
861	cursor.setPosition(m_matchedCursorPosition.at(iMatchIndex) + iSearchStringLength, QTextCursor::KeepAnchor);
862	ensureCursorVisible();
863	setTextCursor(cursor);
864	}
865
866	void UIHelpViewer::sltOpenLinkInNewTab()
867	{
868	QAction pSender = qobject_cast<QAction>(sender());
869	if (!pSender)
870	return;
871	QUrl url = pSender->data().toUrl();
872	if (url.isValid())
873	emit sigOpenLinkInNewTab(url, false);
874	}
875
876	void UIHelpViewer::sltOpenLink()
877	{
878	QAction pSender = qobject_cast<QAction>(sender());
879	if (!pSender)
880	return;
881	QUrl url = pSender->data().toUrl();
882	if (url.isValid())
883	setSource(url);
884	}
885
886	void UIHelpViewer::sltCopyLink()
887	{
888	QAction pSender = qobject_cast<QAction>(sender());
889	if (!pSender)
890	return;
891	QUrl url = pSender->data().toUrl();
892	if (url.isValid())
893	{
894	QClipboard *pClipboard = QApplication::clipboard();
895	if (pClipboard)
896	pClipboard->setText(url.toString());
897	}
898	}
899
900	void UIHelpViewer::sltFindWidgetDrag(const QPoint &delta)
901	{
902	if (!m_pFindInPageWidget)
903	return;
904	QRect geo = m_pFindInPageWidget->geometry();
905	geo.translate(delta);
906
907	/* Allow the move if m_pFindInPageWidget stays inside after the move: */
908	if (isRectInside(geo, m_iMarginForFindWidget))
909	m_pFindInPageWidget->move(m_pFindInPageWidget->pos() + delta);
910	m_fFindWidgetDragged = true;
911	update();
912	}
913
914	void UIHelpViewer::sltFindInPageSearchTextChange(const QString &strSearchText)
915	{
916	m_iSearchTermLength = strSearchText.length();
917	findAllMatches(strSearchText);
918	highlightFinds(m_iSearchTermLength);
919	selectMatch(0, m_iSearchTermLength);
920	if (m_pFindInPageWidget)
921	m_pFindInPageWidget->setMatchCountAndCurrentIndex(m_matchedCursorPosition.size(), 0);
922	}
923
924	void UIHelpViewer::sltSelectPreviousMatch()
925	{
926	m_iSelectedMatchIndex = m_iSelectedMatchIndex <= 0 ? m_matchedCursorPosition.size() - 1 : (m_iSelectedMatchIndex - 1);
927	selectMatch(m_iSelectedMatchIndex, m_iSearchTermLength);
928	if (m_pFindInPageWidget)
929	m_pFindInPageWidget->setMatchCountAndCurrentIndex(m_matchedCursorPosition.size(), m_iSelectedMatchIndex);
930	}
931
932	void UIHelpViewer::sltSelectNextMatch()
933	{
934	m_iSelectedMatchIndex = m_iSelectedMatchIndex >= m_matchedCursorPosition.size() - 1 ? 0 : (m_iSelectedMatchIndex + 1);
935	selectMatch(m_iSelectedMatchIndex, m_iSearchTermLength);
936	if (m_pFindInPageWidget)
937	m_pFindInPageWidget->setMatchCountAndCurrentIndex(m_matchedCursorPosition.size(), m_iSelectedMatchIndex);
938	}
939
940	void UIHelpViewer::iterateDocumentImages()
941	{
942	m_imageMap.clear();
943	QTextCursor cursor = textCursor();
944	cursor.movePosition(QTextCursor::Start);
945	while (!cursor.atEnd())
946	{
947	cursor.movePosition(QTextCursor::NextCharacter);
948	if (cursor.charFormat().isImageFormat())
949	{
950	QTextImageFormat imageFormat = cursor.charFormat().toImageFormat();
951	/* There seems to be two cursors per image. Use the first one: */
952	if (m_imageMap.contains(imageFormat.name()))
953	continue;
954	QHash<QString, DocumentImage>::iterator iterator = m_imageMap.insert(imageFormat.name(), DocumentImage());
955	DocumentImage &image = iterator.value();
956	image.m_fInitialWidth = imageFormat.width();
957	image.m_strName = imageFormat.name();
958	image.m_textCursor = cursor;
959	QUrl imageFileUrl;
960	foreach (const QUrl &fileUrl, m_helpFileList)
961	{
962	if (fileUrl.toString().contains(imageFormat.name(), Qt::CaseInsensitive))
963	{
964	imageFileUrl = fileUrl;
965	break;
966	}
967	}
968	if (imageFileUrl.isValid())
969	{
970	QByteArray fileData = m_pHelpEngine->fileData(imageFileUrl);
971	if (!fileData.isEmpty())
972	image.m_pixmap.loadFromData(fileData,"PNG");
973	}
974	}
975	}
976	}
977
978	void UIHelpViewer::scaleFont()
979	{
980	QFont mFont = font();
981	mFont.setPointSize(m_iInitialFontPointSize * m_iZoomPercentage / 100.);
982	setFont(mFont);
983	}
984
985	void UIHelpViewer::scaleImages()
986	{
987	for (QHash<QString, DocumentImage>::iterator iterator = m_imageMap.begin();
988	iterator != m_imageMap.end(); ++iterator)
989	{
990	DocumentImage &image = *iterator;
991	QTextCursor cursor = image.m_textCursor;
992	QTextCharFormat format = cursor.charFormat();
993	if (!format.isImageFormat())
994	continue;
995	QTextImageFormat imageFormat = format.toImageFormat();
996	image.m_fScaledWidth = image.m_fInitialWidth * m_iZoomPercentage / 100.;
997	imageFormat.setWidth(image.m_fScaledWidth);
998	cursor.deletePreviousChar();
999	cursor.deleteChar();
1000	cursor.insertImage(imageFormat);
1001	}
1002	}
1003
1004	void UIHelpViewer::clearOverlay()
1005	{
1006	AssertReturnVoid(m_pOverlayLabel);
1007
1008	if (!m_fOverlayMode)
1009	return;
1010	m_overlayPixmap = QPixmap();
1011	m_fOverlayMode = false;
1012	if (m_pOverlayBlurEffect)
1013	m_pOverlayBlurEffect->setEnabled(false);
1014	m_pOverlayLabel->hide();
1015	}
1016
1017	void UIHelpViewer::enableOverlay()
1018	{
1019	AssertReturnVoid(m_pOverlayLabel);
1020	m_fOverlayMode = true;
1021	if (m_pOverlayBlurEffect)
1022	m_pOverlayBlurEffect->setEnabled(true);
1023	toggleFindInPageWidget(false);
1024
1025	/* Scale the image to 1:1 as long as it fits into avaible space (minus some margins and scrollbar sizes): */
1026	int vWidth = 0;
1027	if (verticalScrollBar() && verticalScrollBar()->isVisible())
1028	vWidth = verticalScrollBar()->width();
1029	int hMargin = qApp->style()->pixelMetric(QStyle::PM_LayoutLeftMargin) +
1030	qApp->style()->pixelMetric(QStyle::PM_LayoutRightMargin) + vWidth;
1031
1032	int hHeight = 0;
1033	if (horizontalScrollBar() && horizontalScrollBar()->isVisible())
1034	hHeight = horizontalScrollBar()->height();
1035	int vMargin = qApp->style()->pixelMetric(QStyle::PM_LayoutTopMargin) +
1036	qApp->style()->pixelMetric(QStyle::PM_LayoutBottomMargin) + hHeight;
1037
1038	QSize size(qMin(width() - hMargin, m_overlayPixmap.width()),
1039	qMin(height() - vMargin, m_overlayPixmap.height()));
1040	m_pOverlayLabel->setPixmap(m_overlayPixmap.scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation));
1041	m_pOverlayLabel->show();
1042
1043	/* Center the label: */
1044	int x = 0.5 * (width() - vWidth - m_pOverlayLabel->width());
1045	int y = 0.5 * (height() - hHeight - m_pOverlayLabel->height());
1046	m_pOverlayLabel->move(x, y);
1047	}
1048
1049	void UIHelpViewer::loadImage(const QUrl &imageFileUrl)
1050	{
1051	clearOverlay();
1052	/* Dont zoom into image if mouse button released after a mouse drag: */
1053	if (textCursor().hasSelection())
1054	return;
1055	if (!imageFileUrl.isValid())
1056	return;
1057	QByteArray fileData = m_pHelpEngine->fileData(imageFileUrl);
1058	if (!fileData.isEmpty())
1059	{
1060	m_overlayPixmap.loadFromData(fileData,"PNG");
1061	if (!m_overlayPixmap.isNull())
1062	enableOverlay();
1063	}
1064	}
1065
1066
1067	#include "UIHelpViewer.moc"

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Frontends/VirtualBox/src/helpbrowser/UIHelpViewer.cpp@ 100108

Download in other formats: