<?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" />
<!-- qhelpsearchengine.cpp -->
<title>Qt 4.8: QHelpSearchEngine 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>QHelpSearchEngine</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="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QHelpSearchEngine Class Reference</h1>
<!-- $$$QHelpSearchEngine-brief -->
<p>The QHelpSearchEngine class provides access to widgets reusable to integrate fulltext search as well as to index and search documentation. <a href="#details">More...</a></p>
<!-- @@@QHelpSearchEngine -->
<pre class="cpp"> <span class="preprocessor">#include <QHelpSearchEngine></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qhelpsearchengine-members.html">List of all members, including inherited members</a></li>
<li><a href="qhelpsearchengine-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#SearchHit-typedef">SearchHit</a></b></td></tr>
</table>
<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="qhelpsearchengine.html#QHelpSearchEngine">QHelpSearchEngine</a></b> ( QHelpEngineCore * <i>helpEngine</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#dtor.QHelpSearchEngine">~QHelpSearchEngine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#hitCount">hitCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<SearchHit> </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#hits">hits</a></b> ( int <i>start</i>, int <i>end</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QHelpSearchQuery> </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#query">query</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpSearchQueryWidget * </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#queryWidget">queryWidget</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpSearchResultWidget * </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#resultWidget">resultWidget</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#cancelIndexing">cancelIndexing</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#cancelSearching">cancelSearching</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#reindexDocumentation">reindexDocumentation</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#search">search</a></b> ( const QList<QHelpSearchQuery> & <i>queryList</i> )</td></tr>
</table>
<ul>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">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="qhelpsearchengine.html#indexingFinished">indexingFinished</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#indexingStarted">indexingStarted</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#searchingFinished">searchingFinished</a></b> ( int <i>hits</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchengine.html#searchingStarted">searchingStarted</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</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>
<!-- $$$QHelpSearchEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QHelpSearchEngine class provides access to widgets reusable to integrate fulltext search as well as to index and search documentation.</p>
<p>Before the search engine can be used, one has to instantiate at least a <a href="qhelpenginecore.html">QHelpEngineCore</a> object that needs to be passed to the search engines constructor. This is required as the search engine needs to be connected to the help engines setupFinished() signal to know when it can start to index documentation.</p>
<p>After starting the indexing process the signal <a href="qhelpsearchengine.html#indexingStarted">indexingStarted</a>() is emitted and on the end of the indexing process the <a href="qhelpsearchengine.html#indexingFinished">indexingFinished</a>() is emitted. To stop the indexing one can call <a href="qhelpsearchengine.html#cancelIndexing">cancelIndexing</a>().</p>
<p>While the indexing process has finished, the search engine can now be used to search thru its index for a given term. To do this one may use the possibility of creating the <a href="qhelpsearchquery.html">QHelpSearchQuery</a> list by self or reuse the <a href="qhelpsearchquerywidget.html">QHelpSearchQueryWidget</a> which has the inbuild functionality to set up a proper search queries list that get's passed to the search engines <a href="qhelpsearchengine.html#search">search</a>() function.</p>
<p>After the list of queries have been passed to the search engine, the signal <a href="qhelpsearchengine.html#searchingStarted">searchingStarted</a>() is emitted and after the search has finished the <a href="qhelpsearchengine.html#searchingFinished">searchingFinished</a>() signal is emitted. The search process can be stopped by calling <a href="qhelpsearchengine.html#cancelSearching">cancelSearching</a>().</p>
<p>If the search succeeds, the <a href="qhelpsearchengine.html#searchingFinished">searchingFinished</a>() will be called with the search hits count, which can be reused to fetch the search hits from the search engine. Calling the <a href="qhelpsearchengine.html#hits">hits</a>() function with the range of hits you would like to get will return a list of the requested SearchHits. They basically constist at the moment of a pair of strings where the values of that pair are the documentation file path and the page title.</p>
<p>To display the given hits use the <a href="qhelpsearchresultwidget.html">QHelpSearchResultWidget</a> or build up your own one if you need more advanced functionality. Note that the <a href="qhelpsearchresultwidget.html">QHelpSearchResultWidget</a> can not be instantiated directly, you must retrieve the widget from the search engine in use as all connections will be established for you by the widget itself.</p>
</div>
<!-- @@@QHelpSearchEngine -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$SearchHit -->
<h3 class="fn"><a name="SearchHit-typedef"></a>typedef QHelpSearchEngine::<span class="name">SearchHit</span></h3>
<p>Typedef for <a href="qpair.html">QPair</a><<a href="qstring.html">QString</a>, <a href="qstring.html">QString</a>>. The values of that pair are the documentation file path and the page title.</p>
<p><b>See also </b><a href="qhelpsearchengine.html#hits">hits</a>().</p>
<!-- @@@SearchHit -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpSearchEngine[overload1]$$$QHelpSearchEngineQHelpEngineCore*QObject* -->
<h3 class="fn"><a name="QHelpSearchEngine"></a>QHelpSearchEngine::<span class="name">QHelpSearchEngine</span> ( <span class="type"><a href="qhelpenginecore.html">QHelpEngineCore</a></span> * <i>helpEngine</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new search engine with the given <i>parent</i>. The search engine uses the given <i>helpEngine</i> to access the documentation that needs to be indexed. The <a href="qhelpengine.html">QHelpEngine</a>'s setupFinished() signal is automatically connected to the <a href="qhelpsearchengine.html">QHelpSearchEngine</a>'s indexing function, so that new documentation will be indexed after the signal is emitted.</p>
<!-- @@@QHelpSearchEngine -->
<!-- $$$~QHelpSearchEngine[overload1]$$$~QHelpSearchEngine -->
<h3 class="fn"><a name="dtor.QHelpSearchEngine"></a>QHelpSearchEngine::<span class="name">~QHelpSearchEngine</span> ()</h3>
<p>Destructs the search engine.</p>
<!-- @@@~QHelpSearchEngine -->
<!-- $$$cancelIndexing[overload1]$$$cancelIndexing -->
<h3 class="fn"><a name="cancelIndexing"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">cancelIndexing</span> ()<tt> [slot]</tt></h3>
<p>Stops the indexing process.</p>
<!-- @@@cancelIndexing -->
<!-- $$$cancelSearching[overload1]$$$cancelSearching -->
<h3 class="fn"><a name="cancelSearching"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">cancelSearching</span> ()<tt> [slot]</tt></h3>
<p>Stops the search process.</p>
<!-- @@@cancelSearching -->
<!-- $$$hitCount[overload1]$$$hitCount -->
<h3 class="fn"><a name="hitCount"></a><span class="type">int</span> QHelpSearchEngine::<span class="name">hitCount</span> () const</h3>
<p>Returns the amount of hits the search engine found.</p>
<p>This function was introduced in Qt 4.6.</p>
<!-- @@@hitCount -->
<!-- $$$hits[overload1]$$$hitsintint -->
<h3 class="fn"><a name="hits"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qhelpsearchengine.html#SearchHit-typedef">SearchHit</a></span>> QHelpSearchEngine::<span class="name">hits</span> ( <span class="type">int</span> <i>start</i>, <span class="type">int</span> <i>end</i> ) const</h3>
<p>Returns a list of search hits within the range of <i>start</i> <i>end</i>.</p>
<!-- @@@hits -->
<!-- $$$indexingFinished[overload1]$$$indexingFinished -->
<h3 class="fn"><a name="indexingFinished"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">indexingFinished</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when the indexing process is complete.</p>
<!-- @@@indexingFinished -->
<!-- $$$indexingStarted[overload1]$$$indexingStarted -->
<h3 class="fn"><a name="indexingStarted"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">indexingStarted</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when indexing process is started.</p>
<!-- @@@indexingStarted -->
<!-- $$$query[overload1]$$$query -->
<h3 class="fn"><a name="query"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qhelpsearchquery.html">QHelpSearchQuery</a></span>> QHelpSearchEngine::<span class="name">query</span> () const</h3>
<p>Returns the list of queries last searched for.</p>
<p>This function was introduced in Qt 4.5.</p>
<!-- @@@query -->
<!-- $$$queryWidget[overload1]$$$queryWidget -->
<h3 class="fn"><a name="queryWidget"></a><span class="type"><a href="qhelpsearchquerywidget.html">QHelpSearchQueryWidget</a></span> * QHelpSearchEngine::<span class="name">queryWidget</span> ()</h3>
<p>Returns a widget to use as input widget. Depending on your search engine configuration you will get a different widget with more or less subwidgets.</p>
<!-- @@@queryWidget -->
<!-- $$$reindexDocumentation[overload1]$$$reindexDocumentation -->
<h3 class="fn"><a name="reindexDocumentation"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">reindexDocumentation</span> ()<tt> [slot]</tt></h3>
<p>Forces the search engine to reindex all documentation files.</p>
<!-- @@@reindexDocumentation -->
<!-- $$$resultWidget[overload1]$$$resultWidget -->
<h3 class="fn"><a name="resultWidget"></a><span class="type"><a href="qhelpsearchresultwidget.html">QHelpSearchResultWidget</a></span> * QHelpSearchEngine::<span class="name">resultWidget</span> ()</h3>
<p>Returns a widget that can hold and display the search results.</p>
<!-- @@@resultWidget -->
<!-- $$$search[overload1]$$$searchconstQList<QHelpSearchQuery>& -->
<h3 class="fn"><a name="search"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">search</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qhelpsearchquery.html">QHelpSearchQuery</a></span>> & <i>queryList</i> )<tt> [slot]</tt></h3>
<p>Starts the search process using the given list of queries <i>queryList</i> build by the search field name and the values to search for.</p>
<!-- @@@search -->
<!-- $$$searchingFinished[overload1]$$$searchingFinishedint -->
<h3 class="fn"><a name="searchingFinished"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">searchingFinished</span> ( <span class="type">int</span> <i>hits</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the search process is complete. The hit count is stored in <i>hits</i>.</p>
<!-- @@@searchingFinished -->
<!-- $$$searchingStarted[overload1]$$$searchingStarted -->
<h3 class="fn"><a name="searchingStarted"></a><span class="type">void</span> QHelpSearchEngine::<span class="name">searchingStarted</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when the search process is started.</p>
<!-- @@@searchingStarted -->
</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>
