alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add some docu to ButtonRow and ButtonColumn

Browse Source
This commit is contained in:
Giorgos Tsiapaliwkas 2011-10-31 06:47:17 +02:00
parent 339904e610
commit 90b4d074ca
2 changed files with 65 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
declarativeimports/plasmacomponents/qml/ButtonColumn.qml
View File

@ -42,36 +42,45 @@
import Qt 4.7 import Qt 4.7
import "ButtonGroup.js" as Behavior import "ButtonGroup.js" as Behavior
/* /**Documentanted API
Class: ButtonColumn Inherits:
Column
Imports:
ButtonGroup.js
Qt 4.7
Description:
A ButtonColumn allows you to group Buttons in a column. It provides a selection-behavior as well. A ButtonColumn allows you to group Buttons in a column. It provides a selection-behavior as well.
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,
<code> <code>
ButtonColumn { ButtonColumn {
Button { text: "Top" } Button { text: "Top" }
Button { text: "Bottom" } Button { text: "Bottom" }
} }
</code> </code>
*/
Properties:
bool exclusive:
Specifies the grouping behavior. If enabled, the checked property on buttons contained
in the group will be exclusive.
Note that a button in an exclusive group will allways be checkable
Item checkedButton:
Returns the last checked button.
**/
Column { Column {
id: root id: root
/*
* Property: exclusive
* [bool=true] Specifies the grouping behavior. If enabled, the checked property on buttons contained
* in the group will be exclusive.
*
* Note that a button in an exclusive group will allways be checkable
*/
property bool exclusive: true property bool exclusive: true
/*
* Property: checkedButton
* [string] Contains the last checked Button.
*/
property Item checkedButton; property Item checkedButton;
Component.onCompleted: { Component.onCompleted: {

38
declarativeimports/plasmacomponents/qml/ButtonRow.qml
View File

@ -42,36 +42,46 @@
import QtQuick 1.1 import QtQuick 1.1
import "ButtonGroup.js" as Behavior import "ButtonGroup.js" as Behavior
/*
Class: ButtonRow /**Documentanted API
Inherits:
Row
Imports:
ButtonGroup.js
QtQuick 1.1
Description:
A ButtonRow allows you to group Buttons in a row. It provides a selection-behavior as well. A ButtonRow allows you to group Buttons in a row. It provides a selection-behavior as well.
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,
<code> <code>
ButtonRow { ButtonRow {
Button { text: "Left" } Button { text: "Left" }
Button { text: "Right" } Button { text: "Right" }
} }
</code> </code>
*/
Properties:
bool exclusive:
Specifies the grouping behavior. If enabled, the checked property on buttons contained
in the group will be exclusive.
Note that a button in an exclusive group will allways be checkable
Item checkedButton:
Returns the last checked button.
**/
Row { Row {
id: root id: root
/*
* Property: exclusive
* [bool=true] Specifies the grouping behavior. If enabled, the checked property on buttons contained
* in the group will be exclusive.
*
* Note that a button in an exclusive group will allways be checkable
*/
property bool exclusive: true property bool exclusive: true
/*
* Property: checkedButton
* [string] Contains the last checked Button.
*/
property Item checkedButton; property Item checkedButton;
Component.onCompleted: { Component.onCompleted: {