From 0f62487da7aa4233b962a6636f3bd2e47573b58d Mon Sep 17 00:00:00 2001 From: Marco Martin Date: Thu, 22 Dec 2011 14:11:22 +0100 Subject: [PATCH] documentatiuon for checkbox and radiobutton --- .../plasmacomponents/qml/ButtonColumn.qml | 1 - .../plasmacomponents/qml/ButtonRow.qml | 1 - .../plasmacomponents/qml/CheckBox.qml | 14 ++++++++++++-- .../plasmacomponents/qml/RadioButton.qml | 15 ++++++++++++--- 4 files changed, 24 insertions(+), 7 deletions(-) diff --git a/declarativeimports/plasmacomponents/qml/ButtonColumn.qml b/declarativeimports/plasmacomponents/qml/ButtonColumn.qml index 731d2e4b4..2bb6ac461 100644 --- a/declarativeimports/plasmacomponents/qml/ButtonColumn.qml +++ b/declarativeimports/plasmacomponents/qml/ButtonColumn.qml @@ -53,7 +53,6 @@ Description: Note: This component don't support the enabled property. If you need to disable it you should disable all the buttons inside it. - TODO we need an example here... This is an example, diff --git a/declarativeimports/plasmacomponents/qml/ButtonRow.qml b/declarativeimports/plasmacomponents/qml/ButtonRow.qml index 98a83df1a..17191e220 100644 --- a/declarativeimports/plasmacomponents/qml/ButtonRow.qml +++ b/declarativeimports/plasmacomponents/qml/ButtonRow.qml @@ -53,7 +53,6 @@ Description: Note: This component don't support the enabled property. If you need to disable it you should disable all the buttons inside it. - TODO we need an example here... This is an example, diff --git a/declarativeimports/plasmacomponents/qml/CheckBox.qml b/declarativeimports/plasmacomponents/qml/CheckBox.qml index 6e30a245d..1a9c17db6 100644 --- a/declarativeimports/plasmacomponents/qml/CheckBox.qml +++ b/declarativeimports/plasmacomponents/qml/CheckBox.qml @@ -19,15 +19,25 @@ /**Documented API Inherits: - DualStateButton + The private DualStateButton Imports: QtQuick 1.0 org.kde.plasma.core Description: - TODO i need more info here + A check box is a component that can be switched on (checked) or off (unchecked). Check boxes are typically used to represent features in an application that can be enabled or disabled without affecting others, but different types of behavior can be implemented. When a check box is checked or unchecked it sends a clicked signal for the application to handle. + When a check box has the focus, its state can be toggled using the Qt.Key_Select, Qt.Key_Return, and Qt.Key_Enter hardware keys that send the clicked signal. Properties: + bool checked: If the button is checked, its checked property is true; otherwise false. The property is false by default. + + bool pressed: If the button is pressed, its pressed property is true. + See also clicked. + + string text: The text is shown beside the check box. By default text is an empty string. +Signals: + clicked(): + Emitted when the user clicked a mouse button over the checkbox (or tapped on the touch screen) **/ import QtQuick 1.0 diff --git a/declarativeimports/plasmacomponents/qml/RadioButton.qml b/declarativeimports/plasmacomponents/qml/RadioButton.qml index 2b79cb9fd..b40eee0b0 100644 --- a/declarativeimports/plasmacomponents/qml/RadioButton.qml +++ b/declarativeimports/plasmacomponents/qml/RadioButton.qml @@ -19,16 +19,25 @@ /**Documented API Inherits: - DualStateButton + The private DualStateButton Imports: QtQuick 1.0 org.kde.plasma.core Description: - It is a simple Radio button which is using the plasma theme. - TODO Do we need more info? + A radio button component consists of a radio button and a line of text. Only one item in a list may be selected at a time. Once an item is selected, it can be deselected only by selecting another item. Initial item selection may be set at the list creation. If not set, the list is shown without a selection. +Properties: + bool checked: If the button is checked, its checked property is true; otherwise false. The property is false by default. + + bool pressed: If the button is pressed, its pressed property is true. + See also clicked. + + string text: The text is shown beside the check box. By default text is an empty string. +Signals: + clicked(): + Emitted when the user clicked a mouse button over the checkbox (or tapped on the touch screen) **/ import QtQuick 1.0