<?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" />
<!-- qhelpenginecore.cpp -->
<title>Qt 4.8: QHelpEngineCore Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<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>QHelpEngineCore</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QHelpEngineCore Class Reference</h1>
<!-- $$$QHelpEngineCore-brief -->
<p>The QHelpEngineCore class provides the core functionality of the help system. <a href="#details">More...</a></p>
<!-- @@@QHelpEngineCore -->
<pre class="cpp"> <span class="preprocessor">#include <QHelpEngineCore></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<p><b>Inherited by: </b><a href="qhelpengine.html">QHelpEngine</a>.</p>
<p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qhelpenginecore-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qhelpenginecore.html#autoSaveFilter-prop">autoSaveFilter</a></b> : bool</li>
<li class="fn"><b><a href="qhelpenginecore.html#collectionFile-prop">collectionFile</a></b> : QString</li>
<li class="fn"><b><a href="qhelpenginecore.html#currentFilter-prop">currentFilter</a></b> : QString</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</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="qhelpenginecore.html#QHelpEngineCore">QHelpEngineCore</a></b> ( const QString & <i>collectionFile</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#dtor.QHelpEngineCore">~QHelpEngineCore</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#addCustomFilter">addCustomFilter</a></b> ( const QString & <i>filterName</i>, const QStringList & <i>attributes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#autoSaveFilter-prop">autoSaveFilter</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#collectionFile-prop">collectionFile</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#copyCollectionFile">copyCollectionFile</a></b> ( const QString & <i>fileName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#currentFilter-prop">currentFilter</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#customFilters">customFilters</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#customValue">customValue</a></b> ( const QString & <i>key</i>, const QVariant & <i>defaultValue</i> = QVariant() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#documentationFileName">documentationFileName</a></b> ( const QString & <i>namespaceName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#error">error</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#fileData">fileData</a></b> ( const QUrl & <i>url</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QUrl> </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#files">files</a></b> ( const QString <i>namespaceName</i>, const QStringList & <i>filterAttributes</i>, const QString & <i>extensionFilter</i> = QString() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QStringList> </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#filterAttributeSets">filterAttributeSets</a></b> ( const QString & <i>namespaceName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#filterAttributes">filterAttributes</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#filterAttributes-2">filterAttributes</a></b> ( const QString & <i>filterName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#findFile">findFile</a></b> ( const QUrl & <i>url</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMap<QString, QUrl> </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#linksForIdentifier">linksForIdentifier</a></b> ( const QString & <i>id</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#registerDocumentation">registerDocumentation</a></b> ( const QString & <i>documentationFileName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#registeredDocumentations">registeredDocumentations</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#removeCustomFilter">removeCustomFilter</a></b> ( const QString & <i>filterName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#removeCustomValue">removeCustomValue</a></b> ( const QString & <i>key</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#autoSaveFilter-prop">setAutoSaveFilter</a></b> ( bool <i>save</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#collectionFile-prop">setCollectionFile</a></b> ( const QString & <i>fileName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#currentFilter-prop">setCurrentFilter</a></b> ( const QString & <i>filterName</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#setCustomValue">setCustomValue</a></b> ( const QString & <i>key</i>, const QVariant & <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#setupData">setupData</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#unregisterDocumentation">unregisterDocumentation</a></b> ( const QString & <i>namespaceName</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#currentFilterChanged">currentFilterChanged</a></b> ( const QString & <i>newFilter</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#readersAboutToBeInvalidated">readersAboutToBeInvalidated</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#setupFinished">setupFinished</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#setupStarted">setupStarted</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#warning">warning</a></b> ( const QString & <i>msg</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#metaData">metaData</a></b> ( const QString & <i>documentationFileName</i>, const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qhelpenginecore.html#namespaceName">namespaceName</a></b> ( const QString & <i>documentationFileName</i> )</td></tr>
</table>
<ul>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">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>
<!-- $$$QHelpEngineCore-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QHelpEngineCore class provides the core functionality of the help system.</p>
<p>Before the help engine can be used, it must be initialized by calling <a href="qhelpenginecore.html#setupData">setupData</a>(). At the beginning of the setup process the signal <a href="qhelpenginecore.html#setupStarted">setupStarted</a>() is emitted. From this point on until the signal <a href="qhelpenginecore.html#setupFinished">setupFinished</a>() is emitted, is the help data in an undefined meaning unusable state.</p>
<p>The core help engine can be used to perform different tasks. By calling <a href="qhelpenginecore.html#linksForIdentifier">linksForIdentifier</a>() the engine returns urls specifying the file locations inside the help system. The actual file data can then be retrived by calling <a href="qhelpenginecore.html#fileData">fileData</a>(). In contrast to all other functions in this class, <a href="qhelpenginecore.html#linksForIdentifier">linksForIdentifier</a>() depends on the currently set custom filter. Depending on the filter, the function may return different hits.</p>
<p>Every help engine can contain any number of custom filters. A custom filter is defined by a name and set of filter attributes and can be added to the help engine by calling <a href="qhelpenginecore.html#addCustomFilter">addCustomFilter</a>(). Analogous, it is removed by calling <a href="qhelpenginecore.html#removeCustomFilter">removeCustomFilter</a>(). <a href="qhelpenginecore.html#customFilters">customFilters</a>() returns all defined filters.</p>
<p>The help engine also offers the possibility to set and read values in a persistant way comparable to ini files or Windows registry entries. For more information see setValue() or value().</p>
<p>This class does not offer any GUI components or functionality for indices or contents. If you need one of those use <a href="qhelpengine.html">QHelpEngine</a> instead.</p>
<p>When creating a custom help viewer the viewer can be configured by writing a custom collection file which could contain various keywords to be used to configure the help engine. These keywords and values and their meaning can be found in the help information for <a href="assistant-custom-help-viewer.html#creating-a-custom-help-collection-file">creating a custom help collection file</a> for Assistant.</p>
</div>
<!-- @@@QHelpEngineCore -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$autoSaveFilter-prop$$$autoSaveFilter$$$setAutoSaveFilterbool -->
<h3 class="fn"><a name="autoSaveFilter-prop"></a><span class="name">autoSaveFilter</span> : <span class="type">bool</span></h3>
<p>This property holds whether QHelpEngineCore is in auto save filter mode or not.</p>
<p>If <a href="qhelpenginecore.html">QHelpEngineCore</a> is in auto save filter mode, the current filter is automatically saved when it is changed by the <a href="qhelpenginecore.html#currentFilter-prop">setCurrentFilter</a>() function. The filter is saved persistently in the help collection file.</p>
<p>By default, this mode is on.</p>
<p>This property was introduced in Qt 4.5.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>autoSaveFilter</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAutoSaveFilter</b></span> ( bool <i>save</i> )</td></tr>
</table>
<!-- @@@autoSaveFilter -->
<!-- $$$collectionFile-prop$$$collectionFile$$$setCollectionFileconstQString& -->
<h3 class="fn"><a name="collectionFile-prop"></a><span class="name">collectionFile</span> : <span class="type"><a href="qstring.html">QString</a></span></h3>
<p>This property holds the absolute file name of the collection file currently used.</p>
<p>Setting this property leaves the help engine in an invalid state. It is important to invoke <a href="qhelpenginecore.html#setupData">setupData</a>() or any getter function in order to setup the help engine again.</p>
<p>This property was introduced in Qt 4.5.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>collectionFile</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCollectionFile</b></span> ( const QString & <i>fileName</i> )</td></tr>
</table>
<!-- @@@collectionFile -->
<!-- $$$currentFilter-prop$$$currentFilter$$$setCurrentFilterconstQString& -->
<h3 class="fn"><a name="currentFilter-prop"></a><span class="name">currentFilter</span> : <span class="type"><a href="qstring.html">QString</a></span></h3>
<p>This property holds the name of the custom filter currently applied.</p>
<p>Setting this property will save the new custom filter permanently in the help collection file. To set a custom filter without saving it permanently, disable the auto save filter mode.</p>
<p>This property was introduced in Qt 4.5.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>currentFilter</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCurrentFilter</b></span> ( const QString & <i>filterName</i> )</td></tr>
</table>
<p><b>See also </b><a href="qhelpenginecore.html#autoSaveFilter-prop">autoSaveFilter</a>().</p>
<!-- @@@currentFilter -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpEngineCore[overload1]$$$QHelpEngineCoreconstQString&QObject* -->
<h3 class="fn"><a name="QHelpEngineCore"></a>QHelpEngineCore::<span class="name">QHelpEngineCore</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>collectionFile</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new core help engine with a <i>parent</i>. The help engine uses the information stored in the <i>collectionFile</i> to provide help. If the collection file does not exist yet, it'll be created.</p>
<!-- @@@QHelpEngineCore -->
<!-- $$$~QHelpEngineCore[overload1]$$$~QHelpEngineCore -->
<h3 class="fn"><a name="dtor.QHelpEngineCore"></a>QHelpEngineCore::<span class="name">~QHelpEngineCore</span> ()<tt> [virtual]</tt></h3>
<p>Destructs the help engine.</p>
<!-- @@@~QHelpEngineCore -->
<!-- $$$addCustomFilter[overload1]$$$addCustomFilterconstQString&constQStringList& -->
<h3 class="fn"><a name="addCustomFilter"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">addCustomFilter</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>filterName</i>, const <span class="type"><a href="qstringlist.html">QStringList</a></span> & <i>attributes</i> )</h3>
<p>Adds the new custom filter <i>filterName</i>. The filter attributes are specified by <i>attributes</i>. If the filter already exists, its attribute set is replaced. The function returns true if the operation succeeded, otherwise it returns false.</p>
<p><b>See also </b><a href="qhelpenginecore.html#customFilters">customFilters</a>() and <a href="qhelpenginecore.html#removeCustomFilter">removeCustomFilter</a>().</p>
<!-- @@@addCustomFilter -->
<!-- $$$copyCollectionFile[overload1]$$$copyCollectionFileconstQString& -->
<h3 class="fn"><a name="copyCollectionFile"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">copyCollectionFile</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>fileName</i> )</h3>
<p>Creates the file <i>fileName</i> and copies all contents from the current collection file into the newly created file, and returns true if successful; otherwise returns false.</p>
<p>The copying process makes sure that file references to Qt Collection files (<tt>.qch</tt>) files are updated accordingly.</p>
<!-- @@@copyCollectionFile -->
<!-- $$$currentFilterChanged[overload1]$$$currentFilterChangedconstQString& -->
<h3 class="fn"><a name="currentFilterChanged"></a><span class="type">void</span> QHelpEngineCore::<span class="name">currentFilterChanged</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>newFilter</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the current filter is changed to <i>newFilter</i>.</p>
<!-- @@@currentFilterChanged -->
<!-- $$$customFilters[overload1]$$$customFilters -->
<h3 class="fn"><a name="customFilters"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QHelpEngineCore::<span class="name">customFilters</span> () const</h3>
<p>Returns a list of custom filters.</p>
<p><b>See also </b><a href="qhelpenginecore.html#addCustomFilter">addCustomFilter</a>() and <a href="qhelpenginecore.html#removeCustomFilter">removeCustomFilter</a>().</p>
<!-- @@@customFilters -->
<!-- $$$customValue[overload1]$$$customValueconstQString&constQVariant& -->
<h3 class="fn"><a name="customValue"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QHelpEngineCore::<span class="name">customValue</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>key</i>, const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>defaultValue</i> = QVariant() ) const</h3>
<p>Returns the value assigned to the <i>key</i>. If the requested key does not exist, the specified <i>defaultValue</i> is returned.</p>
<p><b>See also </b><a href="qhelpenginecore.html#setCustomValue">setCustomValue</a>() and <a href="qhelpenginecore.html#removeCustomValue">removeCustomValue</a>().</p>
<!-- @@@customValue -->
<!-- $$$documentationFileName[overload1]$$$documentationFileNameconstQString& -->
<h3 class="fn"><a name="documentationFileName"></a><span class="type"><a href="qstring.html">QString</a></span> QHelpEngineCore::<span class="name">documentationFileName</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>namespaceName</i> )</h3>
<p>Returns the absolute file name of the Qt compressed help file (.qch) identified by the <i>namespaceName</i>. If there is no Qt compressed help file with the specified namespace registered, an empty string is returned.</p>
<p><b>See also </b><a href="qhelpenginecore.html#namespaceName">namespaceName</a>().</p>
<!-- @@@documentationFileName -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn"><a name="error"></a><span class="type"><a href="qstring.html">QString</a></span> QHelpEngineCore::<span class="name">error</span> () const</h3>
<p>Returns a description of the last error that occurred.</p>
<!-- @@@error -->
<!-- $$$fileData[overload1]$$$fileDataconstQUrl& -->
<h3 class="fn"><a name="fileData"></a><span class="type"><a href="qbytearray.html">QByteArray</a></span> QHelpEngineCore::<span class="name">fileData</span> ( const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> ) const</h3>
<p>Returns the data of the file specified by <i>url</i>. If the file does not exist, an empty <a href="qbytearray.html">QByteArray</a> is returned.</p>
<p><b>See also </b><a href="qhelpenginecore.html#findFile">findFile</a>().</p>
<!-- @@@fileData -->
<!-- $$$files[overload1]$$$filesconstQStringconstQStringList&constQString& -->
<h3 class="fn"><a name="files"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qurl.html">QUrl</a></span>> QHelpEngineCore::<span class="name">files</span> ( const <span class="type"><a href="qstring.html">QString</a></span> <i>namespaceName</i>, const <span class="type"><a href="qstringlist.html">QStringList</a></span> & <i>filterAttributes</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>extensionFilter</i> = QString() )</h3>
<p>Returns a list of files contained in the Qt compressed help file <i>namespaceName</i>. The files can be filtered by <i>filterAttributes</i> as well as by their extension <i>extensionFilter</i> (e.g. 'html').</p>
<!-- @@@files -->
<!-- $$$filterAttributeSets[overload1]$$$filterAttributeSetsconstQString& -->
<h3 class="fn"><a name="filterAttributeSets"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qstringlist.html">QStringList</a></span>> QHelpEngineCore::<span class="name">filterAttributeSets</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>namespaceName</i> ) const</h3>
<p>Returns a list of filter attributes for the different filter sections defined in the Qt compressed help file with the given namespace <i>namespaceName</i>.</p>
<!-- @@@filterAttributeSets -->
<!-- $$$filterAttributes[overload1]$$$filterAttributes -->
<h3 class="fn"><a name="filterAttributes"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QHelpEngineCore::<span class="name">filterAttributes</span> () const</h3>
<p>Returns a list of all defined filter attributes.</p>
<!-- @@@filterAttributes -->
<!-- $$$filterAttributes$$$filterAttributesconstQString& -->
<h3 class="fn"><a name="filterAttributes-2"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QHelpEngineCore::<span class="name">filterAttributes</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>filterName</i> ) const</h3>
<p>Returns a list of filter attributes used by the custom filter <i>filterName</i>.</p>
<!-- @@@filterAttributes -->
<!-- $$$findFile[overload1]$$$findFileconstQUrl& -->
<h3 class="fn"><a name="findFile"></a><span class="type"><a href="qurl.html">QUrl</a></span> QHelpEngineCore::<span class="name">findFile</span> ( const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> ) const</h3>
<p>Returns an invalid URL if the file <i>url</i> cannot be found. If the file exists, either the same url is returned or a different url if the file is located in a different namespace which is merged via a common virtual folder.</p>
<!-- @@@findFile -->
<!-- $$$linksForIdentifier[overload1]$$$linksForIdentifierconstQString& -->
<h3 class="fn"><a name="linksForIdentifier"></a><span class="type"><a href="qmap.html">QMap</a></span><<span class="type"><a href="qstring.html">QString</a></span>, <span class="type"><a href="qurl.html">QUrl</a></span>> QHelpEngineCore::<span class="name">linksForIdentifier</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>id</i> ) const</h3>
<p>Returns a map of hits found for the <i>id</i>. A hit contains the title of the document and the url where the keyword is located. The result depends on the current filter, meaning only the keywords registered for the current filter will be returned.</p>
<!-- @@@linksForIdentifier -->
<!-- $$$metaData[overload1]$$$metaDataconstQString&constQString& -->
<h3 class="fn"><a name="metaData"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QHelpEngineCore::<span class="name">metaData</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>documentationFileName</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )<tt> [static]</tt></h3>
<p>Returns the meta data for the Qt compressed help file <i>documentationFileName</i>. If there is no data available for <i>name</i>, an invalid QVariant() is returned. The meta data is defined when creating the Qt compressed help file and cannot be modified later. Common meta data includes e.g. the author of the documentation.</p>
<!-- @@@metaData -->
<!-- $$$namespaceName[overload1]$$$namespaceNameconstQString& -->
<h3 class="fn"><a name="namespaceName"></a><span class="type"><a href="qstring.html">QString</a></span> QHelpEngineCore::<span class="name">namespaceName</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>documentationFileName</i> )<tt> [static]</tt></h3>
<p>Returns the namespace name defined for the Qt compressed help file (.qch) specified by its <i>documentationFileName</i>. If the file is not valid, an empty string is returned.</p>
<p><b>See also </b><a href="qhelpenginecore.html#documentationFileName">documentationFileName</a>().</p>
<!-- @@@namespaceName -->
<!-- $$$readersAboutToBeInvalidated[overload1]$$$readersAboutToBeInvalidated -->
<h3 class="fn"><a name="readersAboutToBeInvalidated"></a><span class="type">void</span> QHelpEngineCore::<span class="name">readersAboutToBeInvalidated</span> ()<tt> [signal]</tt></h3>
<!-- @@@readersAboutToBeInvalidated -->
<!-- $$$registerDocumentation[overload1]$$$registerDocumentationconstQString& -->
<h3 class="fn"><a name="registerDocumentation"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">registerDocumentation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>documentationFileName</i> )</h3>
<p>Registers the Qt compressed help file (.qch) contained in the file <i>documentationFileName</i>. One compressed help file, uniquely identified by its namespace can only be registered once. True is returned if the registration was successful, otherwise false.</p>
<p><b>See also </b><a href="qhelpenginecore.html#unregisterDocumentation">unregisterDocumentation</a>() and <a href="qhelpenginecore.html#error">error</a>().</p>
<!-- @@@registerDocumentation -->
<!-- $$$registeredDocumentations[overload1]$$$registeredDocumentations -->
<h3 class="fn"><a name="registeredDocumentations"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QHelpEngineCore::<span class="name">registeredDocumentations</span> () const</h3>
<p>Returns a list of all registered Qt compressed help files of the current collection file. The returned names are the namespaces of the registered Qt compressed help files (.qch).</p>
<!-- @@@registeredDocumentations -->
<!-- $$$removeCustomFilter[overload1]$$$removeCustomFilterconstQString& -->
<h3 class="fn"><a name="removeCustomFilter"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">removeCustomFilter</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>filterName</i> )</h3>
<p>Returns true if the filter <i>filterName</i> was removed successfully, otherwise false.</p>
<p><b>See also </b><a href="qhelpenginecore.html#addCustomFilter">addCustomFilter</a>() and <a href="qhelpenginecore.html#customFilters">customFilters</a>().</p>
<!-- @@@removeCustomFilter -->
<!-- $$$removeCustomValue[overload1]$$$removeCustomValueconstQString& -->
<h3 class="fn"><a name="removeCustomValue"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">removeCustomValue</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>key</i> )</h3>
<p>Removes the <i>key</i> from the settings section in the collection file. Returns true if the value was removed successfully, otherwise false.</p>
<p><b>See also </b><a href="qhelpenginecore.html#customValue">customValue</a>() and <a href="qhelpenginecore.html#setCustomValue">setCustomValue</a>().</p>
<!-- @@@removeCustomValue -->
<!-- $$$setCustomValue[overload1]$$$setCustomValueconstQString&constQVariant& -->
<h3 class="fn"><a name="setCustomValue"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">setCustomValue</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>key</i>, const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>value</i> )</h3>
<p>Save the <i>value</i> under the <i>key</i>. If the key already exist, the value will be overwritten. Returns true if the value was saved successfully, otherwise false.</p>
<p><b>See also </b><a href="qhelpenginecore.html#customValue">customValue</a>() and <a href="qhelpenginecore.html#removeCustomValue">removeCustomValue</a>().</p>
<!-- @@@setCustomValue -->
<!-- $$$setupData[overload1]$$$setupData -->
<h3 class="fn"><a name="setupData"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">setupData</span> ()</h3>
<p>Sets up the help engine by processing the information found in the collection file and returns true if successful; otherwise returns false.</p>
<p>By calling the function, the help engine is forced to initialize itself immediately. Most of the times, this function does not have to be called explicitly because getter functions which depend on a correctly set up help engine do that themselves.</p>
<p><b>Note:</b> <tt>qsqlite4.dll</tt> needs to be deployed with the application as the help system uses the sqlite driver when loading help collections.</p>
<!-- @@@setupData -->
<!-- $$$setupFinished[overload1]$$$setupFinished -->
<h3 class="fn"><a name="setupFinished"></a><span class="type">void</span> QHelpEngineCore::<span class="name">setupFinished</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when the setup is complete.</p>
<!-- @@@setupFinished -->
<!-- $$$setupStarted[overload1]$$$setupStarted -->
<h3 class="fn"><a name="setupStarted"></a><span class="type">void</span> QHelpEngineCore::<span class="name">setupStarted</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when setup is started.</p>
<!-- @@@setupStarted -->
<!-- $$$unregisterDocumentation[overload1]$$$unregisterDocumentationconstQString& -->
<h3 class="fn"><a name="unregisterDocumentation"></a><span class="type">bool</span> QHelpEngineCore::<span class="name">unregisterDocumentation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>namespaceName</i> )</h3>
<p>Unregisters the Qt compressed help file (.qch) identified by its <i>namespaceName</i> from the help collection. Returns true on success, otherwise false.</p>
<p><b>See also </b><a href="qhelpenginecore.html#registerDocumentation">registerDocumentation</a>() and <a href="qhelpenginecore.html#error">error</a>().</p>
<!-- @@@unregisterDocumentation -->
<!-- $$$warning[overload1]$$$warningconstQString& -->
<h3 class="fn"><a name="warning"></a><span class="type">void</span> QHelpEngineCore::<span class="name">warning</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when a non critical error occurs. The warning message is stored in <i>msg</i>.</p>
<!-- @@@warning -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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>
Qt and respective logos are trademarks of The Qt Company Ltd
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>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
