<?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" />
<!-- qtwebkit.qdoc -->
<title>Qt 4.8: WebKit in Qt</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="modules.html">Modules</a></li>
<li>QtWebKit</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">
<link rel="prev" href="qtsvg.html" />
<link rel="next" href="qtxml.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="qtsvg.html">QtSvg Module</a>
<a class="nextPage" href="qtxml.html">QtXml Module</a>
</p><p/>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#including-in-your-project">Including In Your Project</a></li>
<li class="level2"><a href="#notes">Notes</a></li>
<li class="level2"><a href="#architecture">Architecture</a></li>
<li class="level2"><a href="#netscape-plugin-support">Netscape Plugin Support</a></li>
<li class="level2"><a href="#license-information">License Information</a></li>
</ul>
</div>
<h1 class="title">WebKit in Qt</h1>
<span class="subtitle"></span>
<!-- $$$QtWebKit-brief -->
<p>The QtWebKit module provides a web browser engine as well as classes to render and interact with web content. <a href="#details">More...</a></p>
<!-- @@@QtWebKit -->
<a name="classes"></a>
<h2>Classes</h2>
<table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qgraphicswebview.html">QGraphicsWebView</a></p></td><td class="tblDescr"><p>Allows Web content to be added to a GraphicsView</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebdatabase.html">QWebDatabase</a></p></td><td class="tblDescr"><p>Access to HTML 5 databases created with JavaScript</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebelement.html">QWebElement</a></p></td><td class="tblDescr"><p>Convenient access to DOM elements in a QWebFrame</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebelementcollection.html">QWebElementCollection</a></p></td><td class="tblDescr"><p>Represents a collection of web elements</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebframe.html">QWebFrame</a></p></td><td class="tblDescr"><p>Represents a frame in a web page</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebhistory.html">QWebHistory</a></p></td><td class="tblDescr"><p>Represents the history of a QWebPage</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebhistoryinterface.html">QWebHistoryInterface</a></p></td><td class="tblDescr"><p>Interface to implement link history</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebhistoryitem.html">QWebHistoryItem</a></p></td><td class="tblDescr"><p>Represents one item in the history of a QWebPage</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebhittestresult.html">QWebHitTestResult</a></p></td><td class="tblDescr"><p>Information about the web page content after a hit test</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebinspector.html">QWebInspector</a></p></td><td class="tblDescr"><p>Allows the placement and control of a QWebPage's inspector. The inspector can display a page's hierarchy, its loading statistics and the current state of its individual elements. It is mostly used by web developers</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebpage.html">QWebPage</a></p></td><td class="tblDescr"><p>Object to view and edit web documents</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebpluginfactory.html">QWebPluginFactory</a></p></td><td class="tblDescr"><p>Used to embed custom data types in web pages</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebsecurityorigin.html">QWebSecurityOrigin</a></p></td><td class="tblDescr"><p>Defines a security boundary for web sites</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qwebsettings.html">QWebSettings</a></p></td><td class="tblDescr"><p>Object to store the settings used by QWebPage and QWebFrame</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qwebview.html">QWebView</a></p></td><td class="tblDescr"><p>Widget that is used to view and edit web documents</p></td></tr>
</table>
<!-- $$$QtWebKit-description -->
<a name="details"></a>
<div class="descr">
<h2>Detailed Description</h2>
<p>QtWebKit provides a Web browser engine that makes it easy to embed content from the World Wide Web into your Qt application. At the same time Web content can be enhanced with native controls.</p>
<p>QtWebKit provides facilities for rendering of HyperText Markup Language (HTML), Extensible HyperText Markup Language (XHTML) and Scalable Vector Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and scripted with JavaScript.</p>
<p>A bridge between the JavaScript execution environment and the Qt object model makes it possible for custom <a href="qtwebkit-bridge.html#qobjects">QObjects</a> to be scripted. For detailed documentation see <a href="qtwebkit-bridge.html">The QtWebkit Bridge</a>. Integration with the Qt networking module enables Web pages to be transparently loaded from Web servers, the local file system or even the Qt resource system.</p>
<p>In addition to providing pure rendering features, HTML documents can be made fully editable to the user through the use of the <tt>contenteditable</tt> attribute on HTML elements.</p>
<p>QtWebKit has been enhanced to become more attractive on the mobile front as well. For more information see <a href="qtwebkit-goes-mobile.html">QtWebKit Goes Mobile</a>.</p>
<p>QtWebKit is based on the Open Source WebKit engine. More information about WebKit itself can be found on the <a href="http://webkit.org/">WebKit Open Source Project</a> Web site.</p>
<a name="including-in-your-project"></a>
<h2>Including In Your Project</h2>
<p>To include the definitions of the module's classes, use the following directive:</p>
<pre class="cpp"> #include <QtWebKit></pre>
<p>To link against the module, add this line to your <a href="qmake-manual.html#qmake">qmake</a> <tt>.pro</tt> file:</p>
<pre class="cpp"> QT += webkit</pre>
<a name="notes"></a>
<h2>Notes</h2>
<p><b>Note:</b> Building the QtWebKit module with debugging symbols is problematic on many platforms due to the size of the WebKit engine. We recommend building the module only in release mode for embedded platforms. Currently QtWebKit will always be compiled without debugging symbols when using gcc. Take a look at the last lines of <tt>src/3rdparty/webkit/Source/WebCore/WebCore.pro</tt> if you need to change this.</p>
<p><b>Note:</b> Web site icons, also known as "FavIcons", are currently not supported on Windows. We plan to address this in a future release.</p>
<p><b>Note:</b> WebKit has certain minimum requirements that must be met on Embedded Linux systems. See the <a href="requirements-embedded-linux.html">Qt for Embedded Linux Requirements</a> document for more information.</p>
<a name="architecture"></a>
<h2>Architecture</h2>
<p>The easiest way to render content is through the <a href="qwebview.html">QWebView</a> class. As a widget it can be embedded into your forms or a graphics view, and it provides convenience functions for downloading and rendering web sites.</p>
<pre class="cpp"> <span class="type"><a href="qwebview.html">QWebView</a></span> <span class="operator">*</span>view <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qwebview.html">QWebView</a></span>(parent);
view<span class="operator">-</span><span class="operator">></span>load(<span class="type"><a href="qurl.html">QUrl</a></span>(<span class="string">"http://qt-project.org"</span>));
view<span class="operator">-</span><span class="operator">></span>show();</pre>
<p><a href="qwebview.html">QWebView</a> is used to view Web pages. An instance of <a href="qwebview.html">QWebView</a> has one <a href="qwebpage.html">QWebPage</a>. <a href="qwebpage.html">QWebPage</a> provides access to the document structure in a page, describing features such as frames, the navigation history, and the undo/redo stack for editable content.</p>
<p>HTML documents can be nested using frames in a frameset. An individual frame in HTML is represented using the <a href="qwebframe.html">QWebFrame</a> class. This class includes the bridge to the JavaScript window object and can be painted using <a href="qpainter.html">QPainter</a>. Each <a href="qwebpage.html">QWebPage</a> has one <a href="qwebframe.html">QWebFrame</a> object as its main frame, and the main frame may contain many child frames.</p>
<p>Individual elements of an HTML document can be accessed via DOM JavaScript interfaces from within a web page. The equivalent of this API in QtWebKit is represented by <a href="qwebelement.html">QWebElement</a>. <a href="qwebelement.html">QWebElement</a> objects are obtained using <a href="qwebframe.html">QWebFrame</a>'s <a href="qwebframe.html#findAllElements">findAllElements()</a> and <a href="qwebframe.html#findFirstElement">findFirstElement()</a> functions with CSS selector queries.</p>
<p>Common web browser features, defaults and other settings can be configured through the <a href="qwebsettings.html">QWebSettings</a> class. It is possible to provide defaults for all <a href="qwebpage.html">QWebPage</a> instances through the default settings. Individual attributes can be overidden by the page specific settings object.</p>
<a name="netscape-plugin-support"></a>
<h2>Netscape Plugin Support</h2>
<p><b>Note:</b> Netscape plugin support is only available on desktop platforms.</p>
<p>Since WebKit supports the Netscape Plugin API, Qt applications can display Web pages that embed common plugins on platforms for which those plugins are available. To enable plugin support, the user must have the appropriate binary files for those plugins installed and the <a href="qwebsettings.html#WebAttribute-enum">QWebSettings::PluginsEnabled</a> attribute must be enabled for the application.</p>
<p>The following locations are searched for plugins:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Linux/Unix (X11)</th></tr></thead>
<tr valign="top" class="odd"><td ><ul>
<li><tt>.mozilla/plugins</tt> in the user's home directory</li>
<li><tt>.netscape/plugins</tt> in the user's home directory</li>
<li>System locations, such as<ul>
<li><tt>/usr/lib/browser/plugins</tt></li>
<li><tt>/usr/local/lib/mozilla/plugins</tt></li>
<li><tt>/usr/lib/firefox/plugins</tt></li>
<li><tt>/usr/lib64/browser-plugins</tt></li>
<li><tt>/usr/lib/browser-plugins</tt></li>
<li><tt>/usr/lib/mozilla/plugins</tt></li>
<li><tt>/usr/local/netscape/plugins</tt></li>
<li><tt>/opt/mozilla/plugins</tt></li>
<li><tt>/opt/mozilla/lib/plugins</tt></li>
<li><tt>/opt/netscape/plugins</tt></li>
<li><tt>/opt/netscape/communicator/plugins</tt></li>
<li><tt>/usr/lib/netscape/plugins</tt></li>
<li><tt>/usr/lib/netscape/plugins-libc5</tt></li>
<li><tt>/usr/lib/netscape/plugins-libc6</tt></li>
<li><tt>/usr/lib64/netscape/plugins</tt></li>
<li><tt>/usr/lib64/mozilla/plugins</tt></li>
</ul>
</li>
<li>Locations specified by environment variables:<ul>
<li><tt>$MOZILLA_HOME/plugins</tt></li>
<li><tt>$MOZ_PLUGIN_PATH</tt></li>
<li><tt>$QTWEBKIT_PLUGIN_PATH</tt></li>
</ul>
</li>
</ul>
</td></tr>
</table>
<table class="generic">
<thead><tr class="qt-style"><th >Windows</th></tr></thead>
<tr valign="top" class="odd"><td ><ul>
<li>The user's <tt>Application Data\Mozilla\plugins</tt> directory</li>
<li>Standard system locations of plugins for Quicktime, Flash, etc.</li>
</ul>
</td></tr>
</table>
<table class="generic">
<thead><tr class="qt-style"><th >Mac OS X</th></tr></thead>
<tr valign="top" class="odd"><td ><ul>
<li><tt>Library/Internet Plug-Ins</tt> in the user's home directory</li>
<li>The system <tt>/Library/Internet Plug-Ins</tt> directory</li>
</ul>
</td></tr>
</table>
<a name="license-information"></a>
<h2>License Information</h2>
<p>This is a snapshot of the Qt port of WebKit. The exact version information can be found in the <tt>src/3rdparty/webkit/VERSION</tt> file supplied with Qt.</p>
<p>Qt Commercial Edition licensees that wish to distribute applications that use the QtWebKit module need to be aware of their obligations under the GNU Library General Public License (LGPL).</p>
<p>Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL.</p>
<div class="LegaleseLeft"><p>WebKit is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code.</p>
<p>This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.</p>
<p>You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
</div></div>
<!-- @@@QtWebKit -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="qtsvg.html">QtSvg Module</a>
<a class="nextPage" href="qtxml.html">QtXml Module</a>
</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>
