/usr/share/qt5/doc/qtlabscalendar/qml-qt-labs-calendar-calendarmodel.html is in qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickcalendarmodel.cpp -->
<title>CalendarModel QML Type | Qt Labs Calendar 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="qtlabscalendar-index.html">Qt Labs Calendar</a></td><td ><a href="qt-labs-calendar-qmlmodule.html">QML Types</a></td><td >CalendarModel QML Type</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="#methods">Methods</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">CalendarModel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$CalendarModel-brief -->
<p>A calendar model. <a href="#details">More...</a></p>
<!-- @@@CalendarModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt.labs.calendar 1.0</td></tr></table></div><ul>
<li><a href="qml-qt-labs-calendar-calendarmodel-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><b><a href="qml-qt-labs-calendar-calendarmodel.html#from-prop">from</a></b></b> : date</li>
<li class="fn"><b><b><a href="qml-qt-labs-calendar-calendarmodel.html#to-prop">to</a></b></b> : date</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">int <b><b><a href="qml-qt-labs-calendar-calendarmodel.html#indexOf-method-1">indexOf</a></b></b>(int <i>year</i>, int <i>month</i>)</li>
<li class="fn">int <b><b><a href="qml-qt-labs-calendar-calendarmodel.html#indexOf-method">indexOf</a></b></b>(Date <i>date</i>)</li>
<li class="fn">int <b><b><a href="qml-qt-labs-calendar-calendarmodel.html#monthAt-method">monthAt</a></b></b>(int <i>index</i>)</li>
<li class="fn">int <b><b><a href="qml-qt-labs-calendar-calendarmodel.html#yearAt-method">yearAt</a></b></b>(int <i>index</i>)</li>
</ul>
<!-- $$$CalendarModel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qt-labs-calendar-calendarmodel.html">CalendarModel</a> provides a way of creating a range of <a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> instances. It is typically used as a model for a <a href="../qtquick/qml-qtquick-listview.html">ListView</a> that uses <a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> as a delegate.</p>
<pre class="qml">
<span class="type"><a href="../qtquick/qml-qtquick-listview.html">ListView</a></span> {
<span class="name">id</span>: <span class="name">listview</span>
<span class="name">width</span>: <span class="number">200</span>; <span class="name">height</span>: <span class="number">200</span>
<span class="name">snapMode</span>: <span class="name">ListView</span>.<span class="name">SnapOneItem</span>
<span class="name">orientation</span>: <span class="name">ListView</span>.<span class="name">Horizontal</span>
<span class="name">highlightRangeMode</span>: <span class="name">ListView</span>.<span class="name">StrictlyEnforceRange</span>
<span class="name">model</span>: <span class="name">CalendarModel</span> {
<span class="name">from</span>: new <span class="name">Date</span>(<span class="number">2015</span>, <span class="number">0</span>, <span class="number">1</span>)
<span class="name">to</span>: new <span class="name">Date</span>(<span class="number">2015</span>, <span class="number">11</span>, <span class="number">31</span>)
}
<span class="name">delegate</span>: <span class="name">MonthGrid</span> {
<span class="name">width</span>: <span class="name">listview</span>.<span class="name">width</span>
<span class="name">height</span>: <span class="name">listview</span>.<span class="name">height</span>
<span class="name">month</span>: <span class="name">model</span>.<span class="name">month</span>
<span class="name">year</span>: <span class="name">model</span>.<span class="name">year</span>
<span class="name">locale</span>: <span class="name">Qt</span>.<span class="name">locale</span>(<span class="string">"en_US"</span>)
}
<span class="name">ScrollIndicator</span>.horizontal: <span class="name">ScrollIndicator</span> { }
}
</pre>
<p>In addition to the <code>index</code> property, a list of model data roles are available in the context of each delegate:</p>
<div class="table"><table class="generic">
<tr valign="top" class="odd"><td ><b>model.month</b> : int</td><td >The number of the month</td></tr>
<tr valign="top" class="even"><td ><b>model.year</b> : int</td><td >The number of the year</td></tr>
</table></div>
<p>The Qt Labs Calendar module uses 0-based month numbers to be consistent with the JavaScript Date type, that is used by the QML language. This means that <code>Date::getMonth()</code> can be passed to the methods as is. When dealing with month numbers directly, it is highly recommended to use the following enumeration values to avoid confusion.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Calendar.January</code></td><td class="topAlign">January (0)</td></tr>
<tr><td class="topAlign"><code>Calendar.February</code></td><td class="topAlign">February (1)</td></tr>
<tr><td class="topAlign"><code>Calendar.March</code></td><td class="topAlign">March (2)</td></tr>
<tr><td class="topAlign"><code>Calendar.April</code></td><td class="topAlign">April (3)</td></tr>
<tr><td class="topAlign"><code>Calendar.May</code></td><td class="topAlign">May (4)</td></tr>
<tr><td class="topAlign"><code>Calendar.June</code></td><td class="topAlign">June (5)</td></tr>
<tr><td class="topAlign"><code>Calendar.July</code></td><td class="topAlign">July (6)</td></tr>
<tr><td class="topAlign"><code>Calendar.August</code></td><td class="topAlign">August (7)</td></tr>
<tr><td class="topAlign"><code>Calendar.September</code></td><td class="topAlign">September (8)</td></tr>
<tr><td class="topAlign"><code>Calendar.October</code></td><td class="topAlign">October (9)</td></tr>
<tr><td class="topAlign"><code>Calendar.November</code></td><td class="topAlign">November (10)</td></tr>
<tr><td class="topAlign"><code>Calendar.December</code></td><td class="topAlign">December (11)</td></tr>
</table></div>
<p><b>Note: </b><i>Types in Qt.labs modules are not guaranteed to remain compatible in future versions.</i></p><p><b>See also </b><a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> and <a href="qml-qt-labs-calendar-calendar.html">Calendar</a>.</p>
<!-- @@@CalendarModel -->
<h2>Property Documentation</h2>
<!-- $$$from -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="from-prop">
<td class="tblQmlPropNode"><p>
<a name="from-prop"></a><span class="name">from</span> : <span class="type"><a href="../qtqml/qml-date.html">date</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the start date.</p>
</div></div><!-- @@@from -->
<br/>
<!-- $$$to -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="to-prop">
<td class="tblQmlPropNode"><p>
<a name="to-prop"></a><span class="name">to</span> : <span class="type"><a href="../qtqml/qml-date.html">date</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the end date.</p>
</div></div><!-- @@@to -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$indexOf -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="indexOf-method-1">
<td class="tblQmlFuncNode"><p>
<a name="indexOf-method-1"></a><span class="type">int</span> <span class="name">indexOf</span>(<span class="type">int</span> <i>year</i>, <span class="type">int</span> <i>month</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the model index of the specified <i>year</i> and <i>month</i>.</p>
</div></div><!-- @@@indexOf -->
<br/>
<!-- $$$indexOf -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="indexOf-method">
<td class="tblQmlFuncNode"><p>
<a name="indexOf-method"></a><span class="type">int</span> <span class="name">indexOf</span>(<span class="type"><a href="../qtqml/qml-qtqml-date.html">Date</a></span> <i>date</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the model index of the specified <i>date</i>.</p>
</div></div><!-- @@@indexOf -->
<br/>
<!-- $$$monthAt -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="monthAt-method">
<td class="tblQmlFuncNode"><p>
<a name="monthAt-method"></a><span class="type">int</span> <span class="name">monthAt</span>(<span class="type">int</span> <i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the month number at the specified model <i>index</i>.</p>
</div></div><!-- @@@monthAt -->
<br/>
<!-- $$$yearAt -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="yearAt-method">
<td class="tblQmlFuncNode"><p>
<a name="yearAt-method"></a><span class="type">int</span> <span class="name">yearAt</span>(<span class="type">int</span> <i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the year number at the specified model <i>index</i>.</p>
</div></div><!-- @@@yearAt -->
<br/>
</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>
|