Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > ed56237261fa5ad3d1f8082a5fac7e2e > files > 149

qtlocation5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qplacecategory.cpp -->
  <title>QPlaceCategory Class | Qt Location 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="qtlocation-index.html">Qt Location</a></td><td ><a href="qtlocation-module.html">C++ Classes</a></td><td >QPlaceCategory</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QPlaceCategory Class</h1>
<!-- $$$QPlaceCategory-brief -->
<p>The <a href="qplacecategory.html">QPlaceCategory</a> class represents a category that a <a href="qplace.html">QPlace</a> can be associated with. <a href="#details">More...</a></p>
<!-- @@@QPlaceCategory -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QPlaceCategory&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += location</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.6</td></tr></table></div><ul>
<li><a href="qplacecategory-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="qplacecategory.html#QPlaceCategory">QPlaceCategory</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#QPlaceCategory-1">QPlaceCategory</a></b>(const QPlaceCategory &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#dtor.QPlaceCategory">~QPlaceCategory</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#categoryId">categoryId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceIcon </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#icon">icon</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#name">name</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#setCategoryId">setCategoryId</a></b>(const QString &amp;<i>identifier</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#setIcon">setIcon</a></b>(const QPlaceIcon &amp;<i>icon</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#setName">setName</a></b>(const QString &amp;<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#setVisibility">setVisibility</a></b>(QLocation::Visibility <i>visibility</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocation::Visibility </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#visibility">visibility</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#operator-not-eq">operator!=</a></b>(const QPlaceCategory &amp;<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceCategory &amp;</td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#operator-eq">operator=</a></b>(const QPlaceCategory &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacecategory.html#operator-eq-eq">operator==</a></b>(const QPlaceCategory &amp;<i>other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QPlaceCategory-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qplacecategory.html">QPlaceCategory</a> class represents a category that a <a href="qplace.html">QPlace</a> can be associated with.</p>
<p>Categories are used to search for places based on the categories they are associated with. The list/tree of available categories can be obtained from <a href="qplacemanager.html">QPlaceManager</a>. The <a href="qplacesearchrequest.html#setCategories">QPlaceSearchRequest::setCategories</a>() function can be used to limit the search results to places with the specified categories.</p>
<p>If the <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> supports it, categories can be created and removed. This functionality is available in the <a href="qplacemanager.html">QPlaceManager</a> class.</p>
</div>
<!-- @@@QPlaceCategory -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceCategory[overload1]$$$QPlaceCategory -->
<h3 class="fn" id="QPlaceCategory"><a name="QPlaceCategory"></a>QPlaceCategory::<span class="name">QPlaceCategory</span>()</h3>
<p>Constructs a category.</p>
<!-- @@@QPlaceCategory -->
<!-- $$$QPlaceCategory$$$QPlaceCategoryconstQPlaceCategory& -->
<h3 class="fn" id="QPlaceCategory-1"><a name="QPlaceCategory-1"></a>QPlaceCategory::<span class="name">QPlaceCategory</span>(const <span class="type"><a href="qplacecategory.html#QPlaceCategory">QPlaceCategory</a></span> &amp;<i>other</i>)</h3>
<p>Constructs a category which is a copy of <i>other</i>.</p>
<!-- @@@QPlaceCategory -->
<!-- $$$~QPlaceCategory[overload1]$$$~QPlaceCategory -->
<h3 class="fn" id="dtor.QPlaceCategory"><a name="dtor.QPlaceCategory"></a><code>[virtual] </code>QPlaceCategory::<span class="name">~QPlaceCategory</span>()</h3>
<p>Destroys the category.</p>
<!-- @@@~QPlaceCategory -->
<!-- $$$categoryId[overload1]$$$categoryId -->
<h3 class="fn" id="categoryId"><a name="categoryId"></a><span class="type">QString</span> QPlaceCategory::<span class="name">categoryId</span>() const</h3>
<p>Returns the identifier of the category. The category identifier is a string which uniquely identifies this category within a particular <a href="qplacemanager.html">QPlaceManager</a>. The identifier is only meaningful to the <a href="qplacemanager.html">QPlaceManager</a> that generated it and is not transferable between managers.</p>
<p><b>See also </b><a href="qplacecategory.html#setCategoryId">setCategoryId</a>().</p>
<!-- @@@categoryId -->
<!-- $$$icon[overload1]$$$icon -->
<h3 class="fn" id="icon"><a name="icon"></a><span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> QPlaceCategory::<span class="name">icon</span>() const</h3>
<p>Returns the icon associated with the category.</p>
<p><b>See also </b><a href="qplacecategory.html#setIcon">setIcon</a>().</p>
<!-- @@@icon -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn" id="isEmpty"><a name="isEmpty"></a><span class="type">bool</span> QPlaceCategory::<span class="name">isEmpty</span>() const</h3>
<p>Returns a boolean indicating whether the all the fields of the place category are empty or not.</p>
<!-- @@@isEmpty -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn" id="name"><a name="name"></a><span class="type">QString</span> QPlaceCategory::<span class="name">name</span>() const</h3>
<p>Returns the name of category.</p>
<p><b>See also </b><a href="qplacecategory.html#setName">setName</a>().</p>
<!-- @@@name -->
<!-- $$$setCategoryId[overload1]$$$setCategoryIdconstQString& -->
<h3 class="fn" id="setCategoryId"><a name="setCategoryId"></a><span class="type">void</span> QPlaceCategory::<span class="name">setCategoryId</span>(const <span class="type">QString</span> &amp;<i>identifier</i>)</h3>
<p>Sets the <i>identifier</i> of the category.</p>
<p><b>See also </b><a href="qplacecategory.html#categoryId">categoryId</a>().</p>
<!-- @@@setCategoryId -->
<!-- $$$setIcon[overload1]$$$setIconconstQPlaceIcon& -->
<h3 class="fn" id="setIcon"><a name="setIcon"></a><span class="type">void</span> QPlaceCategory::<span class="name">setIcon</span>(const <span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> &amp;<i>icon</i>)</h3>
<p>Sets the <i>icon</i> of the category.</p>
<p><b>See also </b><a href="qplacecategory.html#icon">icon</a>().</p>
<!-- @@@setIcon -->
<!-- $$$setName[overload1]$$$setNameconstQString& -->
<h3 class="fn" id="setName"><a name="setName"></a><span class="type">void</span> QPlaceCategory::<span class="name">setName</span>(const <span class="type">QString</span> &amp;<i>name</i>)</h3>
<p>Sets the <i>name</i> of the category.</p>
<p><b>See also </b><a href="qplacecategory.html#name">name</a>().</p>
<!-- @@@setName -->
<!-- $$$setVisibility[overload1]$$$setVisibilityQLocation::Visibility -->
<h3 class="fn" id="setVisibility"><a name="setVisibility"></a><span class="type">void</span> QPlaceCategory::<span class="name">setVisibility</span>(<span class="type"><a href="qlocation.html#Visibility-enum">QLocation::Visibility</a></span> <i>visibility</i>)</h3>
<p>Sets the <i>visibility</i> of the category.</p>
<p><b>See also </b><a href="qplacecategory.html#visibility">visibility</a>().</p>
<!-- @@@setVisibility -->
<!-- $$$visibility[overload1]$$$visibility -->
<h3 class="fn" id="visibility"><a name="visibility"></a><span class="type"><a href="qlocation.html#Visibility-enum">QLocation::Visibility</a></span> QPlaceCategory::<span class="name">visibility</span>() const</h3>
<p>Returns the visibility of the category.</p>
<p><b>See also </b><a href="qplacecategory.html#setVisibility">setVisibility</a>().</p>
<!-- @@@visibility -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceCategory& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceCategory::<span class="name">operator!=</span>(const <span class="type"><a href="qplacecategory.html#QPlaceCategory">QPlaceCategory</a></span> &amp;<i>other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this category; otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceCategory& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qplacecategory.html#QPlaceCategory">QPlaceCategory</a></span> &amp;QPlaceCategory::<span class="name">operator=</span>(const <span class="type"><a href="qplacecategory.html#QPlaceCategory">QPlaceCategory</a></span> &amp;<i>other</i>)</h3>
<p>Assigns <i>other</i> to this category and returns a reference to this category.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceCategory& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceCategory::<span class="name">operator==</span>(const <span class="type"><a href="qplacecategory.html#QPlaceCategory">QPlaceCategory</a></span> &amp;<i>other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this category; otherwise returns false.</p>
<!-- @@@operator== -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>