Doxygenize RadioButton

This commit is contained in:
Aurélien Gâteau 2012-12-17 22:02:29 +01:00
parent d096024f63
commit e0575ce650

View File

@ -17,37 +17,19 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**Documented API
Inherits:
The private DualStateButton
Imports:
QtQuick 1.0
org.kde.plasma.core
Description:
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
import org.kde.plasma.core 0.1 as PlasmaCore
import "private" as Private
/**
* 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.
*
* All elements of this component are defined in DualStateButton, its base component.
*/
//FIXME: this should be round, DualStateButton shouldn't draw the shadow
Private.DualStateButton {
id: radioButton