ViewWindow: Add the mode argument to the linkClicked signal

Author: u-235

src/CMakeLists.txt

@@ -5,6 +5,7 @@ set(CMAKE_INCLUDE_CURRENT_DIR ON)
 
 # Project files
 set(CPP_SOURCES
+    browser-types.hpp
     config.cpp
     config.h
     dialog_chooseurlfromlist.cpp

src/browser-types.hpp

@@ -0,0 +1,46 @@
+/*
+ *  uChmViewer - a CHM and EPUB file viewer with broad language support
+ *  Copyright (C) 2022  Nick Egorrov, [email protected]
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef BROWSER_TYPES_HPP
+#define BROWSER_TYPES_HPP
+
+
+namespace UBrowser
+{
+
+//------------------------------------------------------------------------------
+// Start BrowserAPI group.
+/// @addtogroup BrowserAPI
+/// @{
+
+enum OpenMode {
+	/// The link should open in the current tab.
+	OPEN_IN_CURRENT,
+	/// The link should open in the new foregraund tab.
+	OPEN_IN_NEW,
+	/// The link should open in the new backgraund tab.
+	OPEN_IN_BACKGROUND
+};
+
+/// @}
+// End BrowserAPI group.
+//------------------------------------------------------------------------------
+
+} // namespace UBrowser
+
+#endif // BROWSER_TYPES_HPP

src/mainwindow.cpp

@@ -16,6 +16,7 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <functional>
 #include <cstdio>
 #include <cstdlib>
 #include <cstring>
@@ -71,6 +72,7 @@
 
 class QCloseEvent;
 
+#include <browser-types.hpp>
 #include <ebook.h>
 
 #include "config.h"
@@ -136,7 +138,7 @@ MainWindow::MainWindow( const QStringList& arguments )
 	connect(m_viewWindowMgr, &ViewWindowMgr::urlChanged,
 	        this, &MainWindow::onUrlChanged);
 	connect(m_viewWindowMgr, &ViewWindowMgr::linkClicked,
-	        this, &MainWindow::activateUrl);
+	        this, &MainWindow::onLinkClicked);
 
 	// Add navigation dock
 	m_navPanel->setAllowedAreas( Qt::LeftDockWidgetArea | Qt::RightDockWidgetArea );
@@ -424,19 +426,19 @@ void MainWindow::activateUrl( const QUrl& link )
 	Qt::KeyboardModifiers mods = QApplication::keyboardModifiers();
 
 	if ( mods & Qt::ShiftModifier )
-		openPage( link, OPF_NEW_TAB | OPF_CONTENT_TREE );
+		openPage( link, UBrowser::OPEN_IN_NEW );
 	else if ( mods & Qt::ControlModifier )
-		openPage( link, OPF_NEW_TAB | OPF_BACKGROUND );
+		openPage( link, UBrowser::OPEN_IN_BACKGROUND );
 	else
-		openPage( link, OPF_CONTENT_TREE );
+		openPage( link, UBrowser::OPEN_IN_CURRENT );
 }
 
-bool MainWindow::openPage( const QUrl& url, unsigned int flags )
+bool MainWindow::openPage(const QUrl& url, UBrowser::OpenMode mode )
 {
-	return onLinkClicked( currentBrowser(), url, flags );
+	return onLinkClicked( currentBrowser(), url, mode );
 }
 
-bool MainWindow::onLinkClicked( ViewWindow* browser, const QUrl& url, unsigned int flags )
+bool MainWindow::onLinkClicked( ViewWindow* browser, const QUrl& url, UBrowser::OpenMode mode )
 {
 	QString otherlink;
 
@@ -470,22 +472,23 @@ bool MainWindow::onLinkClicked( ViewWindow* browser, const QUrl& url, unsigned i
 		return false; // do not change the current page.
 	}
 
-	if ( flags & OPF_NEW_TAB )
+
+	if ( mode == UBrowser::OPEN_IN_NEW || mode == UBrowser::OPEN_IN_BACKGROUND )
 	{
 		qreal zoom = currentBrowser()->zoomFactor();
-		browser = m_viewWindowMgr->addNewTab( !(flags & OPF_BACKGROUND) );
+		browser = m_viewWindowMgr->addNewTab( mode != UBrowser::OPEN_IN_BACKGROUND );
 		browser->setZoomFactor( zoom );
 	}
 
 	browser->load( url );
 
-	// Open all the tree items to show current item (if needed)
-	if ( (flags & OPF_CONTENT_TREE) != 0 )
+	if ( mode != UBrowser::OPEN_IN_BACKGROUND )
+	{
+		// Open all the tree items to show current item (if needed)
 		m_navPanel->findUrlInContents( url );
-
-	// Focus on the view window so keyboard scroll works; do not do it for the background tabs
-	if ( (flags & OPF_BACKGROUND) == 0 )
+		// Focus on the view window so keyboard scroll works; do not do it for the background tabs
 		browser->setFocus( Qt::OtherFocusReason );
+	}
 
 	return true;
 }
@@ -729,12 +732,12 @@ QUrl MainWindow::getNewTabLink() const
 
 void MainWindow::onOpenPageInNewTab( )
 {
-	openPage( getNewTabLink(), OPF_NEW_TAB | OPF_CONTENT_TREE );
+	openPage( getNewTabLink(), UBrowser::OPEN_IN_NEW );
 }
 
 void MainWindow::onOpenPageInNewBackgroundTab( )
 {
-	openPage( getNewTabLink(), OPF_NEW_TAB | OPF_BACKGROUND );
+	openPage( getNewTabLink(), UBrowser::OPEN_IN_BACKGROUND );
 }
 
 void MainWindow::browserChanged(ViewWindow* browser)

src/mainwindow.h

@@ -36,6 +36,7 @@ class QMenu;
 class QSharedMemory;
 class QTemporaryFile;
 
+#include <browser-types.hpp>
 #include <ebook.h>
 
 class NavigationPanel;
@@ -66,20 +67,11 @@ class MainWindow : public QMainWindow, public Ui::MainWindow
 {
 		Q_OBJECT
 
-	public:
-		// "Open page" parameter flags
-		enum
-		{
-			OPF_CONTENT_TREE = 1 << 0,  //! Locate this page in the content tree
-			OPF_NEW_TAB = 1 << 2,       //! Open the page in a new tab
-			OPF_BACKGROUND  = 1 << 3    //! Open the page in a new tab in background
-		};
-
 	public:
 		MainWindow( const QStringList& arguments );
 		~MainWindow();
 
-		bool        openPage (const QUrl& url, unsigned int flags = OPF_CONTENT_TREE );
+		bool        openPage (const QUrl& url, UBrowser::OpenMode mode = UBrowser::OPEN_IN_CURRENT );
 
 		EBook*      chmFile() const { return m_ebookFile; }
 		const QString&  getOpenedFileName () { return m_ebookFilename; }
@@ -161,7 +153,7 @@ class MainWindow : public QMainWindow, public Ui::MainWindow
 
 		// Link activation
 		void        activateUrl( const QUrl& link );
-		bool        onLinkClicked( ViewWindow* browser, const QUrl& url, unsigned int flags );
+		bool        onLinkClicked( ViewWindow* browser, const QUrl& url, UBrowser::OpenMode mode );
 
 		void        updateToolbars();
 		void        updateActions();

src/navigationpanel.cpp

@@ -160,7 +160,7 @@ void NavigationPanel::showPrevInToc()
 	lit--;
 
 	if ( *lit )
-		::mainWindow->openPage( ((TreeItem_TOC*) (*lit) )->getUrl(), MainWindow::OPF_CONTENT_TREE );
+		::mainWindow->openPage( ((TreeItem_TOC*) (*lit) )->getUrl() );
 }
 
 void NavigationPanel::showNextInToc()
@@ -178,7 +178,7 @@ void NavigationPanel::showNextInToc()
 	lit++;
 
 	if ( *lit )
-		::mainWindow->openPage( ((TreeItem_TOC*) (*lit) )->getUrl(), MainWindow::OPF_CONTENT_TREE );
+		::mainWindow->openPage( ((TreeItem_TOC*) (*lit) )->getUrl() );
 }
 
 int NavigationPanel::active() const

src/qtwebengine/viewwindow.cpp

@@ -18,7 +18,6 @@
 
 #include <QApplication>
 #include <QContextMenuEvent>
-#include <QDialog>
 #include <QKeySequence>
 #include <QMenu>
 #include <QPalette>
@@ -42,8 +41,15 @@
 
 class QPrinter;
 
+#include <browser-settings.hpp>
+#include <browser-types.hpp>
 #include <ebook.h>
 
+#include "../i18n.h"
+#include "../mainwindow.h"
+#include "../viewwindowmgr.h"
+#include "webenginepage.h"
+
 #include "viewwindow.h"
 
 
@@ -62,7 +68,7 @@ ViewWindow::ViewWindow( QWidget* parent )
 	m_storedScrollbarPosition = 0;
 
 	WebEnginePage* page = new WebEnginePage( this );
-	connect( page, SIGNAL( linkClicked ( const QUrl& ) ), this, SLOT( onLinkClicked( const QUrl& ) ) );
+	connect( page, SIGNAL( linkClicked ( const QUrl&, UBrowser::OpenMode ) ), this, SLOT( onLinkClicked( const QUrl&, UBrowser::OpenMode ) ) );
 	setPage( page );
 
 	connect( this, SIGNAL( loadFinished(bool)), this, SLOT( onLoadFinished(bool)) );
@@ -294,9 +300,9 @@ void ViewWindow::onLoadFinished ( bool )
 	emit dataLoaded( this );
 }
 
-void ViewWindow::onLinkClicked(const QUrl& url)
+void ViewWindow::onLinkClicked(const QUrl& url, UBrowser::OpenMode mode)
 {
-	emit linkClicked( url );
+	emit linkClicked( url, mode );
 }
 
 void ViewWindow::applySettings(BrowserSettings& settings)

src/qtwebengine/viewwindow.h

@@ -32,6 +32,8 @@ class QMenu;
 class QPrinter;
 class QWidget;
 
+#include <browser-types.hpp>
+
 struct BrowserSettings;
 
 
@@ -53,7 +55,7 @@ class ViewWindow : public QWebEngineView
 		void    dataLoaded( ViewWindow* window );
 
 		// This signal is emitted whenever the user clicks on a link.
-		void linkClicked(const QUrl& url);
+		void    linkClicked(const QUrl& url, UBrowser::OpenMode mode);
 
 	public:
 		// Apply the configuration settings (JS enabled etc) to the web renderer
@@ -125,7 +127,7 @@ class ViewWindow : public QWebEngineView
 	private slots:
 		// Used to restore the scrollbar position and the navigation button status
 		void            onLoadFinished ( bool ok );
-		void            onLinkClicked(const QUrl& url);
+		void            onLinkClicked(const QUrl& url, UBrowser::OpenMode mode = UBrowser::OPEN_IN_CURRENT);
 
 	private:
 		QMenu*                  m_contextMenu;

src/qtwebengine/webenginepage.h

@@ -26,6 +26,7 @@
 #include <QWebEnginePage>
 #include <QWebEngineProfile>
 
+#include <browser-types.hpp>
 #include <ebook_chm.h>
 #include <ebook_epub.h>
 
@@ -41,7 +42,7 @@ class WebEnginePage : public QWebEnginePage
 
 	signals:
 		// This signal is emitted whenever the user clicks on a link.
-		void linkClicked( const QUrl& url );
+		void linkClicked( const QUrl& url, UBrowser::OpenMode mode );
 
 	public:
 		WebEnginePage(QObject* parent)
@@ -63,7 +64,13 @@ class WebEnginePage : public QWebEnginePage
 		{
 		}
 
-		// Link click capture. This does not work for the right mouse button.
+		/* Link click capture. This does not work for the right mouse button.
+		 * Important! In Qt5, this function is called both when clicking with
+		 * the Ctrl and/or Shift keys pressed and when clicking without keyboard
+		 * modifiers, whereas in Qt6 it is called only when clicking without
+		 * keyboard modifiers. In any Qt, the createWindow function is called
+		 * when clicking with keyboard modifier.
+		 */
 		virtual bool acceptNavigationRequest( const QUrl& url, NavigationType type, bool isMainFrame ) override
 		{
 #if PRINT_DEBUG
@@ -77,7 +84,14 @@ class WebEnginePage : public QWebEnginePage
 
 			if ( type == QWebEnginePage::NavigationTypeLinkClicked )
 			{
-				emit linkClicked( url );
+				/*
+				 * Here m_url is used as a flag. If linkClicked was emitted in the createWindow
+				 * function, the m_url variable has been cleared and we don't need to re-emit
+				 * linkClicked. This is specifically for QwebEngine < 6.2.
+				 */
+				if ( !m_url.isEmpty() )
+					emit linkClicked( url, UBrowser::OPEN_IN_CURRENT );
+
 				return false;
 			}
 
@@ -104,11 +118,16 @@ class WebEnginePage : public QWebEnginePage
 			if ( !m_url.isEmpty() )
 			{
 				Qt::KeyboardModifiers mods = QApplication::keyboardModifiers();
-				if ( !( mods & (Qt::ShiftModifier | Qt::ControlModifier ) ) )
-					linkClicked( ( m_url ) );
+
+				if ( ( mods & Qt::ShiftModifier ) != 0 || type == QWebEnginePage::WebBrowserTab)
+					emit linkClicked( m_url, UBrowser::OPEN_IN_NEW );
+				else
+					emit linkClicked(  m_url, UBrowser::OPEN_IN_BACKGROUND );
+
+				m_url.clear();
 			}
 
-			return 0;
+			return nullptr;
 		}
 
 	protected slots: