diff options
author | J-P Nurmi <jpnurmi@theqtcompany.com> | 2016-01-14 12:59:43 +0100 |
---|---|---|
committer | J-P Nurmi <jpnurmi@theqtcompany.com> | 2016-01-19 14:22:15 +0000 |
commit | 60e91559dddb5d75dc308986b009bc82e7a0080c (patch) | |
tree | 24410dce1dce3f288a781713e1419b1eb3708497 | |
parent | d690010c3ab0780cffb341b185a0e29edb80c678 (diff) |
Docs: add notes about the Qt.labs module
Change-Id: I65c37f661689bf30e7a9119bb877dce68eeb634c
Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
46 files changed, 92 insertions, 0 deletions
diff --git a/src/imports/calendar/qquickcalendarmodel.cpp b/src/imports/calendar/qquickcalendarmodel.cpp index 832513d7..6b59d45a 100644 --- a/src/imports/calendar/qquickcalendarmodel.cpp +++ b/src/imports/calendar/qquickcalendarmodel.cpp @@ -60,6 +60,8 @@ QT_BEGIN_NAMESPACE \row \li \b model.year : int \li The number of the year \endtable + \labs + \sa MonthGrid */ diff --git a/src/imports/calendar/qquickdayofweekrow.cpp b/src/imports/calendar/qquickdayofweekrow.cpp index 8788ac95..76bcf5df 100644 --- a/src/imports/calendar/qquickdayofweekrow.cpp +++ b/src/imports/calendar/qquickdayofweekrow.cpp @@ -64,6 +64,8 @@ QT_BEGIN_NAMESPACE The visual appearance of DayOfWeekRow can be changed by implementing a \l {delegate}{custom delegate}. + \labs + \sa MonthGrid, WeekNumberColumn */ diff --git a/src/imports/calendar/qquickmonthgrid.cpp b/src/imports/calendar/qquickmonthgrid.cpp index a3a58eab..fd2909f8 100644 --- a/src/imports/calendar/qquickmonthgrid.cpp +++ b/src/imports/calendar/qquickmonthgrid.cpp @@ -68,6 +68,8 @@ QT_BEGIN_NAMESPACE The visual appearance of MonthGrid can be changed by implementing a \l {delegate}{custom delegate}. + \labs + \sa DayOfWeekRow, WeekNumberColumn, CalendarModel */ diff --git a/src/imports/calendar/qquickweeknumbercolumn.cpp b/src/imports/calendar/qquickweeknumbercolumn.cpp index 04890411..3e8f1a6b 100644 --- a/src/imports/calendar/qquickweeknumbercolumn.cpp +++ b/src/imports/calendar/qquickweeknumbercolumn.cpp @@ -66,6 +66,8 @@ QT_BEGIN_NAMESPACE The visual appearance of WeekNumberColumn can be changed by implementing a \l {delegate}{custom delegate}. + \labs + \sa MonthGrid, DayOfWeekRow */ diff --git a/src/imports/controls/doc/qtlabscontrols.qdocconf b/src/imports/controls/doc/qtlabscontrols.qdocconf index df004294..cfd5ec55 100644 --- a/src/imports/controls/doc/qtlabscontrols.qdocconf +++ b/src/imports/controls/doc/qtlabscontrols.qdocconf @@ -60,3 +60,5 @@ macro.styleimport.HTML = "<table class=\"alignedsummary\"><tbody><tr><td class=\ # \endstyleproperty macro.styleproperty.HTML = "<div class=\"qmlproto\"><table class=\"qmlname\"><tbody><tr valign=\"top\" class=\"odd\" id=\"\3\"><td class=\"tblQmlPropNode\"><p><span class=\"name\">\1</span> : <span class=\"type\">\2</span></p></td></tr></tbody></table></div>" macro.endstyleproperty = "\\br" + +macro.labs = "\\note \\e{Types in the Qt.labs module are not guaranteed to remain compatible in future versions.}" diff --git a/src/imports/controls/doc/src/qtlabscontrols-material.qdoc b/src/imports/controls/doc/src/qtlabscontrols-material.qdoc index f9b6a008..2de27f18 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-material.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-material.qdoc @@ -123,6 +123,8 @@ of explicit Material style-specific references, the Material style must be deployed with the application. + \labs + \section1 Attached Property Documentation \styleproperty {Material.accent} {color} {accent-attached-prop} diff --git a/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc b/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc index 3c616d84..bf3dcfdc 100644 --- a/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc @@ -124,6 +124,8 @@ of explicit Universal style-specific references, the Universal style must be deployed with the application. + \labs + \section1 Attached Property Documentation \styleproperty {Universal.accent} {color} {accent-attached-prop} diff --git a/src/imports/controls/doc/src/qtlabscontrols.qdoc b/src/imports/controls/doc/src/qtlabscontrols.qdoc index 10476f08..17e93a44 100644 --- a/src/imports/controls/doc/src/qtlabscontrols.qdoc +++ b/src/imports/controls/doc/src/qtlabscontrols.qdoc @@ -49,6 +49,8 @@ import Qt.labs.calendar 1.0 \endcode + \labs + \section1 QML Types \section2 Qt.labs.controls Module diff --git a/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc b/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc index 84eabe44..0f7f7d86 100644 --- a/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc +++ b/src/imports/controls/doc/src/templates/qtlabstemplates.qdoc @@ -41,6 +41,8 @@ import Qt.labs.templates 1.0 as T \endcode + \labs + For the sake of clarity, there is a one-to-one mapping between the types provided by the \c Qt.labs.templates and \c Qt.labs.controls imports. For every type available in the \c Qt.labs.controls import, a non-visual template diff --git a/src/templates/qquickabstractbutton.cpp b/src/templates/qquickabstractbutton.cpp index d2f1c7ec..fe39a4e5 100644 --- a/src/templates/qquickabstractbutton.cpp +++ b/src/templates/qquickabstractbutton.cpp @@ -62,6 +62,8 @@ static const int AUTO_REPEAT_INTERVAL = 100; implementations, leaving them to the types that derive from it. TODO: ButtonGroup usage + + \labs */ /*! diff --git a/src/templates/qquickapplicationwindow.cpp b/src/templates/qquickapplicationwindow.cpp index 71adf87e..7d58ba16 100644 --- a/src/templates/qquickapplicationwindow.cpp +++ b/src/templates/qquickapplicationwindow.cpp @@ -81,6 +81,8 @@ QT_BEGIN_NAMESPACE \note By default, an ApplicationWindow is not visible. + \labs + \sa Page, {Container Controls} */ diff --git a/src/templates/qquickbusyindicator.cpp b/src/templates/qquickbusyindicator.cpp index 8751ef7c..381ac5c7 100644 --- a/src/templates/qquickbusyindicator.cpp +++ b/src/templates/qquickbusyindicator.cpp @@ -60,6 +60,8 @@ QT_BEGIN_NAMESPACE } \endqml + \labs + \sa {Customizing BusyIndicator}, {Indicator Controls} */ diff --git a/src/templates/qquickbutton.cpp b/src/templates/qquickbutton.cpp index b323cb0b..1e40ec05 100644 --- a/src/templates/qquickbutton.cpp +++ b/src/templates/qquickbutton.cpp @@ -80,6 +80,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing Button}, {Button Controls} */ diff --git a/src/templates/qquickbuttongroup.cpp b/src/templates/qquickbuttongroup.cpp index 6fddcbc4..0865277e 100644 --- a/src/templates/qquickbuttongroup.cpp +++ b/src/templates/qquickbuttongroup.cpp @@ -119,6 +119,8 @@ QT_BEGIN_NAMESPACE More advanced use cases can be handled using the addButton() and removeButton() methods. + \labs + \sa RadioButton */ diff --git a/src/templates/qquickcheckbox.cpp b/src/templates/qquickcheckbox.cpp index 9a416419..644e151e 100644 --- a/src/templates/qquickcheckbox.cpp +++ b/src/templates/qquickcheckbox.cpp @@ -80,6 +80,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing CheckBox}, {Button Controls} */ diff --git a/src/templates/qquickcombobox.cpp b/src/templates/qquickcombobox.cpp index c079b1e3..aa1ecec8 100644 --- a/src/templates/qquickcombobox.cpp +++ b/src/templates/qquickcombobox.cpp @@ -98,6 +98,8 @@ QT_BEGIN_NAMESPACE \l textRole is not defined, ComboBox is unable to visualize it and throws a \c {ReferenceError: modelData is not defined}. + \labs + \sa {Customizing ComboBox}, {Input Controls} */ diff --git a/src/templates/qquickcontainer.cpp b/src/templates/qquickcontainer.cpp index 90c46e14..841eae8a 100644 --- a/src/templates/qquickcontainer.cpp +++ b/src/templates/qquickcontainer.cpp @@ -51,6 +51,8 @@ QT_BEGIN_NAMESPACE Container is the base type of container-like user interface controls. + \labs + \sa {Container Controls} */ diff --git a/src/templates/qquickcontrol.cpp b/src/templates/qquickcontrol.cpp index d1abafe2..6bedfe3f 100644 --- a/src/templates/qquickcontrol.cpp +++ b/src/templates/qquickcontrol.cpp @@ -63,6 +63,8 @@ QT_BEGIN_NAMESPACE \brief A user interface control. Control is the base type of user interface controls. + + \labs */ QQuickControlPrivate::QQuickControlPrivate() : diff --git a/src/templates/qquickdial.cpp b/src/templates/qquickdial.cpp index dcc2b293..e476db9e 100644 --- a/src/templates/qquickdial.cpp +++ b/src/templates/qquickdial.cpp @@ -70,6 +70,8 @@ QT_BEGIN_NAMESPACE \row \li Set \l value to \l to \li \c Qt.Key_End \endtable + \labs + \sa {Customizing Dial}, {Input Controls} */ diff --git a/src/templates/qquickdrawer.cpp b/src/templates/qquickdrawer.cpp index ca6c8c13..5f3d95c9 100644 --- a/src/templates/qquickdrawer.cpp +++ b/src/templates/qquickdrawer.cpp @@ -80,6 +80,8 @@ QT_BEGIN_NAMESPACE If you would like the application's contents to stay where they are when the drawer is opened, don't apply a translation. + \labs + \sa SwipeView, {Customizing Drawer}, {Navigation Controls}, {Container Controls} */ diff --git a/src/templates/qquickframe.cpp b/src/templates/qquickframe.cpp index 386aa5fb..67dfe256 100644 --- a/src/templates/qquickframe.cpp +++ b/src/templates/qquickframe.cpp @@ -60,6 +60,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-frame.qml 1 + \labs + \sa {Customizing Frame}, {Container Controls} */ diff --git a/src/templates/qquickgroupbox.cpp b/src/templates/qquickgroupbox.cpp index ef8789a5..84944987 100644 --- a/src/templates/qquickgroupbox.cpp +++ b/src/templates/qquickgroupbox.cpp @@ -75,6 +75,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-groupbox-checkable.qml 1 + \labs + \sa CheckBox, {Customizing GroupBox}, {Container Controls} */ diff --git a/src/templates/qquickitemdelegate.cpp b/src/templates/qquickitemdelegate.cpp index 7e13b638..f25a117f 100644 --- a/src/templates/qquickitemdelegate.cpp +++ b/src/templates/qquickitemdelegate.cpp @@ -54,6 +54,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-itemdelegate.qml 1 + \labs + \sa {Customizing ItemDelegate} */ diff --git a/src/templates/qquicklabel.cpp b/src/templates/qquicklabel.cpp index d2c86037..13ff3a6e 100644 --- a/src/templates/qquicklabel.cpp +++ b/src/templates/qquicklabel.cpp @@ -65,6 +65,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-label.qml 1 + \labs + \sa {Customizing Label} */ diff --git a/src/templates/qquickmenu.cpp b/src/templates/qquickmenu.cpp index d08583f3..585d758d 100644 --- a/src/templates/qquickmenu.cpp +++ b/src/templates/qquickmenu.cpp @@ -85,6 +85,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing Menu}, {Menu Controls} */ diff --git a/src/templates/qquickmenuitem.cpp b/src/templates/qquickmenuitem.cpp index f6cfda4c..d784af02 100644 --- a/src/templates/qquickmenuitem.cpp +++ b/src/templates/qquickmenuitem.cpp @@ -75,6 +75,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing MenuItem}, {Menu Controls} */ diff --git a/src/templates/qquickpageindicator.cpp b/src/templates/qquickpageindicator.cpp index 331a1d85..a360627e 100644 --- a/src/templates/qquickpageindicator.cpp +++ b/src/templates/qquickpageindicator.cpp @@ -59,6 +59,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-pageindicator.qml 1 + \labs + \sa SwipeView, {Customizing PageIndicator}, {Indicator Controls} */ diff --git a/src/templates/qquickpane.cpp b/src/templates/qquickpane.cpp index 27e76ea3..9bedb150 100644 --- a/src/templates/qquickpane.cpp +++ b/src/templates/qquickpane.cpp @@ -60,6 +60,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-pane.qml 1 + \labs + \sa {Customizing Pane}, {Container Controls} */ diff --git a/src/templates/qquickpopup.cpp b/src/templates/qquickpopup.cpp index 2e826591..8d5f4d19 100644 --- a/src/templates/qquickpopup.cpp +++ b/src/templates/qquickpopup.cpp @@ -55,6 +55,8 @@ QT_BEGIN_NAMESPACE \brief A popup control. Popup is the base type of popup-like user interface controls. + + \labs */ QQuickPopupPrivate::QQuickPopupPrivate() diff --git a/src/templates/qquickprogressbar.cpp b/src/templates/qquickprogressbar.cpp index aa0789bc..972654ad 100644 --- a/src/templates/qquickprogressbar.cpp +++ b/src/templates/qquickprogressbar.cpp @@ -62,6 +62,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing ProgressBar} */ diff --git a/src/templates/qquickradiobutton.cpp b/src/templates/qquickradiobutton.cpp index 9aca5808..7d7a64aa 100644 --- a/src/templates/qquickradiobutton.cpp +++ b/src/templates/qquickradiobutton.cpp @@ -84,6 +84,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa ButtonGroup, {Customizing RadioButton}, {Button Controls} */ diff --git a/src/templates/qquickrangeslider.cpp b/src/templates/qquickrangeslider.cpp index 70d5a03d..4bb320cf 100644 --- a/src/templates/qquickrangeslider.cpp +++ b/src/templates/qquickrangeslider.cpp @@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing RangeSlider}, {Input Controls} */ diff --git a/src/templates/qquickscrollbar.cpp b/src/templates/qquickscrollbar.cpp index 23db7fcf..86d4e290 100644 --- a/src/templates/qquickscrollbar.cpp +++ b/src/templates/qquickscrollbar.cpp @@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE \li \l active \endlist + \labs + \sa ScrollIndicator, {Customizing ScrollBar}, {Indicator Controls} */ diff --git a/src/templates/qquickscrollindicator.cpp b/src/templates/qquickscrollindicator.cpp index b041e2ab..4dc04141 100644 --- a/src/templates/qquickscrollindicator.cpp +++ b/src/templates/qquickscrollindicator.cpp @@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE \li \l active \endlist + \labs + \sa ScrollBar, {Customizing ScrollIndicator}, {Indicator Controls} */ diff --git a/src/templates/qquickslider.cpp b/src/templates/qquickslider.cpp index bdb18ad9..e59b46e6 100644 --- a/src/templates/qquickslider.cpp +++ b/src/templates/qquickslider.cpp @@ -68,6 +68,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing Slider}, {Input Controls} */ diff --git a/src/templates/qquickspinbox.cpp b/src/templates/qquickspinbox.cpp index 13770e46..435c86e5 100644 --- a/src/templates/qquickspinbox.cpp +++ b/src/templates/qquickspinbox.cpp @@ -80,6 +80,8 @@ static const int AUTO_REPEAT_INTERVAL = 100; \snippet qtlabscontrols-spinbox-textual.qml 1 + \labs + \sa Tumbler, {Customizing SpinBox} */ diff --git a/src/templates/qquickstackview.cpp b/src/templates/qquickstackview.cpp index 90ca799f..415e8700 100644 --- a/src/templates/qquickstackview.cpp +++ b/src/templates/qquickstackview.cpp @@ -257,6 +257,8 @@ QT_BEGIN_NAMESPACE } \endqml + \labs + \sa {Customizing StackView}, {Navigation Controls}, {Container Controls} */ diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp index 2f0dee54..f78d0120 100644 --- a/src/templates/qquickswipeview.cpp +++ b/src/templates/qquickswipeview.cpp @@ -67,6 +67,8 @@ QT_BEGIN_NAMESPACE \l {Container::moveItem()}{move}, and \l {Container::removeItem()}{remove} pages dynamically at run time. + \labs + \sa TabBar, PageIndicator, {Customizing SwipeView}, {Navigation Controls}, {Container Controls} */ diff --git a/src/templates/qquickswitch.cpp b/src/templates/qquickswitch.cpp index a867ec70..8544d7ca 100644 --- a/src/templates/qquickswitch.cpp +++ b/src/templates/qquickswitch.cpp @@ -77,6 +77,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa {Customizing Switch}, {Button Controls} */ diff --git a/src/templates/qquicktabbar.cpp b/src/templates/qquicktabbar.cpp index a2fc1e11..58d68058 100644 --- a/src/templates/qquicktabbar.cpp +++ b/src/templates/qquicktabbar.cpp @@ -59,6 +59,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-tabbar.qml 1 + \labs + \sa TabButton, {Customizing TabBar}, {Navigation Controls}, {Container Controls} */ diff --git a/src/templates/qquicktabbutton.cpp b/src/templates/qquicktabbutton.cpp index 00d4d8b4..a70dcbe1 100644 --- a/src/templates/qquicktabbutton.cpp +++ b/src/templates/qquicktabbutton.cpp @@ -55,6 +55,8 @@ QT_BEGIN_NAMESPACE \snippet qtlabscontrols-tabbutton.qml 1 + \labs + \sa TabBar, {Customizing TabButton}, {Navigation Controls} */ diff --git a/src/templates/qquicktextarea.cpp b/src/templates/qquicktextarea.cpp index fbc14573..05b1b9a7 100644 --- a/src/templates/qquicktextarea.cpp +++ b/src/templates/qquicktextarea.cpp @@ -67,6 +67,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa TextField, {Customizing TextArea}, {Input Controls} */ diff --git a/src/templates/qquicktextfield.cpp b/src/templates/qquicktextfield.cpp index ec8c24ab..c3070614 100644 --- a/src/templates/qquicktextfield.cpp +++ b/src/templates/qquicktextfield.cpp @@ -77,6 +77,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa TextArea, {Customizing TextField}, {Input Controls} */ diff --git a/src/templates/qquicktoolbar.cpp b/src/templates/qquicktoolbar.cpp index c20303e8..882834e3 100644 --- a/src/templates/qquicktoolbar.cpp +++ b/src/templates/qquicktoolbar.cpp @@ -86,6 +86,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa ApplicationWindow, ToolButton, {Customizing ToolBar}, {Container Controls} */ diff --git a/src/templates/qquicktoolbutton.cpp b/src/templates/qquicktoolbutton.cpp index 3505346c..775eedd1 100644 --- a/src/templates/qquicktoolbutton.cpp +++ b/src/templates/qquicktoolbutton.cpp @@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE } \endcode + \labs + \sa ToolBar, {Customizing ToolButton}, {Button Controls} */ diff --git a/src/templates/qquicktumbler.cpp b/src/templates/qquicktumbler.cpp index df1120ad..3818910a 100644 --- a/src/templates/qquicktumbler.cpp +++ b/src/templates/qquicktumbler.cpp @@ -66,6 +66,8 @@ QT_BEGIN_NAMESPACE \image qtlabscontrols-tumbler-wrap.gif + \labs + \sa {Customizing Tumbler}, {Input Controls} */ |