summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_spin_button.eo
blob: 45b16b7af8cee5c37bc92b4ca07f76a8f40b8a87 (plain)
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
69
70
71
72
73
74
75
76
77
class @beta Efl.Ui.Spin_Button extends Efl.Ui.Spin implements Efl.Ui.Focus.Composition, Efl.Ui.Layout_Orientable,
                          Efl.Access.Widget.Action
{
   [[A Button Spin.

     This is a widget which allows the user to increase or decrease
     numeric values using the arrow buttons or to edit values directly by clicking
     over them and inputting new ones.
   ]]
   methods {
      @property wraparound {
         [[Control whether the spin should circulate value when it reaches its minimum or maximum value.

           Disabled by default. If disabled, when the user tries to increment the
           value
           but displayed value plus step value is bigger than maximum value,
           the new value will be the maximum value.
           The same happens when the user tries to decrement it
           but the value less step is less than minimum value. In this case,
           the new displayed value will be the minimum value.

           If enabled, when the user tries to increment the value
           but displayed value plus step value is bigger than maximum value,
           the new value will become the minimum value. When the the user tries to
           decrement it, if the value minus step is less than minimum value,
           the new displayed value will be the maximum value.

           E.g.:
           $min = 10
           $max = 50
           $step = 20
           $displayed = 20

           When the user decrements the value (using left or bottom arrow), it will
           display $50.]]
         set {
         }
         get {
         }
         values {
            circulate: bool(false); [[$true to enable circulate or $false to disable it.]]
         }
      }
      @property editable {
         [[Control whether the spin can be directly edited by the user.

           Spin objects can have editing disabled, in which case they can only
           be changed by using arrows.
           This is useful for situations
           where you don't want your users to write their own value.
           It's especially useful
           when using special values. The user can see the real values instead
           of special label when editing.]]
         set {
         }
         get {
         }
         values {
            editable: bool(false); [[$true to allow users to edit it or $false to don't allow users to edit it directly.]]
         }
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Ui.Widget.theme_apply;
      Efl.Ui.Widget.widget_input_event_handler;
      Efl.Ui.Focus.Object.on_focus_update;
      Efl.Ui.Range_Display.range_value { set; }
      Efl.Ui.Layout_Orientable.orientation { get; set; }
      Efl.Access.Object.i18n_name { get; }
      Efl.Access.Value.value_and_text { get; set; }
      Efl.Access.Value.range { get; }
      Efl.Access.Value.increment { get; }
      Efl.Access.Widget.Action.elm_actions { get; }
      Efl.Ui.Format.apply_formatted_value;
   }
}