summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_progressbar.eo
blob: e2994a266f71f0b6819b85afda0f20dfb208281e (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
64
65
66
67
68
class @beta Efl.Ui.Progressbar extends Efl.Ui.Layout_Base implements Efl.Ui.Range_Display, Efl.Ui.Format,
                          Efl.Ui.Layout_Orientable, Efl.Access.Value,
                          Efl.Text, Efl.Content, Efl.Text_Markup
{
   [[Elementary progressbar class]]
   methods {
      @property pulse_mode {
         [[Control whether a given progress bar widget is at "pulsing mode" or not.

           By default progress bars display values from low to
           high boundaries. There are situations however in which the
           progress of a given task is unknown. In these cases,
           you can set a progress bar widget to a "pulsing state" to give
           the user an idea that some computation is being done
           without showing the precise progress rate. In the default theme, it will
           animate the bar with content, switching constantly between filling it and back
           to non-filled in a loop. To start and stop this pulsing
           animation you need to explicitly call @.pulse.set().
         ]]

         set {
         }
         get {
         }
         values {
            pulse: bool; [[$true to put $obj in pulsing mode, $false to put it back to its default one]]
         }
      }
      @property pulse {
         [[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". See @.pulse_mode.
         ]]
         set {
         }
         get {
         }
         values {
           state: bool; [[$true, to start the pulsing animation, $false to stop it]]
         }
      }
      @property show_progress_label {
         [[Whether a textual progress label is shown alongside the progressbar to give an exact
           numerical indication of the current progress.

           Not to be confused with the widget label set through @Efl.Text.text.
         ]]
         values {
           show: bool; [[$true to show the progress label.]]
         }
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Ui.Widget.theme_apply;
      Efl.Ui.Range_Display.range_value { get; set; }
      Efl.Ui.Range_Display.range_limits {get; set; }
      Efl.Ui.Layout_Orientable.orientation { get; set; }
      Efl.Ui.Format.apply_formatted_value;
      Efl.Part.part_get;
      Efl.Access.Value.value_and_text { get; }
      Efl.Text.text { get; set; }
      Efl.Text_Markup.markup { get; set; }
      Efl.Content.content { get; set; }
      Efl.Content.content_unset;
      Efl.Ui.L10n.l10n_text { get; set; }
   }
}