aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/calendar
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@qt.io>2016-06-29 14:27:54 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2016-08-09 15:25:39 +0000
commit3a07d1b2e102826f13c80361fe5491ec44c173a6 (patch)
treec9fa599ca1aadf169708f9663086c0db7f10e57e /src/imports/calendar
parent45de496a54202b41c0c2f7b519cebc0788b82df0 (diff)
Restructure the docs to separate the experimental labs QML types
Including the experimental Qt Labs Calendar docs to qqc2.qdocconf leads to Qt Creator's help contents being mixed with QML types from both modules. Move the Qt Labs Calendar to its own .qdocconf the same way it's done for Qt Labs Platform, and just link to both from the index page. This also ensures that the index-search offers "Calendar" from "Qt Quick Controls (1)" and "Qt Labs Calendar" instead of "Qt Quick Controls 2". Change-Id: Iaf5e7df6d3013657c774d65bf76fb7bc2f80aa71 Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/imports/calendar')
-rw-r--r--src/imports/calendar/calendar.pro2
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.pngbin0 -> 5724 bytes
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.pngbin0 -> 7455 bytes
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.pngbin0 -> 2017 bytes
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.pngbin0 -> 8876 bytes
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-monthgrid.pngbin0 -> 3827 bytes
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.pngbin0 -> 4986 bytes
-rw-r--r--src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.pngbin0 -> 1453 bytes
-rw-r--r--src/imports/calendar/doc/qtlabscalendar.qdocconf37
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml57
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml47
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml35
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml61
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml37
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml49
-rw-r--r--src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml37
16 files changed, 362 insertions, 0 deletions
diff --git a/src/imports/calendar/calendar.pro b/src/imports/calendar/calendar.pro
index 8e9446cc..981860b5 100644
--- a/src/imports/calendar/calendar.pro
+++ b/src/imports/calendar/calendar.pro
@@ -7,6 +7,8 @@ QT_PRIVATE += core-private gui-private qml-private quick-private quicktemplates2
DEFINES += QT_NO_CAST_TO_ASCII QT_NO_CAST_FROM_ASCII
+QMAKE_DOCS = $$PWD/doc/qtlabscalendar.qdocconf
+
OTHER_FILES += \
qmldir
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.png b/src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.png
new file mode 100644
index 00000000..7a140d27
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-calendarmodel.png
Binary files differ
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.png b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.png
new file mode 100644
index 00000000..130e3757
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow-layout.png
Binary files differ
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.png b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.png
new file mode 100644
index 00000000..6c8424ab
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-dayofweekrow.png
Binary files differ
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.png b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.png
new file mode 100644
index 00000000..dd903650
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid-layout.png
Binary files differ
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-monthgrid.png b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid.png
new file mode 100644
index 00000000..0c3b3c41
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-monthgrid.png
Binary files differ
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.png b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.png
new file mode 100644
index 00000000..b015a3e6
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn-layout.png
Binary files differ
diff --git a/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.png b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.png
new file mode 100644
index 00000000..65e25b29
--- /dev/null
+++ b/src/imports/calendar/doc/images/qtlabscalendar-weeknumbercolumn.png
Binary files differ
diff --git a/src/imports/calendar/doc/qtlabscalendar.qdocconf b/src/imports/calendar/doc/qtlabscalendar.qdocconf
new file mode 100644
index 00000000..0e230aa1
--- /dev/null
+++ b/src/imports/calendar/doc/qtlabscalendar.qdocconf
@@ -0,0 +1,37 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project = QtLabsCalendar
+description = Qt Labs Calendar Reference Documentation
+version = $QT_VERSION
+
+qhp.projects = QtLabsCalendar
+
+qhp.QtLabsCalendar.file = qtlabscalendar.qhp
+qhp.QtLabsCalendar.namespace = org.qt-project.qtlabscalendar.$QT_VERSION_TAG
+qhp.QtLabsCalendar.virtualFolder = qtlabscalendar
+qhp.QtLabsCalendar.indexTitle = Qt Labs Calendar
+qhp.QtLabsCalendar.indexRoot =
+
+qhp.QtLabsCalendar.filterAttributes = qtlabscalendar $QT_VERSION qtrefdoc
+qhp.QtLabsCalendar.customFilters.Qt.name = QtLabsCalendar $QT_VERSION
+qhp.QtLabsCalendar.customFilters.Qt.filterAttributes = qtlabscalendar $QT_VERSION
+
+qhp.QtLabsCalendar.subprojects = qmltypes
+qhp.QtLabsCalendar.subprojects.qmltypes.title = QML Types
+qhp.QtLabsCalendar.subprojects.qmltypes.indexTitle = Qt Labs Calendar QML Types
+qhp.QtLabsCalendar.subprojects.qmltypes.selectors = qmlclass
+qhp.QtLabsCalendar.subprojects.qmltypes.sortPages = true
+
+depends = qtcore qtgui qtdoc qtqml qtquick qtquickcontrols2
+
+headerdirs += ../
+sourcedirs += ../ src
+exampledirs += ../ snippets
+imagedirs += images
+
+navigation.landingpage = "Qt Labs Calendar"
+navigation.qmltypespage = "Qt Labs Calendar QML Types"
+
+tagfile = qtlabscalendar.tags
+
+macro.labs = "\\note \\e{Types in Qt.labs modules are not guaranteed to remain compatible in future versions.}"
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml
new file mode 100644
index 00000000..37a6ced7
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-calendarmodel.qml
@@ -0,0 +1,57 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import Qt.labs.calendar 1.0
+import QtQuick.Controls 2.1
+
+//! [1]
+ListView {
+ id: listview
+
+ width: 200; height: 200
+ snapMode: ListView.SnapOneItem
+ orientation: ListView.Horizontal
+ highlightRangeMode: ListView.StrictlyEnforceRange
+
+ model: CalendarModel {
+ from: new Date(2015, 0, 1)
+ to: new Date(2015, 11, 31)
+ }
+
+ delegate: MonthGrid {
+ width: listview.width
+ height: listview.height
+
+ month: model.month
+ year: model.year
+ locale: Qt.locale("en_US")
+ }
+
+ ScrollIndicator.horizontal: ScrollIndicator { }
+}
+//! [1]
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml
new file mode 100644
index 00000000..ce41d224
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow-layout.qml
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import QtQuick.Layouts 1.0
+import Qt.labs.calendar 1.0
+
+//! [1]
+ColumnLayout {
+ DayOfWeekRow {
+ locale: grid.locale
+ Layout.fillWidth: true
+ }
+
+ MonthGrid {
+ id: grid
+ month: Calendar.December
+ year: 2015
+ locale: Qt.locale("en_US")
+ Layout.fillWidth: true
+ }
+}
+//! [1]
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml
new file mode 100644
index 00000000..5ea3714c
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-dayofweekrow.qml
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import Qt.labs.calendar 1.0
+
+//! [1]
+DayOfWeekRow {
+ locale: Qt.locale("en_US")
+}
+//! [1]
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml
new file mode 100644
index 00000000..346e6099
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid-layout.qml
@@ -0,0 +1,61 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import QtQuick.Layouts 1.0
+import Qt.labs.calendar 1.0
+
+//! [1]
+GridLayout {
+ columns: 2
+
+ DayOfWeekRow {
+ locale: grid.locale
+
+ Layout.column: 1
+ Layout.fillWidth: true
+ }
+
+ WeekNumberColumn {
+ month: grid.month
+ year: grid.year
+ locale: grid.locale
+
+ Layout.fillHeight: true
+ }
+
+ MonthGrid {
+ id: grid
+ month: Calendar.December
+ year: 2015
+ locale: Qt.locale("en_US")
+
+ Layout.fillWidth: true
+ Layout.fillHeight: true
+ }
+}
+//! [1]
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml
new file mode 100644
index 00000000..16f872b8
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-monthgrid.qml
@@ -0,0 +1,37 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import Qt.labs.calendar 1.0
+
+//! [1]
+MonthGrid {
+ month: Calendar.December
+ year: 2015
+ locale: Qt.locale("en_US")
+}
+//! [1]
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml
new file mode 100644
index 00000000..d105553f
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn-layout.qml
@@ -0,0 +1,49 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import QtQuick.Layouts 1.0
+import Qt.labs.calendar 1.0
+
+//! [1]
+RowLayout {
+ WeekNumberColumn {
+ month: grid.month
+ year: grid.year
+ locale: grid.locale
+ Layout.fillHeight: true
+ }
+
+ MonthGrid {
+ id: grid
+ month: Calendar.December
+ year: 2015
+ locale: Qt.locale("en_US")
+ Layout.fillHeight: true
+ }
+}
+//! [1]
diff --git a/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml
new file mode 100644
index 00000000..e58e5c7b
--- /dev/null
+++ b/src/imports/calendar/doc/snippets/qtlabscalendar-weeknumbercolumn.qml
@@ -0,0 +1,37 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import Qt.labs.calendar 1.0
+
+//! [1]
+WeekNumberColumn {
+ month: Calendar.December
+ year: 2015
+ locale: Qt.locale("en_US")
+}
+//! [1]