summaryrefslogtreecommitdiff
path: root/src/lib/elm_slider.eo
blob: 305d64fbe35ad629c5984d899beebfc7109ff07f (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
class Elm.Slider (Elm.Layout, Elm.Interface_Atspi_Value,
                  Elm.Interface_Atspi_Widget_Action)
{
   eo_prefix: elm_obj_slider;
   methods {
      @property horizontal {
         set {
            [[Set the orientation of a given slider widget.

              Use this function to change how your slider is to be
              disposed: vertically or horizontally.

              By default it's displayed horizontally.
            ]]
         }
         get {
            [[Get the orientation of a given slider widget.]]
         }
         values {
            horizontal: bool;
         }
      }
      @property value {
         set {
            [[Set the value the slider displays.

              Value will be presented on the unit label following format
              specified with @.unit_format.set and on indicator with
              @.indicator_format.set.

              Note: The value must to be between min and max values. This values
              are set by @.min_max.set.
            ]]
         }
         get {
            [[Get the value displayed by the slider.]]
         }
         values {
            val: double; [[The value to be displayed.]]
         }
      }
      @property indicator_format {
         set {
            [[Set the format string for the indicator label.

              The slider may display its value somewhere else then unit label,
              for example, above the slider knob that is dragged around. This
              function sets the format string used for this.

              If $null, indicator label won't be visible. If not it sets the
              format string for the label text. To the label text is provided
              a floating point value, so the label text can display up to 1
              floating point value. Note that this is optional.

              Use a format string such as "%1.2f meters" for example, and it
              will display values like: "3.14 meters" for a value equal to
              3.14159.

              Default is indicator label disabled.
            ]]
         }
         get {
            [[Get the indicator label format of the slider.

              The slider may display its value somewhere else then unit label,
              for example, above the slider knob that is dragged around. This
              function gets the format string used for this.
            ]]
         }
         values {
            indicator: const(char)* @nullable; [[The format string for the indicator display.]]
         }
      }
      @property inverted {
         set {
            [[Invert a given slider widget's displaying values order

              A slider may be inverted, in which state it gets its values
              inverted, with high vales being on the left or top and low
              values on the right or bottom, as opposed to normally have
              the low values on the former and high values on the latter,
              respectively, for horizontal and vertical modes.
            ]]
         }
         get {
            [[Get whether a given slider widget's displaying values are
              inverted or not.
            ]]
         }
         values {
            inverted: bool; [[Use $true to make $obj inverted, $false to bring
                              it back to default, non-inverted values.]]
         }
      }
      @property indicator_show {
         set {
            [[Set whether to enlarge slider indicator (augmented knob) or not.

              By default, indicator will be bigger while dragged by the user.

              Warning: It won't display values set with @.indicator_format.set
              if you disable indicator.
            ]]
         }
         get {
            [[Get whether a given slider widget's enlarging indicator or not.]]
         }
         values {
            show: bool; [[$true will make it enlarge, $false will
                          let the knob always at default size.]]
         }
      }
      @property min_max {
         set {
            [[Set the minimum and maximum values for the slider.

              Define the allowed range of values to be selected by the user.

              If actual value is less than $min, it will be updated to $min.
              If it is bigger then $max, will be updated to $max. Actual value
              can be get with @.value,get.

              By default, min is equal to 0.0, and max is equal to 1.0.

              Warning: maximum must be greater than minimum, otherwise behavior
              is undefined.
            ]]
         }
         get {
            [[Get the minimum and maximum values of the slider.

              Note: If only one value is needed, the other pointer can be passed
              as $null.
            ]]
         }
         values {
            min: double; [[The minimum value.]]
            max: double; [[The maximum value.]]
         }
      }
      @property unit_format {
         set {
            [[Set the format string for the unit label.

              Unit label is displayed all the time, if set, after slider's bar.
              In horizontal mode, at right and in vertical mode, at bottom.

              If $null, unit label won't be visible. If not it sets the format
              string for the label text. To the label text is provided a
              floating point value, so the label text can display up to 1
              floating point value. Note that this is optional.

              Use a format string such as "%1.2f meters" for example, and it
              will display values like: "3.14 meters" for a value equal to
              3.14159.

              Default is unit label disabled.
            ]]
         }
         get {
            [[Get the unit label format of the slider.

              Unit label is displayed all the time, if set, after slider's bar.
              In horizontal mode, at right and in vertical mode, at bottom.
            ]]
         }
         values {
            units: const(char)* @nullable; [[The format string for the unit display.]]
         }
      }
      @property indicator_show_on_focus {
         set {
            [[Show the indicator of slider on focus.]]
         }
         get {
            [[Get whether the indicator of the slider is set or not.]]
         }
         values {
            flag: bool;
         }
      }
      @property span_size {
         set {
            [[Set the (exact) length of the bar region of a given slider widget.

              This sets the minimum width (when in horizontal mode) or height
              (when in vertical mode) of the actual bar area of the slider
              $obj. This in turn affects the object's minimum size. Use
              this when you're not setting other size hints expanding on the
              given direction (like weight and alignment hints) and you would
              like it to have a specific size.

              Note: Icon, end, label, indicator and unit text around $obj
              will require their own space, which will make $obj to require
              more the $size, actually.
            ]]
         }
         get {
            [[Get the length set for the bar region of a given slider widget

              If that size was not set previously, with @.span_size.set, this
              call will return $0.
            ]]
         }
         values {
            size: Evas.Coord; [[The length of the slider's bar region.]]
         }
      }
      @property step {
         set {
            [[Set the step by which slider indicator will move.

              This value is used when draggable object is moved automatically
              i.e., in case of key event when up/down/left/right key is pressed
              or in case when accessibility is set and flick event is used to
              inc/dec slider values. By default step value is equal to 0.05.

              @since 1.8
            ]]
         }
         get {
            [[Get the step by which slider indicator moves.

              @since 1.8
            ]]
         }
         values {
            step: double; [[The step value.]]
         }
      }
      @property indicator_visible_mode {
         set {
            [[Set the visible mode of indicator.]]
         }
         get {
            [[Get the visible mode of indicator.]]
         }
         values {
            indicator_visible_mode: Elm.Slider.Indicator_Visible_Mode; [[The indicator visible mode.]]
         }
      }
      @property indicator_format_function {
         set {
            [[Set the format function pointer for the indicator label

              Set the callback function to format the indicator string.
            ]]
         }
         values {
            func: slider_func_type @nullable; [[The indicator format function.]]
            free_func: slider_freefunc_type @nullable; [[The freeing function for the format string.]]
         }
      }
      @property units_format_function {
         set {
            [[Set the format function pointer for the units label

              Set the callback function to format the units string.
            ]]
         }
         values {
            func: slider_func_type @nullable; [[The units format function.]]
            free_func: slider_freefunc_type @nullable; [[The freeing function for the format string.]]
         }
      }
      @property range_enable {
         set {
            [[Enable range]]
         }
         get {
            [[Enable range]]
         }
         values {
            enable: Eina_Bool;
         }
      }
      range_value_get {
         [[Get range between two indicator
         ]]
         params {
            @out from: double;
            @out to: double;
         }
      }
      range_value_set {
         [[Set range between two indicators from to to 
         ]]
         return: Eina_Bool;
         params {
            @in from: double;
            @in to: double;
         }
      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Evas.Object_Smart.calculate;
      Evas.Object_Smart.add;
      Evas.Object_Smart.del;
      Elm.Widget.theme_apply;
      Elm.Widget.activate;
      Elm.Widget.focus_next_manager_is;
      Elm.Widget.focus_direction_manager_is;
      Elm.Widget.on_focus;
      Elm.Widget.event;
      Elm.Layout.text_aliases.get;
      Elm.Layout.content_aliases.get;
      Elm.Layout.sizing_eval;
      Elm.Interface_Atspi_Value.value_and_text.get;
      Elm.Interface_Atspi_Value.value_and_text.set;
      Elm.Interface_Atspi_Value.range.get;
      Elm.Interface_Atspi_Value.increment.get;
      Elm.Interface_Atspi_Widget_Action.elm_actions.get;
   }
   events {
      changed;
      delay,changed;
      slider,drag,start;
      slider,drag,stop;
   }

}