goldendict-ng/articlewebview.hh

/* This file is (c) 2008-2012 Konstantin Isakov <ikm@goldendict.org>
 * Part of GoldenDict. Licensed under GPLv3 or later, see the LICENSE file */

#ifndef __ARTICLEWEBVIEW_HH_INCLUDED__
#define __ARTICLEWEBVIEW_HH_INCLUDED__

#include "config.hh"
#include <QEvent>
#include <QMouseEvent>
#include <QWebEngineView>

/// A thin wrapper around QWebEngineView to accommodate to some ArticleView's needs.
/// Currently the only added features:
/// 1. Ability to know if the middle mouse button is pressed or not according
///    to the view's current state. This is used to open links in new tabs when
///    they are clicked with middle button. There's also an added possibility to
///    get double-click events after the fact with the doubleClicked() signal.
/// 2. Manage our own QWebInspector instance. In order to show inspector correctly,
///    use triggerPageAction( QWebEnginePage::InspectElement ) instead.
class ArticleWebView: public QWebEngineView
{
  Q_OBJECT

public:

  ArticleWebView( QWidget * parent );
  ~ArticleWebView();

  void setUp( Config::Class * cfg );

  bool isMidButtonPressed() const
  { return midButtonPressed; }
  void setSelectionBySingleClick( bool set )
  { selectionBySingleClick = set; }

  void triggerPageAction(QWebEnginePage::WebAction action, bool checked = false);

  bool eventFilter(QObject *obj, QEvent *ev);

  signals:

  /// Signals that the user has just double-clicked. The signal is delivered
  /// after the event was processed by the view -- that's the difference from
  /// installing an event filter. This is used for translating the double-clicked
  /// word, which gets selected by the view in response to double-click.
  void doubleClicked( QPoint pos );

  //the linkClicked signal was removed from webengineview. add the signal to simulate.
  void linkClicked(QUrl const& url);

protected:

  bool event( QEvent * event );
  void singleClickAction(QMouseEvent *event);
  void sendCustomMouseEvent(QEvent::Type type);
  void mousePressEvent(QMouseEvent *event);
  void mouseReleaseEvent( QMouseEvent * event );
  void doubleClickAction( QMouseEvent * event );
  void focusInEvent( QFocusEvent * event );
  void wheelEvent( QWheelEvent * event );


private:

  Config::Class * cfg;

  bool midButtonPressed;
  bool selectionBySingleClick;
  bool showInspectorDirectly;

  //MouseDbClickEvent will also emit MousePressEvent which conflict the single click event.
  //this variable used to distinguish the single click and real double click.
  bool firstClicked;
};

#endif