From c9fd039faac4c7a04f1a47ad0e96ca929aa5c2ca Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Tue, 9 Jun 2015 22:31:20 +0200 Subject: Tweak Button docs Change-Id: I23ee64fea97718a4688b03887eb2a62ccb464193 Reviewed-by: J-P Nurmi --- src/controls/qquickbutton.cpp | 28 +++++++++++----------------- 1 file changed, 11 insertions(+), 17 deletions(-) (limited to 'src/controls') diff --git a/src/controls/qquickbutton.cpp b/src/controls/qquickbutton.cpp index f8aa426c..69182881 100644 --- a/src/controls/qquickbutton.cpp +++ b/src/controls/qquickbutton.cpp @@ -76,20 +76,17 @@ QT_BEGIN_NAMESPACE } \endcode - \section1 Structure - Button consists of two delegates, \l {Control::background}{background} - and \l {Button::label}{label}. The implicit sizes of both delegates are - used to calculate the implicit size of the control. + Button consists of two parts, \l {Control::background}{background} and + \l {Button::label}{label}. Their implicit sizes are used to calculate + the implicit size of the control. \section3 Background \image qtquickcontrols2-button-background.png - If the \l {Control::background}{background} delegate has no explicit size - specified, it automatically follows the control's size. The following - snippet presents the default background delegate implementation. + The following snippet presents the default background item implementation. \snippet Button.qml background @@ -97,7 +94,7 @@ QT_BEGIN_NAMESPACE \image qtquickcontrols2-button-label.png - The following snippet presents the default label delegate implementation. + The following snippet presents the default label item implementation. \snippet Button.qml label @@ -109,13 +106,13 @@ QT_BEGIN_NAMESPACE /*! \qmlsignal QtQuickControls2::Button::pressed() - This signal is emitted when the button is pressed. + This signal is emitted when the button is interactively pressed by the user. */ /*! \qmlsignal QtQuickControls2::Button::released() - This signal is emitted when the button is released. + This signal is emitted when the button is interactively released by the user. */ /*! @@ -153,10 +150,10 @@ QQuickButton::QQuickButton(QQuickButtonPrivate &dd, QQuickItem *parent) : /*! \qmlproperty string QtQuickControls2::Button::text - This property holds the text shown on the button. + This property holds a textual description of the button. \note The text is used for accessibility purposes, so it makes sense to - set a textual description even if the label delegate is an image. + set a textual description even if the label item is an image. \sa label */ @@ -198,12 +195,9 @@ void QQuickButton::setPressed(bool isPressed) /*! \qmlproperty Item QtQuickControls2::Button::label - This property holds the label delegate. - - The implicit size of the label delegate is used to calculate - the implicit size of the control. + This property holds the label item. - \sa Structure, text + \sa text */ QQuickItem *QQuickButton::label() const { -- cgit v1.2.3