diff options
author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-08-23 15:12:03 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2016-09-06 07:22:31 +0000 |
commit | 57b15814c8865e517c43fe173c0ffcadf8557ade (patch) | |
tree | 35c238f57be475e69abd3e34baa32a136739dfd5 /src/imports/timedatesettings/plugin.cpp | |
parent | 1812b8e95b8b27b0879c97e66fcda739b502f7aa (diff) |
Doc: Document QtDeviceUtilities
Added documentation for the following QML modules:
QtDeviceUtilities.BluetoothSettings
QtDeviceUtilities.DisplaySettings
QtDeviceUtilities.LocalDeviceSettings
QtDeviceUtilities.LocaleSettings
QtDeviceUtilities.NetworkSettings
QtDeviceUtilities.TimeDateSettings
QtDeviceUtilities.SettingsUI
And changed the name of this documentation module to
'Qt Device Utilities'.
Task-number: QTBUG-55320
Change-Id: Iee0d8467dccddc0ee75d7a395ae91f68b12ab9f2
Reviewed-by: Kimmo Ollila <kimmo.ollila@theqtcompany.com>
Diffstat (limited to 'src/imports/timedatesettings/plugin.cpp')
-rw-r--r-- | src/imports/timedatesettings/plugin.cpp | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/src/imports/timedatesettings/plugin.cpp b/src/imports/timedatesettings/plugin.cpp index c725a10..9ebe945 100644 --- a/src/imports/timedatesettings/plugin.cpp +++ b/src/imports/timedatesettings/plugin.cpp @@ -34,7 +34,110 @@ #include <systemtime.h> #include "timezonefiltermodel.h" +/*! + \qmlmodule QtDeviceUtilities.TimeDateSettings 1.0 + \title Qt Device Utilities: Time and Date Settings + \ingroup qtee-qmlmodules + \brief Provides singleton QML types for controlling date and time + settings. + + Provides singleton QML types for controlling date and time settings + in an embedded device. + + Import the module as follows: + + \badcode + import QtDeviceUtilities.TimeDateSettings 1.0 + \endcode + + \note Some functions may not be available on all of the platforms. + + \section1 QML Types +*/ + +/*! + \qmltype TimeManager + \inqmlmodule QtDeviceUtilities.TimeDateSettings + \brief A singleton QML type for managing the system date and time. + + There is no need to create an instance of this object. To use it, + simply import the \c {QtDeviceUtilities.TimeDateSettings} module. +*/ + +/*! + \qmlproperty string TimeManager::timeZone + + Holds the current time zone string. +*/ + +/*! + \qmlproperty bool TimeManager::ntp + + Holds whether the system time is synchronized using NTP (Network + Time Protocol). +*/ + +/*! + \qmlproperty Date TimeManager::time + + Holds the current date and time. +*/ + +/*! + \qmltype TimezonesFilter + \inqmlmodule QtDeviceUtilities.TimeDateSettings + \brief Provides a filtered model for the available time zones. + + There is no need to create an instance of this object. To use it, + simply import the \c {QtDeviceUtilities.TimeDateSettings} module. + + The TimezonesFilter QML type can be used as the model in a view + that lists the available time zones. + + For example: + + \code + ListView { + model: TimezonesFilter + delegate: Text { text: name + " | " + country } + } + \endcode + + Available \e roles in the time zone model: + + \table + \header \li Role \li Description + + \row \li \c name + \li Display name of the time zone. See QTimeZone::displayName() for + details. + + \row \li \c country + \li Name of the country for the zone time. + + \row \li \c id + \li IANA time zone ID. + \endtable +*/ + +/*! + \qmlproperty string TimezonesFilter::filter + + Holds a string that filters out the time zones in the model. + The filtering process is a case-insensitive match for + whether the time zone's name or country name contain the + \e filter substring; it can be taken from user input. +*/ + +/*! + \qmlmethod object TimezonesFilter::itemFromRow(int index) + + Returns the item at \a index in the model. This item can + be assigned to \l [QML] {TimeManager::timeZone} + {TimeManager.timeZone}, when the user selects a time zone + from a list. +*/ template <typename T> QObject *instance(QQmlEngine *engine, QJSEngine *) { T *t = new T(engine); |