1 enum Elm.Datetime.Field_Type
3 [[Identifies a Datetime field, The widget supports 6 fields : Year, month,
4 Date, Hour, Minute, AM/PM
8 year = 0, [[Indicates Year field.]]
9 month = 1, [[Indicates Month field.]]
10 date = 2, [[Indicates Date field.]]
11 hour = 3, [[Indicates Hour field.]]
12 minute = 4, [[Indicates Minute field.]]
13 ampm = 5, [[Indicates AM/PM field .]]
16 class Elm.Datetime (Elm.Layout)
18 eo_prefix: elm_obj_datetime;
22 [[Set the datetime format. Format is a combination of allowed
23 Libc date format specifiers like: "%b %d, %Y %I : %M %p".
25 Maximum allowed format length is 64 chars.
27 Format can include separators for each individual datetime
28 field except for AM/PM field.
30 Each separator can be a maximum of 6 UTF-8 bytes.
31 Space is also taken as a separator.
33 These specifiers can be arranged in any order and the widget
34 will display the fields accordingly.
36 Default format is taken as per the system locale settings.
38 \@if MOBILE \@since_tizen 2.3
39 \@elseif WEARABLE \@since_tizen 2.3.1
43 Following are the allowed set of format specifiers for each datetime field.
45 @b %%Y : The year as a decimal number including the century.
47 @b %%y : The year as a decimal number without a century (range 00 to 99).
49 @b %%m : The month as a decimal number (range 01 to 12).
51 @b %%b : The abbreviated month name according to the current locale.
53 @b %%B : The full month name according to the current locale.
55 @b %%h : The abbreviated month name according to the current locale(same as %%b).
57 @b %%d : The day of the month as a decimal number (range 01 to 31).
59 @b %%e : The day of the month as a decimal number (range 1 to 31). single
60 digits are preceded by a blank.
62 @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12).
64 @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23).
66 @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single
67 digits are preceded by a blank.
69 @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single
70 digits are preceded by a blank.
72 @b %%M : The minute as a decimal number (range 00 to 59).
74 @b %%p : Either 'AM' or 'PM' according to the given time value, or the
75 corresponding strings for the current locale. Noon is treated as 'PM'
78 @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for
81 @b %%c : The preferred date and time representation for the current locale.
83 @b %%x : The preferred date representation for the current locale without the time.
85 @b %%X : The preferred time representation for the current locale without the date.
87 @b %%r : The complete calendar time using the AM/PM format of the current locale.
89 @b %%R : The hour and minute in decimal numbers using the format %H:%M.
91 @b %%T : The time of day in decimal numbers using the format %H:%M:%S.
93 @b %%D : The date using the format %%m/%%d/%%y.
95 @b %%F : The date using the format %%Y-%%m-%%d.
99 [[Get the datetime format.
101 \@if MOBILE \@since_tizen 2.3
102 \@elseif WEARABLE \@since_tizen 2.3.1
107 fmt: const(char)* @nullable; [[The datetime format.]]
111 [[Set the field limits of a field.
113 Limits can be set to individual fields, independently, except
114 for AM/PM field. Any field can display the values only in between
115 these minimum and maximum limits unless the corresponding time
116 value is restricted from MinTime to MaxTime. That is, min/max
117 field limits always works under the limitations of mintime/maxtime.
119 There is no provision to set the limits of AM/PM field.
121 \@if MOBILE \@since_tizen 2.3
122 \@elseif WEARABLE \@since_tizen 2.3.1
126 @in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
127 @in min: int; [[Reference to field's minimum value.]]
128 @in max: int; [[Reference to field's maximum value.]]
131 field_limit_get @const {
132 [[ Get the field limits of a field.
134 Limits can be set to individual fields, independently, except
135 for AM/PM field. Any field can display the values only in between
136 these minimum and maximum limits unless the corresponding time
137 value is restricted from MinTime to MaxTime. That is, min/max
138 field limits always works under the limitations of mintime/maxtime.
140 There is no provision to set the limits of AM/PM field.
142 \@if MOBILE \@since_tizen 2.3
143 \@elseif WEARABLE \@since_tizen 2.3.1
147 @in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
148 @out min: int; [[Reference to field's minimum value.]]
149 @out max: int; [[Reference to field's maximum value.]]
153 [[Set the lower boundary of a field.
155 Year: years since 1900. Negative value represents year below 1900
156 (year value -30 represents 1870). Year default range is from 70
159 Month: default value range is from 0 to 11.
161 Date: default value range is from 1 to 31 according to the month
164 Hour: default value will be in terms of 24 hr format (0~23)
166 Minute: default value range is from 0 to 59.
168 \@if MOBILE \@since_tizen 2.3
169 \@elseif WEARABLE \@since_tizen 2.3.1
173 return: bool; [[$true if minimum value is accepted.]]
175 @in mintime: const(Elm_Datetime_Time)*; [[Time structure containing the minimum time value.]]
178 value_min_get @const {
179 [[Get the lower boundary of a field.
181 Year: years since 1900. Negative value represents year below 1900
182 (year value -30 represents 1870). Year default range is from 70
185 Month: default value range is from 0 to 11.
187 Date: default value range is from 1 to 31 according to the month
190 Hour: default value will be in terms of 24 hr format (0~23)
192 Minute: default value range is from 0 to 59.
194 \@if MOBILE \@since_tizen 2.3
195 \@elseif WEARABLE \@since_tizen 2.3.1
198 return: bool; [[$true if minimum value is successfully returned.]]
200 @inout mintime: Elm_Datetime_Time; [[Time structure.]]
204 [[Set the current value of a Datetime object.
206 Year: years since 1900. Negative value represents year below 1900
207 (year value -30 represents 1870). Year default range is from 70
210 Month: default value range is from 0 to 11.
212 Date: default value range is from 1 to 31 according to the month
215 Hour: default value will be in terms of 24 hr format (0~23)
217 Minute: default value range is from 0 to 59.
219 \@if MOBILE \@since_tizen 2.3
220 \@elseif WEARABLE \@since_tizen 2.3.1
223 return: bool; [[$true if current time is set successfully.]]
225 @in newtime: const(Elm_Datetime_Time)*; [[Time structure filled with values to be set.]]
229 [[Get the current value of a Datetime object.
231 Year: years since 1900. Negative value represents year below 1900
232 (year value -30 represents 1870). Year default range is from 70
235 Month: default value range is from 0 to 11.
237 Date: default value range is from 1 to 31 according to the month
240 Hour: default value will be in terms of 24 hr format (0~23)
242 Minute: default value range is from 0 to 59.
244 \@if MOBILE \@since_tizen 2.3
245 \@elseif WEARABLE \@since_tizen 2.3.1
248 return: bool; [[$true if current time is returned successfully.]]
250 @inout currtime: Elm_Datetime_Time; [[Time structure.]]
254 [[Set a field to be visible or not.
256 Setting this API to $true does not ensure that the field is
257 visible, apart from this, the field's format must be present
258 in Datetime overall format. If a field's visibility is set
259 to $false then it won't appear even though its format is
260 present in overall format. So if and only if this API is
261 set true and the corresponding field's format is present
262 in Datetime format, the field is visible.
264 By default the field visibility is set to $true.
266 \@if MOBILE \@since_tizen 2.3
267 \@elseif WEARABLE \@since_tizen 2.3.1
271 @in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
272 @in visible: bool; [[$true field can be visible, $false otherwise.]]
275 field_visible_get @const {
276 [[ Get whether a field can be visible/not.
278 \@if MOBILE \@since_tizen 2.3
279 \@elseif WEARABLE \@since_tizen 2.3.1
282 return: bool; [[$true, if field can be visible. $false otherwise.]]
284 @in fieldtype: Elm.Datetime.Field_Type; [[Type of the field. #ELM_DATETIME_YEAR etc.]]
288 [[Set the upper boundary of a field.
290 Year: years since 1900. Negative value represents year below 1900
291 (year value -30 represents 1870). Year default range is from 70
294 Month: default value range is from 0 to 11.
296 Date: default value range is from 1 to 31 according to the month
299 Hour: default value will be in terms of 24 hr format (0~23)
301 Minute: default value range is from 0 to 59.
303 \@if MOBILE \@since_tizen 2.3
304 \@elseif WEARABLE \@since_tizen 2.3.1
307 return: bool; [[$true if maximum value is accepted.]]
309 @in maxtime: const(Elm_Datetime_Time)*; [[Time structure containing the maximum time value.]]
312 value_max_get @const {
313 [[Get the upper boundary of a field.
315 Year: years since 1900. Negative value represents year below 1900
316 (year value -30 represents 1870). Year default range is from 70
319 Month: default value range is from 0 to 11.
321 Date: default value range is from 1 to 31 according to the month
324 Hour: default value will be in terms of 24 hr format (0~23)
326 Minute: default value range is from 0 to 59.
328 \@if MOBILE \@since_tizen 2.3
329 \@elseif WEARABLE \@since_tizen 2.3.1
332 return: bool; [[$true if maximum value is returned successfully.]]
334 @inout maxtime: Elm_Datetime_Time; [[Time structure containing the maximum time value.]]
341 Evas.Object_Smart.add;
342 Evas.Object_Smart.del;
343 Elm.Widget.theme_apply;
344 Elm.Widget.focus_next_manager_is;
345 Elm.Widget.focus_next;
348 Elm.Widget.translate;
349 Elm.Layout.sizing_eval;
350 //TIZEN_ONLY(20170807): Apply UI Mirror for Tizen 4.0 UX