/usr/share/qt5/doc/qtwebkit/qtwebkitwidgets-index.html is in qtwebkit5-doc-html 5.1.1-1ubuntu8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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 WebKit Widgets | QtWebKit 5.1</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.1</li>
<li>Qt WebKit Widgets</li>
<li id="buildversion">
Qt 5.1.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#including-in-your-project">Including In Your Project</a></li>
<li class="level1"><a href="#notes">Notes</a></li>
<li class="level1"><a href="#architecture">Architecture</a></li>
<li class="level1"><a href="#netscape-plugin-support">Netscape Plugin Support</a></li>
<li class="level1"><a href="#examples">Examples</a></li>
<li class="level1"><a href="#license-information">License Information</a></li>
</ul>
</div>
<h1 class="title">Qt WebKit Widgets</h1>
<span class="subtitle"></span>
<!-- $$$qtwebkitwidgets-index.html-description -->
<div class="descr"> <a name="details"></a>
<p>Qt WebKit Widgets 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>Qt WebKit Widgets 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 Qt WebKit 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>Qt WebKit is based on the Open Source WebKit engine. More information about WebKit itself can be found on the WebKit Open Source Project 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"><span class="preprocessor">#include <QtWebKitWidgets></span></pre>
<p>To link against the module, add this line to your qmake <tt>.pro</tt> file:</p>
<pre class="cpp">QT <span class="operator">+</span><span class="operator">=</span> webkitwidgets</pre>
<a name="notes"></a>
<h2>Notes</h2>
<p><b>Note: </b>Building the Qt WebKit 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 Qt WebKit 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 Qt for Embedded Linux Requirements 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">QUrl</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 QPainter. 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 Qt WebKit 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="examples"></a>
<h2>Examples</h2>
<p>There are several Qt WebKit Widgets examples located in the Qt WebKit Examples page.</p>
<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 Qt WebKit 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>
<!-- @@@qtwebkitwidgets-index.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|