path: root/src/lib/elm_clock.eo

class Elm_Clock (Elm_Layout)
{
   eo_prefix: elm_obj_clock;
   properties {
      show_am_pm {
         set {
            /*@
            Set if the given clock widget must show hours in military or
            am/pm 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 */
         }
         get {
            /*@
            Get if the given clock widget shows hours in military or am/pm
            mode

            @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 */
         }
         values {
            Eina_Bool am_pm; /*@ @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
            to military mode */
         }
      }
      first_interval {
         set {
            /*@
            Set the first interval on time updates for a user mouse button hold
            on clock widgets' time edition.

            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_first_interval_get()

            @ingroup Clock */
         }
         get {
            /*@
            Get the first interval on time updates for a user mouse button hold
            on clock widgets' time edition.

            @return The first interval value, in seconds, set on it

            @see elm_clock_first_interval_set() for more details

            @ingroup Clock */
         }
         values {
            double interval; /*@ The first interval value in seconds */
         }
      }
      show_seconds {
         set {
            /*@
            Set 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 @b not shown.

            @see elm_clock_show_seconds_get()

            @ingroup Clock */
         }
         get {
            /*@
            Get whether the given clock widget is showing time with seconds
            or not

            @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 */
         }
         values {
            Eina_Bool seconds; /*@ @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise */
         }
      }
      edit {
         set {
            /*@
            Set whether a given clock widget is under <b>edition mode</b> or
            under (default) 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_edit_mode_set() function will influence which digits
            of the clock will be editable.

            @note am/pm sheets, if being shown, will @b always be editable
            under edition mode.

            @see elm_clock_edit_get()

            @ingroup Clock */
         }
         get {
            /*@
            Retrieve whether a given clock widget is under editing mode
            or under (default) displaying-only mode.

            @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.

            @see elm_clock_edit_set() for more details

            @ingroup Clock */
         }
         values {
            Eina_Bool edit; /*@ @c EINA_TRUE to put it in edition, @c EINA_FALSE to
            put it back to "displaying only" mode */
         }
      }
      pause {
         set {
            /*@
            Set whether the given clock widget should be paused or not.

            This function pauses or starts the clock widget.

            @see elm_clock_pause_get()

            @ingroup Clock
            @since 1.9 */
         }
         get {
            /*@
            Get whether the given clock widget is paused.

            @return @c EINA_TRUE if it's paused @c EINA_FALSE otherwise

            This function gets whether the clock is paused or not.

            @see elm_clock_pause_set()

            @ingroup Clock
            @since 1.9 */
         }
         values {
            Eina_Bool paused; /*@ @c EINA_TRUE to pause clock, @c EINA_FALSE otherwise */
         }
      }
      time {
         set {
            /*@
            Set a clock widget's time, programmatically

            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 */
         }
         get {
            /*@
            Get a clock widget's time values

            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 */
         }
         values {
            int hrs; /*@ The hours to set */
            int min; /*@ The minutes to set */
            int sec; /*@ The seconds to set */
         }
      }
      edit_mode {
         set {
            /*@
            Set what digits of the given clock widget should be editable
            when in edition mode.

            @see elm_clock_edit_mode_get()

            @ingroup Clock */
         }
         get {
            /*@
            Retrieve what digits of the given clock widget should be
            editable when in edition mode.

            @return Bit mask indicating the digits to be editable
            (values in #Elm_Clock_Edit_Mode).

            @see elm_clock_edit_mode_set() for more details

            @ingroup Clock */
         }
         values {
            Elm_Clock_Edit_Mode digedit; /*@ Bit mask indicating the digits to be editable
            (values in #Elm_Clock_Edit_Mode). */
         }
      }
   }
   implements {
      class.constructor;
      Eo_Base.constructor;
      Evas_Object_Smart.add;
      Evas_Object_Smart.del;
      Elm_Widget.focus_next_manager_is;
      Elm_Widget.focus_direction_manager_is;
      Elm_Widget.access;
      Elm_Widget.focus_next;
      Elm_Widget.theme_apply;
   }
   events {
      changed;
      language,changed;
      access,changed;
      focused;
      unfocused;
   }

}