<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qhelpindexwidget.cpp -->
<title>QHelpIndexModel Class | Qt Help 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qthelp-index.html">Qt Help</a></td><td ><a href="qthelp-module.html">C++ Classes</a></td><td >QHelpIndexModel</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QHelpIndexModel Class</h1>
<!-- $$$QHelpIndexModel-brief -->
<p>The <a href="qhelpindexmodel.html">QHelpIndexModel</a> class provides a model that supplies index keywords to views. <a href="#details">More...</a></p>
<!-- @@@QHelpIndexModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QHelpIndexModel></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += help</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.4</td></tr></table></div><ul>
<li><a href="qhelpindexmodel-members.html">List of all members, including inherited members</a></li>
<li><a href="qhelpindexmodel-obsolete.html">Obsolete members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexmodel.html#createIndex">createIndex</a></b>(const QString &<i>customFilterName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QModelIndex </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexmodel.html#filter">filter</a></b>(const QString &<i>filter</i>, const QString &<i>wildcard</i> = QString())</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexmodel.html#isCreatingIndex">isCreatingIndex</a></b>() const</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexmodel.html#indexCreated">indexCreated</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexmodel.html#indexCreationStarted">indexCreationStarted</a></b>()</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QHelpIndexModel-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qhelpindexmodel.html">QHelpIndexModel</a> class provides a model that supplies index keywords to views.</p>
</div>
<!-- @@@QHelpIndexModel -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$createIndex[overload1]$$$createIndexconstQString& -->
<h3 class="fn" id="createIndex"><a name="createIndex"></a><span class="type">void</span> QHelpIndexModel::<span class="name">createIndex</span>(const <span class="type">QString</span> &<i>customFilterName</i>)</h3>
<p>Creates a new index by querying the help system for keywords for the specified <i>customFilterName</i>.</p>
<!-- @@@createIndex -->
<!-- $$$filter[overload1]$$$filterconstQString&constQString& -->
<h3 class="fn" id="filter"><a name="filter"></a><span class="type">QModelIndex</span> QHelpIndexModel::<span class="name">filter</span>(const <span class="type">QString</span> &<i>filter</i>, const <span class="type">QString</span> &<i>wildcard</i> = QString())</h3>
<p>Filters the indices and returns the model index of the best matching keyword. In a first step, only the keywords containing <i>filter</i> are kept in the model's index list. Analogously, if <i>wildcard</i> is not empty, only the keywords matched are left in the index list. In a second step, the best match is determined and its index model returned. When specifying a wildcard expression, the <i>filter</i> string is used to search for the best match.</p>
<!-- @@@filter -->
<!-- $$$indexCreated[overload1]$$$indexCreated -->
<h3 class="fn" id="indexCreated"><a name="indexCreated"></a><code>[signal] </code><span class="type">void</span> QHelpIndexModel::<span class="name">indexCreated</span>()</h3>
<p>This signal is emitted when the index has been created.</p>
<!-- @@@indexCreated -->
<!-- $$$indexCreationStarted[overload1]$$$indexCreationStarted -->
<h3 class="fn" id="indexCreationStarted"><a name="indexCreationStarted"></a><code>[signal] </code><span class="type">void</span> QHelpIndexModel::<span class="name">indexCreationStarted</span>()</h3>
<p>This signal is emitted when the creation of a new index has started. The current index is invalid from this point on until the signal <a href="qhelpindexmodel.html#indexCreated">indexCreated</a>() is emitted.</p>
<p><b>See also </b><a href="qhelpindexmodel.html#isCreatingIndex">isCreatingIndex</a>().</p>
<!-- @@@indexCreationStarted -->
<!-- $$$isCreatingIndex[overload1]$$$isCreatingIndex -->
<h3 class="fn" id="isCreatingIndex"><a name="isCreatingIndex"></a><span class="type">bool</span> QHelpIndexModel::<span class="name">isCreatingIndex</span>() const</h3>
<p>Returns true if the index is currently built up, otherwise false.</p>
<!-- @@@isCreatingIndex -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> 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.<br> 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. </p>
</div>
</body>
</html>
