aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/elementary/efl_ui_clock.eo
blob: f882ba0d3fe965041cda384696ea4d2116e5626b (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
import efl_types;

enum Efl.Ui.Clock_Type
{
   [[Identifies a clock field, The widget supports 6 fields : Year, month,
     Date, Hour, Minute, AM/PM
   ]]

   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.]]
   second  = 5, [[Indicates Second field.]]
   day     = 6, [[Indicated Day field.]]
   ampm    = 7, [[Indicates AM/PM field .]]
}

class Efl.Ui.Clock (Efl.Ui.Layout)
{
   [[Efl UI clock class]]
   methods {
      @property format {
         [[The current clock 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 clock
           field except for AM/PM field.

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

           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.
         ]]
         /* FIXME-doc
         Following are the allowed set of format specifiers for each clock 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.
         */
         set {} get {}
         values {
            fmt: string @nullable; [[The clock format.]]
         }
      }
      @property pause {
         [[Whether the given clock widget should be paused or not.

           This function pauses or starts the clock widget.
         ]]
         set {} get {}
         values {
            paused: bool; [[$true to pause clock, $false otherwise]]
         }
      }
      @property edit_mode {
         [[Digits of the given clock widget should be editable when in editing mode.]]
         set {} get {}
         values {
            value: bool; [[$true to set edit mode, $false otherwise]]
         }
      }
      @property time_min {
         [[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.
         ]]
         values {
            mintime: Efl.Time; [[Time structure containing the minimum time value.]]
         }
      }
      @property time_max {
         [[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.
         ]]
         values {
            maxtime: Efl.Time; [[Time structure containing the maximum time value.]]
         }
      }
      @property time {
         [[The current value of a clock 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.
         ]]
         values {
            curtime: Efl.Time; [[Time structure containing the time value.]]
         }
      }
      @property field_visible {
         [[ The field to be visible/not.]]
         set{} get{}
         keys {
            fieldtype: Efl.Ui.Clock_Type; [[Type of the field. #EFL_UI_CLOCK_TYPE_YEAR etc.]]
         }
         values {
            visible: bool; [[$true field can be visible, $false otherwise.]]
         }
      }
      @property field_limit {
         set {
             [[Set a field to be visible or not.

              Setting this API to $true in itself doen't ensure that the field is
              visible. The field's format also must be present
              in the overall clock format.  If a field's visibility is set
              to $false then it won't appear even though its format is
              present. In summary, if this API is
              set to true and the corresponding field's format is present
              in clock format, the field is visible.

              By default the field visibility is set to $true.
            ]]
         }
         get {
            [[ Get the field limits of a field.

              Limits can be set to individual fields, independently, except
              for the 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 work under the limitations of mintime/maxtime.

              There is no provision to set the limits of AM/PM field.
            ]]
         }
         keys {
            fieldtype: Efl.Ui.Clock_Type; [[Type of the field. #EFL_UI_CLOCK_TYPE_YEAR etc.]]
         }
         values {
            min: int; [[Reference to field's minimum value.]]
            max: int; [[Reference to field's maximum value.]]
         }
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Ui.Widget.theme_apply;
      Efl.Ui.Widget.on_disabled_update;
      Efl.Ui.Focus.Object.on_focus_update;
      Efl.Ui.Translatable.translation_update;
   }
   events {
      changed: void; [[Called when clock changed]]
   }
}