/**
* @defgroup Clock Clock
+ * @ingroup Elementary
*
* @image html img/widget/clock/preview-00.png
* @image latex img/widget/clock/preview-00.eps
*
* 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.
+ * accordingly. It may or may not show seconds.
*
- * Clocks have an @b edition mode. When in it, the sheets will
+ * 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
*
* 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
+ * 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.
* Smart callbacks one can register to:
* - "changed" - the clock's user changed the time
*
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
+ *
* Here is an example on its usage:
* @li @ref clock_example
*/
/**
* Identifiers for which clock digits should be editable, when a
- * clock widget is in edition mode. Values may be ORed together to
+ * clock widget is in edition mode. Values may be OR-ed together to
* make a mask, naturally.
*
* @see elm_clock_edit_set()
- * @see elm_clock_digit_edit_set()
+ * @see elm_clock_edit_mode_set()
*/
-typedef enum _Elm_Clock_Digedit
+typedef enum
{
- 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;
+ ELM_CLOCK_EDIT_DEFAULT = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
+ ELM_CLOCK_EDIT_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
+ ELM_CLOCK_EDIT_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
+ ELM_CLOCK_EDIT_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
+ ELM_CLOCK_EDIT_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
+ ELM_CLOCK_EDIT_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
+ ELM_CLOCK_EDIT_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
+ ELM_CLOCK_EDIT_ALL = (1 << 6) - 1 /**< All digits should be editable */
+} Elm_Clock_Edit_Mode;
/**
* Add a new clock widget to the given parent Elementary
*
* @ingroup Clock
*/
-EAPI Evas_Object *
- elm_clock_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_clock_add(Evas_Object *parent);
/**
* 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
+ * @param sec The seconds to set
*
* This function updates the time that is showed by the clock
* widget.
*
* @ingroup Clock
*/
-EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec);
/**
* Get a clock widget's time values
*
* @ingroup Clock
*/
-EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec);
/**
* Set whether a given clock widget is under <b>edition mode</b> or
* 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
+ * elm_clock_edit_mode_set() function will influence which digits
* of the clock will be editable. By default, all of them will be
* (#ELM_CLOCK_NONE).
*
*
* @ingroup Clock
*/
-EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit);
/**
- * Retrieve whether a given clock widget is under <b>edition
- * mode</b> or under (default) displaying-only mode.
+ * Retrieve whether a given clock widget is under editing mode
+ * 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
+ * @return @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.
*
* @ingroup Clock
*/
-EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj);
/**
* Set what digits of the given clock widget should be editable
*
* @param obj The clock object
* @param digedit Bit mask indicating the digits to be editable
- * (values in #Elm_Clock_Digedit).
+ * (values in #Elm_Clock_Edit_Mode).
*
* 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()
+ * @see elm_clock_edit_mode_get()
*
* @ingroup Clock
*/
-EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_edit_mode_set(Evas_Object *obj, Elm_Clock_Edit_Mode digedit);
/**
* Retrieve what digits of the given clock widget should be
*
* @param obj The clock object
* @return Bit mask indicating the digits to be editable
- * (values in #Elm_Clock_Digedit).
+ * (values in #Elm_Clock_Edit_Mode).
*
- * @see elm_clock_digit_edit_set() for more details
+ * @see elm_clock_edit_mode_set() for more details
*
* @ingroup Clock
*/
-EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Clock_Edit_Mode elm_clock_edit_mode_get(const Evas_Object *obj);
/**
* Set if the given clock widget must show hours in military or
*
* @ingroup Clock
*/
-EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm);
/**
* Get if the given clock widget shows hours in military or am/pm
*
* @ingroup Clock
*/
-EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj);
/**
* Set if the given clock widget must show time with seconds or not
*
* @ingroup Clock
*/
-EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds);
/**
* Get whether the given clock widget is showing time with seconds
*
* @ingroup Clock
*/
-EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj);
/**
- * Set the interval on time updates for an user mouse button hold
+ * Set the first interval on time updates for a user mouse button hold
* on clock widgets' time edition.
*
* @param obj The clock object
- * @param interval The (first) interval value in seconds
+ * @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
* The default starting interval value for automatic flips is
* @b 0.85 seconds.
*
- * @see elm_clock_interval_get()
+ * @see elm_clock_first_interval_get()
*
* @ingroup Clock
*/
-EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
+EAPI void elm_clock_first_interval_set(Evas_Object *obj, double interval);
/**
- * Get the interval on time updates for an user mouse button hold
+ * Get the first interval on time updates for a user mouse button hold
* on clock widgets' time edition.
*
* @param obj The clock object
- * @return The (first) interval value, in seconds, set on it
+ * @return The first interval value, in seconds, set on it
*
- * @see elm_clock_interval_set() for more details
+ * @see elm_clock_first_interval_set() for more details
*
* @ingroup Clock
*/
-EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI double elm_clock_first_interval_get(const Evas_Object *obj);
/**
* @}
projects / framework / uifw / elementary.git / blobdiff