diff options
author | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-06-16 14:44:32 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@theqtcompany.com> | 2015-06-16 22:35:14 +0000 |
commit | 21697e9df962339dc4b1b40c3d3c46ae65790881 (patch) | |
tree | e8ff314b8d1a6a9b215cabde4f3f143e86b8168f /src/controls | |
parent | 6a2d7ea011424d77c892229dae4756a8e7a90a88 (diff) |
Docs: TextField
Change-Id: I892ca73cdc1d96d924b369b30d822b3dd7611c94
Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'src/controls')
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-textfield-background.png | bin | 0 -> 1540 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-textfield-disabled.png | bin | 0 -> 1428 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-textfield-focused.png | bin | 0 -> 1587 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-textfield-normal.png | bin | 0 -> 1261 bytes | |||
-rw-r--r-- | src/controls/doc/images/qtquickcontrols2-textfield-placeholder.png | bin | 0 -> 1588 bytes | |||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols2-customize.qdoc | 18 | ||||
-rw-r--r-- | src/controls/qquicktextfield.cpp | 47 |
7 files changed, 65 insertions, 0 deletions
diff --git a/src/controls/doc/images/qtquickcontrols2-textfield-background.png b/src/controls/doc/images/qtquickcontrols2-textfield-background.png Binary files differnew file mode 100644 index 00000000..a2908200 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-textfield-background.png diff --git a/src/controls/doc/images/qtquickcontrols2-textfield-disabled.png b/src/controls/doc/images/qtquickcontrols2-textfield-disabled.png Binary files differnew file mode 100644 index 00000000..bb5b779e --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-textfield-disabled.png diff --git a/src/controls/doc/images/qtquickcontrols2-textfield-focused.png b/src/controls/doc/images/qtquickcontrols2-textfield-focused.png Binary files differnew file mode 100644 index 00000000..5d8592c1 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-textfield-focused.png diff --git a/src/controls/doc/images/qtquickcontrols2-textfield-normal.png b/src/controls/doc/images/qtquickcontrols2-textfield-normal.png Binary files differnew file mode 100644 index 00000000..26ad9c11 --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-textfield-normal.png diff --git a/src/controls/doc/images/qtquickcontrols2-textfield-placeholder.png b/src/controls/doc/images/qtquickcontrols2-textfield-placeholder.png Binary files differnew file mode 100644 index 00000000..b040315f --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols2-textfield-placeholder.png diff --git a/src/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/controls/doc/src/qtquickcontrols2-customize.qdoc index a89c8d69..be6fc368 100644 --- a/src/controls/doc/src/qtquickcontrols2-customize.qdoc +++ b/src/controls/doc/src/qtquickcontrols2-customize.qdoc @@ -168,6 +168,24 @@ \snippet Switch.qml indicator + \section1 Customizing TextField + + TextField consists of two parts: \l {TextField::background}{background} + and \l {TextField::placeholder}{placeholder}. Their implicit sizes are + used to calculate the implicit size of the control. + + \section3 Background + + \image qtquickcontrols2-textfield-background.png + + \snippet TextField.qml background + + \section3 Placeholder + + \image qtquickcontrols2-textfield-placeholder.png + + \snippet TextField.qml placeholder + \section1 Customizing ToggleButton ToggleButton consists of three parts: \l {Control::background}{background}, diff --git a/src/controls/qquicktextfield.cpp b/src/controls/qquicktextfield.cpp index 8c7cb310..ba79fbed 100644 --- a/src/controls/qquicktextfield.cpp +++ b/src/controls/qquicktextfield.cpp @@ -42,6 +42,35 @@ QT_BEGIN_NAMESPACE +/*! + \qmltype TextField + \inherits TextInput + \instantiates QQuickTextField + \inqmlmodule QtQuick.Controls + \ingroup editors + \brief A single line text input control. + + TextField is a single line text editor. TextField extends TextInput + with a \l placeholder text functionality, and adds decoration. + + \table + \row \li \image qtquickcontrols2-textfield-normal.png + \li A text field in its normal state. + \row \li \image qtquickcontrols2-textfield-focused.png + \li A text field that has active focus. + \row \li \image qtquickcontrols2-textfield-disabled.png + \li A text field that is disabled. + \endtable + + \code + TextField { + placeholder.text: qsTr("Enter name") + } + \endcode + + \sa TextArea, {Customizing TextField} +*/ + class QQuickTextFieldPrivate { Q_DECLARE_PUBLIC(QQuickTextField) @@ -83,6 +112,17 @@ QQuickTextField::~QQuickTextField() { } +/*! + \qmlproperty Item QtQuickControls2::TextField::background + + This property holds the background item. + + \note If the background item has no explicit size specified, it automatically + follows the control's size. In most cases, there is no need to specify + width or height for a background item. + + \sa {Customizing TextField} +*/ QQuickItem *QQuickTextField::background() const { Q_D(const QQuickTextField); @@ -106,6 +146,13 @@ void QQuickTextField::setBackground(QQuickItem *background) } } +/*! + \qmlproperty Text QtQuickControls2::TextField::placeholder + + This property holds the placeholder text item. + + \sa {Customizing TextField} +*/ QQuickText *QQuickTextField::placeholder() const { Q_D(const QQuickTextField); |