summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_progressbar.eo
blob: da65e80fc0569fbd149d2d650a51388db4b926dc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class Efl.Ui.Progressbar (Efl.Ui.Layout, Efl.Ui.Range, Efl.Ui.Format, Efl.Ui.Direction)
{
   [[Elementary progressbar class]]
   methods {
      @property pulse_mode {
         [[Control whether a given progress bar widget is at "pulsing mode" or not.

           By default, progress bars will display values from the low to
           high value boundaries. There are, though, contexts in which the
           progress of a given task is unknown. For such cases,
           one can set a progress bar widget to a "pulsing state", to give
           the user an idea that some computation is being held, but
           without exact progress values. In the default theme, it will
           animate its bar with the contents filling in constantly and back
           to non-filled, in a loop. To start and stop this pulsing
           animation, one has to explicitly call elm_progressbar_pulse().

           @since 1.20
         ]]

         set {
         }
         get {
         }
         values {
            pulse: bool; [[$true to put $obj in pulsing mode, $false to put it back to its default one]]
         }
      }
      @property pulse {
         set {
           [[Start/stop a given progress bar "pulsing" animation, if its under that mode

           Note: This call won't do anything if $obj is not under "pulsing mode".

           @since 1.20
           ]]
         }
         get {
            [[ Get the pulsing state on a given progressbar widget.

            @since 1.20
            ]]
         }
         values {
           state: bool; [[$true, to start the pulsing animation, $false to stop it]]
         }
      }
   }
   implements {
      class.constructor;
      Efl.Object.constructor;
      Elm.Widget.theme_apply;
      Elm.Widget.widget_sub_object_add;
      Elm.Widget.widget_sub_object_del;
      Efl.Ui.Range.range_value { get; set; }
      Efl.Ui.Direction.direction { get; set; }
      Efl.Ui.Format.format_string { get; set; }
      Efl.Part.part;
   }
   events {
      changed; [[Called when progressbar changed]]
   }
}