File: qhelpengine.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (131 lines) | stat: -rw-r--r-- 7,875 bytes parent folder | download 
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
 
<?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" />
<!-- qhelpengine.cpp -->
  <title>Qt 4.8: QHelpEngine Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <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><a href="qthelp.html">QtHelp</a></li>
<li>QHelpEngine</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QHelpEngine Class Reference</h1>
<!-- $$$QHelpEngine-brief -->
<p>The QHelpEngine class provides access to contents and indices of the help engine. <a href="#details">More...</a></p>
<!-- @@@QHelpEngine -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QHelpEngine&gt;</span></pre><p><b>Inherits: </b><a href="qhelpenginecore.html">QHelpEngineCore</a>.</p>
<p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qhelpengine-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#QHelpEngine">QHelpEngine</a></b> ( const QString &amp; <i>collectionFile</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#dtor.QHelpEngine">~QHelpEngine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpContentModel * </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#contentModel">contentModel</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpContentWidget * </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#contentWidget">contentWidget</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpIndexModel * </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#indexModel">indexModel</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpIndexWidget * </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#indexWidget">indexWidget</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpSearchEngine * </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#searchEngine">searchEngine</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">26 public functions inherited from <a href="qhelpenginecore.html#public-functions">QHelpEngineCore</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 properties inherited from <a href="qhelpenginecore.html#properties">QHelpEngineCore</a></li>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">4 signals inherited from <a href="qhelpenginecore.html#signals">QHelpEngineCore</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">2 static public members inherited from <a href="qhelpenginecore.html#static-public-members">QHelpEngineCore</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QHelpEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QHelpEngine class provides access to contents and indices of the help engine.</p>
</div>
<!-- @@@QHelpEngine -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpEngine[overload1]$$$QHelpEngineconstQString&QObject* -->
<h3 class="fn"><a name="QHelpEngine"></a>QHelpEngine::<span class="name">QHelpEngine</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>collectionFile</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<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>
<!-- @@@QHelpEngine -->
<!-- $$$~QHelpEngine[overload1]$$$~QHelpEngine -->
<h3 class="fn"><a name="dtor.QHelpEngine"></a>QHelpEngine::<span class="name">~QHelpEngine</span> ()</h3>
<p>Destroys the help engine object.</p>
<!-- @@@~QHelpEngine -->
<!-- $$$contentModel[overload1]$$$contentModel -->
<h3 class="fn"><a name="contentModel"></a><span class="type"><a href="qhelpcontentmodel.html">QHelpContentModel</a></span> * QHelpEngine::<span class="name">contentModel</span> () const</h3>
<p>Returns the content model.</p>
<!-- @@@contentModel -->
<!-- $$$contentWidget[overload1]$$$contentWidget -->
<h3 class="fn"><a name="contentWidget"></a><span class="type"><a href="qhelpcontentwidget.html">QHelpContentWidget</a></span> * QHelpEngine::<span class="name">contentWidget</span> ()</h3>
<p>Returns the content widget.</p>
<!-- @@@contentWidget -->
<!-- $$$indexModel[overload1]$$$indexModel -->
<h3 class="fn"><a name="indexModel"></a><span class="type"><a href="qhelpindexmodel.html">QHelpIndexModel</a></span> * QHelpEngine::<span class="name">indexModel</span> () const</h3>
<p>Returns the index model.</p>
<!-- @@@indexModel -->
<!-- $$$indexWidget[overload1]$$$indexWidget -->
<h3 class="fn"><a name="indexWidget"></a><span class="type"><a href="qhelpindexwidget.html">QHelpIndexWidget</a></span> * QHelpEngine::<span class="name">indexWidget</span> ()</h3>
<p>Returns the index widget.</p>
<!-- @@@indexWidget -->
<!-- $$$searchEngine[overload1]$$$searchEngine -->
<h3 class="fn"><a name="searchEngine"></a><span class="type"><a href="qhelpsearchengine.html">QHelpSearchEngine</a></span> * QHelpEngine::<span class="name">searchEngine</span> ()</h3>
<p>Returns the default search engine.</p>
<!-- @@@searchEngine -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. 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>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      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>
</body>
</html>