summaryrefslogtreecommitdiff
path: root/src/lib/ewe_ruler.eo
blob: 2699e153f8c8b502a665888f039db13d82b03e6b (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
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
class Ewe_Ruler (Elm_Widget)
{
   eo_prefix: ewe_obj_ruler;
   data: Ewe_Ruler_Smart_Data;
   properties {
      horizontal {
         get {
         /*@
          Get the ruler orientation.

          @param obj The ruler object
          @return EINA_TRUE if ruler is horizontal or EINA_FALSE otherwise
          @ingroup ruler*/
         }
         set {
         /*@
          Change the ruler's orientation to horizontal or vertical.

          @return EINA_TRUE if orientation was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         values {
           Eina_Bool horizontal;
         }
      }
      step {
         get {
         /*@
          Get step between marks of the ruler.

          @param obj The ruler object
          @return step
          @ingroup ruler*/
         }
         set {
         /*@
          Set step between marks of the ruler

          @return EINA_TRUE if step was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           uint step;
         }
      }
      value_step {
         get {
         /*@
          Get step between marks values of the ruler.

          @param obj The ruler object
          @return step
          @ingroup ruler*/
         }
         set {
         /*@
          Set step between marks values of the scale

          @return EINA_TRUE if step was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           double step;
         }
      }
      zero_offset {
         get {
         /*@
          Get "zero pointer" mark position

          @param obj The ruler object
          @return offset
          @ingroup ruler*/
         }
         set {
         /*@
          Change the ruler's "zero pointer" mark position
          @return EINA_TRUE if offset was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           int offset;
         }
      }
      format {
         get {
         /*@
          Get format string of given scale.

          @param obj The ruler object
          @return format string
          @ingroup ruler*/
         }
         set {
         /*@
          Set format string for given scale

          @return EINA_TRUE if format was setted or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           const(char) *format;
         }
      }
      style {
         get {
         /*@
          Get style of given scale.

          @param obj The ruler object
          @return style
          @ingroup ruler*/
         }
         set {
         /*@
          Set style for given scale

          @return EINA_TRUE if style was setted or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           const(char) *style;
         }
      }
      scale_visible {
         get {
         /*@
          Get visibility of given scale

          @param obj The ruler object
          @param scale Scale
          @return visibility
          @ingroup ruler*/
         }
         set {
         /*@
          Change the scale's visibility
          @param obj The ruler object
          @param scale Scale
          @param visible New visibility state of given scale
          @return EINA_TRUE if offset was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           Eina_Bool visible;
         }
      }
      scale_middle_mark {
         get {
         /*@
          Get visibility of middle mark in given scale

          @param obj The ruler object
          @param scale Scale
          @return visibility
          @ingroup ruler*/
         }
         set {
         /*@
          Change the scale middle mark visibility
          @param obj The ruler object
          @param scale Scale
          @param middle_mark New visibility state of middle mark in scale
          @return EINA_TRUE if middle_mark was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Scale *scale;
         }
         values {
           Eina_Bool middle_mark;
         }
      }
      marker_relative {
         get {
         /*@
          Get marker position relative to given scale

          @param obj The ruler object
          @param marker Marker
          @param scale Scale
          @return relative position
          @ingroup ruler*/
         }
         set {
         /*@
          Set marker to folow specified value on given scale
          @return EINA_TRUE if position was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Marker *marker;
           Ewe_Ruler_Scale *scale;
         }
         values {
           double rel_position;
         }
      }
      marker_absolute {
         get {
         /*@
          Get marker position

          @param obj The ruler object
          @param marker Marker
          @return marker position
          @ingroup ruler*/
         }
         set {
         /*@
          Set marker absolute posiiton
          @return EINA_TRUE if position was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Marker *marker;
         }
         values {
           int position;
         }
      }
      marker_visible {
         get {
         /*@
          Get visibility of given marker

          @param obj The ruler object
          @param marker Marker
          @return visibility of arker
          @ingroup ruler*/
         }
         set {
         /*@
          Change the marker's visibility
          @param obj The ruler object
          @param marker Marker
          @param visible New visibility state of given marker
          @return EINA_TRUE if visibility was set or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Marker *marker;
         }
         values {
           Eina_Bool visible;
         }
      }
      marker_style {
         get {
         /*@
          Get style of given marker.

          @param obj The ruler object
          @return style
          @ingroup ruler*/
         }
         set {
         /*@
          Set style for given marker

          @return EINA_TRUE if style was setted or EINA_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         }
         keys {
           Ewe_Ruler_Marker *marker;
         }
         values {
           const(char) *style;
         }
      }
   }
   methods {
      scale_add {
         /*@
          Add new scale to ruler.
          @param obj The ruler object
          @param style Style of new scale. NULL - default.
          @return Scale object or NULL on failure.

          @ingroup ruler*/
         return: Ewe_Ruler_Scale *;
         params {
            const(char) *style;
         }
      }
      scale_del {
         /*@
          Delete given scale from ruler.
          @param obj The ruler object
          @param scale Scale to be deleted
          @return EINA_TRUE on success, EIAN_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         params {
            Ewe_Ruler_Scale *scale;
         }
      }
      marker_add {
         /*@
          Add new marker to ruler.
          @param obj The ruler object
          @param style Style of new marker. NULL - default.
          @return Marker object or NULL on failure.

          @ingroup ruler*/
         return: Ewe_Ruler_Marker *;
         params {
            const(char) *style;
         }
      }
      marker_del {
         /*@
          Delete given marker from ruler.
          @param obj The ruler object
          @param marker Marker to be deleted
          @return EINA_TRUE on success, EIAN_FALSE on failure.

          @ingroup ruler*/
         return: Eina_Bool;
         params {
            Ewe_Ruler_Marker *marker;
         }
      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Evas.Object_Smart.add;
      Evas.Object_Smart.del;
      Evas.Object_Smart.resize;
      Evas.Object_Smart.calculate;
      Evas.Object_Smart.move;
      Evas.Object_Smart.show;
      Evas.Object_Smart.hide;
      Elm_Widget.theme_apply;
   }
   events {
   }
}