#include <mlabWebEngineViewControl.h>

Inherits MLABSimpleWidgetControl.

Direct QtWebEngine access
void	setUrl (const QUrl &url)

void	setUrlFromFileName (const QString &absoluteFileName)

void	setUrlFromString (const QString &urlString)

void	setHtmlFromString (const QString &html, const QUrl &baseUrl=QUrl())

QString	selectedText ()

QWebEnginePage *	webPage ()

void	setWebPage (QWebEnginePage *page)

QWebEngineView *	webView ()

void	addObjectToWebChannel (const QString &name, QObject *object)

void	removeObjectFromWebChannel (QObject *object)

void	runJavaScript (const QString &script)

void	runJavaScript (const QString &script, const QVariant &resultCallback)

void	openDevTools ()

void	setPrintingEnabled (bool enabled)

bool	isPrintingEnabled () const

void	printPage (QPrinter *printer, const QVariant &resultCallback)

bool	showPrintDialog ()

void	showFindTool ()

void	loadStarted ()

void	loadProgress (float progress)

void	loadFinished (bool success)

void	linkClicked (const QUrl &)

void	selectionChanged ()

void	urlChanged (const QUrl &)

Additional Inherited Members
Public Types inherited from MLABWidgetControl
enum	TitleType

Public Slots inherited from MLABWidgetControl
void	adjustSize ()

virtual void	setEnabled (bool flag)

virtual void	setVisible (bool flag)

virtual bool	isVisible ()

virtual void	setFocus ()

virtual bool	hasFocus ()

virtual void	setToolTip (const QString &string)

virtual void	setWhatsThis (const QString &string)

void	displayWhatsThis ()

void	displayWhatsThis (const QString &text)

virtual void	setTitle (const QString &)

QWidget *	widget ()

QLayout *	layout ()

virtual QString	windowHandle ()

virtual bool	createScreenshot (const QString &filename, bool grabFromScreen=true, bool scaleToLowRes=false)

bool	isReloadable () const

void	reload (MLABTree *tree)

QString	createGlobalScreenshot ()

QString	applicationName ()

QSize	size ()

int	width ()

int	height ()

int	minWidth ()

int	minHeight ()

int	maxWidth ()

int	maxHeight ()

virtual void	setMinWidth (int s)

virtual void	setMinHeight (int s)

void	setMaxWidth (int s)

void	setMaxHeight (int s)

QSize	sizeHint ()

QSize	minSize ()

QSize	maxSize ()

void	setMinSize (QSize size)

void	setMaxSize (QSize size)

void	updateLayout ()

int	windowID ()

MLABWidgetControl *	control (const QString &name)

float	scaleFactor ()

MLABModule *	module ()

QString	getType ()

QString	getName ()

bool	acceptDrops ()

void	setAcceptDrops (bool flag)

void	raiseWidget ()

void	setStyleSheetFromString (const QString &styleSheetText)

void	setStyleSheetFromFile (const QString &styleSheetFileName)

MLABTree *	tree ()

void	updateMaxSize ()

bool	expandX ()

bool	expandY ()

MLABTreePtr	getDefaultTagValues () const

virtual bool	hasUncommittedChanges () const

virtual void	applyUncommittedChanges ()

virtual void	revertUncommittedChanges ()

MLABField *	field () const

virtual QString	py_toString ()

Public Member Functions inherited from MLABWidgetControl
bool	createScreenshot (QWidget *widget, const QString &filename, int x=0, int y=0, int w=-1, int h=-1, bool grabFromScreen=true, bool scaleToLowRes=false)

void	setStyle (MLABStyle *proto)

MLABStyle *	style ()

QString	buildTitleString (MLABField optionalField, bool splitUppercase, TitleType resultTitleType=nullptr)

void	evaluateVisibleOnExpression ()

Static Public Member Functions inherited from MLABWidgetControl
static bool	showMDLFileForWidget (QWidget *w)

static bool	showHelpContextMenuForWidget (QWidget *w)

static QKeySequence	getKeySequence (const MLABTree *attrib)

static QString	trimString (const QString &s, QWidget *w, trim mode)

Protected Slots inherited from MLABWidgetControl
void	emitResizeCommand ()

void	updateEnabledState ()

void	setVisibleDelayed (bool visible)

void	tooltipFieldChanged ()

Protected Member Functions inherited from MLABWidgetControl
void	setupEditedField ()

virtual void	internalReload ()

virtual void	addDefaultTagValues (MLABTree *tree) const

void	addDefaultTagValue (MLABTree *tree, const QString &tagName, const QString &tagValue) const

void	addDefaultTagValue (MLABTree tree, const QString &tagName, const char tagValue) const

void	addDefaultTagValue (MLABTree *tree, const QString &tagName, bool tagValue) const

void	addDefaultTagValue (MLABTree *tree, const QString &tagName, int tagValue) const

void	addDefaultTagValue (MLABTree *tree, const QString &tagName, unsigned int tagValue) const

void	addDefaultTagValue (MLABTree *tree, const QString &tagName, float tagValue) const

void	addDefaultTagValue (MLABTree *tree, const QString &tagName, double tagValue) const

bool	verifyThatParentsHaveDifferentAlignGroups (const QString &alignGroup, bool isXAlign)

MLABField *	lookupField (const QString fieldname, MLABTree tree, const char classname=nullptr, bool warn=true)

QPixmap	readPixmap (MLABTree *tree)

QPixmap	readPixmap (const QString &filename)

QPixmap	readPixmap (MLABTree *tree, float scale)

QPixmap	readPixmap (const QString &filename, float scale)

QImage	readImage (MLABTree *tree, float scale)

QImage	readImage (const QString &filename, float scale)

void	updateMaxSize (bool maygrow)

QString	trimString (const QString &s, QWidget *w)

void	setupScaleFactor ()

QString	uniqueGroupString ()

bool	createIconSet (QIcon &icon, QAbstractButton *button=nullptr, bool autoScale=false)

bool	createIconSetPixmap (QIcon &iconset, const QString &name, QIcon::Mode mode, QIcon::State state, bool resize=false, QSize *scaleSize=nullptr)

bool	createIconSet (MLABTree tree, QIcon &icon, QAbstractButton button=nullptr, bool autoScale=false)

bool	createIconSetPixmap (MLABTree tree, QIcon &iconset, const QString &name, QIcon::Mode mode, QIcon::State state, bool resize=false, QSize scaleSize=nullptr)

QSize	defaultIconSize ()

virtual void	applyStyle ()

QString	loadStyleSheetFile (const QString &styleSheetFileName)

Static Protected Member Functions inherited from MLABWidgetControl
static QString	loadTextFileWithReplacedMDLVariables (const QString &filename)

static bool	shouldExpandCheck (MLABTree *t)

static QString	removeStyleSheetComments (const QString &style)

Protected Attributes inherited from MLABWidgetControl
struct MLABWidgetControl::__flags	_flags

MLABTreePtr	_tree

MLABTreePtr	_prototype

MLABStylePtr	_style

QWidget *	_widget

int	_windowId

float	_scale

MLABWidgetControlContextInfo *	_info

int	_controlType

QString	_alignGroupX

QString	_alignGroupY

QString	_alignGroupLabels

QString	_alignChildX

QString	_alignChildY

int	_maxColIndex

int	_maxRowIndex

int	_layoutXDepth

int	_layoutYDepth

QPointer< MLABModule >	_module

QPointer< MLABField >	_field

QPointer< MLABField >	_tooltipField

MLABFieldExpressionEvaluator *	_visibleOnEvaluator

trim	_trim

bool	_isReloadable

Static Protected Attributes inherited from MLABWidgetControl
static MLABTreePtr	_currentAttrib

static int	_uniqAlignGroupCounter

static const bool	expandXDefault = false

static const bool	expandYDefault = false

static const QString	alignXDefault

static const QString	alignYDefault

static const QString	bgModeDefault

static const QString	editBgModeDefault

static const QString	buttonBgModeDefault

static const int	colspanDefault = 1

Detailed Description

WebEngineView control offers a HTML browser engine based on Chromium/QtWebEngine.

To facilitate debugging of the control, you can enable the logConsoleOutput MDL tag. Another option is to set the environment variable QTWEBENGINE_REMOTE_DEBUGGING to a port number (e.g. 4567) and then connect a Google Chrome browser to http://127.0.0.1:4567/ to use the remote debugging tools.

MDL reference: WebEngineView

Member Function Documentation

◆ addObjectToWebChannel

void MLABWebEngineViewControl::addObjectToWebChannel	(	const QString &	name,
		QObject *	object
	)

slot

Registers the given object to the web channel It needs to be called before setting the content via setUrl().

It requires the usage of qwebchannel.js inside of the html document.

◆ isPrintingEnabled

bool MLABWebEngineViewControl::isPrintingEnabled ( ) const

inlineslot

Return if printing is enabled.

◆ openDevTools

void MLABWebEngineViewControl::openDevTools ( )

slot

Open a new window with developer tools for this web view.

◆ printPage

void MLABWebEngineViewControl::printPage	(	QPrinter *	printer,
		const QVariant &	resultCallback
	)

slot

Prints the current QWebEnginePage using the given printer.

Calls the result callback with a success indicating boolean, if the callback is valid. Otherwise prints an error in case of a failure. You must ensure that printer stays valid until the result callback has been called.

◆ removeObjectFromWebChannel

void MLABWebEngineViewControl::removeObjectFromWebChannel ( QObject * object )

slot

Deregister an object previously registered with addObjectToWebChannel.

This acts the same as if the registered object was destroyed.

◆ runJavaScript [1/2]

void MLABWebEngineViewControl::runJavaScript ( const QString & script )

slot

Runs the given script (asynchronously).

◆ runJavaScript [2/2]

void MLABWebEngineViewControl::runJavaScript	(	const QString &	script,
		const QVariant &	resultCallback
	)

slot

Runs the given script (asynchronously) and calls the result callback with the result of the last JavaScript statement.

◆ selectedText

QString MLABWebEngineViewControl::selectedText ( )

slot

Returns the currently selected text.

◆ setHtmlFromString

void MLABWebEngineViewControl::setHtmlFromString	(	const QString &	html,
		const QUrl &	baseUrl = `QUrl()`
	)

slot

Set the html data from the given string.

If no baseUrl is given, the base url is the of the MDL code that created this WebView.

◆ setPrintingEnabled

void MLABWebEngineViewControl::setPrintingEnabled ( bool enabled )

slot

Sets if printing is enabled (connects current QWebEnginePage::printRequested() to showPrintDialog() slot if enabled is true).

◆ setUrl

void MLABWebEngineViewControl::setUrl ( const QUrl & url )

slot

Set the url to load.

◆ setUrlFromFileName

void MLABWebEngineViewControl::setUrlFromFileName ( const QString & absoluteFileName )

slot

Set the url from the given local filename.

◆ setUrlFromString

void MLABWebEngineViewControl::setUrlFromString ( const QString & urlString )

slot

Set the url from the given string.

◆ setWebPage

void MLABWebEngineViewControl::setWebPage ( QWebEnginePage * page )

slot

Allows to set your own QWebEnginePage, which you can derive using Python.

MDL link delegation and redirection to debug output will not work with your own widget, but you can re-implement that in Python.

◆ showPrintDialog

bool MLABWebEngineViewControl::showPrintDialog ( )

slot

Shows a print dialog which starts printing, if the user accepts it. Returns if the user accepted it.

◆ webPage

QWebEnginePage * MLABWebEngineViewControl::webPage ( )

slot

Get the access to the underlying page.

Import QtWebEngineWidgets to allow full scripting of this class.

from PythonQt import QtWebEngineWidgets

◆ webView

QWebEngineView * MLABWebEngineViewControl::webView ( )

slot

Get the access to the underlying view.

Import QtWebEngineWidgets to allow full scripting of this class.

from PythonQt import QtWebEngineWidgets

Direct QtWebEngine access

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addObjectToWebChannel

◆ isPrintingEnabled

◆ openDevTools

◆ printPage

◆ removeObjectFromWebChannel

◆ runJavaScript [1/2]

◆ runJavaScript [2/2]

◆ selectedText

◆ setHtmlFromString

◆ setPrintingEnabled

◆ setUrl

◆ setUrlFromFileName

◆ setUrlFromString

◆ setWebPage

◆ showPrintDialog

◆ webPage

◆ webView