← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/qhelpengine.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:
doc/html/qhelpengine.html
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/tools/assistant/lib/qhelpengine.cpp -->
 
5
<!-- qhelpengine.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: QHelpEngine Class Reference</title>
 
7
  <title>Qt 4.6: QHelpEngine Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QHelpEngine" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<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="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QHelpEngine Class Reference<br /><span class="small-subtitle">[<a href="qthelp.html">QtHelp</a> module]</span>
 
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">QHelpEngine Class Reference<br /><span class="small-subtitle">[<a href="qthelp.html">QtHelp</a> module]</span>
16
17
</h1>
17
18
<p>The QHelpEngine class provides access to contents and indices of the help engine. <a href="#details">More...</a></p>
18
 
<pre> #include &lt;QHelpEngine&gt;</pre><p>Inherits <a href="qhelpenginecore.html">QHelpEngineCore</a>.</p>
 
19
<pre> #include &lt;QHelpEngine&gt;</pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
 
20
<p>Inherits <a href="qhelpenginecore.html">QHelpEngineCore</a>.</p>
19
21
<p>This class was introduced in Qt 4.4.</p>
20
22
<ul>
21
23
<li><a href="qhelpengine-members.html">List of all members, including inherited members</a></li>
22
24
</ul>
 
25
<hr />
23
26
<a name="public-functions"></a>
24
 
<h3>Public Functions</h3>
25
 
<ul>
26
 
<li><div class="fn"></div><b><a href="qhelpengine.html#QHelpEngine">QHelpEngine</a></b> ( const QString &amp; <i>collectionFile</i>, QObject * <i>parent</i> = 0 )</li>
27
 
<li><div class="fn"></div><b><a href="qhelpengine.html#dtor.QHelpEngine">~QHelpEngine</a></b> ()</li>
28
 
<li><div class="fn"></div>QHelpContentModel * <b><a href="qhelpengine.html#contentModel">contentModel</a></b> () const</li>
29
 
<li><div class="fn"></div>QHelpContentWidget * <b><a href="qhelpengine.html#contentWidget">contentWidget</a></b> ()</li>
30
 
<li><div class="fn"></div>QHelpIndexModel * <b><a href="qhelpengine.html#indexModel">indexModel</a></b> () const</li>
31
 
<li><div class="fn"></div>QHelpIndexWidget * <b><a href="qhelpengine.html#indexWidget">indexWidget</a></b> ()</li>
32
 
<li><div class="fn"></div>QHelpSearchEngine * <b><a href="qhelpengine.html#searchEngine">searchEngine</a></b> ()</li>
33
 
</ul>
34
 
<ul>
35
 
<li><div class="fn"></div>26 public functions inherited from <a href="qhelpenginecore.html#public-functions">QHelpEngineCore</a></li>
36
 
<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
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"></td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#QHelpEngine">QHelpEngine</a></b> ( const QString &amp; <i>collectionFile</i>, QObject * <i>parent</i> = 0 )</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#dtor.QHelpEngine">~QHelpEngine</a></b> ()</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">QHelpContentModel * </td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#contentModel">contentModel</a></b> () const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">QHelpContentWidget * </td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#contentWidget">contentWidget</a></b> ()</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">QHelpIndexModel * </td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#indexModel">indexModel</a></b> () const</td></tr>
 
34
<tr><td class="memItemLeft" align="right" valign="top">QHelpIndexWidget * </td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#indexWidget">indexWidget</a></b> ()</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top">QHelpSearchEngine * </td><td class="memItemRight" valign="bottom"><b><a href="qhelpengine.html#searchEngine">searchEngine</a></b> ()</td></tr>
 
36
</table>
 
37
<ul>
 
38
<li><div bar="2" class="fn"></div>26 public functions inherited from <a href="qhelpenginecore.html#public-functions">QHelpEngineCore</a></li>
 
39
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
37
40
</ul>
38
41
<h3>Additional Inherited Members</h3>
39
42
<ul>
52
55
<p>The QHelpEngine class provides access to contents and indices of the help engine.</p>
53
56
<hr />
54
57
<h2>Member Function Documentation</h2>
 
58
<a name="//apple_ref/cpp/instm/QHelpEngine/QHelpEngine" />
55
59
<h3 class="fn"><a name="QHelpEngine"></a>QHelpEngine::QHelpEngine ( const <a href="qstring.html">QString</a> &amp; <i>collectionFile</i>, <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
56
60
<p>Constructs a new help engine with the given <i>parent</i>. The help engine uses the information stored in the <i>collectionFile</i> for providing help. If the collection file does not already exist, it will be created.</p>
 
61
<a name="//apple_ref/cpp/instm/QHelpEngine/~QHelpEngine" />
57
62
<h3 class="fn"><a name="dtor.QHelpEngine"></a>QHelpEngine::~QHelpEngine ()</h3>
58
63
<p>Destroys the help engine object.</p>
 
64
<a name="//apple_ref/cpp/instm/QHelpEngine/contentModel" />
59
65
<h3 class="fn"><a name="contentModel"></a><a href="qhelpcontentmodel.html">QHelpContentModel</a> * QHelpEngine::contentModel () const</h3>
60
66
<p>Returns the content model.</p>
 
67
<a name="//apple_ref/cpp/instm/QHelpEngine/contentWidget" />
61
68
<h3 class="fn"><a name="contentWidget"></a><a href="qhelpcontentwidget.html">QHelpContentWidget</a> * QHelpEngine::contentWidget ()</h3>
62
69
<p>Returns the content widget.</p>
 
70
<a name="//apple_ref/cpp/instm/QHelpEngine/indexModel" />
63
71
<h3 class="fn"><a name="indexModel"></a><a href="qhelpindexmodel.html">QHelpIndexModel</a> * QHelpEngine::indexModel () const</h3>
64
72
<p>Returns the index model.</p>
 
73
<a name="//apple_ref/cpp/instm/QHelpEngine/indexWidget" />
65
74
<h3 class="fn"><a name="indexWidget"></a><a href="qhelpindexwidget.html">QHelpIndexWidget</a> * QHelpEngine::indexWidget ()</h3>
66
75
<p>Returns the index widget.</p>
 
76
<a name="//apple_ref/cpp/instm/QHelpEngine/searchEngine" />
67
77
<h3 class="fn"><a name="searchEngine"></a><a href="qhelpsearchengine.html">QHelpSearchEngine</a> * QHelpEngine::searchEngine ()</h3>
68
78
<p>Returns the default search engine.</p>
69
79
<p /><address><hr /><div align="center">
70
80
<table width="100%" cellspacing="0" border="0"><tr class="address">
71
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
72
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
73
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
74
 
</tr></table></div></address></body>
 
81
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
82
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
83
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
84
<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>
75
85
</html>