Enumerations | |
enum | Elm_Clock_Edit_Mode { ELM_CLOCK_EDIT_DEFAULT = 0, ELM_CLOCK_EDIT_HOUR_DECIMAL = 1, ELM_CLOCK_EDIT_HOUR_UNIT = 2, ELM_CLOCK_EDIT_MIN_DECIMAL = 4, ELM_CLOCK_EDIT_MIN_UNIT = 8, ELM_CLOCK_EDIT_SEC_DECIMAL = 16, ELM_CLOCK_EDIT_SEC_UNIT = 32, ELM_CLOCK_EDIT_ALL = 63 } |
Identifiers for which clock digits should be editable, when a clock widget is in editing mode. More... | |
Functions | |
void | elm_clock_show_am_pm_set (Elm_Clock *obj, Eina_Bool am_pm) |
If the given clock widget must show hours in military or am/pm mode. More... | |
Eina_Bool | elm_clock_show_am_pm_get (const Elm_Clock *obj) |
If the given clock widget must show hours in military or am/pm mode. More... | |
void | elm_clock_first_interval_set (Elm_Clock *obj, double interval) |
The first interval on time updates for a user mouse button hold on clock widgets' time editing. More... | |
double | elm_clock_first_interval_get (const Elm_Clock *obj) |
The first interval on time updates for a user mouse button hold on clock widgets' time editing. More... | |
void | elm_clock_show_seconds_set (Elm_Clock *obj, Eina_Bool seconds) |
If the given clock widget must show time with seconds or not. More... | |
Eina_Bool | elm_clock_show_seconds_get (const Elm_Clock *obj) |
If the given clock widget must show time with seconds or not. More... | |
void | elm_clock_edit_set (Elm_Clock *obj, Eina_Bool edit) |
Whether a given clock widget is under editing mode or under (default) displaying-only mode. More... | |
Eina_Bool | elm_clock_edit_get (const Elm_Clock *obj) |
Whether a given clock widget is under editing mode or under (default) displaying-only mode. More... | |
void | elm_clock_pause_set (Elm_Clock *obj, Eina_Bool paused) |
Whether the given clock widget should be paused or not. More... | |
Eina_Bool | elm_clock_pause_get (const Elm_Clock *obj) |
Whether the given clock widget should be paused or not. More... | |
void | elm_clock_time_set (Elm_Clock *obj, int hrs, int min, int sec) |
Clock widget's time. More... | |
void | elm_clock_time_get (const Elm_Clock *obj, int *hrs, int *min, int *sec) |
Clock widget's time. More... | |
void | elm_clock_edit_mode_set (Elm_Clock *obj, Elm_Clock_Edit_Mode digedit) |
Digits of the given clock widget should be editable when in editing mode. More... | |
Elm_Clock_Edit_Mode | elm_clock_edit_mode_get (const Elm_Clock *obj) |
Digits of the given clock widget should be editable when in editing mode. More... | |
Evas_Object * | elm_clock_add (Evas_Object *parent) |
Add a new clock widget to the given parent Elementary (container) object. More... | |
This is a digital clock widget. In its default theme, it has a vintage "flipping numbers clock" appearance, which will animate sheets of individual algorisms individually as time goes by.
A newly created clock will fetch system's time (already considering local time adjustments) to start with, and will tick accordingly. It may or may not show seconds.
Clocks have an edition mode. When in it, the sheets will display extra arrow indications on the top and bottom and the user may click on them to raise or lower the time values. After it's told to exit edition mode, it will keep ticking with that new time set (it keeps the difference from local time).
Also, when under edition mode, user clicks on the cited arrows which are held for some time will make the clock to flip the sheet, thus editing the time, continuously and automatically for the user. The interval between sheet flips will keep reducing in time, so that it helps the user to reach a time which is distant from the one set.
The time display is, by default, in military mode (24h), but an am/pm indicator may be optionally shown, too, when it will switch to 12h.
This widget inherits from the Layout one, so that all the functions acting on it also work for clock objects.
This widget emits the following signals, besides the ones sent from Layout:
"changed"
- the clock's user changed the time"focused"
- When the clock ehas received focus. (since 1.8)"unfocused"
- When the clock has lost focus. (since 1.8)"language,changed"
- the program's language changed (since 1.9)Supported elm_object common APIs.
Here is an example on its usage:
enum Elm_Clock_Edit_Mode |
Identifiers for which clock digits should be editable, when a clock widget is in editing mode.
Values may be OR-ed together to make a mask, naturally.
See also elm_clock_edit_set, elm_clock_edit_mode_set.
void elm_clock_show_am_pm_set | ( | Elm_Clock * | obj, |
Eina_Bool | am_pm | ||
) |
If the given clock widget must show hours in military or am/pm mode.
Set if the clock must show hours in military or am/pm mode. In some countries like Brazil the military mode (00-24h-format) is used, in opposition to the USA, where the am/pm mode is more commonly used.
[in] | obj | The object. |
[in] | am_pm | true to put it in am/pm mode, false to military mode |
Eina_Bool elm_clock_show_am_pm_get | ( | const Elm_Clock * | obj | ) |
If the given clock widget must show hours in military or am/pm mode.
Set if the clock must show hours in military or am/pm mode. In some countries like Brazil the military mode (00-24h-format) is used, in opposition to the USA, where the am/pm mode is more commonly used.
[in] | obj | The object. |
true
to put it in am/pm mode, false
to military mode void elm_clock_first_interval_set | ( | Elm_Clock * | obj, |
double | interval | ||
) |
The first interval on time updates for a user mouse button hold on clock widgets' time editing.
This interval value is decreased while the user holds the mouse pointer either incrementing or decrementing a given the clock digit's value.
This helps the user to get to a given time distant from the current one easier/faster, as it will start to flip quicker and quicker on mouse button holds.
The calculation for the next flip interval value, starting from the one set with this call, is the previous interval divided by 1.05, so it decreases a little bit.
The default starting interval value for automatic flips is 0.85 seconds.
[in] | obj | The object. |
[in] | interval | The first interval value in seconds |
double elm_clock_first_interval_get | ( | const Elm_Clock * | obj | ) |
The first interval on time updates for a user mouse button hold on clock widgets' time editing.
This interval value is decreased while the user holds the mouse pointer either incrementing or decrementing a given the clock digit's value.
This helps the user to get to a given time distant from the current one easier/faster, as it will start to flip quicker and quicker on mouse button holds.
The calculation for the next flip interval value, starting from the one set with this call, is the previous interval divided by 1.05, so it decreases a little bit.
The default starting interval value for automatic flips is 0.85 seconds.
[in] | obj | The object. |
void elm_clock_show_seconds_set | ( | Elm_Clock * | obj, |
Eina_Bool | seconds | ||
) |
If the given clock widget must show time with seconds or not.
This function sets if the given clock must show or not elapsed seconds. By default, they are not shown.
[in] | obj | The object. |
[in] | seconds | true to show seconds, false otherwise. |
Eina_Bool elm_clock_show_seconds_get | ( | const Elm_Clock * | obj | ) |
If the given clock widget must show time with seconds or not.
This function sets if the given clock must show or not elapsed seconds. By default, they are not shown.
[in] | obj | The object. |
true
to show seconds, false
otherwise. void elm_clock_edit_set | ( | Elm_Clock * | obj, |
Eina_Bool | edit | ||
) |
Whether a given clock widget is under editing mode or under (default) displaying-only mode.
This function makes a clock's time to be editable or not by user interaction. When in editing mode, clocks stop ticking, until one brings them back to display mode. The elm_clock_edit_mode_set function will influence which digits of the clock will be editable.
[in] | obj | The object. |
[in] | edit | true to put it in editing, false to put it back to "displaying only" mode |
Eina_Bool elm_clock_edit_get | ( | const Elm_Clock * | obj | ) |
Whether a given clock widget is under editing mode or under (default) displaying-only mode.
This function makes a clock's time to be editable or not by user interaction. When in editing mode, clocks stop ticking, until one brings them back to display mode. The elm_clock_edit_mode_set function will influence which digits of the clock will be editable.
[in] | obj | The object. |
true
to put it in editing, false
to put it back to "displaying
only" mode void elm_clock_pause_set | ( | Elm_Clock * | obj, |
Eina_Bool | paused | ||
) |
Whether the given clock widget should be paused or not.
This function pauses or starts the clock widget.
[in] | obj | The object. |
[in] | paused | true to pause clock, false otherwise |
Eina_Bool elm_clock_pause_get | ( | const Elm_Clock * | obj | ) |
Whether the given clock widget should be paused or not.
This function pauses or starts the clock widget.
[in] | obj | The object. |
true
to pause clock, false
otherwisevoid elm_clock_time_set | ( | Elm_Clock * | obj, |
int | hrs, | ||
int | min, | ||
int | sec | ||
) |
Clock widget's time.
Values must be set within 0-23 for hours and 0-59 for minutes and seconds, even if the clock is not in "military" mode.
[in] | obj | The object. |
[in] | hrs | The hours to set |
[in] | min | The minutes to set |
[in] | sec | The seconds to set |
void elm_clock_time_get | ( | const Elm_Clock * | obj, |
int * | hrs, | ||
int * | min, | ||
int * | sec | ||
) |
Clock widget's time.
Values must be set within 0-23 for hours and 0-59 for minutes and seconds, even if the clock is not in "military" mode.
null
pointers on the time values you're not interested in: they'll be ignored by the function.[in] | obj | The object. |
[out] | hrs | The hours to set |
[out] | min | The minutes to set |
[out] | sec | The seconds to set |
void elm_clock_edit_mode_set | ( | Elm_Clock * | obj, |
Elm_Clock_Edit_Mode | digedit | ||
) |
Digits of the given clock widget should be editable when in editing mode.
[in] | obj | The object. |
[in] | digedit | Bit mask indicating the digits to be editable (values in Elm_Clock_Edit_Mode). |
Elm_Clock_Edit_Mode elm_clock_edit_mode_get | ( | const Elm_Clock * | obj | ) |
Digits of the given clock widget should be editable when in editing mode.
[in] | obj | The object. |
Evas_Object* elm_clock_add | ( | Evas_Object * | parent | ) |
Add a new clock widget to the given parent Elementary (container) object.
parent | The parent object |
NULL
, on errorsThis function inserts a new clock widget on the canvas.