diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-03-07 16:49:14 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-03-11 12:49:41 +0100 |
commit | b19f991a2c1fb9f0ce3ce833b55a0d11d8077032 (patch) | |
tree | 941621b79ab3934451524dc4b5c4212d941d6785 /src | |
parent | 31b5da1053bd714c09e5a7bb7d9e53a9eff800e6 (diff) | |
download | qtquickcontrols-b19f991a2c1fb9f0ce3ce833b55a0d11d8077032.tar.gz |
Doc: Edited Button documentation.
-edited the sentences and the width of the doc comments.
Change-Id: If05e8205730347368cd75aac475f520cc2a50184
Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/controls/Button.qml | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/src/controls/Button.qml b/src/controls/Button.qml index 9d066f62..57b5b355 100644 --- a/src/controls/Button.qml +++ b/src/controls/Button.qml @@ -49,29 +49,38 @@ import "Styles/Settings.js" as Settings \ingroup controls \brief A push button with a text label. - A normal push button. Similar to the QPushButton widget. + The push button is perhaps the most commonly used widget in any graphical + user interface. Pushing (or clicking) a button commands the computer to + perform some action or to answer a question. Common examples of buttons are + OK, Apply, Cancel, Close, Yes, No, and Help buttons. - The push button is perhaps the most commonly used widget in any graphical user interface. - Push (click) a button to command the computer to perform some action, or to answer a question. - Typical buttons are OK, Apply, Cancel, Close, Yes, No and Help. + Button is similar to the QPushButton widget. */ BasicButton { id: button /*! This property holds whether the push button is the default button. - Default buttons decide what happens when the user presses enter in a dialog without giving a button explicit focus. - \note This property is currently ignored by Dialog + Default buttons decide what happens when the user presses enter in a + dialog without giving a button explicit focus. \note This property is + ignored by Dialog. + The default value is \c false. */ property bool isDefault: false - /*! This property holds the text shown on the button. - If the button has no text, the \l text property will be an empty string. */ + /*! This property holds the text shown on the button. If the button has no + text, the \l text property will be an empty string. + + The default value is the empty string. + */ property string text - /*! This property holds the icon shown on the button. - If the button has no icon, the \l iconSource property will be an empty string. */ + /*! This property holds the icon shown on the button. If the button has no + icon, the \l iconSource property will be an empty string. + + The default value is the empty string. + */ property url iconSource Accessible.name: text |