468 lines
41 KiB
HTML
468 lines
41 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<!-- qdeclarativewebview.cpp -->
|
|
<title>Qt 4.8: QML WebView Element</title>
|
|
<link rel="stylesheet" type="text/css" href="style/style.css" />
|
|
<script src="scripts/jquery.js" type="text/javascript"></script>
|
|
<script src="scripts/functions.js" type="text/javascript"></script>
|
|
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
|
|
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
|
|
<!--[if IE]>
|
|
<meta name="MSSmartTagsPreventParsing" content="true">
|
|
<meta http-equiv="imagetoolbar" content="no">
|
|
<![endif]-->
|
|
<!--[if lt IE 7]>
|
|
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
|
|
<![endif]-->
|
|
<!--[if IE 7]>
|
|
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
|
|
<![endif]-->
|
|
<!--[if IE 8]>
|
|
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
|
|
<![endif]-->
|
|
|
|
<script src="scripts/superfish.js" type="text/javascript"></script>
|
|
<script src="scripts/narrow.js" type="text/javascript"></script>
|
|
|
|
</head>
|
|
<body class="" onload="CheckEmptyAndLoadList();">
|
|
<div class="header" id="qtdocheader">
|
|
<div class="content">
|
|
<div id="nav-logo">
|
|
<a href="index.html">Home</a></div>
|
|
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
|
|
<div id="narrowsearch"></div>
|
|
<div id="nav-topright">
|
|
<ul>
|
|
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
|
|
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
|
|
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
|
|
DOC</a></li>
|
|
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="shortCut">
|
|
<ul>
|
|
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
|
|
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
|
|
</ul>
|
|
</div>
|
|
<ul class="sf-menu" id="narrowmenu">
|
|
<li><a href="#">API Lookup</a>
|
|
<ul>
|
|
<li><a href="classes.html">Class index</a></li>
|
|
<li><a href="functions.html">Function index</a></li>
|
|
<li><a href="modules.html">Modules</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
<li><a href="qtglobal.html">Global Declarations</a></li>
|
|
<li><a href="qdeclarativeelements.html">QML elements</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Qt Topics</a>
|
|
<ul>
|
|
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
|
|
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
|
|
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
|
|
<li><a href="supported-platforms.html">Supported Platforms</a></li>
|
|
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
|
|
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Examples</a>
|
|
<ul>
|
|
<li><a href="all-examples.html">Examples</a></li>
|
|
<li><a href="tutorials.html">Tutorials</a></li>
|
|
<li><a href="demos.html">Demos</a></li>
|
|
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="wrapper">
|
|
<div class="hd">
|
|
<span></span>
|
|
</div>
|
|
<div class="bd group">
|
|
<div class="sidebar">
|
|
<div class="searchlabel">
|
|
Search index:</div>
|
|
<div class="search" id="sidebarsearch">
|
|
<form id="qtdocsearch" action="" onsubmit="return false;">
|
|
<fieldset>
|
|
<input type="text" name="searchstring" id="pageType" value="" />
|
|
<div id="resultdialog">
|
|
<a href="#" id="resultclose">Close</a>
|
|
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
|
|
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
|
|
<ul id="resultlist" class="all">
|
|
</ul>
|
|
</div>
|
|
</fieldset>
|
|
</form>
|
|
</div>
|
|
<div class="box first bottombar" id="lookup">
|
|
<h2 title="API Lookup"><span></span>
|
|
API Lookup</h2>
|
|
<div id="list001" class="list">
|
|
<ul id="ul001" >
|
|
<li class="defaultLink"><a href="classes.html">Class index</a></li>
|
|
<li class="defaultLink"><a href="functions.html">Function index</a></li>
|
|
<li class="defaultLink"><a href="modules.html">Modules</a></li>
|
|
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
|
|
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
|
|
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="box bottombar" id="topics">
|
|
<h2 title="Qt Topics"><span></span>
|
|
Qt Topics</h2>
|
|
<div id="list002" class="list">
|
|
<ul id="ul002" >
|
|
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
|
|
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
|
|
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
|
|
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
|
|
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
|
|
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="box" id="examples">
|
|
<h2 title="Examples"><span></span>
|
|
Examples</h2>
|
|
<div id="list003" class="list">
|
|
<ul id="ul003">
|
|
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
|
|
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
|
|
<li class="defaultLink"><a href="demos.html">Demos</a></li>
|
|
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="wrap">
|
|
<div class="toolbar">
|
|
<div class="breadcrumb toolblock">
|
|
<ul>
|
|
<li class="first"><a href="index.html">Home</a></li>
|
|
<!-- Breadcrumbs go here -->
|
|
<li><a href="qdeclarativeelements.html">QML Elements</a></li>
|
|
<li>QML WebView Element</li>
|
|
</ul>
|
|
</div>
|
|
<div class="toolbuttons toolblock">
|
|
<ul>
|
|
<li id="smallA" class="t_button">A</li>
|
|
<li id="medA" class="t_button active">A</li>
|
|
<li id="bigA" class="t_button">A</li>
|
|
<li id="print" class="t_button"><a href="javascript:this.print();">
|
|
<span>Print</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="content mainContent">
|
|
<p class="naviNextPrevious headerNavi">
|
|
</p><p/>
|
|
<div class="toc">
|
|
<h3><a name="toc">Contents</a></h3>
|
|
<ul>
|
|
<li class="level1"><a href="#properties">Properties</a></li>
|
|
<li class="level1"><a href="#signal-handlers">Signal Handlers</a></li>
|
|
<li class="level1"><a href="#methods">Methods</a></li>
|
|
<li class="level1"><a href="#details">Detailed Description</a></li>
|
|
<li class="level2"><a href="#appearance">Appearance</a></li>
|
|
<li class="level2"><a href="#user-interaction-and-navigation">User Interaction and Navigation</a></li>
|
|
<li class="level2"><a href="#example-usage">Example Usage</a></li>
|
|
</ul>
|
|
</div>
|
|
<h1 class="title">QML WebView Element</h1>
|
|
<span class="subtitle"></span>
|
|
<!-- $$$WebView-brief -->
|
|
<p>The WebView item allows you to add Web content to a canvas. <a href="#details">More...</a></p>
|
|
<!-- @@@WebView -->
|
|
<p>Inherits <a href="qml-item.html">Item</a></p>
|
|
<p>Inherited by basic, elements, javaScript, loadError, sethtml, and webviewbackgroundcolor.</p>
|
|
<p>This element was introduced in Qt 4.7.</p>
|
|
<ul>
|
|
<li><a href="qml-webview-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="properties"></a>
|
|
<h2>Properties</h2>
|
|
<ul>
|
|
<li class="fn"><b><b><a href="qml-webview.html#back-prop">back</a></b></b> : action</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#forward-prop">forward</a></b></b> : action</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#html-prop">html</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#icon-prop">icon</a></b></b> : pixmap</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#javaScriptWindowObjects-prop">javaScriptWindowObjects</a></b></b> : list<object></li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#newWindowComponent-prop">newWindowComponent</a></b></b> : component</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#newWindowParent-prop">newWindowParent</a></b></b> : item</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#preferredHeight-prop">preferredHeight</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#preferredWidth-prop">preferredWidth</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#pressGrabTime-prop">pressGrabTime</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#progress-prop">progress</a></b></b> : real</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#reload-prop">reload</a></b></b> : action</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.autoLoadImages-prop">settings.autoLoadImages</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.cursiveFontFamily-prop">settings.cursiveFontFamily</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.defaultFixedFontSize-prop">settings.defaultFixedFontSize</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.defaultFontSize-prop">settings.defaultFontSize</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.developerExtrasEnabled-prop">settings.developerExtrasEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.fantasyFontFamily-prop">settings.fantasyFontFamily</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.fixedFontFamily-prop">settings.fixedFontFamily</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.javaEnabled-prop">settings.javaEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.javascriptCanAccessClipboard-prop">settings.javascriptCanAccessClipboard</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.javascriptCanOpenWindows-prop">settings.javascriptCanOpenWindows</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.javascriptEnabled-prop">settings.javascriptEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.linksIncludedInFocusChain-prop">settings.linksIncludedInFocusChain</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.localContentCanAccessRemoteUrls-prop">settings.localContentCanAccessRemoteUrls</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.localStorageDatabaseEnabled-prop">settings.localStorageDatabaseEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.minimumFontSize-prop">settings.minimumFontSize</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.minimumLogicalFontSize-prop">settings.minimumLogicalFontSize</a></b></b> : int</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.offlineStorageDatabaseEnabled-prop">settings.offlineStorageDatabaseEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.offlineWebApplicationCacheEnabled-prop">settings.offlineWebApplicationCacheEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.pluginsEnabled-prop">settings.pluginsEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.printElementBackgrounds-prop">settings.printElementBackgrounds</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.privateBrowsingEnabled-prop">settings.privateBrowsingEnabled</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.sansSerifFontFamily-prop">settings.sansSerifFontFamily</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.serifFontFamily-prop">settings.serifFontFamily</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.standardFontFamily-prop">settings.standardFontFamily</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#settings.zoomTextOnly-prop">settings.zoomTextOnly</a></b></b> : bool</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#statusText-prop">statusText</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#stop-prop">stop</a></b></b> : action</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#title-prop">title</a></b></b> : string</li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#url-prop">url</a></b></b> : url</li>
|
|
</ul>
|
|
<a name="signal-handlers"></a>
|
|
<h2>Signal Handlers</h2>
|
|
<ul>
|
|
<li class="fn"><b><b><a href="qml-webview.html#onAlert-signal">onAlert</a></b></b></li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#onDoubleClick-signal">onDoubleClick</a></b></b></li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#onLoadFailed-signal">onLoadFailed</a></b></b></li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#onLoadFinished-signal">onLoadFinished</a></b></b></li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#onLoadStarted-signal">onLoadStarted</a></b></b></li>
|
|
</ul>
|
|
<a name="methods"></a>
|
|
<h2>Methods</h2>
|
|
<ul>
|
|
<li class="fn"><b><b><a href="qml-webview.html#evaluateJavaScript-method">evaluateJavaScript</a></b></b></li>
|
|
<li class="fn"><b><b><a href="qml-webview.html#heuristicZoom-method">heuristicZoom</a></b></b></li>
|
|
</ul>
|
|
<!-- $$$WebView-description -->
|
|
<a name="details"></a>
|
|
<h2>Detailed Description</h2>
|
|
<p>A WebView renders Web content based on a URL.</p>
|
|
<p>This type is made available by importing the <tt>QtWebKit</tt> module:</p>
|
|
<p><b>import <a href="qtwebkit.html">QtWebKit</a> 1.0</b></p>
|
|
<p>The WebView item includes no scrolling, scaling, toolbars, or other common browser components. These must be implemented around WebView. See the QML Web Browser example for a demonstration of this.</p>
|
|
<p>The page to be displayed by the item is specified using the <a href="qml-webview.html#url-prop">url</a> property, and this can be changed to fetch and display a new page. While the page loads, the <a href="qml-webview.html#progress-prop">progress</a> property is updated to indicate how much of the page has been loaded.</p>
|
|
<a name="appearance"></a>
|
|
<h2>Appearance</h2>
|
|
<p>If the width and height of the item is not set, they will dynamically adjust to a size appropriate for the content. This width may be large for typical online web pages, typically greater than 800 by 600 pixels.</p>
|
|
<p>If the <a href="qml-item.html#width-prop">width</a> or <a href="qml-item.html#height-prop">height</a> is explictly set, the rendered Web site will be clipped, not scaled, to fit into the set dimensions.</p>
|
|
<p>If the <a href="qml-webview.html#preferredWidth-prop">preferredWidth</a> property is set, the width will be this amount or larger, usually laying out the Web content to fit the <a href="qml-webview.html#preferredWidth-prop">preferredWidth</a>.</p>
|
|
<p>The appearance of the content can be controlled to a certain extent by changing the settings.standardFontFamily property and other settings related to fonts.</p>
|
|
<p>The page can be zoomed by calling the <a href="qml-webview.html#heuristicZoom-method">heuristicZoom()</a> method, which performs a series of tests to determine whether zoomed content will be displayed in an appropriate way in the space allocated to the item.</p>
|
|
<a name="user-interaction-and-navigation"></a>
|
|
<h2>User Interaction and Navigation</h2>
|
|
<p>By default, certain mouse and touch events are delivered to other items in preference to the Web content. For example, when a scrolling view is created by placing a WebView in a Flickable, move events are delivered to the Flickable so that the user can scroll the page. This prevents the user from accidentally selecting text in a Web page instead of scrolling.</p>
|
|
<p>The <a href="qml-webview.html#pressGrabTime-prop">pressGrabTime</a> property defines the time the user must touch or press a mouse button over the WebView before the Web content will receive the move events it needs to select text and images.</p>
|
|
<p>When this item has keyboard focus, all keyboard input will be sent directly to the Web page within.</p>
|
|
<p>When the navigates by clicking on links, the item records the pages visited in its internal history</p>
|
|
<p>Because this item is designed to be used as a component in a browser, it exposes <a href="qml-action.html">actions</a> for <a href="qml-webview.html#back-prop">back</a>, <a href="qml-webview.html#forward-prop">forward</a>, <a href="qml-webview.html#reload-prop">reload</a> and <a href="qml-webview.html#stop-prop">stop</a>. These can be triggered to change the current page displayed by the item.</p>
|
|
<a name="example-usage"></a>
|
|
<h2>Example Usage</h2>
|
|
<div style="float: right; margin-left: 2em"><p><img src="images/webview.png" alt="" /> </div></p>
|
|
<p>The following example displays a scaled down Web page at a fixed size.</p>
|
|
<pre class="qml"> import QtWebKit 1.0
|
|
|
|
<span class="type">WebView</span> {
|
|
<span class="name">url</span>: <span class="string">"http://www.nokia.com"</span>
|
|
<span class="name">preferredWidth</span>: <span class="number">490</span>
|
|
<span class="name">preferredHeight</span>: <span class="number">400</span>
|
|
<span class="name">scale</span>: <span class="number">0.5</span>
|
|
<span class="name">smooth</span>: <span class="number">false</span>
|
|
}</pre>
|
|
<br style="clear: both" /><p><b>See also </b>WebView example and <a href="demos-declarative-webbrowser.html">Web Browser demo</a>.</p>
|
|
<!-- @@@WebView -->
|
|
<h2>Property Documentation</h2>
|
|
<!-- $$$back -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="back-prop"></a><span class="qmlreadonly">read-only</span><span class="name">back</span> : <span class="type"><a href="qml-action.html">action</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the action for causing the previous URL in the history to be displayed.</p>
|
|
</div></div><!-- @@@back -->
|
|
<br/>
|
|
<!-- $$$forward -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="forward-prop"></a><span class="qmlreadonly">read-only</span><span class="name">forward</span> : <span class="type"><a href="qml-action.html">action</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the action for causing the next URL in the history to be displayed.</p>
|
|
</div></div><!-- @@@forward -->
|
|
<br/>
|
|
<!-- $$$html -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="html-prop"></a><span class="name">html</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds HTML text set directly</p>
|
|
<p>The html property can be set as a string.</p>
|
|
<pre class="qml"> <span class="type"><a href="qml-webview.html">WebView</a></span> {
|
|
<span class="name">html</span>: <span class="string">"<p>This is <b>HTML</b>."</span>
|
|
}</pre>
|
|
</div></div><!-- @@@html -->
|
|
<br/>
|
|
<!-- $$$icon -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="icon-prop"></a><span class="qmlreadonly">read-only</span><span class="name">icon</span> : <span class="type">pixmap</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the icon associated with the web page currently viewed</p>
|
|
</div></div><!-- @@@icon -->
|
|
<br/>
|
|
<!-- $$$javaScriptWindowObjects -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="javaScriptWindowObjects-prop"></a><span class="qmlreadonly">read-only</span><span class="name">javaScriptWindowObjects</span> : <span class="type"><a href="qml-list.html">list</a></span><<span class="type">object</span>></p></td></tr></table></div><div class="qmldoc"><p>A list of QML objects to expose to the web page.</p>
|
|
<p>Each object will be added as a property of the web frame's window object. The property name is controlled by the value of <tt>WebView.windowObjectName</tt> attached property.</p>
|
|
<p>Exposing QML objects to a web page allows JavaScript executing in the web page itself to communicate with QML, by reading and writing properties and by calling methods of the exposed QML objects.</p>
|
|
<p>This example shows how to call into a QML method using a window object.</p>
|
|
<pre class="qml"> <span class="type"><a href="qml-webview.html">WebView</a></span> {
|
|
<span class="name">javaScriptWindowObjects</span>: <span class="name">QtObject</span> {
|
|
<span class="name">WebView</span>.windowObjectName: <span class="string">"qml"</span>
|
|
|
|
<span class="keyword">function</span> <span class="name">qmlCall</span>() {
|
|
<span class="name">console</span>.<span class="name">log</span>(<span class="string">"This call is in QML!"</span>);
|
|
}
|
|
}
|
|
|
|
<span class="name">html</span>: <span class="string">"<script>window.qml.qmlCall();</script>"</span>
|
|
}</pre>
|
|
<p>The output of the example will be:</p>
|
|
<pre class="cpp"> This call is in QML<span class="operator">!</span></pre>
|
|
<p>If Javascript is not enabled for the page, then this property does nothing.</p>
|
|
</div></div><!-- @@@javaScriptWindowObjects -->
|
|
<br/>
|
|
<!-- $$$newWindowComponent -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="newWindowComponent-prop"></a><span class="name">newWindowComponent</span> : <span class="type">component</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the component to use for new windows. The component must have a <a href="qml-webview.html">WebView</a> somewhere in its structure.</p>
|
|
<p>When the web engine requests a new window, it will be an instance of this component.</p>
|
|
<p>The parent of the new window is set by <a href="qml-webview.html#newWindowParent-prop">newWindowParent</a>. It must be set.</p>
|
|
</div></div><!-- @@@newWindowComponent -->
|
|
<br/>
|
|
<!-- $$$newWindowParent -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="newWindowParent-prop"></a><span class="name">newWindowParent</span> : <span class="type">item</span></p></td></tr></table></div><div class="qmldoc"><p>The parent item for new windows.</p>
|
|
<p><b>See also </b><a href="qml-webview.html#newWindowComponent-prop">newWindowComponent</a>.</p>
|
|
</div></div><!-- @@@newWindowParent -->
|
|
<br/>
|
|
<!-- $$$preferredHeight -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="preferredHeight-prop"></a><span class="name">preferredHeight</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the ideal height for displaying the current URL. This only affects the area zoomed by <a href="qml-webview.html#heuristicZoom-method">heuristicZoom()</a>.</p>
|
|
</div></div><!-- @@@preferredHeight -->
|
|
<br/>
|
|
<!-- $$$preferredWidth -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="preferredWidth-prop"></a><span class="name">preferredWidth</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the ideal width for displaying the current URL.</p>
|
|
</div></div><!-- @@@preferredWidth -->
|
|
<br/>
|
|
<!-- $$$pressGrabTime -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="pressGrabTime-prop"></a><span class="name">pressGrabTime</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>The number of milliseconds the user must press before the <a href="qml-webview.html">WebView</a> starts passing move events through to the Web engine (rather than letting other QML elements such as a Flickable take them).</p>
|
|
<p>Defaults to 400ms. Set to 0 to always grab and pass move events to the Web engine.</p>
|
|
</div></div><!-- @@@pressGrabTime -->
|
|
<br/>
|
|
<!-- $$$progress -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="progress-prop"></a><span class="qmlreadonly">read-only</span><span class="name">progress</span> : <span class="type"><a href="qml-real.html">real</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the progress of loading the current URL, from 0 to 1.</p>
|
|
<p>If you just want to know when progress gets to 1, use WebView::onLoadFinished() or WebView::onLoadFailed() instead.</p>
|
|
</div></div><!-- @@@progress -->
|
|
<br/>
|
|
<!-- $$$reload -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="reload-prop"></a><span class="qmlreadonly">read-only</span><span class="name">reload</span> : <span class="type"><a href="qml-action.html">action</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the action for reloading with the current URL</p>
|
|
</div></div><!-- @@@reload -->
|
|
<br/>
|
|
<!-- $$$settings.standardFontFamily -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.standardFontFamily-prop"></a><span class="name">settings.standardFontFamily</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.fixedFontFamily-prop"></a><span class="name">settings.fixedFontFamily</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.serifFontFamily-prop"></a><span class="name">settings.serifFontFamily</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.sansSerifFontFamily-prop"></a><span class="name">settings.sansSerifFontFamily</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.cursiveFontFamily-prop"></a><span class="name">settings.cursiveFontFamily</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.fantasyFontFamily-prop"></a><span class="name">settings.fantasyFontFamily</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.minimumFontSize-prop"></a><span class="name">settings.minimumFontSize</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.minimumLogicalFontSize-prop"></a><span class="name">settings.minimumLogicalFontSize</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.defaultFontSize-prop"></a><span class="name">settings.defaultFontSize</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.defaultFixedFontSize-prop"></a><span class="name">settings.defaultFixedFontSize</span> : <span class="type"><a href="qml-int.html">int</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.autoLoadImages-prop"></a><span class="name">settings.autoLoadImages</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.javascriptEnabled-prop"></a><span class="name">settings.javascriptEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.javaEnabled-prop"></a><span class="name">settings.javaEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.pluginsEnabled-prop"></a><span class="name">settings.pluginsEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.privateBrowsingEnabled-prop"></a><span class="name">settings.privateBrowsingEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.javascriptCanOpenWindows-prop"></a><span class="name">settings.javascriptCanOpenWindows</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.javascriptCanAccessClipboard-prop"></a><span class="name">settings.javascriptCanAccessClipboard</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.developerExtrasEnabled-prop"></a><span class="name">settings.developerExtrasEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.linksIncludedInFocusChain-prop"></a><span class="name">settings.linksIncludedInFocusChain</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.zoomTextOnly-prop"></a><span class="name">settings.zoomTextOnly</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.printElementBackgrounds-prop"></a><span class="name">settings.printElementBackgrounds</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.offlineStorageDatabaseEnabled-prop"></a><span class="name">settings.offlineStorageDatabaseEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.offlineWebApplicationCacheEnabled-prop"></a><span class="name">settings.offlineWebApplicationCacheEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="even"><td class="tblQmlPropNode"><p><a name="settings.localStorageDatabaseEnabled-prop"></a><span class="name">settings.localStorageDatabaseEnabled</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="settings.localContentCanAccessRemoteUrls-prop"></a><span class="name">settings.localContentCanAccessRemoteUrls</span> : <span class="type"><a href="qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>These properties give access to the settings controlling the web view.</p>
|
|
<p>See <a href="qwebsettings.html">QWebSettings</a> for details of these properties.</p>
|
|
<pre class="qml"> <span class="type"><a href="qml-webview.html">WebView</a></span> {
|
|
<span class="name">settings</span>.pluginsEnabled: <span class="number">true</span>
|
|
<span class="name">settings</span>.standardFontFamily: <span class="string">"Arial"</span>
|
|
<span class="comment">// ...</span>
|
|
}</pre>
|
|
</div></div><!-- @@@settings.standardFontFamily -->
|
|
<br/>
|
|
<!-- $$$statusText -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="statusText-prop"></a><span class="qmlreadonly">read-only</span><span class="name">statusText</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property is the current status suggested by the current web page. In a web browser, such status is often shown in some kind of status bar.</p>
|
|
</div></div><!-- @@@statusText -->
|
|
<br/>
|
|
<!-- $$$stop -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="stop-prop"></a><span class="qmlreadonly">read-only</span><span class="name">stop</span> : <span class="type"><a href="qml-action.html">action</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the action for stopping loading with the current URL</p>
|
|
</div></div><!-- @@@stop -->
|
|
<br/>
|
|
<!-- $$$title -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="title-prop"></a><span class="qmlreadonly">read-only</span><span class="name">title</span> : <span class="type"><a href="qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the title of the web page currently viewed</p>
|
|
<p>By default, this property contains an empty string.</p>
|
|
</div></div><!-- @@@title -->
|
|
<br/>
|
|
<!-- $$$url -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="url-prop"></a><span class="name">url</span> : <span class="type"><a href="qml-url.html">url</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the URL to the page displayed in this item. It can be set, but also can change spontaneously (eg. because of network redirection).</p>
|
|
<p>If the url is empty, the page is blank.</p>
|
|
<p>The url is always absolute (QML will resolve relative URL strings in the context of the containing QML document).</p>
|
|
</div></div><!-- @@@url -->
|
|
<br/>
|
|
<h2>Signal Handler Documentation</h2>
|
|
<!-- $$$onAlert -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onAlert-signal"></a>WebView::<span class="name">onAlert</span> ( <span class="type"><a href="qml-string.html">string</a></span> <i>message</i> )</p></td></tr></table></div><div class="qmldoc"><p>The handler is called when the web engine sends a JavaScript alert. The <i>message</i> is the text to be displayed in the alert to the user.</p>
|
|
</div></div><!-- @@@onAlert -->
|
|
<br/>
|
|
<!-- $$$onDoubleClick -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onDoubleClick-signal"></a>WebView::<span class="name">onDoubleClick</span> ( <span class="type"><a href="qml-int.html">int</a></span> <i>clickx</i>, <span class="type"><a href="qml-int.html">int</a></span> <i>clicky</i> )</p></td></tr></table></div><div class="qmldoc"><p>The <a href="qml-webview.html">WebView</a> does not pass double-click events to the web engine, but rather emits this signals.</p>
|
|
</div></div><!-- @@@onDoubleClick -->
|
|
<br/>
|
|
<!-- $$$onLoadFailed -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onLoadFailed-signal"></a>WebView::<span class="name">onLoadFailed</span> ()</p></td></tr></table></div><div class="qmldoc"><p>This handler is called when the web engine fails loading a page or any component content (WebView::onLoadFinished() will be emitted on success).</p>
|
|
</div></div><!-- @@@onLoadFailed -->
|
|
<br/>
|
|
<!-- $$$onLoadFinished -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onLoadFinished-signal"></a>WebView::<span class="name">onLoadFinished</span> ()</p></td></tr></table></div><div class="qmldoc"><p>This handler is called when the web engine <i>successfully</i> finishes loading a page, including any component content (WebView::onLoadFailed() will be emitted otherwise).</p>
|
|
<p><b>See also </b><a href="qml-webview.html#progress-prop">progress</a>.</p>
|
|
</div></div><!-- @@@onLoadFinished -->
|
|
<br/>
|
|
<!-- $$$onLoadStarted -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="onLoadStarted-signal"></a>WebView::<span class="name">onLoadStarted</span> ()</p></td></tr></table></div><div class="qmldoc"><p>This handler is called when the web engine begins loading a page. Later, WebView::onLoadFinished() or WebView::onLoadFailed() will be emitted.</p>
|
|
</div></div><!-- @@@onLoadStarted -->
|
|
<br/>
|
|
<h2>Method Documentation</h2>
|
|
<!-- $$$evaluateJavaScript -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="evaluateJavaScript-method"></a><span class="type"><a href="qml-bool.html">bool</a></span> WebView::<span class="name">evaluateJavaScript</span> ( <span class="type"><a href="qml-string.html">string</a></span> <i>scriptSource</i> )</p></td></tr></table></div><div class="qmldoc"><p>Evaluates the <i>scriptSource</i> JavaScript inside the context of the main web frame, and returns the result of the last executed statement.</p>
|
|
<p>Note that this JavaScript does <i>not</i> have any access to QML objects except as made available as windowObjects.</p>
|
|
</div></div><!-- @@@evaluateJavaScript -->
|
|
<br/>
|
|
<!-- $$$heuristicZoom -->
|
|
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="heuristicZoom-method"></a><span class="type"><a href="qml-bool.html">bool</a></span> WebView::<span class="name">heuristicZoom</span> ( <span class="type"><a href="qml-int.html">int</a></span> <i>clickX</i>, <span class="type"><a href="qml-int.html">int</a></span> <i>clickY</i>, <span class="type"><a href="qml-real.html">real</a></span> <i>maxzoom</i> )</p></td></tr></table></div><div class="qmldoc"><p>Finds a zoom that:</p>
|
|
<ul>
|
|
<li>shows a whole item</li>
|
|
<li>includes (<i>clickX</i>, <i>clickY</i>)</li>
|
|
<li>fits into the <a href="qml-webview.html#preferredWidth-prop">preferredWidth</a> and <a href="qml-webview.html#preferredHeight-prop">preferredHeight</a></li>
|
|
<li>zooms by no more than <i>maxZoom</i></li>
|
|
<li>is more than 10% above the current zoom</li>
|
|
</ul>
|
|
<p>If such a zoom exists, emits zoomTo(zoom,centerX,centerY) and returns true; otherwise, no signal is emitted and returns false.</p>
|
|
</div></div><!-- @@@heuristicZoom -->
|
|
<br/>
|
|
<p class="naviNextPrevious footerNavi">
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="ft">
|
|
<span></span>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<p>
|
|
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
|
|
Documentation contributions included herein are the copyrights of
|
|
their respective owners.</p>
|
|
<br />
|
|
<p>
|
|
The documentation provided herein is licensed under the terms of the
|
|
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
|
|
License version 1.3</a> as published by the Free Software Foundation.</p>
|
|
<p>
|
|
Documentation sources may be obtained from <a href="http://www.qt-project.org">
|
|
www.qt-project.org</a>.</p>
|
|
<br />
|
|
<p>
|
|
Qt and respective logos are trademarks of The Qt Company Ltd
|
|
in Finland and/or other countries worldwide. All other trademarks are property
|
|
of their respective owners. <a title="Privacy Policy"
|
|
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
|
|
</div>
|
|
|
|
<script src="scripts/functions.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|