summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_clock.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_clock.eo')
-rw-r--r--src/lib/elementary/elm_clock.eo172
1 files changed, 0 insertions, 172 deletions
diff --git a/src/lib/elementary/elm_clock.eo b/src/lib/elementary/elm_clock.eo
deleted file mode 100644
index 65813b7..0000000
--- a/src/lib/elementary/elm_clock.eo
+++ /dev/null
@@ -1,172 +0,0 @@
1enum Elm.Clock.Edit_Mode
2{
3 [[Identifiers for which clock digits should be editable, when a
4 clock widget is in editing mode. Values may be OR-ed together to
5 make a mask, naturally.
6
7 See also @Elm.Clock.edit.set, @Elm.Clock.edit_mode.set.
8 ]]
9
10 legacy: elm_clock_edit;
11 default = 0, [[Default value. Means that all digits are editable, when in editing mode.]]
12 hour_decimal = 1 << 0, [[Decimal digit of hours value should be editable.]]
13 hour_unit = 1 << 1, [[Unit digit of hours value should be editable.]]
14 min_decimal = 1 << 2, [[Decimal digit of minutes value should be editable.]]
15 min_unit = 1 << 3, [[Unit digit of minutes value should be editable.]]
16 sec_decimal = 1 << 4, [[Decimal digit of seconds value should be editable.]]
17 sec_unit = 1 << 5, [[Unit digit of seconds value should be editable.]]
18 all = (1 << 6) - 1 [[All digits should be editable.]]
19}
20
21class Elm.Clock extends Efl.Ui.Layout implements Efl.Ui.Focus.Composition, Efl.Ui.Legacy
22{
23 [[Digital clock widget
24
25 This is a digital clock widget. In its default theme, it has a vintage "flipping numbers clock"
26 appearance, which will animate sheets of individual algorisms individually as time goes by.
27
28 A newly created clock will fetch system's time (already considering local time adjustments) to
29 start with, and will tick accordingly.
30 ]]
31 legacy_prefix: elm_clock;
32 eo_prefix: elm_obj_clock;
33 event_prefix: elm_clock;
34 methods {
35 @property show_am_pm {
36 [[If the given clock widget must show hours in military or am/pm mode
37
38 Set if the clock must show hours in military or am/pm mode. In some
39 countries like Brazil the military mode (00-24h-format) is used, in
40 opposition to the USA, where the am/pm mode is more commonly used.
41 ]]
42 set {
43 }
44 get {
45 }
46 values {
47 am_pm: bool; [[$true to put it in am/pm mode, $false to military mode]]
48 }
49 }
50 @property first_interval {
51 [[The first interval on time updates for a user mouse button hold
52 on clock widgets' time editing.
53
54 This interval value is decreased while the user holds the
55 mouse pointer either incrementing or decrementing a given the
56 clock digit's value.
57
58 This helps the user to get to a given time distant from the
59 current one easier/faster, as it will start to flip quicker and
60 quicker on mouse button holds.
61
62 The calculation for the next flip interval value, starting from
63 the one set with this call, is the previous interval divided by
64 1.05, so it decreases a little bit.
65
66 The default starting interval value for automatic flips is
67 0.85 seconds.
68 ]]
69 set {
70 }
71 get {
72 }
73 values {
74 interval: double; [[The first interval value in seconds]]
75 }
76 }
77 @property show_seconds {
78 [[If the given clock widget must show time with seconds or not
79
80 This function sets if the given clock must show or not elapsed
81 seconds. By default, they are not shown.
82 ]]
83 set {
84 }
85 get {
86 }
87 values {
88 seconds: bool; [[$true to show seconds, $false otherwise.]]
89 }
90 }
91 @property edit {
92 [[Whether a given clock widget is under editing mode or
93 under (default) displaying-only mode.
94
95 This function makes a clock's time to be editable or not by
96 user interaction. When in editing mode, clocks stop
97 ticking, until one brings them back to display mode. The
98 @.edit_mode.set function will influence which digits
99 of the clock will be editable.
100
101 Note: am/pm sheets, if being shown, will always be editable
102 under editing mode.
103 ]]
104 set {
105 }
106 get {
107 }
108 values {
109 edit: bool; [[$true to put it in editing, $false to
110 put it back to "displaying only" mode]]
111 }
112 }
113 @property pause {
114 [[Whether the given clock widget should be paused or not.
115
116 This function pauses or starts the clock widget.
117
118 @since 1.9
119 ]]
120 set {
121 }
122 get {
123 }
124 values {
125 paused: bool; [[$true to pause clock, $false otherwise]]
126 }
127 }
128 @property time {
129 [[Clock widget's time
130
131 Values must be set within 0-23 for hours and
132 0-59 for minutes and seconds, even if the clock
133 is not in "military" mode.
134 ]]
135 set {
136 [[Warning: The behavior for values set out of those ranges is
137 undefined.
138 ]]
139 }
140 get {
141 [[Note: Use $null pointers on the time values you're not
142 interested in: they'll be ignored by the function.
143 ]]
144 }
145 values {
146 hrs: int; [[The hours to set]]
147 min: int; [[The minutes to set]]
148 sec: int; [[The seconds to set]]
149 }
150 }
151 @property edit_mode {
152 [[Digits of the given clock widget should be editable when in editing mode.]]
153 set {
154 }
155 get {
156 }
157 values {
158 digedit: Elm.Clock.Edit_Mode; [[Bit mask indicating the digits to be editable
159 (values in @Elm.Clock.Edit_Mode).]]
160 }
161 }
162 }
163 implements {
164 class.constructor;
165 Efl.Object.constructor;
166 Efl.Ui.Widget.on_access_update;
167 Efl.Ui.Widget.theme_apply;
168 }
169 events {
170 changed: void; [[The clock's user changed the time]]
171 }
172}