<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickmonthgrid.cpp -->
<title>MonthGrid QML Type | Qt Labs Controls 5.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
window.onload = function(){document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");};
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.6</td><td ><a href="qtlabscontrols-index.html">Qt Labs Controls</a></td><td ><a href="qt-labs-controls-qmlmodule.html">QML Types</a></td><td >MonthGrid QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.6.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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">MonthGrid QML Type</h1>
<span class="subtitle"></span>
<!-- $$$MonthGrid-brief -->
<p>A grid of days for a calendar month. <a href="#details">More...</a></p>
<!-- @@@MonthGrid -->
<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><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt-labs-controls-control.html">Control</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt-labs-calendar-monthgrid-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-monthgrid.html#delegate-prop">delegate</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qt-labs-calendar-monthgrid.html#month-prop">month</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt-labs-calendar-monthgrid.html#title-prop">title</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qt-labs-calendar-monthgrid.html#year-prop">year</a></b></b> : int</li>
</ul>
<!-- $$$MonthGrid-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> presents a calendar month in a grid. The contents are calculated for a given <a href="qml-qt-labs-calendar-monthgrid.html#month-prop">month</a> and <a href="qml-qt-labs-calendar-monthgrid.html#year-prop">year</a>, using the specified <a href="qml-qt-labs-controls-control.html#locale-prop">locale</a>.</p>
<p class="centerAlign"><img src="images/qtlabscalendar-monthgrid.png" alt="" /></p><pre class="qml">
<span class="type"><a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a></span> {
<span class="name">month</span>: <span class="name">Calendar</span>.<span class="name">December</span>
<span class="name">year</span>: <span class="number">2015</span>
<span class="name">locale</span>: <span class="name">Qt</span>.<span class="name">locale</span>(<span class="string">"en_US"</span>)
}
</pre>
<p><a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> can be used as a standalone control, but it is most often used in conjunction with <a href="qml-qt-labs-calendar-dayofweekrow.html">DayOfWeekRow</a> and <a href="qml-qt-labs-calendar-weeknumbercolumn.html">WeekNumberColumn</a>. Regardless of the use case, positioning of the grid is left to the user.</p>
<p class="centerAlign"><img src="images/qtlabscalendar-monthgrid-layout.png" alt="" /></p><pre class="qml">
<span class="type">GridLayout</span> {
<span class="name">columns</span>: <span class="number">2</span>
<span class="type"><a href="qml-qt-labs-calendar-dayofweekrow.html">DayOfWeekRow</a></span> {
<span class="name">locale</span>: <span class="name">grid</span>.<span class="name">locale</span>
<span class="name">Layout</span>.column: <span class="number">1</span>
<span class="name">Layout</span>.fillWidth: <span class="number">true</span>
}
<span class="type"><a href="qml-qt-labs-calendar-weeknumbercolumn.html">WeekNumberColumn</a></span> {
<span class="name">month</span>: <span class="name">grid</span>.<span class="name">month</span>
<span class="name">year</span>: <span class="name">grid</span>.<span class="name">year</span>
<span class="name">locale</span>: <span class="name">grid</span>.<span class="name">locale</span>
<span class="name">Layout</span>.fillHeight: <span class="number">true</span>
}
<span class="type"><a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a></span> {
<span class="name">id</span>: <span class="name">grid</span>
<span class="name">month</span>: <span class="name">Calendar</span>.<span class="name">December</span>
<span class="name">year</span>: <span class="number">2015</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">Layout</span>.fillWidth: <span class="number">true</span>
<span class="name">Layout</span>.fillHeight: <span class="number">true</span>
}
}
</pre>
<p>The visual appearance of <a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> can be changed by implementing a <a href="qtlabscontrols-customize.html#delegate">custom delegate</a>.</p>
<p><b>Note: </b><i>Types in the Qt.labs module are not guaranteed to remain compatible in future versions.</i></p><p><b>See also </b><a href="qml-qt-labs-calendar-dayofweekrow.html">DayOfWeekRow</a>, <a href="qml-qt-labs-calendar-weeknumbercolumn.html">WeekNumberColumn</a>, and <a href="qml-qt-labs-calendar-calendarmodel.html">CalendarModel</a>.</p>
<!-- @@@MonthGrid -->
<h2>Property Documentation</h2>
<!-- $$$delegate -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="delegate-prop">
<td class="tblQmlPropNode"><p>
<a name="delegate-prop"></a><span class="name">delegate</span> : <span class="type">Component</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the item delegate that visualizes each day.</p>
<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.date</b> : date</td><td >The date of the cell</td></tr>
<tr valign="top" class="even"><td ><b>model.day</b> : int</td><td >The number of the day</td></tr>
<tr valign="top" class="odd"><td ><b>model.today</b> : bool</td><td >Whether the delegate represents today</td></tr>
<tr valign="top" class="even"><td ><b>model.weekNumber</b> : int</td><td >The week number</td></tr>
<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 following snippet presents the default implementation of the item delegate. It can be used as a starting point for implementing custom delegates.</p>
<pre class="qml">
<span class="name">delegate</span>: <span class="name">Text</span> {
<span class="name">horizontalAlignment</span>: <span class="name">Text</span>.<span class="name">AlignHCenter</span>
<span class="name">verticalAlignment</span>: <span class="name">Text</span>.<span class="name">AlignVCenter</span>
<span class="name">opacity</span>: <span class="name">model</span>.<span class="name">month</span> <span class="operator">===</span> <span class="name">control</span>.<span class="name">month</span> ? <span class="number">1</span> : <span class="number">0</span>
<span class="name">text</span>: <span class="name">model</span>.<span class="name">day</span>
<span class="name">font</span>: <span class="name">control</span>.<span class="name">font</span>
}
</pre>
</div></div><!-- @@@delegate -->
<br/>
<!-- $$$month -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="month-prop">
<td class="tblQmlPropNode"><p>
<a name="month-prop"></a><span class="name">month</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the number of the month. The default value is the current month.</p>
<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 assigned to this property as is. When dealing with 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>See also </b><a href="qml-qt-labs-calendar-calendar.html">Calendar</a>.</p>
</div></div><!-- @@@month -->
<br/>
<!-- $$$title -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="title-prop">
<td class="tblQmlPropNode"><p>
<a name="title-prop"></a><span class="name">title</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a title for the calendar.</p>
<p>This property is provided for convenience. <a href="qml-qt-labs-calendar-monthgrid.html">MonthGrid</a> itself does not visualize the title. The default value consists of the month name, formatted using <a href="qml-qt-labs-controls-control.html#locale-prop">locale</a>, and the year number.</p>
</div></div><!-- @@@title -->
<br/>
<!-- $$$year -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="year-prop">
<td class="tblQmlPropNode"><p>
<a name="year-prop"></a><span class="name">year</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the number of the year.</p>
<p>The value must be in the range from <code>-271820</code> to <code>275759</code>. The default value is the current year.</p>
</div></div><!-- @@@year -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2016 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>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
886c2ed147b4d6954d2d9fb23759f3ff
>
files
>
185
