qSlicerWebWidget Class Reference

#include <Base/QTGUI/qSlicerWebWidget.h>

Inheritance diagram for qSlicerWebWidget:

Collaboration diagram for qSlicerWebWidget:

Public Types
typedef QWidget	Superclass
	Superclass typedef. More...

Properties
bool	handleExternalUrlWithDesktopService
QStringList	internalHosts
QString	url

Public Slots
void	onDownloadFinished (QNetworkReply *reply)
void	onDownloadProgress (qint64 bytesReceived, qint64 bytesTotal)
void	onDownloadStarted (QNetworkReply *reply)
void	setUrl (const QString &url)
	Convenience for setting the internal webView QUrl from a QString. More...

Signals
void	evalResult (QString js, QString result)
	emited with result of evalJS More...
void	loadFinished (bool ok)
void	loadProgress (int progress)
void	loadStarted ()
	signal passed through from QWebEngineView More...

Public Member Functions
Q_INVOKABLE QString	evalJS (const QString &js)
bool	handleExternalUrlWithDesktopService () const
	Return true if external URL should be open with desktop service. More...
QStringList	internalHosts () const
	Set/Get internal host. More...
	qSlicerWebWidget (QWidget *parent=0)
	Constructor. More...
void	setHandleExternalUrlWithDesktopService (bool enable)
void	setInternalHosts (const QStringList &hosts)
Q_INVOKABLE QString	url ()
	Convenience for setting the internal webView QUrl from a QString. More...
Q_INVOKABLE QWebEngineView *	webView ()
	Return a reference to the QWebView used internally. More...
virtual	~qSlicerWebWidget ()
	Destructor. More...

Protected Slots
void	handleSslErrors (QNetworkReply *reply, const QList< QSslError > &errors)
virtual void	initJavascript ()
virtual void	onLoadFinished (bool ok)
virtual void	onLoadProgress (int progress)
virtual void	onLoadStarted ()

Protected Member Functions
virtual bool	acceptNavigationRequest (const QUrl &url, QWebEnginePage::NavigationType type, bool isMainFrame)
bool	eventFilter (QObject *obj, QEvent *event)
	qSlicerWebWidget (qSlicerWebWidgetPrivate *pimpl, QWidget *parent=0)

Protected Attributes
QScopedPointer< qSlicerWebWidgetPrivate >	d_ptr

Friends
class	qSlicerWebEnginePage

Detailed Description

Definition at line 54 of file qSlicerWebWidget.h.

Member Typedef Documentation

Superclass

typedef QWidget qSlicerWebWidget::Superclass

Superclass typedef.

Definition at line 64 of file qSlicerWebWidget.h.

Property Documentation

handleExternalUrlWithDesktopService

bool qSlicerWebWidget::handleExternalUrlWithDesktopService

readwrite

Definition at line 58 of file qSlicerWebWidget.h.

internalHosts

QStringList qSlicerWebWidget::internalHosts

readwrite

Definition at line 59 of file qSlicerWebWidget.h.

url

QString qSlicerWebWidget::url

readwrite

Definition at line 60 of file qSlicerWebWidget.h.

Constructor & Destructor Documentation

qSlicerWebWidget() [1/2]

qSlicerWebWidget::qSlicerWebWidget ( QWidget *  parent = 0 )

explicit

Constructor.

~qSlicerWebWidget()

virtual qSlicerWebWidget::~qSlicerWebWidget ( )

virtual

Destructor.

qSlicerWebWidget() [2/2]

qSlicerWebWidget::qSlicerWebWidget ( qSlicerWebWidgetPrivate *  pimpl, QWidget *  parent = 0  )

protected

Member Function Documentation

acceptNavigationRequest()

virtual bool qSlicerWebWidget::acceptNavigationRequest ( const QUrl &  url, QWebEnginePage::NavigationType  type, bool  isMainFrame  )

protectedvirtual

Reimplemented in qSlicerExtensionsInstallWidget.

evalJS()

Q_INVOKABLE QString qSlicerWebWidget::evalJS

(

const QString &

js

)

Convenient function to evaluate JS in main frame context from C++ or Python code

evalResult

void qSlicerWebWidget::evalResult ( QString  js, QString  result  )

signal

emited with result of evalJS

eventFilter()

bool qSlicerWebWidget::eventFilter ( QObject *  obj, QEvent *  event  )

protected

Event filter used to capture WebView Show and Hide events in order to both set "document.webkitHidden" property and trigger the associated event.

handleExternalUrlWithDesktopService()

bool qSlicerWebWidget::handleExternalUrlWithDesktopService

(

)

const

Return true if external URL should be open with desktop service.

Setting both this property to true and at least one internal host will ensure URLs not matching an internal host are open with the current desktop browser.

See also

setInternalHost(const QString&)

QDesktopServices::openUrl

handleSslErrors

void qSlicerWebWidget::handleSslErrors ( QNetworkReply *  reply, const QList< QSslError > &  errors  )

protectedslot

initJavascript

virtual void qSlicerWebWidget::initJavascript ( )

protectedvirtualslot

internalHosts()

QStringList qSlicerWebWidget::internalHosts

(

)

const

Set/Get internal host.

See also

setHandleExternalUrlWithDesktopService(bool)

loadFinished

void qSlicerWebWidget::loadFinished ( bool  ok )

signal

loadProgress

void qSlicerWebWidget::loadProgress ( int  progress )

signal

loadStarted

void qSlicerWebWidget::loadStarted ( )

signal

signal passed through from QWebEngineView

onDownloadFinished

void qSlicerWebWidget::onDownloadFinished ( QNetworkReply *  reply )

slot

onDownloadProgress

void qSlicerWebWidget::onDownloadProgress ( qint64  bytesReceived, qint64  bytesTotal  )

slot

onDownloadStarted

void qSlicerWebWidget::onDownloadStarted ( QNetworkReply *  reply )

slot

onLoadFinished

virtual void qSlicerWebWidget::onLoadFinished ( bool  ok )

protectedvirtualslot

onLoadProgress

virtual void qSlicerWebWidget::onLoadProgress ( int  progress )

protectedvirtualslot

onLoadStarted

virtual void qSlicerWebWidget::onLoadStarted ( )

protectedvirtualslot

setHandleExternalUrlWithDesktopService()

void qSlicerWebWidget::setHandleExternalUrlWithDesktopService

(

bool

enable

)

setInternalHosts()

void qSlicerWebWidget::setInternalHosts

(

const QStringList &

hosts

)

setUrl

void qSlicerWebWidget::setUrl ( const QString &  url )

slot

Convenience for setting the internal webView QUrl from a QString.

url()

Q_INVOKABLE QString qSlicerWebWidget::url

(

)

Convenience for setting the internal webView QUrl from a QString.

webView()

Q_INVOKABLE QWebEngineView* qSlicerWebWidget::webView

(

)

Return a reference to the QWebView used internally.

Friends And Related Function Documentation

qSlicerWebEnginePage

friend class qSlicerWebEnginePage

friend

Definition at line 61 of file qSlicerWebWidget.h.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerWebWidgetPrivate> qSlicerWebWidget::d_ptr

protected

Definition at line 138 of file qSlicerWebWidget.h.

---

The documentation for this class was generated from the following file:

• Base/QTGUI/qSlicerWebWidget.h