qSlicerWebWidget.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __qSlicerWebWidget_h
#define __qSlicerWebWidget_h

// Qt includes
#include <QSslError>
#include <QWidget>

// QtGUI includes
#include "qSlicerBaseQTGUIExport.h"

#include "vtkSlicerConfigure.h" // For Slicer_USE_PYTHONQT_WITH_OPENSSL, Slicer_HAVE_WEBKIT_SUPPORT

class QNetworkReply;
class qSlicerWebWidgetPrivate;
class QUrl;
#ifdef Slicer_HAVE_WEBKIT_SUPPORT
class QWebView;
#else
class QWebChannel;
#include <QWebEnginePage>
class QWebEngineView;
#endif

#if (QT_VERSION < QT_VERSION_CHECK(5, 3, 0))
#ifdef QT_NO_OPENSSL
struct QSslError{};
#endif
#else
#ifdef QT_NO_SSL
struct QSslError{};
#endif
#endif

class Q_SLICER_BASE_QTGUI_EXPORT qSlicerWebWidget
  : public QWidget
{
  Q_OBJECT
  Q_PROPERTY(bool handleExternalUrlWithDesktopService READ handleExternalUrlWithDesktopService WRITE setHandleExternalUrlWithDesktopService)
  Q_PROPERTY(QStringList internalHosts READ internalHosts WRITE setInternalHosts)
  Q_PROPERTY(QString url READ url WRITE setUrl)
  friend class qSlicerWebEnginePage;
public:
  typedef QWidget Superclass;

  explicit qSlicerWebWidget(QWidget* parent = 0);

  virtual ~qSlicerWebWidget();

  bool handleExternalUrlWithDesktopService() const;
  void setHandleExternalUrlWithDesktopService(bool enable);

  QStringList internalHosts() const;
  void setInternalHosts(const QStringList& hosts);

//  QWebEngineProfile* profile()const;
//  void setProfile(QWebEngineProfile* profile);

#ifdef Slicer_HAVE_WEBKIT_SUPPORT
  Q_INVOKABLE QWebView * webView();
#else
  Q_INVOKABLE QWebEngineView * webView();
#endif

  Q_INVOKABLE QString evalJS(const QString &js);

  Q_INVOKABLE QString url();

public slots:

  void setUrl(const QString &url);

  void onDownloadStarted(QNetworkReply* reply);

  void onDownloadProgress(qint64 bytesReceived, qint64 bytesTotal);

  void onDownloadFinished(QNetworkReply* reply);

signals:
  void evalResult(QString js, QString result);

  void loadStarted();
  void loadProgress(int progress);
  void loadFinished(bool ok);

protected slots:
  virtual void initJavascript();
  virtual void onLoadStarted();
  virtual void onLoadProgress(int progress);
  virtual void onLoadFinished(bool ok);
#ifdef Slicer_HAVE_WEBKIT_SUPPORT
  virtual void onLinkClicked(const QUrl& url);
#endif
  void handleSslErrors(QNetworkReply* reply, const QList<QSslError> &errors);

protected:
  qSlicerWebWidget(qSlicerWebWidgetPrivate* pimpl, QWidget* parent = 0);
  QScopedPointer<qSlicerWebWidgetPrivate> d_ptr;

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

#ifndef Slicer_HAVE_WEBKIT_SUPPORT
  virtual bool acceptNavigationRequest(const QUrl & url, QWebEnginePage::NavigationType type, bool isMainFrame);
#endif

private:
  Q_DECLARE_PRIVATE(qSlicerWebWidget);
  Q_DISABLE_COPY(qSlicerWebWidget);
};

#endif