Enumerations

enum  Elm_Clock_Edit_Mode {
  ELM_CLOCK_EDIT_DEFAULT = 0,
  ELM_CLOCK_EDIT_HOUR_DECIMAL = 1 << 0,
  ELM_CLOCK_EDIT_HOUR_UNIT = 1 << 1,
  ELM_CLOCK_EDIT_MIN_DECIMAL = 1 << 2,
  ELM_CLOCK_EDIT_MIN_UNIT = 1 << 3,
  ELM_CLOCK_EDIT_SEC_DECIMAL = 1 << 4,
  ELM_CLOCK_EDIT_SEC_UNIT = 1 << 5,
  ELM_CLOCK_EDIT_ALL = (1 << 6) - 1
}
 Identifiers for which clock digits should be editable, when a clock widget is in edition mode. More...

Functions

Evas_Object * elm_clock_add (Evas_Object *parent)
 Add a new clock widget to the given parent Elementary (container) object.
void elm_clock_time_set (Evas_Object *obj, int hrs, int min, int sec)
 Set a clock widget's time, programmatically.
void elm_clock_time_get (const Evas_Object *obj, int *hrs, int *min, int *sec)
 Get a clock widget's time values.
void elm_clock_edit_set (Evas_Object *obj, Eina_Bool edit)
 Set whether a given clock widget is under edition mode or under (default) displaying-only mode.
Eina_Bool elm_clock_edit_get (const Evas_Object *obj)
 Retrieve whether a given clock widget is under editing mode or under (default) displaying-only mode.
void elm_clock_edit_mode_set (Evas_Object *obj, Elm_Clock_Edit_Mode digedit)
 Set what digits of the given clock widget should be editable when in edition mode.
Elm_Clock_Edit_Mode elm_clock_edit_mode_get (const Evas_Object *obj)
 Retrieve what digits of the given clock widget should be editable when in edition mode.
void elm_clock_show_am_pm_set (Evas_Object *obj, Eina_Bool am_pm)
 Set if the given clock widget must show hours in military or am/pm mode.
Eina_Bool elm_clock_show_am_pm_get (const Evas_Object *obj)
 Get if the given clock widget shows hours in military or am/pm mode.
void elm_clock_show_seconds_set (Evas_Object *obj, Eina_Bool seconds)
 Set if the given clock widget must show time with seconds or not.
Eina_Bool elm_clock_show_seconds_get (const Evas_Object *obj)
 Get whether the given clock widget is showing time with seconds or not.
void elm_clock_first_interval_set (Evas_Object *obj, double interval)
 Set the first interval on time updates for a user mouse button hold on clock widgets' time edition.
double elm_clock_first_interval_get (const Evas_Object *obj)
 Get the first interval on time updates for a user mouse button hold on clock widgets' time edition.

Detailed Description

clock_inheritance_tree.png
preview-00.png

This is a digital clock widget. In its default theme, it has a vintage "flipping numbers clock" appearance, which will animate sheets of individual algarisms 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 growing 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

Supported elm_object common APIs.

Here is an example on its usage:


Enumeration Type Documentation

Identifiers for which clock digits should be editable, when a clock widget is in edition mode.

Values may be OR-ed together to make a mask, naturally.

See also:
elm_clock_edit_set()
elm_clock_edit_mode_set()
Enumerator:
ELM_CLOCK_EDIT_DEFAULT 

Default value.

Means that all digits are editable, when in edition mode.

ELM_CLOCK_EDIT_HOUR_DECIMAL 

Decimal algarism of hours value should be editable.

ELM_CLOCK_EDIT_HOUR_UNIT 

Unit algarism of hours value should be editable.

ELM_CLOCK_EDIT_MIN_DECIMAL 

Decimal algarism of minutes value should be editable.

ELM_CLOCK_EDIT_MIN_UNIT 

Unit algarism of minutes value should be editable.

ELM_CLOCK_EDIT_SEC_DECIMAL 

Decimal algarism of seconds value should be editable.

ELM_CLOCK_EDIT_SEC_UNIT 

Unit algarism of seconds value should be editable.

ELM_CLOCK_EDIT_ALL 

All digits should be editable.


Function Documentation

Evas_Object* elm_clock_add ( Evas_Object *  parent)

Add a new clock widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object
Returns:
a new clock widget handle or NULL, on errors

This function inserts a new clock widget on the canvas.

Eina_Bool elm_clock_edit_get ( const Evas_Object *  obj)

Retrieve whether a given clock widget is under editing mode or under (default) displaying-only mode.

Parameters:
objThe clock object
Returns:
EINA_TRUE, if it's in edition mode, EINA_FALSE otherwise

This function retrieves whether the clock's time can be edited or not by user interaction.

See also:
elm_clock_edit_set() for more details
Elm_Clock_Edit_Mode elm_clock_edit_mode_get ( const Evas_Object *  obj)

Retrieve what digits of the given clock widget should be editable when in edition mode.

Parameters:
objThe clock object
Returns:
Bit mask indicating the digits to be editable (values in Elm_Clock_Edit_Mode).
See also:
elm_clock_edit_mode_set() for more details
void elm_clock_edit_mode_set ( Evas_Object *  obj,
Elm_Clock_Edit_Mode  digedit 
)

Set what digits of the given clock widget should be editable when in edition mode.

Parameters:
objThe clock object
digeditBit mask indicating the digits to be editable (values in Elm_Clock_Edit_Mode).
See also:
elm_clock_edit_mode_get()

References ELM_CLOCK_EDIT_DEFAULT, and elm_clock_edit_set().

Referenced by elm_clock_edit_set().

void elm_clock_edit_set ( Evas_Object *  obj,
Eina_Bool  edit 
)

Set whether a given clock widget is under edition mode or under (default) displaying-only mode.

Parameters:
objThe clock object
editEINA_TRUE to put it in edition, EINA_FALSE to put it back to "displaying only" mode

This function makes a clock's time to be editable or not by user interaction. When in edition mode, clocks stop ticking, until one brings them back to canonical mode. The elm_clock_edit_mode_set() function will influence which digits of the clock will be editable.

Note:
am/pm sheets, if being shown, will always be editable under edition mode.
See also:
elm_clock_edit_get()

References ELM_CLOCK_EDIT_ALL, ELM_CLOCK_EDIT_DEFAULT, and elm_clock_edit_mode_set().

Referenced by elm_clock_edit_mode_set().

double elm_clock_first_interval_get ( const Evas_Object *  obj)

Get the first interval on time updates for a user mouse button hold on clock widgets' time edition.

Parameters:
objThe clock object
Returns:
The first interval value, in seconds, set on it
See also:
elm_clock_first_interval_set() for more details
void elm_clock_first_interval_set ( Evas_Object *  obj,
double  interval 
)

Set the first interval on time updates for a user mouse button hold on clock widgets' time edition.

Parameters:
objThe clock object
intervalThe first interval value in seconds

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.

See also:
elm_clock_first_interval_get()
Eina_Bool elm_clock_show_am_pm_get ( const Evas_Object *  obj)

Get if the given clock widget shows hours in military or am/pm mode.

Parameters:
objThe clock object
Returns:
EINA_TRUE, if in am/pm mode, EINA_FALSE if in military

This function gets if the clock shows hours in military or am/pm mode.

See also:
elm_clock_show_am_pm_set() for more details
void elm_clock_show_am_pm_set ( Evas_Object *  obj,
Eina_Bool  am_pm 
)

Set if the given clock widget must show hours in military or am/pm mode.

Parameters:
objThe clock object
am_pmEINA_TRUE to put it in am/pm mode, EINA_FALSE to military mode

This function sets 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.

See also:
elm_clock_show_am_pm_get()
Eina_Bool elm_clock_show_seconds_get ( const Evas_Object *  obj)

Get whether the given clock widget is showing time with seconds or not.

Parameters:
objThe clock object
Returns:
EINA_TRUE if it's showing seconds, EINA_FALSE otherwise

This function gets whether obj is showing or not the elapsed seconds.

See also:
elm_clock_show_seconds_set()
void elm_clock_show_seconds_set ( Evas_Object *  obj,
Eina_Bool  seconds 
)

Set if the given clock widget must show time with seconds or not.

Parameters:
objThe clock object
secondsEINA_TRUE to show seconds, EINA_FALSE otherwise

This function sets if the given clock must show or not elapsed seconds. By default, they are not shown.

See also:
elm_clock_show_seconds_get()
void elm_clock_time_get ( const Evas_Object *  obj,
int *  hrs,
int *  min,
int *  sec 
)

Get a clock widget's time values.

Parameters:
objThe clock object
[out]hrsPointer to the variable to get the hours value
[out]minPointer to the variable to get the minutes value
[out]secPointer to the variable to get the seconds value

This function gets the time set for obj, returning it on the variables passed as the arguments to function

Note:
Use NULL pointers on the time values you're not interested in: they'll be ignored by the function.
void elm_clock_time_set ( Evas_Object *  obj,
int  hrs,
int  min,
int  sec 
)

Set a clock widget's time, programmatically.

Parameters:
objThe clock widget object
hrsThe hours to set
minThe minutes to set
secThe seconds to set

This function updates the time that is showed by the clock widget.

Values must be set within the following ranges:

  • 0 - 23, for hours
  • 0 - 59, for minutes
  • 0 - 59, for seconds,

even if the clock is not in "military" mode.

Warning:
The behavior for values set out of those ranges is undefined.