Merge remote-tracking branch 'remotes/origin/upstream'
[framework/uifw/elementary.git] / src / lib / elm_clock.h
index 35a8d47..deb308d 100644 (file)
  *
  * A newly created clock will fetch system's time (already
  * considering local time adjustments) to start with, and will tick
+<<<<<<< HEAD
  * accondingly. It may or may not show seconds.
  *
  * Clocks have an @b edition mode. When in it, the sheets will
+=======
+ * accordingly. It may or may not show seconds.
+ *
+ * Clocks have an @b edition  mode. When in it, the sheets will
+>>>>>>> remotes/origin/upstream
  * 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
+<<<<<<< HEAD
  * sheet, thus editing the time, continuosly and automatically for
+=======
+ * sheet, thus editing the time, continuously and automatically for
+>>>>>>> remotes/origin/upstream
  * 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.
  * Supported elm_object common APIs.
  * @li elm_object_signal_emit
  * @li elm_object_signal_callback_add
+<<<<<<< HEAD
  * @li elm_object_signal_callbacka_del
+=======
+ * @li elm_object_signal_callback_del
+>>>>>>> remotes/origin/upstream
  *
  * Here is an example on its usage:
  * @li @ref clock_example
@@ -48,6 +62,7 @@
 
 /**
  * Identifiers for which clock digits should be editable, when a
+<<<<<<< HEAD
  * clock widget is in edition mode. Values may be ORed together to
  * make a mask, naturally.
  *
@@ -65,6 +80,25 @@ typedef enum
    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;
+=======
+ * 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_edit_mode_set()
+ */
+typedef enum
+{
+   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;
+>>>>>>> remotes/origin/upstream
 
 /**
  * Add a new clock widget to the given parent Elementary
@@ -85,7 +119,11 @@ EAPI Evas_Object      *elm_clock_add(Evas_Object *parent);
  * @param obj The clock widget object
  * @param hrs The hours to set
  * @param min The minutes to set
+<<<<<<< HEAD
  * @param sec The secondes to set
+=======
+ * @param sec The seconds to set
+>>>>>>> remotes/origin/upstream
  *
  * This function updates the time that is showed by the clock
  * widget.
@@ -133,7 +171,11 @@ EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int
  * 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
+<<<<<<< HEAD
  * elm_clock_digit_edit_set() function will influence which digits
+=======
+ * elm_clock_edit_mode_set() function will influence which digits
+>>>>>>> remotes/origin/upstream
  * of the clock will be editable. By default, all of them will be
  * (#ELM_CLOCK_NONE).
  *
@@ -168,17 +210,29 @@ EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj);
  *
  * @param obj The clock object
  * @param digedit Bit mask indicating the digits to be editable
+<<<<<<< HEAD
  * (values in #Elm_Clock_Digedit).
+=======
+ * (values in #Elm_Clock_Edit_Mode).
+>>>>>>> remotes/origin/upstream
  *
  * 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).
  *
+<<<<<<< HEAD
  * @see elm_clock_digit_edit_get()
  *
  * @ingroup Clock
  */
 EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit);
+=======
+ * @see elm_clock_edit_mode_get()
+ *
+ * @ingroup Clock
+ */
+EAPI void              elm_clock_edit_mode_set(Evas_Object *obj, Elm_Clock_Edit_Mode digedit);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Retrieve what digits of the given clock widget should be
@@ -186,6 +240,7 @@ EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Dige
  *
  * @param obj The clock object
  * @return Bit mask indicating the digits to be editable
+<<<<<<< HEAD
  * (values in #Elm_Clock_Digedit).
  *
  * @see elm_clock_digit_edit_set() for more details
@@ -193,6 +248,15 @@ EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Dige
  * @ingroup Clock
  */
 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj);
+=======
+ * (values in #Elm_Clock_Edit_Mode).
+ *
+ * @see elm_clock_edit_mode_set() for more details
+ *
+ * @ingroup Clock
+ */
+EAPI Elm_Clock_Edit_Mode elm_clock_edit_mode_get(const Evas_Object *obj);
+>>>>>>> remotes/origin/upstream
 
 /**
  * Set if the given clock widget must show hours in military or
@@ -262,11 +326,19 @@ EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool se
 EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj);
 
 /**
+<<<<<<< HEAD
  * 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
+=======
+ * 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
+>>>>>>> remotes/origin/upstream
  *
  * This interval value is @b decreased while the user holds the
  * mouse pointer either incrementing or decrementing a given the
@@ -283,6 +355,7 @@ EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj);
  * The default starting interval value for automatic flips is
  * @b 0.85 seconds.
  *
+<<<<<<< HEAD
  * @see elm_clock_interval_get()
  *
  * @ingroup Clock
@@ -301,6 +374,26 @@ EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval)
  * @ingroup Clock
  */
 EAPI double            elm_clock_interval_get(const Evas_Object *obj);
+=======
+ * @see elm_clock_first_interval_get()
+ *
+ * @ingroup Clock
+ */
+EAPI void              elm_clock_first_interval_set(Evas_Object *obj, double interval);
+
+/**
+ * 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
+ *
+ * @see elm_clock_first_interval_set() for more details
+ *
+ * @ingroup Clock
+ */
+EAPI double            elm_clock_first_interval_get(const Evas_Object *obj);
+>>>>>>> remotes/origin/upstream
 
 /**
  * @}