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

Doxygenize ProgressBar

Browse Source
This commit is contained in:
Aurélien Gâteau 2012-12-17 21:39:55 +01:00
parent 9e72c32972
commit d096024f63
1 changed files with 28 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
declarativeimports/plasmacomponents/qml/ProgressBar.qml
View File

@ -17,54 +17,47 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**Documented API
Inherits:
Item
Imports:
QtQuick 1.0
org.kde.plasma.core
Description:
It is a simple progressBar which is using the plasma theme.
Some operations take a period of time to be performed and the user needs a confirmation that the operation is still ongoing. If the user does not get any confirmation, they might suspect that they did something wrong or that the device has broken. A progress bar is one of available mechanisms for providing this reassurance to the user.
Properties:
* real minimumValue:
Minimum Value for the progressBar
* real maximumValue:
Maximum value for the progressBar
real value:
Current value of the progressBar
* bool indeterminate:
Indicates whether the operation's duration is known or not. The property can have the following values:
true - the operation's duration is unknown, so the progress bar is animated. The value, minimum, and maximum properties are ignored.
false - the operation's duration is known, so the progress bar is drawn to indicate progress between the minimum and maximum values.
The default value is false.
* int orientation:
Orientation of the progressBar:
Qt.Horizontal or
Qt.Vertical
**/
import QtQuick 1.0
import org.kde.plasma.core 0.1 as PlasmaCore
import org.kde.qtextracomponents 0.1
/**
* Simple progressBar using the plasma theme.
*
* Some operations take a period of time to be performed and the user needs a
* confirmation that the operation is still ongoing. If the user does not get
* any confirmation, they might suspect that they did something wrong or that
* the device has broken. A progress bar is one of the available mechanisms for
* providing this reassurance to the user.
*/
Item {
id: progressBar
// Common API
/** type:real Minimum value for the progressBar */
property alias minimumValue: range.minimumValue
/** type:real Maximum value for the progressBar */
property alias maximumValue: range.maximumValue
/** type:real Current value of the progressBar */
property alias value: range.value
/**
* type:bool
* Indicates whether the operation's duration is known or not. The property
* can have the following values:
*
* - true: the operation's duration is unknown, so the progress bar is
* animated. The value, minimum, and maximum properties are ignored.
* - false: the operation's duration is known, so the progress bar is drawn
* to indicate progress between the minimum and maximum values.
*
* The default value is false.
*/
property alias indeterminate: indeterminateAnimation.running
// Plasma API
/**
* Orientation of the progressBar: Qt.Horizontal or Qt.Vertical
*/
property int orientation: Qt.Horizontal
width: 100
@ -179,4 +172,4 @@ Item {
}
}
}
}
}