This file is indexed.

/usr/share/qt5/doc/qtlocation/qplaceratings.html is in qtlocation5-doc-html 5.2.1-1ubuntu2.

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
135
136
137
138
139
140
141
142
143
144
145
<?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" />
<!-- qplaceratings.cpp -->
  <title>QPlaceRatings Class | QtLocation 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="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-module.html">C++ Classes</a></li>
<li>QPlaceRatings</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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QPlaceRatings Class</h1>
<!-- $$$QPlaceRatings-brief -->
<p>The QPlaceRatings class holds rating information about a place. <a href="#details">More...</a></p>
<!-- @@@QPlaceRatings -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include &lt;QPlaceRatings&gt;</span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += location</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt Location 5.0</td></tr></table><ul>
<li><a href="qplaceratings-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"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#QPlaceRatings">QPlaceRatings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#QPlaceRatings-2">QPlaceRatings</a></b>(const QPlaceRatings &amp;<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#dtor.QPlaceRatings">~QPlaceRatings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#average">average</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#count">count</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#maximum">maximum</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#setAverage">setAverage</a></b>(qreal<i> average</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#setCount">setCount</a></b>(int<i> count</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#setMaximum">setMaximum</a></b>(qreal<i> max</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#operator-not-eq">operator!=</a></b>(const QPlaceRatings &amp;<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceRatings &amp; </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#operator-eq">operator=</a></b>(const QPlaceRatings &amp;<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceratings.html#operator-eq-eq">operator==</a></b>(const QPlaceRatings &amp;<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlaceRatings-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceRatings class holds rating information about a place.</p>
<p>Rating information is used to describe how good a place is conceived to be. Typically this information is visualized as a number of stars. The <a href="qplaceratings.html#average">average</a>() function returns an aggregated ratings value out of a possible maximum as given by the <a href="qplaceratings.html#maximum">maximum</a>() function.</p>
<pre class="cpp">qDebug() <span class="operator">&lt;</span><span class="operator">&lt;</span> <span class="type">QString</span>(<span class="string">&quot;This place rated &quot;</span>) <span class="operator">+</span> place<span class="operator">.</span>ratings()<span class="operator">.</span>average()
            <span class="operator">+</span> <span class="string">&quot;out of &quot;</span> <span class="operator">+</span> place<span class="operator">.</span>ratings()<span class="operator">.</span>maximum() <span class="operator">+</span> <span class="string">&quot;stars&quot;</span>;</pre>
</div>
<!-- @@@QPlaceRatings -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceRatings[overload1]$$$QPlaceRatings -->
<h3 class="fn"><a name="QPlaceRatings"></a>QPlaceRatings::<span class="name">QPlaceRatings</span>()</h3>
<p>Constructs a new ratings object.</p>
<!-- @@@QPlaceRatings -->
<!-- $$$QPlaceRatings$$$QPlaceRatingsconstQPlaceRatings& -->
<h3 class="fn"><a name="QPlaceRatings-2"></a>QPlaceRatings::<span class="name">QPlaceRatings</span>(const <span class="type">QPlaceRatings</span> &amp;<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlaceRatings -->
<!-- $$$~QPlaceRatings[overload1]$$$~QPlaceRatings -->
<h3 class="fn"><a name="dtor.QPlaceRatings"></a>QPlaceRatings::<span class="name">~QPlaceRatings</span>()</h3>
<p>Destroys the ratings object.</p>
<!-- @@@~QPlaceRatings -->
<!-- $$$average[overload1]$$$average -->
<h3 class="fn"><a name="average"></a><span class="type">qreal</span> QPlaceRatings::<span class="name">average</span>() const</h3>
<p>Returns the average value of individual ratings.</p>
<p><b>See also </b><a href="qplaceratings.html#setAverage">setAverage</a>().</p>
<!-- @@@average -->
<!-- $$$count[overload1]$$$count -->
<h3 class="fn"><a name="count"></a><span class="type">int</span> QPlaceRatings::<span class="name">count</span>() const</h3>
<p>Returns the total number of individual ratings.</p>
<p><b>See also </b><a href="qplaceratings.html#setCount">setCount</a>().</p>
<!-- @@@count -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QPlaceRatings::<span class="name">isEmpty</span>() const</h3>
<p>Returns true if all fields of the place ratings are 0; otherwise returns false.</p>
<!-- @@@isEmpty -->
<!-- $$$maximum[overload1]$$$maximum -->
<h3 class="fn"><a name="maximum"></a><span class="type">qreal</span> QPlaceRatings::<span class="name">maximum</span>() const</h3>
<p>Returns the maximum possible rating value.</p>
<p><b>See also </b><a href="qplaceratings.html#setMaximum">setMaximum</a>().</p>
<!-- @@@maximum -->
<!-- $$$setAverage[overload1]$$$setAverageqreal -->
<h3 class="fn"><a name="setAverage"></a><span class="type">void</span> QPlaceRatings::<span class="name">setAverage</span>(<span class="type">qreal</span><i> average</i>)</h3>
<p>Sets the <i>average</i> value of the ratings.</p>
<p><b>See also </b><a href="qplaceratings.html#average">average</a>().</p>
<!-- @@@setAverage -->
<!-- $$$setCount[overload1]$$$setCountint -->
<h3 class="fn"><a name="setCount"></a><span class="type">void</span> QPlaceRatings::<span class="name">setCount</span>(<span class="type">int</span><i> count</i>)</h3>
<p>Sets the total number of individual ratings to <i>count</i>.</p>
<p><b>See also </b><a href="qplaceratings.html#count">count</a>().</p>
<!-- @@@setCount -->
<!-- $$$setMaximum[overload1]$$$setMaximumqreal -->
<h3 class="fn"><a name="setMaximum"></a><span class="type">void</span> QPlaceRatings::<span class="name">setMaximum</span>(<span class="type">qreal</span><i> max</i>)</h3>
<p>Sets the maximum possible rating value to <i>max</i>.</p>
<p><b>See also </b><a href="qplaceratings.html#maximum">maximum</a>().</p>
<!-- @@@setMaximum -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceRatings& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceRatings::<span class="name">operator!=</span>(const <span class="type">QPlaceRatings</span> &amp;<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this ratings object, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceRatings& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPlaceRatings</span> &amp; QPlaceRatings::<span class="name">operator=</span>(const <span class="type">QPlaceRatings</span> &amp;<i> other</i>)</h3>
<p>Assigns <i>other</i> to this ratings object and returns a reference to this ratings object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceRatings& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceRatings::<span class="name">operator==</span>(const <span class="type">QPlaceRatings</span> &amp;<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this ratings object, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>