~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qwebplugindatabase.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- qwebplugindatabase.cpp -->
 
6
<head>
 
7
  <title>Qt 4.6: QWebPluginDatabase Class Reference</title>
 
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
 
9
</head>
 
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QWebPluginDatabase" />
 
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
13
<tr>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QWebPluginDatabase Class Reference<br /><span class="small-subtitle">[<a href="qtwebkit.html">QtWebKit</a> module]</span>
 
17
</h1>
 
18
<p>The QWebPluginDatabase class provides an interface for managing Netscape plugins used by WebKit in QWebPages. <a href="#details">More...</a></p>
 
19
<pre> #include &lt;QWebPluginDatabase&gt;</pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
 
20
<p>Inherits <a href="qobject.html">QObject</a>.</p>
 
21
<p>This class was introduced in Qt 4.6.</p>
 
22
<ul>
 
23
<li><a href="qwebplugindatabase-members.html">List of all members, including inherited members</a></li>
 
24
</ul>
 
25
<hr />
 
26
<a name="public-functions"></a>
 
27
<h2>Public Functions</h2>
 
28
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
29
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#addSearchPath">addSearchPath</a></b> ( const QString &amp; <i>path</i> )</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">QWebPluginInfo </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#pluginForMimeType">pluginForMimeType</a></b> ( const QString &amp; <i>mimeType</i> )</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">QList&lt;QWebPluginInfo&gt; </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#plugins">plugins</a></b> () const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#refresh">refresh</a></b> ()</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#searchPaths">searchPaths</a></b> () const</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#setPreferredPluginForMimeType">setPreferredPluginForMimeType</a></b> ( const QString &amp; <i>mimeType</i>, const QWebPluginInfo &amp; <i>plugin</i> )</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#setSearchPaths">setSearchPaths</a></b> ( const QStringList &amp; <i>paths</i> )</td></tr>
 
36
</table>
 
37
<ul>
 
38
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
39
</ul>
 
40
<hr />
 
41
<a name="static-public-members"></a>
 
42
<h2>Static Public Members</h2>
 
43
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
44
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qwebplugindatabase.html#defaultSearchPaths">defaultSearchPaths</a></b> ()</td></tr>
 
45
</table>
 
46
<ul>
 
47
<li><div bar="2" class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
 
48
</ul>
 
49
<h3>Additional Inherited Members</h3>
 
50
<ul>
 
51
<li><div class="fn"></div>1 property inherited from <a href="qobject.html#properties">QObject</a></li>
 
52
<li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
 
53
<li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
 
54
<li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
 
55
</ul>
 
56
<a name="details"></a>
 
57
<hr />
 
58
<h2>Detailed Description</h2>
 
59
<p>The QWebPluginDatabase class provides an interface for managing Netscape plugins used by WebKit in QWebPages.</p>
 
60
<p>The QWebPluginDatabase class is a database of Netscape plugins that are used by WebKit. The plugins are picked up by WebKit by looking up a set of search paths. The default set can be accessed using <a href="qwebplugindatabase.html#defaultSearchPaths">defaultSearchPaths</a>(). The search paths can be changed, see <a href="qwebplugindatabase.html#searchPaths">searchPaths</a>() and <a href="qwebplugindatabase.html#setSearchPaths">setSearchPaths</a>(). Additional search paths can also be added using <a href="qwebplugindatabase.html#addSearchPath">addSearchPath</a>().</p>
 
61
<p>The plugins that have been detected are exposed by the <a href="qwebplugindatabase.html#plugins">plugins</a>() method. The list contains QWebPlugin objects that hold both the metadata and the MIME types that are supported by particular plugins.</p>
 
62
<p>WebKit specifies a plugin for a MIME type by looking for the first plugin that supports the specific MIME type. To get a plugin, that is used by WebKit to handle a specific MIME type, you can use the <a href="qwebplugindatabase.html#pluginForMimeType">pluginForMimeType</a>() function.</p>
 
63
<p>To change the way of resolving MIME types ambiguity, you can explicitly set a preferred plugin for a specific MIME type, using <a href="qwebplugindatabase.html#setPreferredPluginForMimeType">setPreferredPluginForMimeType</a>().</p>
 
64
<p>See also <a href="qwebplugininfo.html">QWebPluginInfo</a> and <a href="qwebsettings.html#pluginDatabase">QWebSettings::pluginDatabase</a>().</p>
 
65
<hr />
 
66
<h2>Member Function Documentation</h2>
 
67
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/addSearchPath" />
 
68
<h3 class="fn"><a name="addSearchPath"></a>void QWebPluginDatabase::addSearchPath ( const <a href="qstring.html">QString</a> &amp; <i>path</i> )</h3>
 
69
<p>Adds an additional <i>path</i> to the current set. The database is automatically refreshed.</p>
 
70
<p>See also <a href="qwebplugindatabase.html#searchPaths">searchPaths</a>() and <a href="qwebplugindatabase.html#setSearchPaths">setSearchPaths</a>().</p>
 
71
<a name="//apple_ref/cpp/clm/QWebPluginDatabase/defaultSearchPaths" />
 
72
<h3 class="fn"><a name="defaultSearchPaths"></a><a href="qstringlist.html">QStringList</a> QWebPluginDatabase::defaultSearchPaths ()&nbsp;&nbsp;<tt> [static]</tt></h3>
 
73
<p>Returns a default set of search paths.</p>
 
74
<p>See also <a href="qwebplugindatabase.html#searchPaths">searchPaths</a>() and <a href="qwebplugindatabase.html#setSearchPaths">setSearchPaths</a>().</p>
 
75
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/pluginForMimeType" />
 
76
<h3 class="fn"><a name="pluginForMimeType"></a><a href="qwebplugininfo.html">QWebPluginInfo</a> QWebPluginDatabase::pluginForMimeType ( const <a href="qstring.html">QString</a> &amp; <i>mimeType</i> )</h3>
 
77
<p>Returns the plugin that is currently used by WebKit for a given <i>mimeType</i>.</p>
 
78
<p>See also <a href="qwebplugindatabase.html#setPreferredPluginForMimeType">setPreferredPluginForMimeType</a>().</p>
 
79
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/plugins" />
 
80
<h3 class="fn"><a name="plugins"></a><a href="qlist.html">QList</a>&lt;<a href="qwebplugininfo.html">QWebPluginInfo</a>&gt; QWebPluginDatabase::plugins () const</h3>
 
81
<p>Returns a list of plugins installed in the search paths.</p>
 
82
<p>This list will contain disabled plugins, although they will not be used by WebKit.</p>
 
83
<p>See also <a href="qwebplugindatabase.html#pluginForMimeType">pluginForMimeType</a>().</p>
 
84
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/refresh" />
 
85
<h3 class="fn"><a name="refresh"></a>void QWebPluginDatabase::refresh ()</h3>
 
86
<p>Refreshes the plugin database, adds new plugins that have been found and removes the ones that are no longer available in the search paths.</p>
 
87
<p>You can call this function when the set of plugins installed in the search paths changes. You do not need to call this function when changing search paths, in that case WebKit automatically refreshes the database.</p>
 
88
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/searchPaths" />
 
89
<h3 class="fn"><a name="searchPaths"></a><a href="qstringlist.html">QStringList</a> QWebPluginDatabase::searchPaths () const</h3>
 
90
<p>Returns a list of search paths that are used by WebKit to look for plugins.</p>
 
91
<p>See also <a href="qwebplugindatabase.html#defaultSearchPaths">defaultSearchPaths</a>() and <a href="qwebplugindatabase.html#setSearchPaths">setSearchPaths</a>().</p>
 
92
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/setPreferredPluginForMimeType" />
 
93
<h3 class="fn"><a name="setPreferredPluginForMimeType"></a>void QWebPluginDatabase::setPreferredPluginForMimeType ( const <a href="qstring.html">QString</a> &amp; <i>mimeType</i>, const <a href="qwebplugininfo.html">QWebPluginInfo</a> &amp; <i>plugin</i> )</h3>
 
94
<p>Changes the preferred plugin for a given <i>mimeType</i> to <i>plugin</i>. The <i>plugin</i> has to support the given <i>mimeType</i>, otherwise the setting will have no effect.</p>
 
95
<p>Calling the function with a null <i>plugin</i> resets the setting.</p>
 
96
<p>See also <a href="qwebplugindatabase.html#pluginForMimeType">pluginForMimeType</a>().</p>
 
97
<a name="//apple_ref/cpp/instm/QWebPluginDatabase/setSearchPaths" />
 
98
<h3 class="fn"><a name="setSearchPaths"></a>void QWebPluginDatabase::setSearchPaths ( const <a href="qstringlist.html">QStringList</a> &amp; <i>paths</i> )</h3>
 
99
<p>Changes the search paths to <i>paths</i>. The database is automatically refreshed.</p>
 
100
<p>See also <a href="qwebplugindatabase.html#searchPaths">searchPaths</a>() and <a href="qwebplugindatabase.html#defaultSearchPaths">defaultSearchPaths</a>().</p>
 
101
<p /><address><hr /><div align="center">
 
102
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
103
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
104
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
105
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
106
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
 
107
</html>