From 53e9437f6758f7d7894574dbf4154f4110c0d6dd Mon Sep 17 00:00:00 2001 From: Pier Luigi Fiorini Date: Sat, 2 Nov 2024 08:20:27 +0100 Subject: [PATCH] docs: convert from qdoc to Doxygen Issue: #345 --- src/imports/controls/qml/AutomaticGrid.qml | 21 +--- src/imports/controls/qml/BoxShadow.qml | 18 --- src/imports/controls/qml/CircleMask.qml | 8 +- src/imports/controls/qml/ColumnFlow.qml | 22 +--- src/imports/controls/qml/DatePickerDialog.qml | 4 - src/imports/controls/qml/Elevation.qml | 4 - .../controls/qml/FloatingActionButton.qml | 4 - src/imports/controls/qml/Object.qml | 8 +- src/imports/controls/qml/TabbedPage.qml | 14 +-- src/imports/controls/qml/Vignette.qml | 4 - src/imports/templates/Card.qml | 6 +- src/imports/templates/datepicker.cpp | 100 --------------- src/imports/templates/datepicker.h | 50 ++++++++ src/imports/templates/dateselector.h | 3 + src/imports/templates/datetimepicker.cpp | 116 ------------------ src/imports/templates/datetimepicker.h | 56 +++++++++ src/imports/templates/picker.h | 23 ++++ src/imports/templates/timepicker.cpp | 84 ------------- src/imports/templates/timepicker.h | 32 +++++ 19 files changed, 171 insertions(+), 406 deletions(-) diff --git a/src/imports/controls/qml/AutomaticGrid.qml b/src/imports/controls/qml/AutomaticGrid.qml index 2238659d..737fb3be 100644 --- a/src/imports/controls/qml/AutomaticGrid.qml +++ b/src/imports/controls/qml/AutomaticGrid.qml @@ -16,13 +16,9 @@ import QtQuick /*! - \qmltype AutomaticGrid - \inqmlmodule Fluid - \ingroup fluid - \brief Lay out children in a grid that automatically fits the available space. - \code + \code{.qml} import QtQuick import Fluid as Fluid @@ -52,9 +48,6 @@ Grid { id: grid /*! - \qmlproperty Component delegate - \default - The delegate provides a template defining each item istantiated by the grid. \sa Repeater::delegate @@ -62,22 +55,16 @@ Grid { default property alias delegate: repeater.delegate /*! - \qmlproperty real cellWidth - Cell width. */ property real cellWidth /*! - \qmlproperty real cellHeight - Cell height. */ property real cellHeight /*! - \qmlproperty any model - The model providing data to the grid. This property can be set to any of the supported \l {qml-data-models}{data models}. @@ -87,22 +74,16 @@ Grid { property alias model: repeater.model /*! - \qmlproperty real widthOverride - Maximum width. */ property real widthOverride: parent.width /*! - \qmlproperty real heightOverride - Maximum height. */ property real heightOverride: parent.height /*! - \qmlproperty real minColumnSpacing - Minimum spacing between columns. */ property real minColumnSpacing diff --git a/src/imports/controls/qml/BoxShadow.qml b/src/imports/controls/qml/BoxShadow.qml index 5a96c8d5..085ec211 100644 --- a/src/imports/controls/qml/BoxShadow.qml +++ b/src/imports/controls/qml/BoxShadow.qml @@ -16,10 +16,6 @@ import QtQuick import Qt5Compat.GraphicalEffects /*! - \qmltype BoxShadow - \inqmlmodule Fluid - \ingroup fluid - \brief A implementation of CSS's box-shadow. A implementation of CSS's box-shadow, used by Elevation for a Material Design @@ -27,51 +23,37 @@ import Qt5Compat.GraphicalEffects */ RectangularGlow { /*! - \qmlproperty int offsetX - Position of the horizontal shadow. */ property int offsetX /*! - \qmlproperty int offsetY - Position of the vertical shadow. */ property int offsetY /*! - \qmlproperty int blurRadius - Blur distance. */ property int blurRadius /*! - \qmlproperty int spreadRadius - Size of shadow. */ property int spreadRadius /*! - \qmlproperty Item source - The source item the shadow is being applied to, used for correctly calculating the corner radius. */ property Item source /*! - \qmlproperty bool fullWidth - Whether the shadow width is calculated based on the parent width. */ property bool fullWidth /*! - \qmlproperty bool fullHeight - Whether the shadow height is calculated based on the parent height. */ property bool fullHeight diff --git a/src/imports/controls/qml/CircleMask.qml b/src/imports/controls/qml/CircleMask.qml index 72f6adf5..e2aaaa1b 100644 --- a/src/imports/controls/qml/CircleMask.qml +++ b/src/imports/controls/qml/CircleMask.qml @@ -17,18 +17,12 @@ import QtQuick import Qt5Compat.GraphicalEffects /*! - \qmltype CircleMask - \inqmlmodule Fluid - \ingroup fluid - - \brief Circular mask. + \brief Circular mask. */ Item { id: item /*! - \qmlproperty variant source - This property defines the source item that is going to be masked. */ property alias source: mask.source diff --git a/src/imports/controls/qml/ColumnFlow.qml b/src/imports/controls/qml/ColumnFlow.qml index 46b96807..e7d1b318 100644 --- a/src/imports/controls/qml/ColumnFlow.qml +++ b/src/imports/controls/qml/ColumnFlow.qml @@ -16,13 +16,9 @@ import QtQuick /*! - \qmltype ColumnFlow - \inqmlmodule Fluid - \ingroup fluid - \brief Automatically position children in columns. - \code + \code{.qml} import QtQuick import Fluid as Fluid @@ -51,24 +47,18 @@ Item { id: columnFlow /*! - \qmlproperty int columnWidth - Column width. This property is \c 100 by default. */ property int columnWidth: 100 /*! - \qmlproperty int columns - Number of columns. By default it fits as many columns as possible. */ property int columns: Math.max(0, Math.floor(width / columnWidth)) /*! - \qmlproperty any model - The model providing data to the column flow. This property can be set to any of the supported \l {qml-data-models}{data models}. @@ -78,8 +68,6 @@ Item { property alias model: repeater.model /*! - \qmlproperty Component delegate - The delegate provides a template defining each item istantiated by the column flow. \sa Repeater::delegate @@ -87,15 +75,11 @@ Item { property alias delegate: repeater.delegate /*! - \qmlproperty int contentHeight - Content height. */ property int contentHeight: 0 /*! - \qmlproperty bool repeaterCompleted - This property holds whether the layout is done. */ readonly property alias repeaterCompleted: __private.repeaterCompleted @@ -114,8 +98,6 @@ Item { } /*! - \qmlmethod void ColumnFlow::updateWidths() - Set the width of all delegates. */ function updateWidths() { @@ -134,8 +116,6 @@ Item { } /*! - \qmlmethod void ColumnFlow::reEvalColumns() - Relayout the columns. */ function reEvalColumns() { diff --git a/src/imports/controls/qml/DatePickerDialog.qml b/src/imports/controls/qml/DatePickerDialog.qml index 0153c234..81dbbd67 100644 --- a/src/imports/controls/qml/DatePickerDialog.qml +++ b/src/imports/controls/qml/DatePickerDialog.qml @@ -18,10 +18,6 @@ import QtQuick.Controls.Material import Fluid as Fluid /*! - \qmltype DatePickerDialog - \inqmlmodule Fluid - \ingroup fluid - \brief Dialog to select a single date. Dialog to select a single date from a calendar. diff --git a/src/imports/controls/qml/Elevation.qml b/src/imports/controls/qml/Elevation.qml index e2edfd6e..5b859d39 100644 --- a/src/imports/controls/qml/Elevation.qml +++ b/src/imports/controls/qml/Elevation.qml @@ -16,10 +16,6 @@ import QtQuick import Fluid /*! - \qmltype Elevation - \inqmlmodule Fluid - \ingroup fluid - \brief Material Design elevation effect. An effect for standard Material Design elevation shadows. diff --git a/src/imports/controls/qml/FloatingActionButton.qml b/src/imports/controls/qml/FloatingActionButton.qml index a3df103c..b96ff930 100644 --- a/src/imports/controls/qml/FloatingActionButton.qml +++ b/src/imports/controls/qml/FloatingActionButton.qml @@ -20,10 +20,6 @@ import Qt5Compat.GraphicalEffects import Fluid as Fluid /*! - \qmltype FloatingActionButton - \inqmlmodule Fluid - \ingroup fluid - \brief A floating action button. A floating action button represents the primary action of the current page diff --git a/src/imports/controls/qml/Object.qml b/src/imports/controls/qml/Object.qml index 3ed1ec28..fe0eaab3 100644 --- a/src/imports/controls/qml/Object.qml +++ b/src/imports/controls/qml/Object.qml @@ -15,16 +15,12 @@ import QtQuick /*! - \qmltype Object - \inqmlmodule Fluid - \ingroup fluid - \brief A \l QtObject with children. The \l Object type is a non-visual element that extends \l QtObject with the ability to hold children objects. - \qml + \code{.qml} import QtQuick import Fluid @@ -32,7 +28,7 @@ import QtQuick QtObject {} QtObject {} } - \endqml + \endcode */ QtObject { id: object diff --git a/src/imports/controls/qml/TabbedPage.qml b/src/imports/controls/qml/TabbedPage.qml index 1720c2b7..0cc05922 100644 --- a/src/imports/controls/qml/TabbedPage.qml +++ b/src/imports/controls/qml/TabbedPage.qml @@ -180,18 +180,14 @@ Fluid.Page { } /*! - \qmlmethod void TabbedPage::addTab(Tab tab) - Add a \a tab programmatically to the page. - */ + */ function addTab(tab) { swipeView.addItem(tab); swipeView.setCurrentIndex(swipeView.count - 1); } /*! - \qmlmethod void TabbedPage::removeTab(int index) - Remove the tab with \a index programmatically. */ function removeTab(index) { @@ -200,8 +196,6 @@ Fluid.Page { } /*! - \qmlmethod Tab TabbedPage::getTab(int index) - Return the tab with \a index. */ function getTab(index) { @@ -209,8 +203,6 @@ Fluid.Page { } /*! - \qmlmethod void TabbedPage::setCurrentIndex(int index) - Select the tab that correspond to \a index. */ function setCurrentIndex(index) { @@ -218,8 +210,6 @@ Fluid.Page { } /*! - \qmlmethod void TabbedPage::incrementCurrentIndex() - Increment current index. \sa currentIndex @@ -229,8 +219,6 @@ Fluid.Page { } /*! - \qmlmethod void TabbedPage::decrementCurrentIndex() - Decrement current index. \sa currentIndex diff --git a/src/imports/controls/qml/Vignette.qml b/src/imports/controls/qml/Vignette.qml index 54db9918..72285e39 100644 --- a/src/imports/controls/qml/Vignette.qml +++ b/src/imports/controls/qml/Vignette.qml @@ -15,10 +15,6 @@ import QtQuick /*! - \qmltype Vignette - \inqmlmodule Fluid - \ingroup fluid - \brief Vignette effect. */ Item { diff --git a/src/imports/templates/Card.qml b/src/imports/templates/Card.qml index 50b07bc3..8da5c7e7 100644 --- a/src/imports/templates/Card.qml +++ b/src/imports/templates/Card.qml @@ -16,14 +16,10 @@ import QtQuick.Controls as C import QtQuick.Controls.Material /*! - \qmltype Fluid.Templates.Card - \inqmlmodule Fluid.Templates - \ingroup fluidtemplates - \brief Cards display content composed of different elements. For more information you can read the - \l{https://material.io/guidelines/components/cards.html}{Material Design guidelines}. + Material Design guidelines. */ C.Pane { padding: 0 diff --git a/src/imports/templates/datepicker.cpp b/src/imports/templates/datepicker.cpp index 208f8439..e1a858ae 100644 --- a/src/imports/templates/datepicker.cpp +++ b/src/imports/templates/datepicker.cpp @@ -14,77 +14,13 @@ #include "datepicker.h" -/*! - \qmltype DatePicker - \inherits QQuickItem - \instantiates DatePicker - \inqmlmodule Fluid - \brief Control to select a single date. - Stand-alone control to select a single date from a calendar. - \code - import QtQuick - import Fluid - Item { - width: 600 - height: 600 - DatePicker { - anchors.centerIn: parent - onSelectedDateChanged: { - console.log("You have selected:", selectedDate); - } - } - } - \endcode - For more information you can read the - \l{https://material.io/guidelines/components/pickers.html}{Material Design guidelines}. -*/ -/*! - \qmlproperty Locale Fluid.Controls::DatePicker::locale - - This property holds the locale of the control. -*/ - -/*! - \qmlproperty enumeration Fluid.Controls::DatePicker::orientation - - This property holds the date picker orientation. - The default value is automatically selected based on the device orientation. - - Possible values: - \value DatePicker.Landscape The date picker is landscape. - \value DatePicker.Portrait The date picker is portrait. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DatePicker::background - - This property holds the background item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DatePicker::header - - This property holds the header item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DatePicker::selector - - This property holds the selector item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DatePicker::footer - - This property holds the footer item. -*/ DatePicker::DatePicker(QQuickItem *parent) : Picker(parent) @@ -94,17 +30,6 @@ DatePicker::DatePicker(QQuickItem *parent) { } -/*! - \qmlproperty enumeration Fluid.Controls::DatePicker::mode - - This property holds the current selection mode. - - It is changed by the user, clicking on the year or calendar. - - Possible values: - \value DatePicker.Year The user is selecting the year. - \value DatePicker.Month The user is selecting the month. -*/ DatePicker::Mode DatePicker::mode() const { return m_mode; @@ -119,11 +44,6 @@ void DatePicker::setMode(DatePicker::Mode mode) Q_EMIT modeChanged(); } -/*! - \qmlproperty bool Fluid.Controls::DatePicker::dayOfWeekRowVisible - - This property determines the visibility of the day of week row. -*/ bool DatePicker::dayOfWeekRowVisible() const { return m_dayOfWeekRowVisible; @@ -138,11 +58,6 @@ void DatePicker::setDayOfWeekRowVisible(bool value) Q_EMIT dayOfWeekRowVisibleChanged(); } -/*! - \qmlproperty bool Fluid.Controls::DatePicker::weekNumberVisible - - This property determines the visibility of the week number column. -*/ bool DatePicker::weekNumberVisible() const { return m_weekNumberVisible; @@ -157,11 +72,6 @@ void DatePicker::setWeekNumberVisible(bool value) Q_EMIT weekNumberVisibleChanged(); } -/*! - \qmlproperty date Fluid.Controls::DatePicker::from - - This property holds the start date. -*/ QDate DatePicker::from() const { return m_from; @@ -181,11 +91,7 @@ void DatePicker::resetFrom() setFrom(QDate(1, 1, 1)); } -/*! - \qmlproperty date Fluid.Controls::DatePicker::to - This property holds the end date. -*/ QDate DatePicker::to() const { return m_to; @@ -205,12 +111,6 @@ void DatePicker::resetTo() setTo(QDate(275759, 9, 25)); } -/*! - \qmlproperty date Fluid.Controls::DatePicker::selectedDate - - This property holds the date that has been selected by the user. - The default value is the current date. -*/ QDate DatePicker::selectedDate() const { return m_selectedDate; diff --git a/src/imports/templates/datepicker.h b/src/imports/templates/datepicker.h index 0ed0d82d..a7c05b87 100644 --- a/src/imports/templates/datepicker.h +++ b/src/imports/templates/datepicker.h @@ -19,14 +19,64 @@ #include "picker.h" +/*! + \brief Control to select a single date. + + Stand-alone control to select a single date from a calendar. + + \code{.qml} + import Fluid + import QtQuick + + Item { + width: 600 + height: 600 + + DatePicker { + anchors.centerIn: parent + onSelectedDateChanged: { + console.log("You have selected:", selectedDate); + } + } + } + \endcode + + For more information you can read the + Material Design guidelines. +*/ class DatePicker : public Picker { Q_OBJECT + /*! + This property holds the current selection mode. + + It is changed by the user, clicking on the year or calendar. + + Possible values: + - DatePicker.Year The user is selecting the year. + - DatePicker.Month The user is selecting the month. + */ Q_PROPERTY(Mode mode READ mode WRITE setMode NOTIFY modeChanged FINAL) + /*! + This property determines the visibility of the day of week row. + */ Q_PROPERTY(bool dayOfWeekRowVisible READ dayOfWeekRowVisible WRITE setDayOfWeekRowVisible NOTIFY dayOfWeekRowVisibleChanged FINAL) + /*! + This property determines the visibility of the week number column. + */ Q_PROPERTY(bool weekNumberVisible READ weekNumberVisible WRITE setWeekNumberVisible NOTIFY weekNumberVisibleChanged FINAL) + /*! + This property holds the start date. + */ Q_PROPERTY(QDate from READ from WRITE setFrom RESET resetFrom NOTIFY fromChanged FINAL) + /*! + This property holds the end date. + */ Q_PROPERTY(QDate to READ to WRITE setTo RESET resetTo NOTIFY toChanged FINAL) + /*! + This property holds the date that has been selected by the user. + The default value is the current date. + */ Q_PROPERTY(QDate selectedDate READ selectedDate WRITE setSelectedDate NOTIFY selectedDateChanged FINAL) QML_ELEMENT public: diff --git a/src/imports/templates/dateselector.h b/src/imports/templates/dateselector.h index 37b2ffa7..885f4739 100644 --- a/src/imports/templates/dateselector.h +++ b/src/imports/templates/dateselector.h @@ -20,6 +20,9 @@ class DateSelector : public QQuickItem { Q_OBJECT + /*! + This property holds the locale of the control. + */ Q_PROPERTY(QLocale locale READ locale WRITE setLocale NOTIFY localeChanged FINAL) Q_PROPERTY(QQuickItem *contentItem READ contentItem CONSTANT FINAL) Q_PROPERTY(QQuickItem *navigator READ navigator WRITE setNavigator NOTIFY navigatorChanged FINAL) diff --git a/src/imports/templates/datetimepicker.cpp b/src/imports/templates/datetimepicker.cpp index eb544a22..91343d3a 100644 --- a/src/imports/templates/datetimepicker.cpp +++ b/src/imports/templates/datetimepicker.cpp @@ -14,77 +14,6 @@ #include "datetimepicker.h" -/*! - \qmltype DateTimePicker - \inherits QQuickItem - \instantiates DateTimePicker - \inqmlmodule Fluid - - \brief Control to select a both date and time. - - Stand-alone control to select both date and time. - - \code - import QtQuick - import Fluid - - Item { - width: 600 - height: 600 - - DateTimePicker { - anchors.centerIn: parent - onSelectedDateTimeChanged: { - console.log("You have selected:", selectedDateTime); - } - } - } - \endcode - - For more information you can read the - \l{https://material.io/guidelines/components/pickers.html}{Material Design guidelines}. -*/ - -/*! - \qmlproperty Locale Fluid.Controls::DateTimePicker::locale - - This property holds the locale of the control. -*/ - -/*! - \qmlproperty enumeration Fluid.Controls::DateTimePicker::orientation - - This property holds the date picker orientation. - The default value is automatically selected based on the device orientation. - - Possible values: - \value DatePicker.Landscape The date picker is landscape. - \value DatePicker.Portrait The date picker is portrait. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DateTimePicker::background - - This property holds the background item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DateTimePicker::header - - This property holds the header item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DateTimePicker::selector - - This property holds the selector item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::DateTimePicker::footer - - This property holds the footer item. -*/ DateTimePicker::DateTimePicker(QQuickItem *parent) : Picker(parent) @@ -94,20 +23,6 @@ DateTimePicker::DateTimePicker(QQuickItem *parent) { } -/*! - \qmlproperty enumeration Fluid.Controls::DateTimePicker::mode - - This property holds the current selection mode. - - It is changed by the user, clicking on the year or calendar. - - Possible values: - \value DateTimePicker.Year The user is selecting the year. - \value DateTimePicker.Month The user is selecting the month. - \value DateTimePicker.Hour The user is selecting the hour. - \value DateTimePicker.Minute The user is selecting the minute. - \value DateTimePicker.Second The user is selecting the second. -*/ DateTimePicker::Mode DateTimePicker::mode() const { return m_mode; @@ -122,11 +37,6 @@ void DateTimePicker::setMode(DateTimePicker::Mode mode) Q_EMIT modeChanged(); } -/*! - \qmlproperty bool Fluid.Controls::DateTimePicker::dayOfWeekRowVisible - - This property determines the visibility of the day of week row. -*/ bool DateTimePicker::dayOfWeekRowVisible() const { return m_dayOfWeekRowVisible; @@ -141,11 +51,6 @@ void DateTimePicker::setDayOfWeekRowVisible(bool value) Q_EMIT dayOfWeekRowVisibleChanged(); } -/*! - \qmlproperty bool Fluid.Controls::DateTimePicker::weekNumberVisible - - This property determines the visibility of the week number column. -*/ bool DateTimePicker::weekNumberVisible() const { return m_weekNumberVisible; @@ -160,11 +65,6 @@ void DateTimePicker::setWeekNumberVisible(bool value) Q_EMIT weekNumberVisibleChanged(); } -/*! - \qmlproperty bool Fluid.Controls::DateTimePicker::prefer24Hour - - This property determines the visibility of the AM/PM switch. -*/ bool DateTimePicker::prefer24Hour() const { return m_prefer24Hour; @@ -179,11 +79,6 @@ void DateTimePicker::setPrefer24Hour(bool value) Q_EMIT prefer24HourChanged(); } -/*! - \qmlproperty date Fluid.Controls::DateTimePicker::from - - This property holds the start date. -*/ QDate DateTimePicker::from() const { return m_from; @@ -203,11 +98,6 @@ void DateTimePicker::resetFrom() setFrom(QDate(1, 1, 1)); } -/*! - \qmlproperty date Fluid.Controls::DateTimePicker::to - - This property holds the end date. -*/ QDate DateTimePicker::to() const { return m_to; @@ -227,12 +117,6 @@ void DateTimePicker::resetTo() setTo(QDate(275759, 9, 25)); } -/*! - \qmlproperty date Fluid.Controls::DateTimePicker::selectedDateTime - - This property holds the date and time that has been selected by the user. - The default value is the current date and time. -*/ QDateTime DateTimePicker::selectedDateTime() const { return m_selectedDateTime; diff --git a/src/imports/templates/datetimepicker.h b/src/imports/templates/datetimepicker.h index 31a2b528..8a80c569 100644 --- a/src/imports/templates/datetimepicker.h +++ b/src/imports/templates/datetimepicker.h @@ -18,15 +18,71 @@ #include "picker.h" +/*! + \brief Control to select a both date and time. + + Stand-alone control to select both date and time. + + \code{.qml} + import QtQuick + import Fluid + + Item { + width: 600 + height: 600 + + DateTimePicker { + anchors.centerIn: parent + onSelectedDateTimeChanged: { + console.log("You have selected:", selectedDateTime); + } + } + } + \endcode + + For more information you can read the + Material Design guidelines. +*/ class DateTimePicker : public Picker { Q_OBJECT + /*! + This property holds the current selection mode. + + It is changed by the user, clicking on the year or calendar. + + Possible values: + - DateTimePicker.Year The user is selecting the year. + - DateTimePicker.Month The user is selecting the month. + - DateTimePicker.Hour The user is selecting the hour. + - DateTimePicker.Minute The user is selecting the minute. + - DateTimePicker.Second The user is selecting the second. + */ Q_PROPERTY(Mode mode READ mode WRITE setMode NOTIFY modeChanged FINAL) + /*! + This property determines the visibility of the day of week row. + */ Q_PROPERTY(bool dayOfWeekRowVisible READ dayOfWeekRowVisible WRITE setDayOfWeekRowVisible NOTIFY dayOfWeekRowVisibleChanged FINAL) + /*! + This property determines the visibility of the week number column. + */ Q_PROPERTY(bool weekNumberVisible READ weekNumberVisible WRITE setWeekNumberVisible NOTIFY weekNumberVisibleChanged FINAL) + /*! + This property determines the visibility of the AM/PM switch. + */ Q_PROPERTY(bool prefer24Hour READ prefer24Hour WRITE setPrefer24Hour NOTIFY prefer24HourChanged FINAL) + /*! + This property holds the start date. + */ Q_PROPERTY(QDate from READ from WRITE setFrom RESET resetFrom NOTIFY fromChanged FINAL) + /*! + This property holds the end date. + */ Q_PROPERTY(QDate to READ to WRITE setTo RESET resetTo NOTIFY toChanged FINAL) + /*! + This property holds the date and time that has been selected by the user. + The default value is the current date and time. + */ Q_PROPERTY(QDateTime selectedDateTime READ selectedDateTime WRITE setSelectedDateTime NOTIFY selectedDateTimeChanged FINAL) QML_ELEMENT public: diff --git a/src/imports/templates/picker.h b/src/imports/templates/picker.h index 2daa74b5..ca423f5b 100644 --- a/src/imports/templates/picker.h +++ b/src/imports/templates/picker.h @@ -20,11 +20,34 @@ class Picker : public QQuickItem { Q_OBJECT + /*! + This property holds the locale of the control. + */ Q_PROPERTY(QLocale locale READ locale WRITE setLocale NOTIFY localeChanged FINAL) + /*! + This property holds the date picker orientation. + The default value is automatically selected based on the device orientation. + + Possible values: + - DatePicker.Landscape The date picker is landscape. + - DatePicker.Portrait The date picker is portrait. + */ Q_PROPERTY(Orientation orientation READ orientation WRITE setOrientation RESET resetOrientation NOTIFY orientationChanged FINAL) + /*! + This property holds the background item. + */ Q_PROPERTY(QQuickItem *background READ background WRITE setBackground NOTIFY backgroundChanged FINAL) + /*! + This property holds the header item. + */ Q_PROPERTY(QQuickItem *header READ header WRITE setHeader NOTIFY headerChanged FINAL) + /*! + This property holds the selector item. + */ Q_PROPERTY(QQuickItem *selector READ selector WRITE setSelector NOTIFY selectorChanged FINAL) + /*! + This property holds the footer item. + */ Q_PROPERTY(QQuickItem *footer READ footer WRITE setFooter NOTIFY footerChanged FINAL) Q_DISABLE_COPY(Picker) public: diff --git a/src/imports/templates/timepicker.cpp b/src/imports/templates/timepicker.cpp index 110d45c7..86986dec 100644 --- a/src/imports/templates/timepicker.cpp +++ b/src/imports/templates/timepicker.cpp @@ -14,90 +14,12 @@ #include "timepicker.h" -/*! - \qmltype TimePicker - \inherits QQuickItem - \instantiates TimePicker - \inqmlmodule Fluid - - \brief Control to select a time. - - Stand-alone control to select a time. - - \code - import QtQuick - import Fluid - - Item { - width: 600 - height: 600 - - TimePicker { - anchors.centerIn: parent - onSelectedTimeChanged: { - console.log("You have selected:", selectedTime); - } - } - } - \endcode - - For more information you can read the - \l{https://material.io/guidelines/components/pickers.html}{Material Design guidelines}. -*/ - - -/*! - \qmlproperty Locale Fluid.Controls::TimePicker::locale - - This property holds the locale of the control. -*/ - -/*! - \qmlproperty enumeration Fluid.Controls::TimePicker::orientation - - This property holds the date picker orientation. - The default value is automatically selected based on the device orientation. - - Possible values: - \value DatePicker.Landscape The date picker is landscape. - \value DatePicker.Portrait The date picker is portrait. -*/ - -/*! - \qmlproperty Item Fluid.Controls::TimePicker::background - - This property holds the background item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::TimePicker::header - - This property holds the header item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::TimePicker::selector - - This property holds the selector item. -*/ - -/*! - \qmlproperty Item Fluid.Controls::TimePicker::footer - - This property holds the footer item. -*/ - TimePicker::TimePicker(QQuickItem *parent) : Picker(parent) , m_selectedTime(QTime::currentTime()) { } -/*! - \qmlproperty bool Fluid.Controls::TimePicker::prefer24Hour - - This property determines the visibility of the AM/PM switch. -*/ bool TimePicker::prefer24Hour() const { return m_prefer24Hour; @@ -112,12 +34,6 @@ void TimePicker::setPrefer24Hour(bool value) Q_EMIT prefer24HourChanged(); } -/*! - \qmlproperty date Fluid.Controls::TimePicker::selectedTime - - This property holds the time that has been selected by the user. - The default value is the current time. -*/ QTime TimePicker::selectedTime() const { return m_selectedTime; diff --git a/src/imports/templates/timepicker.h b/src/imports/templates/timepicker.h index 07bab3d7..01e03243 100644 --- a/src/imports/templates/timepicker.h +++ b/src/imports/templates/timepicker.h @@ -19,10 +19,42 @@ #include "picker.h" +/*! + \brief Control to select a time. + + Stand-alone control to select a time. + + \code{.qml} + import QtQuick + import Fluid + + Item { + width: 600 + height: 600 + + TimePicker { + anchors.centerIn: parent + onSelectedTimeChanged: { + console.log("You have selected:", selectedTime); + } + } + } + \endcode + + For more information you can read the + Material Design guidelines. +*/ class TimePicker : public Picker { Q_OBJECT + /*! + This property determines the visibility of the AM/PM switch. + */ Q_PROPERTY(bool prefer24Hour READ prefer24Hour WRITE setPrefer24Hour NOTIFY prefer24HourChanged FINAL) + /*! + This property holds the time that has been selected by the user. + The default value is the current time. + */ Q_PROPERTY(QTime selectedTime READ selectedTime WRITE setSelectedTime NOTIFY selectedTimeChanged FINAL) QML_ELEMENT public: