summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-01-16 15:05:43 +0000
committerMarcel Hollerbach <mail@marcel-hollerbach.de>2020-01-16 16:36:43 +0100
commitbdaf20fb4c4bca57c165fc3a7126b3963306750a (patch)
treea688016454bc9703bc85afa00f66ed56adf26bd6
parente92ee40b2f73b5860efd20b31bc1501273e7cf8a (diff)
docs: Give some love to progress bar docs.
Differential Revision: https://phab.enlightenment.org/D11112
-rw-r--r--src/lib/efl/interfaces/efl_ui_range_display.eo2
-rw-r--r--src/lib/elementary/efl_ui_progressbar.eo29
2 files changed, 24 insertions, 7 deletions
diff --git a/src/lib/efl/interfaces/efl_ui_range_display.eo b/src/lib/efl/interfaces/efl_ui_range_display.eo
index 4b8cade311..2a9a75abb7 100644
--- a/src/lib/efl/interfaces/efl_ui_range_display.eo
+++ b/src/lib/efl/interfaces/efl_ui_range_display.eo
@@ -4,7 +4,7 @@ interface Efl.Ui.Range_Display
4 4
5 A value range contains a value restricted between specified minimum and maximum 5 A value range contains a value restricted between specified minimum and maximum
6 limits at all times. 6 limits at all times.
7 This can be used for progressbars, sliders or spinners, for example. 7 This can be used for progress bars, sliders or spinners, for example.
8 8
9 @since 1.23 9 @since 1.23
10 ]] 10 ]]
diff --git a/src/lib/elementary/efl_ui_progressbar.eo b/src/lib/elementary/efl_ui_progressbar.eo
index 1bc55057f3..3f6917b95c 100644
--- a/src/lib/elementary/efl_ui_progressbar.eo
+++ b/src/lib/elementary/efl_ui_progressbar.eo
@@ -2,24 +2,41 @@ class @beta Efl.Ui.Progressbar extends Efl.Ui.Layout_Base implements Efl.Ui.Rang
2 Efl.Ui.Layout_Orientable, Efl.Access.Value, 2 Efl.Ui.Layout_Orientable, Efl.Access.Value,
3 Efl.Text, Efl.Content, Efl.Text_Markup 3 Efl.Text, Efl.Content, Efl.Text_Markup
4{ 4{
5 [[Elementary progressbar class]] 5 [[Progress bar widget.
6
7 It shows a graphical indication of the current progress of some lengthy operation,
8 typically as a bar that gradually fills or a pointer that moves from one side of the
9 bar to the other. The bar can be horizontal or vertical, controlled with @Efl.Ui.Layout_Orientable.
10
11 The minimum and maximum values (or starting and ending values), along with the current
12 value can be set using the @Efl.Ui.Range_Display interface.
13
14 @.infinite_mode can be set when the progress state is unknown.
15 An optional textual label can be shown to indicate the exact numerical value of the progress.
16 ]]
6 methods { 17 methods {
7 @property infinite_mode { 18 @property infinite_mode {
8 [[Start/stop a given progress bar "pulsing" animation, if this mode is enabled.]] 19 [[When this mode is enabled the progress bar indicates that there is an operation
20 going on, but does not give information about its progress.
21 This is typically shown as a "pulsing" animation or an endless spinning bar,
22 depending on the theme.
23 ]]
9 set { 24 set {
10 } 25 }
11 get { 26 get {
12 } 27 }
13 values { 28 values {
14 state: bool; [[$true if the progressbar should animate infinitely, 29 state: bool; [[$true if the progress bar should animate infinitely.]]
15 $false if the progressbar should animate based on a fixed endpoint.]]
16 } 30 }
17 } 31 }
18 @property show_progress_label { 32 @property show_progress_label {
19 [[Whether a textual progress label is shown alongside the progressbar to give an exact 33 [[Whether a textual progress label is shown alongside the progress bar to give an exact
20 numerical indication of the current progress. 34 numerical indication of the current progress. Control the conversion of the numerical
35 value to a text string using @Efl.Ui.Format.
21 36
22 Not to be confused with the widget label set through @Efl.Text.text. 37 Not to be confused with the widget label set through @Efl.Text.text.
38
39 The exact location and appearance of the progress label depend on the theme.
23 ]] 40 ]]
24 values { 41 values {
25 show: bool; [[$true to show the progress label.]] 42 show: bool; [[$true to show the progress label.]]