summaryrefslogtreecommitdiffstats
path: root/src/imports/localesettings
diff options
context:
space:
mode:
authorSamuli Piippo <samuli.piippo@qt.io>2016-09-12 09:19:40 +0300
committerSamuli Piippo <samuli.piippo@qt.io>2016-09-12 09:19:40 +0300
commit2b6766f09ad53f1cf2ba7cfe95976b4322c2e8fd (patch)
tree35c238f57be475e69abd3e34baa32a136739dfd5 /src/imports/localesettings
parentf6de3a059ea2207104ff8f23718d714ac4ff41d2 (diff)
parent57b15814c8865e517c43fe173c0ffcadf8557ade (diff)
Merge remote-tracking branch 'origin/5.7' into dev
* origin/5.7: Doc: Document QtDeviceUtilities Doc: Remove rest of the generic Qt for Device Creation doc files Doc: Bump version to 5.7.1 Doc: Remove generic Device Creation documentation Added additional instructions for Windows users using BeagleBone Black Fixes to networkSettingsService model handling Updated icons Doc: Add documentation for NVIDIA DRIVE CX Doc: Add documentation for Intel NUC Doc: Remove references to SILICA ArchiTech Tibidabo Doc: Bump version to 5.7.0 Fixed connman backend crashes and changed it as default. Conflicts: src/doc/src/qtee-changelog.qdoc src/doc/src/qtee-index.qdoc src/doc/src/qtee-static-linking.qdoc Change-Id: Idb13f9fd130211213434576ab5cc3d38766e9711
Diffstat (limited to 'src/imports/localesettings')
-rw-r--r--src/imports/localesettings/plugin.cpp113
1 files changed, 113 insertions, 0 deletions
diff --git a/src/imports/localesettings/plugin.cpp b/src/imports/localesettings/plugin.cpp
index 737ff0c..60c19c1 100644
--- a/src/imports/localesettings/plugin.cpp
+++ b/src/imports/localesettings/plugin.cpp
@@ -35,6 +35,119 @@
#include <systemlocale.h>
#include "localefiltermodel.h"
+/*!
+ \qmlmodule QtDeviceUtilities.LocaleSettings 1.0
+
+ \title Qt Device Utilities: Locale Settings
+ \ingroup qtee-qmlmodules
+ \brief Provides singleton QML types for controlling locale settings.
+
+ Provides singleton QML types for controlling locale settings in an
+ embedded device.
+
+ Import the module as follows:
+
+ \badcode
+ import QtDeviceUtilities.LocaleSettings 1.0
+ \endcode
+
+ \note Some functions may not be available on all of the platforms.
+
+ \section1 QML Types
+*/
+
+/*!
+ \qmltype LocaleManager
+ \inqmlmodule QtDeviceUtilities.LocaleSettings
+ \brief A singleton QML type for managing the system locale.
+
+ There is no need to create an instance of this object. To use it,
+ simply import the \c {QtDeviceUtilities.LocaleSettings} module.
+
+ The \l locale property holds the current system locale string.
+ Pass it to \l {QtQml::Qt::locale()}{Qt.locale}() to
+ retrieve locale-specific properties.
+
+ For example:
+
+ \qml
+ import QtQuick 2.6
+ import QtDeviceUtilities.LocaleSettings 1.0
+
+ Item {
+ property var currentLocale: Qt.locale(LocaleManager.locale)
+ Text { text: currentLocale.nativeLanguageName }
+ }
+ \endqml
+
+ \sa LocaleFilter, {QtQml::}{Locale}
+*/
+
+/*!
+ \qmlproperty string LocaleManager::locale
+
+ Holds the system locale string in the format \e language_country,
+ for example, "en_US".
+
+ \sa QLocale::name()
+*/
+
+/*!
+ \qmltype LocaleFilter
+ \inqmlmodule QtDeviceUtilities.LocaleSettings
+ \brief Provides a filtered model for the available locales.
+
+ There is no need to create an instance of this object. To use it,
+ simply import the \c {QtDeviceUtilities.LocaleSettings} module.
+
+ The LocaleFilter QML type can be used as the model in a view
+ that lists the available locales.
+
+ For example:
+
+ \code
+ ListView {
+ model: LocaleFilter
+ delegate: Text { text: language + " | " + country }
+ }
+ \endcode
+
+ Available \e roles in the locale model:
+
+ \table
+ \header \li Role \li Description
+
+ \row \li \c code \li Locale code string in the format \e language_country.
+ See QLocale::name() for details.
+
+ \row \li \c country \li The name of the country. If available, the native
+ country name is used.
+
+ \row \li \c language \li The name of the language. If available, the
+ native language name is used.
+ \endtable
+
+ \sa LocaleManager
+*/
+
+/*!
+ \qmlproperty string LocaleFilter::filter
+
+ Holds a string that filters out the locales in the model.
+ The filtering process is a case-insensitive match for
+ whether the region (country) name contains the \e filter
+ substring; it can be taken from user input.
+*/
+
+/*!
+ \qmlmethod object LocaleFilter::itemFromRow(int index)
+
+ Returns the item at \a index in the model. This item can
+ assigned to \l [QML] {LocaleManager::locale}
+ {LocaleManager.locale}, when the user selects a locale
+ from a list.
+*/
+
template <typename T>
QObject *instance(QQmlEngine *engine, QJSEngine *) {
T *t = new T(engine);