qtcharts5-doc-html 5.9.5-0ubuntu1 / usr / share / qt5 / doc / qtcharts / qcandlestickmodelmapper.html

This file is indexed.

/usr/share/qt5/doc/qtcharts/qcandlestickmodelmapper.html is in qtcharts5-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
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcandlestickmodelmapper.cpp -->
  <title>QCandlestickModelMapper Class | Qt Charts 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="qtcharts-index.html">Qt Charts</a></td><td ><a href="qt-charts-module.html">C++ Classes</a></td><td >QCandlestickModelMapper</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="#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="#protected-functions">Protected 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">QCandlestickModelMapper Class</h1>
<!-- $$$QCandlestickModelMapper-brief -->
<p>Abstract model mapper class for candlestick series. <a href="#details">More...</a></p>
<!-- @@@QCandlestickModelMapper -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QCandlestickModelMapper&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign">  Qt 5.8</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qhcandlestickmodelmapper.html">QHCandlestickModelMapper</a> and <a href="qvcandlestickmodelmapper.html">QVCandlestickModelMapper</a></p>
</td></tr></table></div><ul>
<li><a href="qcandlestickmodelmapper-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qcandlestickmodelmapper.html#model-prop">model</a></b> : QAbstractItemModel *</li>
<li class="fn"><b><a href="qcandlestickmodelmapper.html#series-prop">series</a></b> : QCandlestickSeries *</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="qcandlestickmodelmapper.html#QCandlestickModelMapper">QCandlestickModelMapper</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAbstractItemModel *</td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#model-prop">model</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual Qt::Orientation </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#orientation">orientation</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCandlestickSeries *</td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#series-prop">series</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.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="qcandlestickmodelmapper.html#series-prop">setSeries</a></b>(QCandlestickSeries *<i>series</i>)</td></tr>
</table></div>
<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="qcandlestickmodelmapper.html#modelReplaced">modelReplaced</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#seriesReplaced">seriesReplaced</a></b>()</td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#close">close</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#firstSetSection">firstSetSection</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#high">high</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#lastSetSection">lastSetSection</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#low">low</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#open">open</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setClose">setClose</a></b>(int <i>close</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setFirstSetSection">setFirstSetSection</a></b>(int <i>firstSetSection</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setHigh">setHigh</a></b>(int <i>high</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setLastSetSection">setLastSetSection</a></b>(int <i>lastSetSection</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setLow">setLow</a></b>(int <i>low</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setOpen">setOpen</a></b>(int <i>open</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#setTimestamp">setTimestamp</a></b>(int <i>timestamp</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcandlestickmodelmapper.html#timestamp">timestamp</a></b>() const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QCandlestickModelMapper-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Abstract model mapper class for candlestick series.</p>
<p>Model mappers allow the use of a QAbstractItemModel-derived model as a data source for a chart series, creating a connection between a <a href="qcandlestickseries.html">QCandlestickSeries</a> and the model object. A model mapper maintains an equal size across all <a href="qcandlestickset.html">QCandlestickSets</a>.</p>
<p><b>Note: </b>The model used must support adding and removing rows/columns and modifying the data of the cells.</p></div>
<!-- @@@QCandlestickModelMapper -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$model-prop$$$model$$$setModelQAbstractItemModel*$$$modelReplaced -->
<h3 class="fn" id="model-prop"><a name="model-prop"></a><span class="name">model</span> : <span class="type">QAbstractItemModel</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="qcandlestickmodelmapper.html#modelReplaced">modelReplaced</a></b></span>()</td></tr>
</table></div>
<!-- @@@model -->
<!-- $$$series-prop$$$series$$$setSeriesQCandlestickSeries*$$$seriesReplaced -->
<h3 class="fn" id="series-prop"><a name="series-prop"></a><span class="name">series</span> : <span class="type"><a href="qcandlestickseries.html">QCandlestickSeries</a></span> *</h3>
<p>Defines the <a href="qcandlestickseries.html">QCandlestickSeries</a> object that is used by the mapper.</p>
<p><b>Note: </b>All data in the series is discarded when it is set to the mapper. When a new series is specified, the old series is disconnected (preserving its data).</p><p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QCandlestickSeries *</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>(QCandlestickSeries *<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="qcandlestickmodelmapper.html#seriesReplaced">seriesReplaced</a></b></span>()</td></tr>
</table></div>
<!-- @@@series -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCandlestickModelMapper[overload1]$$$QCandlestickModelMapperQObject* -->
<h3 class="fn" id="QCandlestickModelMapper"><a name="QCandlestickModelMapper"></a>QCandlestickModelMapper::<span class="name">QCandlestickModelMapper</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a model mapper object as a child of <i>parent</i>.</p>
<!-- @@@QCandlestickModelMapper -->
<!-- $$$close[overload1]$$$close -->
<h3 class="fn" id="close"><a name="close"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">close</span>() const</h3>
<p>Returns the row/column of the model that contains the close values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setClose">setClose</a>().</p>
<!-- @@@close -->
<!-- $$$firstSetSection[overload1]$$$firstSetSection -->
<h3 class="fn" id="firstSetSection"><a name="firstSetSection"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">firstSetSection</span>() const</h3>
<p>Returns the section of the model that is used as the data source for the first candlestick set. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setFirstSetSection">setFirstSetSection</a>().</p>
<!-- @@@firstSetSection -->
<!-- $$$high[overload1]$$$high -->
<h3 class="fn" id="high"><a name="high"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">high</span>() const</h3>
<p>Returns the row/column of the model that contains the high values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setHigh">setHigh</a>().</p>
<!-- @@@high -->
<!-- $$$lastSetSection[overload1]$$$lastSetSection -->
<h3 class="fn" id="lastSetSection"><a name="lastSetSection"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">lastSetSection</span>() const</h3>
<p>Returns the section of the model that is used as the data source for the last candlestick set. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setLastSetSection">setLastSetSection</a>().</p>
<!-- @@@lastSetSection -->
<!-- $$$low[overload1]$$$low -->
<h3 class="fn" id="low"><a name="low"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">low</span>() const</h3>
<p>Returns the row/column of the model that contains the low values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setLow">setLow</a>().</p>
<!-- @@@low -->
<!-- $$$modelReplaced -->
<h3 class="fn" id="modelReplaced"><a name="modelReplaced"></a><code>[signal] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">modelReplaced</span>()</h3>
<p>Emitted when the model, to which the mapper is connected, has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qcandlestickmodelmapper.html#model-prop">model</a>. </p><p><b>See also </b><a href="qcandlestickmodelmapper.html#model-prop">model</a>.</p>
<!-- @@@modelReplaced -->
<!-- $$$open[overload1]$$$open -->
<h3 class="fn" id="open"><a name="open"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">open</span>() const</h3>
<p>Returns the row/column of the model that contains the open values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setOpen">setOpen</a>().</p>
<!-- @@@open -->
<!-- $$$orientation[overload1]$$$orientation -->
<h3 class="fn" id="orientation"><a name="orientation"></a><code>[pure virtual] </code><span class="type">Qt::Orientation</span> QCandlestickModelMapper::<span class="name">orientation</span>() const</h3>
<p>Returns the orientation that is used when <a href="qcandlestickmodelmapper.html">QCandlestickModelMapper</a> accesses the model. This determines whether the consecutive values of the set are read from rows (Qt::Horizontal) or from columns (Qt::Vertical).</p>
<!-- @@@orientation -->
<!-- $$$seriesReplaced -->
<h3 class="fn" id="seriesReplaced"><a name="seriesReplaced"></a><code>[signal] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">seriesReplaced</span>()</h3>
<p>Emitted when the series to which mapper is connected to has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qcandlestickmodelmapper.html#series-prop">series</a>. </p><p><b>See also </b><a href="qcandlestickmodelmapper.html#series-prop">series</a>.</p>
<!-- @@@seriesReplaced -->
<!-- $$$setClose[overload1]$$$setCloseint -->
<h3 class="fn" id="setClose"><a name="setClose"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setClose</span>(<span class="type">int</span> <i>close</i>)</h3>
<p>Sets the row/column of the model that contains the <i>close</i> values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#close">close</a>().</p>
<!-- @@@setClose -->
<!-- $$$setFirstSetSection[overload1]$$$setFirstSetSectionint -->
<h3 class="fn" id="setFirstSetSection"><a name="setFirstSetSection"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setFirstSetSection</span>(<span class="type">int</span> <i>firstSetSection</i>)</h3>
<p>Sets the section of the model that is used as the data source for the first candlestick set. Parameter <i>firstSetSection</i> specifies the section of the model. Default value is -1.</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#firstSetSection">firstSetSection</a>().</p>
<!-- @@@setFirstSetSection -->
<!-- $$$setHigh[overload1]$$$setHighint -->
<h3 class="fn" id="setHigh"><a name="setHigh"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setHigh</span>(<span class="type">int</span> <i>high</i>)</h3>
<p>Sets the row/column of the model that contains the <i>high</i> values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#high">high</a>().</p>
<!-- @@@setHigh -->
<!-- $$$setLastSetSection[overload1]$$$setLastSetSectionint -->
<h3 class="fn" id="setLastSetSection"><a name="setLastSetSection"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setLastSetSection</span>(<span class="type">int</span> <i>lastSetSection</i>)</h3>
<p>Sets the section of the model that is used as the data source for the last candlestick set. Parameter <i>lastSetSection</i> specifies the section of the model. Default value is -1.</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#lastSetSection">lastSetSection</a>().</p>
<!-- @@@setLastSetSection -->
<!-- $$$setLow[overload1]$$$setLowint -->
<h3 class="fn" id="setLow"><a name="setLow"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setLow</span>(<span class="type">int</span> <i>low</i>)</h3>
<p>Sets the row/column of the model that contains the <i>low</i> values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#low">low</a>().</p>
<!-- @@@setLow -->
<!-- $$$setOpen[overload1]$$$setOpenint -->
<h3 class="fn" id="setOpen"><a name="setOpen"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setOpen</span>(<span class="type">int</span> <i>open</i>)</h3>
<p>Sets the row/column of the model that contains the <i>open</i> values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#open">open</a>().</p>
<!-- @@@setOpen -->
<!-- $$$setTimestamp[overload1]$$$setTimestampint -->
<h3 class="fn" id="setTimestamp"><a name="setTimestamp"></a><code>[protected] </code><span class="type">void</span> QCandlestickModelMapper::<span class="name">setTimestamp</span>(<span class="type">int</span> <i>timestamp</i>)</h3>
<p>Sets the row/column of the model that contains the <i>timestamp</i> values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#timestamp">timestamp</a>().</p>
<!-- @@@setTimestamp -->
<!-- $$$timestamp[overload1]$$$timestamp -->
<h3 class="fn" id="timestamp"><a name="timestamp"></a><code>[protected] </code><span class="type">int</span> QCandlestickModelMapper::<span class="name">timestamp</span>() const</h3>
<p>Returns the row/column of the model that contains the timestamp values of the sets in the series. Default value is -1 (invalid mapping).</p>
<p><b>See also </b><a href="qcandlestickmodelmapper.html#setTimestamp">setTimestamp</a>().</p>
<!-- @@@timestamp -->
</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>

APT Browse - Built by Thomas Orozco.