305 lines
10 KiB
C
305 lines
10 KiB
C
|
/**
|
||
|
* @defgroup Clock Clock
|
||
|
*
|
||
|
* @image html img/widget/clock/preview-00.png
|
||
|
* @image latex img/widget/clock/preview-00.eps
|
||
|
*
|
||
|
* This is a @b 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
|
||
|
* accondingly. It may or may not show seconds.
|
||
|
*
|
||
|
* Clocks have an @b 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 @b held for some time will make the clock to flip the
|
||
|
* sheet, thus editing the time, continuosly 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.
|
||
|
*
|
||
|
* Smart callbacks one can register to:
|
||
|
* - "changed" - the clock's user changed the time
|
||
|
*
|
||
|
* Here is an example on its usage:
|
||
|
* @li @ref clock_example
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* @addtogroup Clock
|
||
|
* @{
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* Identifiers for which clock digits should be editable, when a
|
||
|
* clock widget is in edition mode. Values may be ORed together to
|
||
|
* make a mask, naturally.
|
||
|
*
|
||
|
* @see elm_clock_edit_set()
|
||
|
* @see elm_clock_digit_edit_set()
|
||
|
*/
|
||
|
typedef enum _Elm_Clock_Digedit
|
||
|
{
|
||
|
ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
|
||
|
ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
|
||
|
ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
|
||
|
ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
|
||
|
ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
|
||
|
ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
|
||
|
ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
|
||
|
ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
|
||
|
} Elm_Clock_Digedit;
|
||
|
|
||
|
/**
|
||
|
* Add a new clock widget to the given parent Elementary
|
||
|
* (container) object
|
||
|
*
|
||
|
* @param parent The parent object
|
||
|
* @return a new clock widget handle or @c NULL, on errors
|
||
|
*
|
||
|
* This function inserts a new clock widget on the canvas.
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Set a clock widget's time, programmatically
|
||
|
*
|
||
|
* @param obj The clock widget object
|
||
|
* @param hrs The hours to set
|
||
|
* @param min The minutes to set
|
||
|
* @param sec The secondes to set
|
||
|
*
|
||
|
* This function updates the time that is showed by the clock
|
||
|
* widget.
|
||
|
*
|
||
|
* Values @b 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 @b
|
||
|
* undefined.
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Get a clock widget's time values
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param[out] hrs Pointer to the variable to get the hours value
|
||
|
* @param[out] min Pointer to the variable to get the minutes value
|
||
|
* @param[out] sec Pointer to the variable to get the seconds value
|
||
|
*
|
||
|
* This function gets the time set for @p obj, returning
|
||
|
* it on the variables passed as the arguments to function
|
||
|
*
|
||
|
* @note Use @c NULL pointers on the time values you're not
|
||
|
* interested in: they'll be ignored by the function.
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Set whether a given clock widget is under <b>edition mode</b> or
|
||
|
* under (default) displaying-only mode.
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
|
||
|
* put it back to "displaying only" mode
|
||
|
*
|
||
|
* This function makes a clock's time to be editable or not <b>by
|
||
|
* user interaction</b>. When in edition mode, clocks @b stop
|
||
|
* ticking, until one brings them back to canonical mode. The
|
||
|
* elm_clock_digit_edit_set() function will influence which digits
|
||
|
* of the clock will be editable. By default, all of them will be
|
||
|
* (#ELM_CLOCK_NONE).
|
||
|
*
|
||
|
* @note am/pm sheets, if being shown, will @b always be editable
|
||
|
* under edition mode.
|
||
|
*
|
||
|
* @see elm_clock_edit_get()
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Retrieve whether a given clock widget is under <b>edition
|
||
|
* mode</b> or under (default) displaying-only mode.
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
|
||
|
* otherwise
|
||
|
*
|
||
|
* This function retrieves whether the clock's time can be edited
|
||
|
* or not by user interaction.
|
||
|
*
|
||
|
* @see elm_clock_edit_set() for more details
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Set what digits of the given clock widget should be editable
|
||
|
* when in edition mode.
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param digedit Bit mask indicating the digits to be editable
|
||
|
* (values in #Elm_Clock_Digedit).
|
||
|
*
|
||
|
* If the @p digedit param is #ELM_CLOCK_NONE, editing will be
|
||
|
* disabled on @p obj (same effect as elm_clock_edit_set(), with @c
|
||
|
* EINA_FALSE).
|
||
|
*
|
||
|
* @see elm_clock_digit_edit_get()
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Retrieve what digits of the given clock widget should be
|
||
|
* editable when in edition mode.
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @return Bit mask indicating the digits to be editable
|
||
|
* (values in #Elm_Clock_Digedit).
|
||
|
*
|
||
|
* @see elm_clock_digit_edit_set() for more details
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Set if the given clock widget must show hours in military or
|
||
|
* am/pm mode
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param am_pm @c EINA_TRUE to put it in am/pm mode, @c 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 elm_clock_show_am_pm_get()
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Get if the given clock widget shows hours in military or am/pm
|
||
|
* mode
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
|
||
|
* military
|
||
|
*
|
||
|
* This function gets if the clock shows hours in military or am/pm
|
||
|
* mode.
|
||
|
*
|
||
|
* @see elm_clock_show_am_pm_set() for more details
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Set if the given clock widget must show time with seconds or not
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
|
||
|
*
|
||
|
* This function sets if the given clock must show or not elapsed
|
||
|
* seconds. By default, they are @b not shown.
|
||
|
*
|
||
|
* @see elm_clock_show_seconds_get()
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Get whether the given clock widget is showing time with seconds
|
||
|
* or not
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
|
||
|
*
|
||
|
* This function gets whether @p obj is showing or not the elapsed
|
||
|
* seconds.
|
||
|
*
|
||
|
* @see elm_clock_show_seconds_set()
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Set the interval on time updates for an user mouse button hold
|
||
|
* on clock widgets' time edition.
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @param interval The (first) interval value in seconds
|
||
|
*
|
||
|
* This interval value is @b 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
|
||
|
* @b 0.85 seconds.
|
||
|
*
|
||
|
* @see elm_clock_interval_get()
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* Get the interval on time updates for an user mouse button hold
|
||
|
* on clock widgets' time edition.
|
||
|
*
|
||
|
* @param obj The clock object
|
||
|
* @return The (first) interval value, in seconds, set on it
|
||
|
*
|
||
|
* @see elm_clock_interval_set() for more details
|
||
|
*
|
||
|
* @ingroup Clock
|
||
|
*/
|
||
|
EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
|
||
|
|
||
|
/**
|
||
|
* @}
|
||
|
*/
|
||
|
|