From 3bc7a287df4fa16c16b7c6c8bc26d637ebed7be0 Mon Sep 17 00:00:00 2001 From: Giorgos Tsiapaliwkas Date: Mon, 31 Oct 2011 06:35:35 +0200 Subject: [PATCH] add some documentation to the Button.qml --- .../plasmacomponents/qml/Button.qml | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/declarativeimports/plasmacomponents/qml/Button.qml b/declarativeimports/plasmacomponents/qml/Button.qml index d7b62d754..533560ecb 100644 --- a/declarativeimports/plasmacomponents/qml/Button.qml +++ b/declarativeimports/plasmacomponents/qml/Button.qml @@ -17,6 +17,44 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ +/**Documentanted API +Inherits: + Item + +Imports: + org.kde.plasma.core + QtQuick 1.0 + +Description: + Just a simple button which is using the plasma theme. + Plasma theme is the theme which changes via the systemsetting-workspace appearence + -desktop theme. + +Properties: + + bool checked: + Returns if the Button is checked or not. + + bool checkable: + Set if the button will be checkable or not. + + alias pressed: + Returns if the button is pressed or not. + + alias text: + Sets the text for the button. + For example,the ok button has text 'ok' + + alias iconSource: + TODO needs to be filled + + alias font: + TODO needs to be filled + +Signals: + onClicked: + The signal is emited when button is clicked. +**/ import QtQuick 1.0 import org.kde.plasma.core 0.1 as PlasmaCore