MeVisLab Scripting Reference
MLABWebViewControl Class Reference
Inheritance diagram for MLABWebViewControl:
MLABSimpleWidgetControl MLABWidgetControl

Public Types

enum  FindFlags
 
enum  WebAction
 

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 ()
 
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 ()
 
- 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 ()
 
MLABWidgetControlcontrol (const QString &name)
 
float scaleFactor ()
 
MLABModulemodule ()
 
QString getType ()
 
QString getName ()
 
bool acceptDrops ()
 
void setAcceptDrops (bool flag)
 
void raiseWidget ()
 
void setStyleSheetFromString (const QString &styleSheetText)
 
void setStyleSheetFromFile (const QString &styleSheetFileName)
 
MLABTreetree ()
 
void updateMaxSize ()
 
bool expandX ()
 
bool expandY ()
 
MLABTreePtr getDefaultTagValues () const
 
virtual bool hasUncommittedChanges () const
 
virtual void applyUncommittedChanges ()
 
virtual void revertUncommittedChanges ()
 
MLABFieldfield () const
 

Detailed Description

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

MDL reference: WebView

Member Enumeration Documentation

◆ 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

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