summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_datetime.eo
blob: 4f03b486b38eb0b7aba9e7d6d1ee305dce90799b (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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
enum Elm.Datetime.Field_Type
{
   [[
      @addtogroup Datetime
      Identifies a Datetime field, The widget supports 6 fields : Year, month,
      Date, Hour, Minute, AM/PM
   ]]

   legacy: elm_datetime;
   year    = 0, [[Indicates Year field.]]
   month   = 1, [[Indicates Month field.]]
   date    = 2, [[Indicates Date field.]]
   hour    = 3, [[Indicates Hour field.]]
   minute  = 4, [[Indicates Minute field.]]
   ampm    = 5, [[Indicates AM/PM field .]]
}

class Elm.Datetime (Elm.Layout)
{
   eo_prefix: elm_obj_datetime;
   methods {
      @property format {
         set {
            /*@
            Set the datetime format. Format is a combination of allowed Libc date format
            specifiers like: "%b %d, %Y %I : %M %p".

            Maximum allowed format length is 64 chars.

            Format can include separators for each individual datetime field except
            for AM/PM field.

            Each separator can be a maximum of 6 UTF-8 bytes.
            Space is also taken as a separator.

            Following are the allowed set of format specifiers for each datetime field.

            @b %%Y : The year as a decimal number including the century.

            @b %%y : The year as a decimal number without a century (range 00 to 99).

            @b %%m : The month as a decimal number (range 01 to 12).

            @b %%b : The abbreviated month name according to the current locale.

            @b %%B : The full month name according to the current locale.

            @b %%h : The abbreviated month name according to the current locale(same as %%b).

            @b %%d : The day of the month as a decimal number (range 01 to 31).

            @b %%e : The day of the month as a decimal number (range 1 to 31). single
            digits are preceded by a blank.

            @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12).

            @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23).

            @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single
            digits are preceded by a blank.

            @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single
            digits are preceded by a blank.

            @b %%M : The minute as a decimal number (range 00 to 59).

            @b %%p : Either 'AM' or 'PM' according to the given time value, or the
            corresponding strings for the current locale. Noon is treated as 'PM'
            and midnight as 'AM'.

            @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for
            the current locale.

            @b %%c : The preferred date and time representation for the current locale.

            @b %%x : The preferred date representation for the current locale without the time.

            @b %%X : The preferred time representation for the current locale without the date.

            @b %%r : The complete calendar time using the AM/PM format of the current locale.

            @b %%R : The hour and minute in decimal numbers using the format %H:%M.

            @b %%T : The time of day in decimal numbers using the format %H:%M:%S.

            @b %%D : The date using the format %%m/%%d/%%y.

            @b %%F : The date using the format %%Y-%%m-%%d.

            These specifiers can be arranged in any order and the widget will display the
            fields accordingly.

            Default format is taken as per the system locale settings.

            @see elm_datetime_format_get()
            @ingroup Datetime */
         }
         get {
            /*@ Get the datetime format. */
         }
         values {
            fmt: const(char)* @nullable; /*@ The datetime format */
         }
      }
      field_limit_set {
         /*@
         @brief Set the field limits of a field.

         Limits can be set to individual fields, independently, except for AM/PM field.
         Any field can display the values only in between these Minimum and Maximum limits unless
         the corresponding time value is restricted from MinTime to MaxTime.
         That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime.

         There is no provision to set the limits of AM/PM field.

         @see elm_datetime_field_limit_set()
         @ingroup Datetime */

         params {
            @in fieldtype: Elm.Datetime.Field_Type; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
            @in min: int; /*@ Reference to field's minimum value */
            @in max: int; /*@ Reference to field's maximum value */
         }
      }
      field_limit_get @const {
         /*@
         @brief Get the field limits of a field.

         Limits can be set to individual fields, independently, except for AM/PM field.
         Any field can display the values only in between these Minimum and Maximum limits unless
         the corresponding time value is restricted from MinTime to MaxTime.
         That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime.

         There is no provision to set the limits of AM/PM field.

         @see elm_datetime_field_limit_set()
         @ingroup Datetime */
         params {
            @in fieldtype: Elm.Datetime.Field_Type; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
            @out min: int; /*@ Reference to field's minimum value */
            @out max: int; /*@ Reference to field's maximum value */
         }
      }
      value_min_set {
         /*@
         @brief Set the lower boundary of a field.

         Year: years since 1900. Negative value represents year below 1900 (year
         value -30 represents 1870). Year default range is from 70 to 137.

         Month: default value range is from 0 to 11.

         Date: default value range is from 1 to 31 according to the month value.

         Hour: default value will be in terms of 24 hr format (0~23)

         Minute: default value range is from 0 to 59.

         @return @c EINA_TRUE if minimum value is accepted.

         @see elm_datetime_value_min_get()
         @ingroup Datetime */

         return: bool;
         params {
            @in mintime: const(Elm_Datetime_Time)*; /*@ Time structure containing the minimum time value. */
         }
      }
      value_min_get @const {
         /*@
         @brief Get the lower boundary of a field.

         Year: years since 1900. Negative value represents year below 1900 (year
         value -30 represents 1870). Year default range is from 70 to 137.

         Month: default value range is from 0 to 11.

         Date: default value range is from 1 to 31 according to the month value.

         Hour: default value will be in terms of 24 hr format (0~23)

         Minute: default value range is from 0 to 59.

         @return @c EINA_TRUE if minimum value is successfully returned.

         @see elm_datetime_value_min_set()
         @ingroup Datepicker */
         return: bool;
         params {
            @inout mintime: Elm_Datetime_Time; /*@ Time structure. */
         }
      }
      value_set {
         /*@
         @brief Set the current value of a Datetime object.

         Year: years since 1900. Negative value represents year below 1900 (year
         value -30 represents 1870). Year default range is from 70 to 137.

         Month: default value range is from 0 to 11.

         Date: default value range is from 1 to 31 according to the month value.

         Hour: default value will be in terms of 24 hr format (0~23)

         Minute: default value range is from 0 to 59.

         @return @c EINA_TRUE if current time is set successfully.

         @see elm_datetime_value_set()
         @ingroup Datetime */

         return: bool;
         params {
            @in newtime: const(Elm_Datetime_Time)*; /*@ Time structure filled with values to be set. */
         }
      }
      value_get @const {
         /*@
         @brief Get the current value of a Datetime object.

         Year: years since 1900. Negative value represents year below 1900 (year
         value -30 represents 1870). Year default range is from 70 to 137.

         Month: default value range is from 0 to 11.

         Date: default value range is from 1 to 31 according to the month value.

         Hour: default value will be in terms of 24 hr format (0~23)

         Minute: default value range is from 0 to 59.

         @return @c EINA_TRUE if current time is returned successfully.

         @see elm_datetime_value_set()
         @ingroup Datetime */
         return: bool;
         params {
            @inout currtime: Elm_Datetime_Time; /*@ Time structure. */
         }
      }
      field_visible_set {
         /*@
         @brief Set a field to be visible or not.
         Setting this API True does not ensure that the field is visible, apart from
         this, the field's format must be present in Datetime overall format.
         If a field's visibility is set to False then it won't appear even though
         its format is present in overall format.
         So if and only if this API is set true and the corresponding field's format
         is present in Datetime format, the field is visible.

         By default the field visibility is set to True.

         @see elm_datetime_field_visible_get()
         @ingroup Datetime */

         params {
            @in fieldtype: Elm.Datetime.Field_Type; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
            @in visible: bool; /*@ @c EINA_TRUE field can be visible, @c EINA_FALSE otherwise. */
         }
      }
      field_visible_get @const {
         /*@
         @brief Get whether a field can be visible/not

         @return bool @c EINA_TRUE, if field can be visible. @c EINA_FALSE otherwise.

         @see elm_datetime_field_visible_set()
         @ingroup Datetime */
         return: bool;
         params {
            @in fieldtype: Elm.Datetime.Field_Type; /*@ Type of the field. #ELM_DATETIME_YEAR etc */
         }
      }
      value_max_set {
         /*@
         @brief Set the upper boundary of a field.

         Year: years since 1900. Negative value represents year below 1900 (year
         value -30 represents 1870). Year default range is from 70 to 137.

         Month: default value range is from 0 to 11.

         Date: default value range is from 1 to 31 according to the month value.

         Hour: default value will be in terms of 24 hr format (0~23)

         Minute: default value range is from 0 to 59.

         @return @c EINA_TRUE if maximum value is accepted.

         @see elm_datetime_value_max_get()
         @ingroup Datetime */

         return: bool;
         params {
            @in maxtime: const(Elm_Datetime_Time)*; /*@ Time structure containing the maximum time value. */
         }
      }
      value_max_get @const {
         /*@
         @brief Get the upper boundary of a field.

         Year: years since 1900. Negative value represents year below 1900 (year
         value -30 represents 1870). Year default range is from 70 to 137.

         Month: default value range is from 0 to 11.

         Date: default value range is from 1 to 31 according to the month value.

         Hour: default value will be in terms of 24 hr format (0~23)

         Minute: default value range is from 0 to 59.

         @return @c EINA_TRUE if maximum value is returned successfully.

         @see elm_datetime_value_max_set()
         @ingroup Datetime */
         return: bool;
         params {
            @inout maxtime: Elm_Datetime_Time; /*@ Time structure containing the maximum time value. */
         }
      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Evas.Object_Smart.add;
      Evas.Object_Smart.del;
      Elm.Widget.theme_apply;
      Elm.Widget.focus_next_manager_is;
      Elm.Widget.focus_next;
      Elm.Widget.disable;
      Elm.Widget.on_focus;
      Elm.Widget.translate;
      Elm.Layout.sizing_eval;
   }
   events {
      changed;
      language,changed;
      access,changed;
   }

}