2 * @defgroup Clock Clock
4 * @image html img/widget/clock/preview-00.png
5 * @image latex img/widget/clock/preview-00.eps
7 * This is a @b digital clock widget. In its default theme, it has a
8 * vintage "flipping numbers clock" appearance, which will animate
9 * sheets of individual algarisms individually as time goes by.
11 * A newly created clock will fetch system's time (already
12 * considering local time adjustments) to start with, and will tick
13 * accordingly. It may or may not show seconds.
15 * Clocks have an @b edition mode. When in it, the sheets will
16 * display extra arrow indications on the top and bottom and the
17 * user may click on them to raise or lower the time values. After
18 * it's told to exit edition mode, it will keep ticking with that
19 * new time set (it keeps the difference from local time).
21 * Also, when under edition mode, user clicks on the cited arrows
22 * which are @b held for some time will make the clock to flip the
23 * sheet, thus editing the time, continuously and automatically for
24 * the user. The interval between sheet flips will keep growing in
25 * time, so that it helps the user to reach a time which is distant
28 * The time display is, by default, in military mode (24h), but an
29 * am/pm indicator may be optionally shown, too, when it will
32 * Smart callbacks one can register to:
33 * - "changed" - the clock's user changed the time
35 * Supported elm_object common APIs.
36 * @li elm_object_signal_emit
37 * @li elm_object_signal_callback_add
38 * @li elm_object_signal_callback_del
40 * Here is an example on its usage:
41 * @li @ref clock_example
50 * Identifiers for which clock digits should be editable, when a
51 * clock widget is in edition mode. Values may be OR-ed together to
52 * make a mask, naturally.
54 * @see elm_clock_edit_set()
55 * @see elm_clock_digit_edit_set()
59 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
60 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
61 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
62 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
63 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
64 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
65 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
66 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
70 * Add a new clock widget to the given parent Elementary
73 * @param parent The parent object
74 * @return a new clock widget handle or @c NULL, on errors
76 * This function inserts a new clock widget on the canvas.
80 EAPI Evas_Object *elm_clock_add(Evas_Object *parent);
83 * Set a clock widget's time, programmatically
85 * @param obj The clock widget object
86 * @param hrs The hours to set
87 * @param min The minutes to set
88 * @param sec The seconds to set
90 * This function updates the time that is showed by the clock
93 * Values @b must be set within the following ranges:
95 * - 0 - 59, for minutes
96 * - 0 - 59, for seconds,
98 * even if the clock is not in "military" mode.
100 * @warning The behavior for values set out of those ranges is @b
105 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec);
108 * Get a clock widget's time values
110 * @param obj The clock object
111 * @param[out] hrs Pointer to the variable to get the hours value
112 * @param[out] min Pointer to the variable to get the minutes value
113 * @param[out] sec Pointer to the variable to get the seconds value
115 * This function gets the time set for @p obj, returning
116 * it on the variables passed as the arguments to function
118 * @note Use @c NULL pointers on the time values you're not
119 * interested in: they'll be ignored by the function.
123 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec);
126 * Set whether a given clock widget is under <b>edition mode</b> or
127 * under (default) displaying-only mode.
129 * @param obj The clock object
130 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
131 * put it back to "displaying only" mode
133 * This function makes a clock's time to be editable or not <b>by
134 * user interaction</b>. When in edition mode, clocks @b stop
135 * ticking, until one brings them back to canonical mode. The
136 * elm_clock_digit_edit_set() function will influence which digits
137 * of the clock will be editable. By default, all of them will be
140 * @note am/pm sheets, if being shown, will @b always be editable
141 * under edition mode.
143 * @see elm_clock_edit_get()
147 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit);
150 * Retrieve whether a given clock widget is under editing mode
151 * or under (default) displaying-only mode.
153 * @param obj The clock object
154 * @return @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE otherwise
156 * This function retrieves whether the clock's time can be edited
157 * or not by user interaction.
159 * @see elm_clock_edit_set() for more details
163 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj);
166 * Set what digits of the given clock widget should be editable
167 * when in edition mode.
169 * @param obj The clock object
170 * @param digedit Bit mask indicating the digits to be editable
171 * (values in #Elm_Clock_Digedit).
173 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
174 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
177 * @see elm_clock_digit_edit_get()
181 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit);
184 * Retrieve what digits of the given clock widget should be
185 * editable when in edition mode.
187 * @param obj The clock object
188 * @return Bit mask indicating the digits to be editable
189 * (values in #Elm_Clock_Digedit).
191 * @see elm_clock_digit_edit_set() for more details
195 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj);
198 * Set if the given clock widget must show hours in military or
201 * @param obj The clock object
202 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
205 * This function sets if the clock must show hours in military or
206 * am/pm mode. In some countries like Brazil the military mode
207 * (00-24h-format) is used, in opposition to the USA, where the
208 * am/pm mode is more commonly used.
210 * @see elm_clock_show_am_pm_get()
214 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm);
217 * Get if the given clock widget shows hours in military or am/pm
220 * @param obj The clock object
221 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
224 * This function gets if the clock shows hours in military or am/pm
227 * @see elm_clock_show_am_pm_set() for more details
231 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj);
234 * Set if the given clock widget must show time with seconds or not
236 * @param obj The clock object
237 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
239 * This function sets if the given clock must show or not elapsed
240 * seconds. By default, they are @b not shown.
242 * @see elm_clock_show_seconds_get()
246 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds);
249 * Get whether the given clock widget is showing time with seconds
252 * @param obj The clock object
253 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
255 * This function gets whether @p obj is showing or not the elapsed
258 * @see elm_clock_show_seconds_set()
262 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj);
265 * Set the interval on time updates for a user mouse button hold
266 * on clock widgets' time edition.
268 * @param obj The clock object
269 * @param interval The (first) interval value in seconds
271 * This interval value is @b decreased while the user holds the
272 * mouse pointer either incrementing or decrementing a given the
273 * clock digit's value.
275 * This helps the user to get to a given time distant from the
276 * current one easier/faster, as it will start to flip quicker and
277 * quicker on mouse button holds.
279 * The calculation for the next flip interval value, starting from
280 * the one set with this call, is the previous interval divided by
281 * 1.05, so it decreases a little bit.
283 * The default starting interval value for automatic flips is
286 * @see elm_clock_interval_get()
290 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval);
293 * Get the interval on time updates for a user mouse button hold
294 * on clock widgets' time edition.
296 * @param obj The clock object
297 * @return The (first) interval value, in seconds, set on it
299 * @see elm_clock_interval_set() for more details
303 EAPI double elm_clock_interval_get(const Evas_Object *obj);