dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

elm_clock: convert elm_clock eo docs to new format 

Summary:
Converted docs of elm_clock.eo to the new format

Signed-off-by: Vivek Ellur <vivek.ellur@samsung.com>

Reviewers: cedric, q66

Reviewed By: q66

Differential Revision: https://phab.enlightenment.org/D2849
This commit is contained in:
Vivek Ellur 2015-07-22 10:20:35 +01:00 committed by Daniel Kolesa
parent aef335cf4b
commit 8d9a207bd2
1 changed files with 105 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

253
legacy/elementary/src/lib/elm_clock.eo
View File

@ -24,239 +24,196 @@ class Elm.Clock (Elm.Layout)
methods { methods {
@property show_am_pm { @property show_am_pm {
set { set {
/*@ [[Set if the given clock widget must show hours in military or
Set if the given clock widget must show hours in military or am/pm mode
am/pm mode
This function sets if the clock must show hours in military or This function sets if the clock must show hours in military or
am/pm mode. In some countries like Brazil the military mode am/pm mode. In some countries like Brazil the military mode
(00-24h-format) is used, in opposition to the USA, where the (00-24h-format) is used, in opposition to the USA, where the
am/pm mode is more commonly used. am/pm mode is more commonly used.
@see elm_clock_show_am_pm_get() See also @.show_am_pm.get.
]]
@ingroup Clock */
} }
get { get {
/*@ [[Get if the given clock widget shows hours in military or am/pm
Get if the given clock widget shows hours in military or am/pm mode
mode
@return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in This function gets if the clock shows hours in military or am/pm
military mode.
This function gets if the clock shows hours in military or am/pm See also @.show_am_pm.set for more details.
mode. ]]
@see elm_clock_show_am_pm_set() for more details
@ingroup Clock */
} }
values { values {
am_pm: bool; /*@ @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE am_pm: bool; [[$true to put it in am/pm mode,
to military mode */ $false to military mode]]
} }
} }
@property first_interval { @property first_interval {
set { set {
/*@ [[Set the first interval on time updates for a user mouse button hold
Set the first interval on time updates for a user mouse button hold on clock widgets' time edition.
on clock widgets' time edition.
This interval value is @b decreased while the user holds the This interval value is decreased while the user holds the
mouse pointer either incrementing or decrementing a given the mouse pointer either incrementing or decrementing a given the
clock digit's value. clock digit's value.
This helps the user to get to a given time distant from the 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 current one easier/faster, as it will start to flip quicker and
quicker on mouse button holds. quicker on mouse button holds.
The calculation for the next flip interval value, starting from The calculation for the next flip interval value, starting from
the one set with this call, is the previous interval divided by the one set with this call, is the previous interval divided by
1.05, so it decreases a little bit. 1.05, so it decreases a little bit.
The default starting interval value for automatic flips is The default starting interval value for automatic flips is
@b 0.85 seconds. 0.85 seconds.
@see elm_clock_first_interval_get() See also @.first_interval.get.
]]
@ingroup Clock */
} }
get { get {
/*@ [[Get the first interval on time updates for a user mouse button hold
Get the first interval on time updates for a user mouse button hold on clock widgets' time edition.
on clock widgets' time edition.
@return The first interval value, in seconds, set on it See also @.first_interval.set for more details.
]]
@see elm_clock_first_interval_set() for more details
@ingroup Clock */
} }
values { values {
interval: double; /*@ The first interval value in seconds */ interval: double; [[The first interval value in seconds]]
} }
} }
@property show_seconds { @property show_seconds {
set { set {
/*@ [[Set if the given clock widget must show time with seconds or not
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 This function sets if the given clock must show or not elapsed
seconds. By default, they are @b not shown. seconds. By default, they are not shown.
@see elm_clock_show_seconds_get() See also @.show_seconds.get.
]]
@ingroup Clock */
} }
get { get {
/*@ [[Get whether the given clock widget is showing time with seconds
Get whether the given clock widget is showing time with seconds or not
or not
@return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise This function gets whether $obj is showing or not the elapsed
seconds.
This function gets whether @p obj is showing or not the elapsed See also @.show_seconds.set.
seconds. ]]
@see elm_clock_show_seconds_set()
@ingroup Clock */
} }
values { values {
seconds: bool; /*@ @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise */ seconds: bool; [[$true to show seconds, $false otherwise.]]
} }
} }
@property edit { @property edit {
set { set {
/*@ [[Set whether a given clock widget is under edition mode or
Set whether a given clock widget is under <b>edition mode</b> or under (default) displaying-only mode.
under (default) displaying-only mode.
This function makes a clock's time to be editable or not <b>by This function makes a clock's time to be editable or not by
user interaction</b>. When in edition mode, clocks @b stop user interaction. When in edition mode, clocks stop
ticking, until one brings them back to canonical mode. The ticking, until one brings them back to canonical mode. The
elm_clock_edit_mode_set() function will influence which digits @.edit_mode.set function will influence which digits
of the clock will be editable. of the clock will be editable.
@note am/pm sheets, if being shown, will @b always be editable Note: am/pm sheets, if being shown, will always be editable
under edition mode. under edition mode.
@see elm_clock_edit_get() See also @.edit.get.
]]
@ingroup Clock */
} }
get { get {
/*@ [[Get whether a given clock widget is under editing mode
Get whether a given clock widget is under editing mode or under (default) displaying-only 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.
This function retrieves whether the clock's time can be edited See also @.edit.set for more details
or not by user interaction. ]]
@see elm_clock_edit_set() for more details
@ingroup Clock */
} }
values { values {
edit: bool; /*@ @c EINA_TRUE to put it in edition, @c EINA_FALSE to edit: bool; [[$true to put it in edition, $false to
put it back to "displaying only" mode */ put it back to "displaying only" mode]]
} }
} }
@property pause { @property pause {
set { set {
/*@ [[Set whether the given clock widget should be paused or not.
Set whether the given clock widget should be paused or not.
This function pauses or starts the clock widget. This function pauses or starts the clock widget.
@see elm_clock_pause_get() See also @.pause.get.
@ingroup Clock @since 1.9
@since 1.9 */ ]]
} }
get { get {
/*@ [[Get whether the given clock widget is paused.
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.
This function gets whether the clock is paused or not. See also @.pause.set.
@see elm_clock_pause_set() @since 1.9]]
@ingroup Clock
@since 1.9 */
} }
values { values {
paused: bool; /*@ @c EINA_TRUE to pause clock, @c EINA_FALSE otherwise */ paused: bool; [[$true to pause clock, $false otherwise]]
} }
} }
@property time { @property time {
set { set {
/*@ [[Set a clock widget's time, programmatically
Set a clock widget's time, programmatically
This function updates the time that is showed by the clock This function updates the time that is showed by the clock
widget. widget.
Values @b must be set within the following ranges: Values must be set within 0-23 for hours and
- 0 - 23, for hours 0-59 for minutes and seconds, even if the clock
- 0 - 59, for minutes is not in "military" mode.
- 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.
@warning The behavior for values set out of those ranges is @b ]]
undefined.
@ingroup Clock */
} }
get { get {
/*@ [[Get a clock widget's time values
Get a clock widget's time values
This function gets the time set for @p obj, returning This function gets the time set for $obj, returning
it on the variables passed as the arguments to function it on the variables passed as the arguments to function
@note Use @c NULL pointers on the time values you're not Note: Use $null pointers on the time values you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
]]
@ingroup Clock */
} }
values { values {
hrs: int; /*@ The hours to set */ hrs: int; [[The hours to set]]
min: int; /*@ The minutes to set */ min: int; [[The minutes to set]]
sec: int; /*@ The seconds to set */ sec: int; [[The seconds to set]]
} }
} }
@property edit_mode { @property edit_mode {
set { set {
/*@ [[Set what digits of the given clock widget should be editable
Set what digits of the given clock widget should be editable when in edition mode.
when in edition mode.
@see elm_clock_edit_mode_get() See also @.edit_mode.get.
]]
@ingroup Clock */
} }
get { get {
/*@ [[Get what digits of the given clock widget should be
Get what digits of the given clock widget should be editable when in edition mode.
editable when in edition mode.
@return Bit mask indicating the digits to be editable See also @.edit_mode.set for more details.
(values in #Elm_Clock_Edit_Mode). ]]
@see elm_clock_edit_mode_set() for more details
@ingroup Clock */
} }
values { values {
digedit: Elm.Clock.Edit_Mode; /*@ Bit mask indicating the digits to be editable digedit: Elm.Clock.Edit_Mode; [[Bit mask indicating the digits to be editable
(values in #Elm_Clock_Edit_Mode). */ (values in #Elm_Clock_Edit_Mode).]]
} }
} }
} }