/usr/share/qt5/doc/qthelp/qhelpindexmodel.html is in qttools5-doc-html 5.2.1-8build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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" />
<!-- qhelpindexwidget.cpp -->
<title>QHelpIndexModel Class | QtHelp 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qthelp-index.html">Qt Help</a></li>
<li><a href="qthelp-module.html">C++ Classes</a></li>
<li>QHelpIndexModel</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<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>
<h1 class="title">QHelpIndexModel Class</h1>
<!-- $$$QHelpIndexModel-brief -->
<p>The QHelpIndexModel class provides a model that supplies index keywords to views. <a href="#details">More...</a></p>
<!-- @@@QHelpIndexModel -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QHelpIndexModel></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += help</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qstringlistmodel.html">QStringListModel</a>.</td></tr></table><ul>
<li><a href="qhelpindexmodel-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> QMap<QString, QUrl> </td><td class="memItemRight bottomAlign"><b><a href="qhelpindexmodel.html#linksForKeyword">linksForKeyword</a></b>(const QString &<i> keyword</i>) const</td></tr>
</table>
<ul>
<li class="fn">11 public functions inherited from <a href="../qtcore/qstringlistmodel.html#public-functions">QStringListModel</a></li>
<li class="fn">3 public functions inherited from <a href="../qtcore/qabstractlistmodel.html#public-functions">QAbstractListModel</a></li>
<li class="fn">39 public functions inherited from <a href="../qtcore/qabstractitemmodel.html#public-functions">QAbstractItemModel</a></li>
<li class="fn">31 public functions inherited from <a href="../qtcore/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="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>
<ul>
<li class="fn">18 signals inherited from <a href="../qtcore/qabstractitemmodel.html#signals">QAbstractItemModel</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">2 public slots inherited from <a href="../qtcore/qabstractitemmodel.html#public-slots">QAbstractItemModel</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">19 protected functions inherited from <a href="../qtcore/qabstractitemmodel.html#protected-functions">QAbstractItemModel</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected slot inherited from <a href="../qtcore/qabstractitemmodel.html#protected-slots">QAbstractItemModel</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QHelpIndexModel-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QHelpIndexModel 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"><a name="createIndex"></a><span class="type">void</span> QHelpIndexModel::<span class="name">createIndex</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></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"><a name="filter"></a><span class="type"><a href="../qtcore/qmodelindex.html">QModelIndex</a></span> QHelpIndexModel::<span class="name">filter</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i> filter</i>, const <span class="type"><a href="../qtcore/qstring.html">QString</a></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"><a name="indexCreated"></a><span class="type">void</span> QHelpIndexModel::<span class="name">indexCreated</span>()<tt> [signal]</tt></h3>
<p>This signal is emitted when the index has been created.</p>
<!-- @@@indexCreated -->
<!-- $$$indexCreationStarted[overload1]$$$indexCreationStarted -->
<h3 class="fn"><a name="indexCreationStarted"></a><span class="type">void</span> QHelpIndexModel::<span class="name">indexCreationStarted</span>()<tt> [signal]</tt></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"><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 -->
<!-- $$$linksForKeyword[overload1]$$$linksForKeywordconstQString& -->
<h3 class="fn"><a name="linksForKeyword"></a><span class="type"><a href="../qtcore/qmap.html">QMap</a></span><<span class="type"><a href="../qtcore/qstring.html">QString</a></span>, <span class="type"><a href="../qtcore/qurl.html">QUrl</a></span>> QHelpIndexModel::<span class="name">linksForKeyword</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i> keyword</i>) const</h3>
<p>Returns all hits found for the <i>keyword</i>. A hit consists of the URL and the document title.</p>
<!-- @@@linksForKeyword -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|