qhbarmodelmapper.html 20.1 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qhbarmodelmapper.cpp -->
  <title>QHBarModelMapper Class | Qt Charts 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtcharts-index.html">Qt Charts</a></td><td ><a href="qtcharts-module.html">C++ Classes</a></td><td >QHBarModelMapper</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 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="#properties">Properties</a></li>
<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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QHBarModelMapper Class</h1>
<!-- $$$QHBarModelMapper-brief -->
<p>The <a href="qhbarmodelmapper.html">QHBarModelMapper</a> class is a horizontal model mapper for bar series. <a href="#details">More...</a></p>
<!-- @@@QHBarModelMapper -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QHBarModelMapper&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtcharts-hbarmodelmapper.html">HBarModelMapper</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qhbarmodelmapper-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qhbarmodelmapper.html#columnCount-prop">columnCount</a></b> : int</li>
<li class="fn"><b><a href="qhbarmodelmapper.html#firstBarSetRow-prop">firstBarSetRow</a></b> : int</li>
<li class="fn"><b><a href="qhbarmodelmapper.html#firstColumn-prop">firstColumn</a></b> : int</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qhbarmodelmapper.html#lastBarSetRow-prop">lastBarSetRow</a></b> : int</li>
<li class="fn"><b><a href="qhbarmodelmapper.html#model-prop">model</a></b> : QAbstractItemModel*</li>
<li class="fn"><b><a href="qhbarmodelmapper.html#series-prop">series</a></b> : QAbstractBarSeries*</li>
</ul>
</td></tr>
</table></div>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</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="qhbarmodelmapper.html#QHBarModelMapper">QHBarModelMapper</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#columnCount-prop">columnCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#firstBarSetRow-prop">firstBarSetRow</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#firstColumn-prop">firstColumn</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#lastBarSetRow-prop">lastBarSetRow</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAbstractItemModel *</td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#model-prop">model</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAbstractBarSeries *</td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#series-prop">series</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#columnCount-prop">setColumnCount</a></b>(int <i>columnCount</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#firstBarSetRow-prop">setFirstBarSetRow</a></b>(int <i>firstBarSetRow</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#firstColumn-prop">setFirstColumn</a></b>(int <i>firstColumn</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#lastBarSetRow-prop">setLastBarSetRow</a></b>(int <i>lastBarSetRow</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#model-prop">setModel</a></b>(QAbstractItemModel *<i>model</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#series-prop">setSeries</a></b>(QAbstractBarSeries *<i>series</i>)</td></tr>
</table></div>
<ul>
<li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<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="qhbarmodelmapper.html#columnCountChanged">columnCountChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#firstBarSetRowChanged">firstBarSetRowChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#firstColumnChanged">firstColumnChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#lastBarSetRowChanged">lastBarSetRowChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#modelReplaced">modelReplaced</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qhbarmodelmapper.html#seriesReplaced">seriesReplaced</a></b>()</td></tr>
</table></div>
<ul>
<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 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">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>
<!-- $$$QHBarModelMapper-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qhbarmodelmapper.html">QHBarModelMapper</a> class is a horizontal model mapper for bar series.</p>
<p>Model mappers enable using a data model derived from the <a href="../qtcore/qabstractitemmodel.html">QAbstractItemModel</a> class as a data source for a chart. A horizontal model mapper is used to create a connection between a data model and <a href="qabstractbarseries.html">QAbstractBarSeries</a>, so that each row in the data model defines a bar set and each column maps to a category in a bar series.</p>
<p>Both model and bar series properties can be used to manipulate the data. The model mapper keeps the bar series and the data model in sync.</p>
<p>The model mapper ensures that all the bar sets in the bar series have equal sizes. Therefore, adding or removing a value from a bar set causes the same change to be made in all the bar sets in the bar series.</p>
</div>
<p><b>See also </b><a href="qvbarmodelmapper.html">QVBarModelMapper</a>.</p>
<!-- @@@QHBarModelMapper -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$columnCount-prop$$$columnCount$$$setColumnCountint$$$columnCountChanged -->
<h3 class="fn" id="columnCount-prop"><a name="columnCount-prop"></a><span class="name">columnCount</span> : <span class="type">int</span></h3>
<p>This property holds the number of columns of the model that are mapped as the data for the bar series.</p>
<p>The minimum and default value is -1 (number limited to the number of columns in the model).</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>columnCount</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setColumnCount</b></span>(int <i>columnCount</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhbarmodelmapper.html#columnCountChanged">columnCountChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@columnCount -->
<!-- $$$firstBarSetRow-prop$$$firstBarSetRow$$$setFirstBarSetRowint$$$firstBarSetRowChanged -->
<h3 class="fn" id="firstBarSetRow-prop"><a name="firstBarSetRow-prop"></a><span class="name">firstBarSetRow</span> : <span class="type">int</span></h3>
<p>This property holds the row of the model that is used as the data source for the first bar set.</p>
<p>The default value is -1 (invalid mapping).</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>firstBarSetRow</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFirstBarSetRow</b></span>(int <i>firstBarSetRow</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhbarmodelmapper.html#firstBarSetRowChanged">firstBarSetRowChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@firstBarSetRow -->
<!-- $$$firstColumn-prop$$$firstColumn$$$setFirstColumnint$$$firstColumnChanged -->
<h3 class="fn" id="firstColumn-prop"><a name="firstColumn-prop"></a><span class="name">firstColumn</span> : <span class="type">int</span></h3>
<p>This property holds the column of the model that contains the first values of the bar sets in the bar series.</p>
<p>The minimum and default value is 0.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>firstColumn</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFirstColumn</b></span>(int <i>firstColumn</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhbarmodelmapper.html#firstColumnChanged">firstColumnChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@firstColumn -->
<!-- $$$lastBarSetRow-prop$$$lastBarSetRow$$$setLastBarSetRowint$$$lastBarSetRowChanged -->
<h3 class="fn" id="lastBarSetRow-prop"><a name="lastBarSetRow-prop"></a><span class="name">lastBarSetRow</span> : <span class="type">int</span></h3>
<p>This property holds the row of the model that is used as the data source for the last bar set.</p>
<p>The default value is -1 (invalid mapping).</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>lastBarSetRow</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setLastBarSetRow</b></span>(int <i>lastBarSetRow</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhbarmodelmapper.html#lastBarSetRowChanged">lastBarSetRowChanged</a></b></span>()</td></tr>
</table></div>
<!-- @@@lastBarSetRow -->
<!-- $$$model-prop$$$model$$$setModelQAbstractItemModel*$$$modelReplaced -->
<h3 class="fn" id="model-prop"><a name="model-prop"></a><span class="name">model</span> : <span class="type"><a href="../qtcore/qabstractitemmodel.html">QAbstractItemModel</a></span>*</h3>
<p>Defines the model that is used by the mapper.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QAbstractItemModel *</td><td class="memItemRight bottomAlign"><span class="name"><b>model</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setModel</b></span>(QAbstractItemModel *<i>model</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhbarmodelmapper.html#modelReplaced">modelReplaced</a></b></span>()</td></tr>
</table></div>
<!-- @@@model -->
<!-- $$$series-prop$$$series$$$setSeriesQAbstractBarSeries*$$$seriesReplaced -->
<h3 class="fn" id="series-prop"><a name="series-prop"></a><span class="name">series</span> : <span class="type"><a href="qabstractbarseries.html">QAbstractBarSeries</a></span>*</h3>
<p>This property holds the bar series that is used by the mapper.</p>
<p>All the data in the series is discarded when it is set to the mapper. When a new series is specified, the old series is disconnected (but it preserves its data).</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QAbstractBarSeries *</td><td class="memItemRight bottomAlign"><span class="name"><b>series</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSeries</b></span>(QAbstractBarSeries *<i>series</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qhbarmodelmapper.html#seriesReplaced">seriesReplaced</a></b></span>()</td></tr>
</table></div>
<!-- @@@series -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHBarModelMapper[overload1]$$$QHBarModelMapperQObject* -->
<h3 class="fn" id="QHBarModelMapper"><a name="QHBarModelMapper"></a>QHBarModelMapper::<span class="name">QHBarModelMapper</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a mapper object that is a child of <i>parent</i>.</p>
<!-- @@@QHBarModelMapper -->
<!-- $$$columnCountChanged -->
<h3 class="fn" id="columnCountChanged"><a name="columnCountChanged"></a><code>[signal] </code><span class="type">void</span> QHBarModelMapper::<span class="name">columnCountChanged</span>()</h3>
<p>This signal is emitted when the number of columns changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qhbarmodelmapper.html#columnCount-prop">columnCount</a>. </p><!-- @@@columnCountChanged -->
<!-- $$$firstBarSetRowChanged -->
<h3 class="fn" id="firstBarSetRowChanged"><a name="firstBarSetRowChanged"></a><code>[signal] </code><span class="type">void</span> QHBarModelMapper::<span class="name">firstBarSetRowChanged</span>()</h3>
<p>This signal is emitted when the first bar set row changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qhbarmodelmapper.html#firstBarSetRow-prop">firstBarSetRow</a>. </p><!-- @@@firstBarSetRowChanged -->
<!-- $$$firstColumnChanged -->
<h3 class="fn" id="firstColumnChanged"><a name="firstColumnChanged"></a><code>[signal] </code><span class="type">void</span> QHBarModelMapper::<span class="name">firstColumnChanged</span>()</h3>
<p>This signal is emitted when the first column changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qhbarmodelmapper.html#firstColumn-prop">firstColumn</a>. </p><!-- @@@firstColumnChanged -->
<!-- $$$lastBarSetRowChanged -->
<h3 class="fn" id="lastBarSetRowChanged"><a name="lastBarSetRowChanged"></a><code>[signal] </code><span class="type">void</span> QHBarModelMapper::<span class="name">lastBarSetRowChanged</span>()</h3>
<p>This signal is emitted when the last bar set row changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qhbarmodelmapper.html#lastBarSetRow-prop">lastBarSetRow</a>. </p><!-- @@@lastBarSetRowChanged -->
<!-- $$$modelReplaced -->
<h3 class="fn" id="modelReplaced"><a name="modelReplaced"></a><code>[signal] </code><span class="type">void</span> QHBarModelMapper::<span class="name">modelReplaced</span>()</h3>
<p>This signal is emitted when the model that the mapper is connected to changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qhbarmodelmapper.html#model-prop">model</a>. </p><!-- @@@modelReplaced -->
<!-- $$$seriesReplaced -->
<h3 class="fn" id="seriesReplaced"><a name="seriesReplaced"></a><code>[signal] </code><span class="type">void</span> QHBarModelMapper::<span class="name">seriesReplaced</span>()</h3>
<p>This signal is emitted when the series that the mapper is connected to changes.</p>
<p><b>Note:</b> Notifier signal for property <a href="qhbarmodelmapper.html#series-prop">series</a>. </p><!-- @@@seriesReplaced -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 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>