documentatiuon for checkbox and radiobutton

This commit is contained in:
Marco Martin 2011-12-22 14:11:22 +01:00
parent de666a6fd3
commit 0f62487da7
4 changed files with 24 additions and 7 deletions

View File

@ -53,7 +53,6 @@ Description:
Note: This component don't support the enabled property. Note: This component don't support the enabled property.
If you need to disable it you should disable all the buttons inside it. If you need to disable it you should disable all the buttons inside it.
TODO we need an example here...
This is an example, This is an example,
<code> <code>

View File

@ -53,7 +53,6 @@ Description:
Note: This component don't support the enabled property. Note: This component don't support the enabled property.
If you need to disable it you should disable all the buttons inside it. If you need to disable it you should disable all the buttons inside it.
TODO we need an example here...
This is an example, This is an example,
<code> <code>

View File

@ -19,15 +19,25 @@
/**Documented API /**Documented API
Inherits: Inherits:
DualStateButton The private DualStateButton
Imports: Imports:
QtQuick 1.0 QtQuick 1.0
org.kde.plasma.core org.kde.plasma.core
Description: 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: 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 import QtQuick 1.0

View File

@ -19,16 +19,25 @@
/**Documented API /**Documented API
Inherits: Inherits:
DualStateButton The private DualStateButton
Imports: Imports:
QtQuick 1.0 QtQuick 1.0
org.kde.plasma.core org.kde.plasma.core
Description: Description:
It is a simple Radio button which is using the plasma theme. 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.
TODO Do we need more info?
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 import QtQuick 1.0