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

Add more details to Button Plasma Component documentation

Browse Source 
Signed-off-by: Daker Fernandes Pinheiro <daker.pinheiro@openbossa.org>
This commit is contained in:
Daker Fernandes Pinheiro 2011-11-26 14:16:21 -03:00
parent 8c317c3727
commit f50fb6e6d6
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -28,34 +28,43 @@ Imports:
QtQuick 1.0 QtQuick 1.0
Description: Description:
Just a simple button which is using the plasma theme. A simple button, with optional label and icon which uses the plasma theme.
This button component can also be used as a checkable button by using the checkable
and checked properties for that.
Plasma theme is the theme which changes via the systemsetting-workspace appearence Plasma theme is the theme which changes via the systemsetting-workspace appearence
-desktop theme. -desktop theme.
Properties: Properties:
bool checked: bool checked:
Returns if the Button is checked or not. This property holds wheter this button is checked or not.
The button must be in the checkable state for enable users check or uncheck it.
The default value is false.
See also checkable property.
bool checkable: bool checkable:
Set if the button will be checkable or not. This property holds if the button is acting like a checkable button or not.
The default value is false.
alias pressed: bool pressed:
Returns if the button is pressed or not. This property holds if the button is pressed or not.
Read-only.
alias text: string text:
Sets the text for the button. This property holds the text label for the button.
For example,the ok button has text 'ok' For example,the ok button has text 'ok'.
The default value for this property is an empty string.
alias iconSource: url iconSource:
TODO needs to be filled This property holds the source url for the Button's icon.
The default value is an empty url, which displays no icon.
alias font: font font:
Sets the font for the button. This property holds the font used by the button label.
See also Qt documentation for font type.
Signals: Signals:
onClicked: onClicked:
The signal is emited when button is clicked. This handler is called when there is a click.
**/ **/
import QtQuick 1.0 import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore import org.kde.plasma.core 0.1 as PlasmaCore