<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qhelpengine.cpp -->
<head>
<title>Qt 4.6: QHelpEngine Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<a name="//apple_ref/cpp/cl//QHelpEngine"></a>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<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>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QHelpEngine Class Reference<br /><span class="small-subtitle">[<a href="qthelp.html">QtHelp</a> module]</span>
</h1>
<p>The QHelpEngine class provides access to contents and indices of the help engine. <a href="#details">More...</a></p>
<pre> #include <QHelpEngine></pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
<p>Inherits <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>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<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 & <i>collectionFile</i>, QObject * <i>parent</i> = 0 )</td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
</table>
<ul>
<li><div bar="2" class="fn"></div>26 public functions inherited from <a href="qhelpenginecore.html#public-functions">QHelpEngineCore</a></li>
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>3 properties inherited from <a href="qhelpenginecore.html#properties">QHelpEngineCore</a></li>
<li><div class="fn"></div>1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li><div class="fn"></div>4 signals inherited from <a href="qhelpenginecore.html#signals">QHelpEngineCore</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li><div class="fn"></div>2 static public members inherited from <a href="qhelpenginecore.html#static-public-members">QHelpEngineCore</a></li>
<li><div class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QHelpEngine class provides access to contents and indices of the help engine.</p>
<hr />
<h2>Member Function Documentation</h2>
<a name="//apple_ref/cpp/instm/QHelpEngine/QHelpEngine"></a>
<h3 class="fn"><a name="QHelpEngine"></a>QHelpEngine::QHelpEngine ( const <a href="qstring.html">QString</a> & <i>collectionFile</i>, <a href="qobject.html">QObject</a> * <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>
<a name="//apple_ref/cpp/instm/QHelpEngine/~QHelpEngine"></a>
<h3 class="fn"><a name="dtor.QHelpEngine"></a>QHelpEngine::~QHelpEngine ()</h3>
<p>Destroys the help engine object.</p>
<a name="//apple_ref/cpp/instm/QHelpEngine/contentModel"></a>
<h3 class="fn"><a name="contentModel"></a><a href="qhelpcontentmodel.html">QHelpContentModel</a> * QHelpEngine::contentModel () const</h3>
<p>Returns the content model.</p>
<a name="//apple_ref/cpp/instm/QHelpEngine/contentWidget"></a>
<h3 class="fn"><a name="contentWidget"></a><a href="qhelpcontentwidget.html">QHelpContentWidget</a> * QHelpEngine::contentWidget ()</h3>
<p>Returns the content widget.</p>
<a name="//apple_ref/cpp/instm/QHelpEngine/indexModel"></a>
<h3 class="fn"><a name="indexModel"></a><a href="qhelpindexmodel.html">QHelpIndexModel</a> * QHelpEngine::indexModel () const</h3>
<p>Returns the index model.</p>
<a name="//apple_ref/cpp/instm/QHelpEngine/indexWidget"></a>
<h3 class="fn"><a name="indexWidget"></a><a href="qhelpindexwidget.html">QHelpIndexWidget</a> * QHelpEngine::indexWidget ()</h3>
<p>Returns the index widget.</p>
<a name="//apple_ref/cpp/instm/QHelpEngine/searchEngine"></a>
<h3 class="fn"><a name="searchEngine"></a><a href="qhelpsearchengine.html">QHelpSearchEngine</a> * QHelpEngine::searchEngine ()</h3>
<p>Returns the default search engine.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td>
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="40%" align="right"><div align="right">Qt 4.6.3</div></td>
</tr></table></div></address></body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8e6051afcdb111a0317a58fb64c2abf5
>
files
>
4261
