#include <mlabWebViewControl.h>

Inherits MLABSimpleWidgetControl.

Public Types
enum	FindFlags

enum	WebAction

Public Types inherited from MLABWidgetControl
enum	TitleType

Public Slots
Direct WebKit access
Note that this is best accessed using Python and that you need to import PythonQt.QtWebKit to get access to the full API of these classes. Have a look at http://doc.qt.io/archives/qt-5.5/qtwebkit.html for a detailed API description.
QWebView *	webView ()

QWebPage *	webPage ()

QWebFrame *	webMainFrame ()

QWebElement	documentElement ()

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 ()

Scripting access
QVariant	evaluateJavaScript (const QString &script)

QVariant	callJavaScript (const QString &functionToCall, QVariantList args=QVariantList())

QVariant	getJavaScriptValue (const QString &scopedName)

void	setJavaScriptValue (const QString &scopedName, const QVariant &value)

QString	selectedText ()

bool	findText (const QString &subString, int options=0)

void	setUrl (const QUrl &url)

void	setUrlFromFileName (const QString &absoluteFileName)

void	setUrlFromString (const QString &urlString)

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

QUrl	url ()

void	print (MLABScriptPrinter *printer)

QObject *	getAction (WebAction action)

void	triggerAction (WebAction action)

void	addActionToMenu (MLABPopupMenuControl *menu, WebAction action)

void	showFindTool ()

void	hideFindTool ()

void	loadStarted ()

void	loadProgress (float progress)

void	loadFinished (bool success)

void	javaScriptInit ()

void	linkClicked (const QUrl &)

void	selectionChanged ()

void	urlChanged (const QUrl &)

Additional Inherited Members
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

WebView control offers a full features HTML browser engine based on WebKit.

MDL reference: WebView

Member Enumeration Documentation

◆ FindFlags

enum MLABWebViewControl::FindFlags

FindFlags can be used to specify how findText behaves.

The possible values are described at http://doc.qt.io/archives/qt-5.5/qwebpage.html#FindFlag-enum

◆ WebAction

enum MLABWebViewControl::WebAction

WebAction can be used to specify which WebAction to get.

The possible values are described at http://doc.qt.io/archives/qt-5.5/qwebpage.html#WebAction-enum

Member Function Documentation

◆ addActionToMenu

void MLABWebViewControl::addActionToMenu	(	MLABPopupMenuControl *	menu,
		WebAction	action
	)

slot

add the WebAction to the given MDL popup menu

◆ callJavaScript

QVariant MLABWebViewControl::callJavaScript	(	const QString &	functionToCall,
		QVariantList	args = `QVariantList()`
	)

slot

call the given javascript function with given args and return the result of the call

◆ documentElement

QWebElement MLABWebViewControl::documentElement ( )

slot

get the document element of the current web page's main frame Have a look at http://doc.qt.io/archives/qt-5.5/qwebelement.html

◆ evaluateJavaScript

QVariant MLABWebViewControl::evaluateJavaScript ( const QString & script )

slot

evaluate the given javascript inside of web page

◆ findText

bool MLABWebViewControl::findText	(	const QString &	subString,
		int	options = `0`
	)

slot

find given text and return if it was found. Options are or'ed together from FindFlags.

◆ getAction

QObject * MLABWebViewControl::getAction ( WebAction action )

slot

get web action for usage in a QMenu/QToolbar

◆ getJavaScriptValue

QVariant MLABWebViewControl::getJavaScriptValue ( const QString & scopedName )

slot

get the given javascript value

◆ hideFindTool

void MLABWebViewControl::hideFindTool ( )

slot

hide the find tool

◆ print

void MLABWebViewControl::print ( MLABScriptPrinter * printer )

slot

print on the given printer

◆ selectedText

QString MLABWebViewControl::selectedText ( )

slot

get the currently selected text

◆ setHtmlFromString

void MLABWebViewControl::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.

◆ setJavaScriptValue

void MLABWebViewControl::setJavaScriptValue	(	const QString &	scopedName,
		const QVariant &	value
	)

slot

set the given javascript value

◆ setUrl

void MLABWebViewControl::setUrl ( const QUrl & url )

slot

set the url to load

◆ setUrlFromFileName

void MLABWebViewControl::setUrlFromFileName ( const QString & absoluteFileName )

slot

set the url from the given local filename

◆ setUrlFromString

void MLABWebViewControl::setUrlFromString ( const QString & urlString )

slot

set the url from the given string

◆ showFindTool

void MLABWebViewControl::showFindTool ( )

slot

show the find tool

◆ triggerAction

void MLABWebViewControl::triggerAction ( WebAction action )

slot

trigger the given web action The actions are available as enum values on the view.

webview = ctx.control("webview")

webview.triggerAction(webview.Copy)

◆ webMainFrame

QWebFrame * MLABWebViewControl::webMainFrame ( )

slot

get the underlying main frame of the web page

◆ webPage

QWebPage * MLABWebViewControl::webPage ( )

slot

get the underlying web page

◆ webView

QWebView * MLABWebViewControl::webView ( )

slot

get the underlying web view

Public Types

Public Slots

Scripting access

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FindFlags

◆ WebAction

Member Function Documentation

◆ addActionToMenu

◆ callJavaScript

◆ documentElement

◆ evaluateJavaScript

◆ findText

◆ getAction

◆ getJavaScriptValue

◆ hideFindTool

◆ print

◆ selectedText

◆ setHtmlFromString

◆ setJavaScriptValue

◆ setUrl

◆ setUrlFromFileName

◆ setUrlFromString

◆ showFindTool

◆ triggerAction

◆ webMainFrame

◆ webPage

◆ webView