/usr/share/qt5/doc/qthelp/qhelpengine.html is in qttools5-doc-html 5.9.5-0ubuntu1.
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 130 131 132 133 134 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qhelpengine.cpp -->
<title>QHelpEngine 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 >QHelpEngine</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QHelpEngine Class</h1>
<!-- $$$QHelpEngine-brief -->
<p>The <a href="qhelpengine.html">QHelpEngine</a> class provides access to contents and indices of the help engine. <a href="#details">More...</a></p>
<!-- @@@QHelpEngine -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QHelpEngine></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><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qhelpenginecore.html">QHelpEngineCore</a></td></tr></table></div><ul>
<li><a href="qhelpengine-members.html">List of all members, including inherited 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"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#QHelpEngine">QHelpEngine</a></b>(const QString &<i>collectionFile</i>, QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#dtor.QHelpEngine">~QHelpEngine</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpContentModel *</td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#contentModel">contentModel</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpContentWidget *</td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#contentWidget">contentWidget</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpIndexModel *</td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#indexModel">indexModel</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpIndexWidget *</td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#indexWidget">indexWidget</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QHelpSearchEngine *</td><td class="memItemRight bottomAlign"><b><a href="qhelpengine.html#searchEngine">searchEngine</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">27 public functions inherited from <a href="qhelpenginecore.html#public-functions">QHelpEngineCore</a></li>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 properties inherited from <a href="qhelpenginecore.html#properties">QHelpEngineCore</a></li>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">5 signals inherited from <a href="qhelpenginecore.html#signals">QHelpEngineCore</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">2 static public members inherited from <a href="qhelpenginecore.html#static-public-members">QHelpEngineCore</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">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</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>
<!-- $$$QHelpEngine-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qhelpengine.html">QHelpEngine</a> class provides access to contents and indices of the help engine.</p>
</div>
<!-- @@@QHelpEngine -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpEngine[overload1]$$$QHelpEngineconstQString&QObject* -->
<h3 class="fn" id="QHelpEngine"><a name="QHelpEngine"></a>QHelpEngine::<span class="name">QHelpEngine</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>collectionFile</i>, <span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a new help engine with the given <i>parent</i>. The help engine uses the information stored in the <i>collectionFile</i> for providing help. If the collection file does not already exist, it will be created.</p>
<!-- @@@QHelpEngine -->
<!-- $$$~QHelpEngine[overload1]$$$~QHelpEngine -->
<h3 class="fn" id="dtor.QHelpEngine"><a name="dtor.QHelpEngine"></a>QHelpEngine::<span class="name">~QHelpEngine</span>()</h3>
<p>Destroys the help engine object.</p>
<!-- @@@~QHelpEngine -->
<!-- $$$contentModel[overload1]$$$contentModel -->
<h3 class="fn" id="contentModel"><a name="contentModel"></a><span class="type"><a href="qhelpcontentmodel.html">QHelpContentModel</a></span> *QHelpEngine::<span class="name">contentModel</span>() const</h3>
<p>Returns the content model.</p>
<!-- @@@contentModel -->
<!-- $$$contentWidget[overload1]$$$contentWidget -->
<h3 class="fn" id="contentWidget"><a name="contentWidget"></a><span class="type"><a href="qhelpcontentwidget.html">QHelpContentWidget</a></span> *QHelpEngine::<span class="name">contentWidget</span>()</h3>
<p>Returns the content widget.</p>
<!-- @@@contentWidget -->
<!-- $$$indexModel[overload1]$$$indexModel -->
<h3 class="fn" id="indexModel"><a name="indexModel"></a><span class="type"><a href="qhelpindexmodel.html">QHelpIndexModel</a></span> *QHelpEngine::<span class="name">indexModel</span>() const</h3>
<p>Returns the index model.</p>
<!-- @@@indexModel -->
<!-- $$$indexWidget[overload1]$$$indexWidget -->
<h3 class="fn" id="indexWidget"><a name="indexWidget"></a><span class="type"><a href="qhelpindexwidget.html">QHelpIndexWidget</a></span> *QHelpEngine::<span class="name">indexWidget</span>()</h3>
<p>Returns the index widget.</p>
<!-- @@@indexWidget -->
<!-- $$$searchEngine[overload1]$$$searchEngine -->
<h3 class="fn" id="searchEngine"><a name="searchEngine"></a><span class="type"><a href="qhelpsearchengine.html">QHelpSearchEngine</a></span> *QHelpEngine::<span class="name">searchEngine</span>()</h3>
<p>Returns the default search engine.</p>
<!-- @@@searchEngine -->
</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>
|