<?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>QHelpIndexWidget 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 >QHelpIndexWidget</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-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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QHelpIndexWidget Class</h1>
<!-- $$$QHelpIndexWidget-brief -->
<p>The <a href="qhelpindexwidget.html">QHelpIndexWidget</a> class provides a list view displaying the <a href="qhelpindexmodel.html">QHelpIndexModel</a>. <a href="#details">More...</a></p>
<!-- @@@QHelpIndexWidget -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QHelpIndexWidget></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="qhelpindexwidget-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexwidget.html#activateCurrentItem">activateCurrentItem</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexwidget.html#filterIndices">filterIndices</a></b>(const QString &<i>filter</i>, const QString &<i>wildcard</i> = QString())</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="qhelpindexwidget.html#linkActivated">linkActivated</a></b>(const QUrl &<i>link</i>, const QString &<i>keyword</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexwidget.html#linksActivated">linksActivated</a></b>(const QMap<QString, QUrl> &<i>links</i>, const QString &<i>keyword</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QHelpIndexWidget-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qhelpindexwidget.html">QHelpIndexWidget</a> class provides a list view displaying the <a href="qhelpindexmodel.html">QHelpIndexModel</a>.</p>
</div>
<!-- @@@QHelpIndexWidget -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$activateCurrentItem[overload1]$$$activateCurrentItem -->
<h3 class="fn" id="activateCurrentItem"><a name="activateCurrentItem"></a><code>[slot] </code><span class="type">void</span> QHelpIndexWidget::<span class="name">activateCurrentItem</span>()</h3>
<p>Activates the current item which will result eventually in the emitting of a <a href="qhelpindexwidget.html#linkActivated">linkActivated</a>() or <a href="qhelpindexwidget.html#linksActivated">linksActivated</a>() signal.</p>
<!-- @@@activateCurrentItem -->
<!-- $$$filterIndices[overload1]$$$filterIndicesconstQString&constQString& -->
<h3 class="fn" id="filterIndices"><a name="filterIndices"></a><code>[slot] </code><span class="type">void</span> QHelpIndexWidget::<span class="name">filterIndices</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 according to <i>filter</i> or <i>wildcard</i>. The item with the best match is set as current item.</p>
<p><b>See also </b><a href="qhelpindexmodel.html#filter">QHelpIndexModel::filter</a>().</p>
<!-- @@@filterIndices -->
<!-- $$$linkActivated[overload1]$$$linkActivatedconstQUrl&constQString& -->
<h3 class="fn" id="linkActivated"><a name="linkActivated"></a><code>[signal] </code><span class="type">void</span> QHelpIndexWidget::<span class="name">linkActivated</span>(const <span class="type">QUrl</span> &<i>link</i>, const <span class="type">QString</span> &<i>keyword</i>)</h3>
<p>This signal is emitted when an item is activated and its associated <i>link</i> should be shown. To know where the link belongs to, the <i>keyword</i> is given as a second paremeter.</p>
<!-- @@@linkActivated -->
<!-- $$$linksActivated[overload1]$$$linksActivatedconstQMap<QString,QUrl>&constQString& -->
<h3 class="fn" id="linksActivated"><a name="linksActivated"></a><code>[signal] </code><span class="type">void</span> QHelpIndexWidget::<span class="name">linksActivated</span>(const <span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QUrl</span>> &<i>links</i>, const <span class="type">QString</span> &<i>keyword</i>)</h3>
<p>This signal is emitted when the item representing the <i>keyword</i> is activated and the item has more than one link associated. The <i>links</i> consist of the document titles and their URLs.</p>
<!-- @@@linksActivated -->
</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>
