<?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: QHelpSearchQuery 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>QHelpSearchQuery</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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QHelpSearchQuery Class Reference</h1>
<!-- $$$QHelpSearchQuery-brief -->
<p>The QHelpSearchQuery class contains the field name and the associated search term <a href="#details">More...</a></p>
<!-- @@@QHelpSearchQuery -->
<pre class="cpp"> <span class="preprocessor">#include <QHelpSearchQuery></span></pre><p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qhelpsearchquery-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchquery.html#FieldName-enum">FieldName</a></b> { DEFAULT, FUZZY, WITHOUT, PHRASE, ALL, ATLEAST }</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="qhelpsearchquery.html#QHelpSearchQuery">QHelpSearchQuery</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpsearchquery.html#QHelpSearchQuery-2">QHelpSearchQuery</a></b> ( FieldName <i>field</i>, const QStringList & <i>wordList</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QHelpSearchQuery-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QHelpSearchQuery class contains the field name and the associated search term</p>
<p>The QHelpSearchQuery class contains the field name and the associated search term. Depending on the field the search term might get split up into separate terms to be parsed differently by the search engine.</p>
</div>
<p><b>See also </b><a href="qhelpsearchquerywidget.html">QHelpSearchQueryWidget</a>.</p>
<!-- @@@QHelpSearchQuery -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$FieldName$$$DEFAULT$$$FUZZY$$$WITHOUT$$$PHRASE$$$ALL$$$ATLEAST -->
<h3 class="fn"><a name="FieldName-enum"></a>enum QHelpSearchQuery::<span class="name">FieldName</span></h3>
<p>This enum type specifies the field names that are handled by the search engine.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QHelpSearchQuery::DEFAULT</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">the default field provided by the search widget, several terms should be split and stored in the word list except search terms enclosed in quotes.</td></tr>
<tr><td class="topAlign"><tt>QHelpSearchQuery::FUZZY</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">a field only provided in use with clucene. Terms should be split in separate words and passed to the search engine.</td></tr>
<tr><td class="topAlign"><tt>QHelpSearchQuery::WITHOUT</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">a field only provided in use with clucene. Terms should be split in separate words and passed to the search engine.</td></tr>
<tr><td class="topAlign"><tt>QHelpSearchQuery::PHRASE</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">a field only provided in use with clucene. Terms should not be split in separate words.</td></tr>
<tr><td class="topAlign"><tt>QHelpSearchQuery::ALL</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">a field only provided in use with clucene. Terms should be split in separate words and passed to the search engine</td></tr>
<tr><td class="topAlign"><tt>QHelpSearchQuery::ATLEAST</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">a field only provided in use with clucene. Terms should be split in separate words and passed to the search engine</td></tr>
</table>
<!-- @@@FieldName -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpSearchQuery[overload1]$$$QHelpSearchQuery -->
<h3 class="fn"><a name="QHelpSearchQuery"></a>QHelpSearchQuery::<span class="name">QHelpSearchQuery</span> ()</h3>
<p>Constructs a new empty <a href="qhelpsearchquery.html">QHelpSearchQuery</a>.</p>
<!-- @@@QHelpSearchQuery -->
<!-- $$$QHelpSearchQuery$$$QHelpSearchQueryFieldNameconstQStringList& -->
<h3 class="fn"><a name="QHelpSearchQuery-2"></a>QHelpSearchQuery::<span class="name">QHelpSearchQuery</span> ( <span class="type"><a href="qhelpsearchquery.html#FieldName-enum">FieldName</a></span> <i>field</i>, const <span class="type"><a href="qstringlist.html">QStringList</a></span> & <i>wordList</i> )</h3>
<p>Constructs a new <a href="qhelpsearchquery.html">QHelpSearchQuery</a> and initializes it with the given <i>field</i> and <i>wordList</i>.</p>
<!-- @@@QHelpSearchQuery -->
</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>
