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

Eo files docs: replace all @c/@p with $. 

This is part of the new syntax.
This commit is contained in:
Tom Hacohen 2015-08-06 15:12:27 +01:00
parent bc8730acee
commit d4cfcbdad3
32 changed files with 623 additions and 623 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
legacy/elementary/src/lib/elm_datetime.eo
View File

@ -154,7 +154,7 @@ class Elm.Datetime (Elm.Layout)
Minute: default value range is from 0 to 59. Minute: default value range is from 0 to 59.
@return @c true if minimum value is accepted. @return $true if minimum value is accepted.
@see elm_datetime_value_min_get() @see elm_datetime_value_min_get()
@ingroup Datetime */ @ingroup Datetime */
@ -179,7 +179,7 @@ class Elm.Datetime (Elm.Layout)
Minute: default value range is from 0 to 59. Minute: default value range is from 0 to 59.
@return @c true if minimum value is successfully returned. @return $true if minimum value is successfully returned.
@see elm_datetime_value_min_set() @see elm_datetime_value_min_set()
@ingroup Datepicker */ @ingroup Datepicker */
@ -203,7 +203,7 @@ class Elm.Datetime (Elm.Layout)
Minute: default value range is from 0 to 59. Minute: default value range is from 0 to 59.
@return @c true if current time is set successfully. @return $true if current time is set successfully.
@see elm_datetime_value_set() @see elm_datetime_value_set()
@ingroup Datetime */ @ingroup Datetime */
@ -228,7 +228,7 @@ class Elm.Datetime (Elm.Layout)
Minute: default value range is from 0 to 59. Minute: default value range is from 0 to 59.
@return @c true if current time is returned successfully. @return $true if current time is returned successfully.
@see elm_datetime_value_set() @see elm_datetime_value_set()
@ingroup Datetime */ @ingroup Datetime */
@ -254,14 +254,14 @@ class Elm.Datetime (Elm.Layout)
params { params {
@in fieldtype: Elm.Datetime.Field_Type; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */ @in fieldtype: Elm.Datetime.Field_Type; /*@ Type of the field. #ELM_DATETIME_YEAR etc. */
@in visible: bool; /*@ @c true field can be visible, @c false otherwise. */ @in visible: bool; /*@ $true field can be visible, $false otherwise. */
} }
} }
field_visible_get @const { field_visible_get @const {
/*@ /*@
@brief Get whether a field can be visible/not @brief Get whether a field can be visible/not
@return bool @c true, if field can be visible. @c false otherwise. @return bool $true, if field can be visible. $false otherwise.
@see elm_datetime_field_visible_set() @see elm_datetime_field_visible_set()
@ingroup Datetime */ @ingroup Datetime */
@ -285,7 +285,7 @@ class Elm.Datetime (Elm.Layout)
Minute: default value range is from 0 to 59. Minute: default value range is from 0 to 59.
@return @c true if maximum value is accepted. @return $true if maximum value is accepted.
@see elm_datetime_value_max_get() @see elm_datetime_value_max_get()
@ingroup Datetime */ @ingroup Datetime */
@ -310,7 +310,7 @@ class Elm.Datetime (Elm.Layout)
Minute: default value range is from 0 to 59. Minute: default value range is from 0 to 59.
@return @c true if maximum value is returned successfully. @return $true if maximum value is returned successfully.
@see elm_datetime_value_max_set() @see elm_datetime_value_max_set()
@ingroup Datetime */ @ingroup Datetime */

44
legacy/elementary/src/lib/elm_entry.eo
View File

@ -138,7 +138,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
/*@ /*@
Get the attribute to show the input panel in case of only an user's explicit Mouse Up event. Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.
@return @c true if the input panel will be shown in case of only Mouse up event. @return $true if the input panel will be shown in case of only Mouse up event.
@since 1.9 @since 1.9
@ingroup Entry */ @ingroup Entry */
@ -302,7 +302,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
By default, entries are editable and when focused, any text input by the By default, entries are editable and when focused, any text input by the
user will be inserted at the current cursor position. But calling this user will be inserted at the current cursor position. But calling this
function with @p editable as false will prevent the user from function with $editable as false will prevent the user from
inputting text into the entry. inputting text into the entry.
The only way to change the text of a non-editable entry is to use The only way to change the text of a non-editable entry is to use
@ -333,9 +333,9 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
Set the style that the hover should use Set the style that the hover should use
When creating the popup hover, entry will request that it's When creating the popup hover, entry will request that it's
themed according to @p style. themed according to $style.
Setting style no @c NULL means disabling automatic hover. Setting style no $NULL means disabling automatic hover.
@see elm_object_style_set() @see elm_object_style_set()
@ -347,7 +347,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
Get the style, the hover created by entry will use. Get the style, the hover created by entry will use.
@return The style to use by the hover. @c NULL means the default is used. @return The style to use by the hover. $NULL means the default is used.
@see elm_object_style_set() @see elm_object_style_set()
@ -363,10 +363,10 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
Sets the entry to single line mode. Sets the entry to single line mode.
In single line mode, entries don't ever wrap when the text reaches the In single line mode, entries don't ever wrap when the text reaches the
edge, and instead they keep growing horizontally. Pressing the @c Enter edge, and instead they keep growing horizontally. Pressing the $Enter
key will generate an @c "activate" event instead of adding a new line. key will generate an $"activate" event instead of adding a new line.
When @p single_line is @c false, line wrapping takes effect again When $single_line is $false, line wrapping takes effect again
and pressing enter will break the text into a different line and pressing enter will break the text into a different line
without generating any events. without generating any events.
@ -429,8 +429,8 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
@ingroup Entry */ @ingroup Entry */
} }
values { values {
disabled: bool; /*@ The state to put in in: @c true for disabled: bool; /*@ The state to put in in: $true for
disabled, @c false for enabled */ disabled, $false for enabled */
} }
} }
@property autosave { @property autosave {
@ -619,7 +619,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
/*@ /*@
Sets the cursor position in the entry to the given value Sets the cursor position in the entry to the given value
The value in @p pos is the index of the character position within the The value in $pos is the index of the character position within the
contents of the string as returned by elm_entry_cursor_pos_get(). contents of the string as returned by elm_entry_cursor_pos_get().
@ingroup Entry */ @ingroup Entry */
@ -675,14 +675,14 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
/*@ /*@
Set whether the return key on the input panel is disabled automatically when entry has no text. Set whether the return key on the input panel is disabled automatically when entry has no text.
If @p enabled is true, The return key on input panel is disabled when the entry has no text. If $enabled is true, The return key on input panel is disabled when the entry has no text.
The return key on the input panel is automatically enabled when the entry has text. The return key on the input panel is automatically enabled when the entry has text.
The default value is false. The default value is false.
@ingroup Entry */ @ingroup Entry */
} }
values { values {
enabled: bool; /*@ If @p enabled is true, the return key is automatically disabled when the entry has no text. */ enabled: bool; /*@ If $enabled is true, the return key is automatically disabled when the entry has no text. */
} }
} }
@property end_visible { @property end_visible {
@ -837,7 +837,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
if an error occurred. if an error occurred.
The returned value points to an internal string and should not be freed The returned value points to an internal string and should not be freed
or modified in any way. If the @p entry object is deleted or its or modified in any way. If the $entry object is deleted or its
contents are changed, the returned pointer should be considered invalid. contents are changed, the returned pointer should be considered invalid.
@return The selected text within the entry or NULL on failure @return The selected text within the entry or NULL on failure
@ -891,7 +891,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
params { params {
@in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */ @in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */
@in data: void * @optional; /*@ The data passed to @p func */ @in data: void * @optional; /*@ The data passed to $func */
} }
} }
input_panel_show { input_panel_show {
@ -994,7 +994,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
params { params {
@in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */ @in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */
@in data: void * @optional; /*@ The data passed to @p func */ @in data: void * @optional; /*@ The data passed to $func */
} }
} }
text_style_user_peek @const { text_style_user_peek @const {
@ -1142,7 +1142,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
tag for which no provider finds anything, and no text is displayed, this tag for which no provider finds anything, and no text is displayed, this
function still returns false. function still returns false.
@return @c true if the entry text is empty or @p entry is NULL, @c false otherwise. @return $true if the entry text is empty or $entry is NULL, $false otherwise.
@ingroup Entry */ @ingroup Entry */
return: bool(true); return: bool(true);
@ -1178,7 +1178,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
params { params {
@in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */ @in func: Elm_Entry_Item_Provider_Cb; /*@ The function called to provide the item object */
@in data: void * @optional; /*@ The data passed to @p func */ @in data: void * @optional; /*@ The data passed to $func */
} }
} }
markup_filter_append { markup_filter_append {
@ -1198,14 +1198,14 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
params { params {
@in func: Elm_Entry_Filter_Cb; /*@ The function to use as text filter */ @in func: Elm_Entry_Filter_Cb; /*@ The function to use as text filter */
@in data: void * @optional; /*@ User data to pass to @p func */ @in data: void * @optional; /*@ User data to pass to $func */
} }
} }
entry_append { entry_append {
/*@ /*@
Appends @p str to the text of the entry. Appends $str to the text of the entry.
Adds the text in @p str to the end of any text already present in the Adds the text in $str to the end of any text already present in the
widget. widget.
The appended text is subject to any filters set for the widget. The appended text is subject to any filters set for the widget.
@ -1252,7 +1252,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
params { params {
@in func: Elm_Entry_Filter_Cb; /*@ The function to use as text filter */ @in func: Elm_Entry_Filter_Cb; /*@ The function to use as text filter */
@in data: void * @optional; /*@ User data to pass to @p func */ @in data: void * @optional; /*@ User data to pass to $func */
} }
} }
} }

12
legacy/elementary/src/lib/elm_flip.eo
View File

@ -98,11 +98,11 @@ class Elm.Flip (Elm.Container)
and dragging must always start from the opposite half of the flip (eg. right and dragging must always start from the opposite half of the flip (eg. right
half of the flip when dragging to the left). half of the flip when dragging to the left).
Note that the @c dir parameter is not actually related to the direction of Note that the $dir parameter is not actually related to the direction of
the drag, it only refers to the area in the flip where interaction can the drag, it only refers to the area in the flip where interaction can
occur (top, bottom, left, right). occur (top, bottom, left, right).
Negative values of @c hitsize will disable this hit area. Negative values of $hitsize will disable this hit area.
@see elm_flip_interaction_set() @see elm_flip_interaction_set()
@ -138,7 +138,7 @@ class Elm.Flip (Elm.Container)
call this function once for each direction that should be enabled. call this function once for each direction that should be enabled.
You can also set the appropriate hit area size by calling You can also set the appropriate hit area size by calling
@c elm_flip_interaction_direction_hitsize_set(). By default, a minimum $elm_flip_interaction_direction_hitsize_set(). By default, a minimum
hit area will be created on the opposite edge of the flip. hit area will be created on the opposite edge of the flip.
@see elm_flip_interaction_set() @see elm_flip_interaction_set()
@ -171,7 +171,7 @@ class Elm.Flip (Elm.Container)
/*@ /*@
@brief Runs the flip animation @brief Runs the flip animation
Flips the front and back contents using the @p mode animation. This Flips the front and back contents using the $mode animation. This
effectively hides the currently visible content and shows the hidden one. effectively hides the currently visible content and shows the hidden one.
There a number of possible animations to use for the flipping: There a number of possible animations to use for the flipping:
@ -223,7 +223,7 @@ class Elm.Flip (Elm.Container)
/*@ /*@
@brief Runs the flip animation to front or back. @brief Runs the flip animation to front or back.
Flips the front and back contents using the @p mode animation. This Flips the front and back contents using the $mode animation. This
effectively hides the currently visible content and shows the hidden one. effectively hides the currently visible content and shows the hidden one.
There a number of possible animations to use for the flipping: There a number of possible animations to use for the flipping:
@ -268,7 +268,7 @@ class Elm.Flip (Elm.Container)
@ingroup Flip */ @ingroup Flip */
params { params {
@in front: bool; /*@ if @c true, makes front visible, otherwise makes back. */ @in front: bool; /*@ if $true, makes front visible, otherwise makes back. */
@in mode: Elm.Flip.Mode; /*@ The mode type */ @in mode: Elm.Flip.Mode; /*@ The mode type */
} }
} }

88
legacy/elementary/src/lib/elm_gengrid.eo
View File

@ -29,7 +29,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
Get the items grid's alignment values within a given gengrid Get the items grid's alignment values within a given gengrid
widget widget
@note Use @c NULL pointers on the alignment values you're not @note Use $NULL pointers on the alignment values you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
@see elm_gengrid_align_set() for more details @see elm_gengrid_align_set() for more details
@ -59,10 +59,10 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get how the items grid's filled within a given gengrid widget Get how the items grid's filled within a given gengrid widget
@return @c true, if filled is on, @c false if it's @return $true, if filled is on, $false if it's
off off
@note Use @c NULL pointers on the alignment values you're not @note Use $NULL pointers on the alignment values you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
@see elm_gengrid_align_set() for more details @see elm_gengrid_align_set() for more details
@ -108,7 +108,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
Get whether multi-selection is enabled or disabled for a given Get whether multi-selection is enabled or disabled for a given
gengrid widget gengrid widget
@return @c true, if multi-selection is enabled, @c @return $true, if multi-selection is enabled, @c
false otherwise false otherwise
@see elm_gengrid_multi_select_set() for more details @see elm_gengrid_multi_select_set() for more details
@ -116,8 +116,8 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@ingroup Gengrid */ @ingroup Gengrid */
} }
values { values {
multi: bool; /*@ @c true, to enable multi-selection, multi: bool; /*@ $true, to enable multi-selection,
@c false to disable it. */ $false to disable it. */
} }
} }
@property group_item_size { @property group_item_size {
@ -139,7 +139,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get the size set for the group items of a given gengrid widget Get the size set for the group items of a given gengrid widget
@note Use @c NULL pointers on the size values you're not @note Use $NULL pointers on the size values you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
@see elm_gengrid_group_item_size_get() for more details @see elm_gengrid_group_item_size_get() for more details
@ -210,7 +210,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
Get whether a given gengrid widget is or not able have items Get whether a given gengrid widget is or not able have items
@b reordered @b reordered
@return @c true, if reordering is on, @c false if it's @return $true, if reordering is on, $false if it's
off off
@see elm_gengrid_reorder_mode_set() for more details @see elm_gengrid_reorder_mode_set() for more details
@ -218,8 +218,8 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@ingroup Gengrid */ @ingroup Gengrid */
} }
values { values {
reorder_mode: bool; /*@ Use @c true to turn reordering on, reorder_mode: bool; /*@ Use $true to turn reordering on,
@c false to turn it off */ $false to turn it off */
} }
} }
@property highlight_mode { @property highlight_mode {
@ -252,7 +252,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get the size set for the items of a given gengrid widget Get the size set for the items of a given gengrid widget
@note Use @c NULL pointers on the size values you're not @note Use $NULL pointers on the size values you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
@see elm_gengrid_item_size_get() for more details @see elm_gengrid_item_size_get() for more details
@ -304,14 +304,14 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
Set the direction in which a given gengrid widget will expand while Set the direction in which a given gengrid widget will expand while
placing its items. placing its items.
When in "horizontal mode" (@c true), items will be placed in @b columns, When in "horizontal mode" ($true), items will be placed in @b columns,
from top to bottom and, when the space for a column is filled, another one is from top to bottom and, when the space for a column is filled, another one is
started on the right, thus expanding the grid horizontally. When in started on the right, thus expanding the grid horizontally. When in
"vertical mode" (@c false), though, items will be placed in @b rows, "vertical mode" ($false), though, items will be placed in @b rows,
from left to right and, when the space for a row is filled, another one is from left to right and, when the space for a row is filled, another one is
started below, thus expanding the grid vertically. started below, thus expanding the grid vertically.
@note By default, gengrid is in vertical mode, @c false. @note By default, gengrid is in vertical mode, $false.
@see elm_gengrid_horizontal_get() @see elm_gengrid_horizontal_get()
@ -322,16 +322,16 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
Get for what direction a given gengrid widget will expand while Get for what direction a given gengrid widget will expand while
placing its items. placing its items.
@return @c true, if @p obj is set to expand horizontally, @return $true, if $obj is set to expand horizontally,
@c false if it's set to expand vertically. $false if it's set to expand vertically.
@see elm_gengrid_horizontal_set() for more details @see elm_gengrid_horizontal_set() for more details
@ingroup Gengrid */ @ingroup Gengrid */
} }
values { values {
horizontal: bool; /*@ @c true to make the gengrid expand horizontally, horizontal: bool; /*@ $true to make the gengrid expand horizontally,
@c false to expand vertically. */ $false to expand vertically. */
} }
} }
@property page_size { @property page_size {
@ -348,11 +348,11 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get the selected item in a given gengrid widget Get the selected item in a given gengrid widget
@return The selected item's handle or @c NULL, if none is @return The selected item's handle or $NULL, if none is
selected at the moment (and on errors) selected at the moment (and on errors)
This returns the selected item in @p obj. If multi selection is This returns the selected item in $obj. If multi selection is
enabled on @p obj (@see elm_gengrid_multi_select_set()), only enabled on $obj (@see elm_gengrid_multi_select_set()), only
the first item in the list is selected, which might not be very the first item in the list is selected, which might not be very
useful. For that case, see elm_gengrid_selected_items_get(). useful. For that case, see elm_gengrid_selected_items_get().
@ -384,10 +384,10 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get the first item in a given gengrid widget Get the first item in a given gengrid widget
@return The first item's handle or @c NULL, if there are no @return The first item's handle or $NULL, if there are no
items in @p obj (and on errors) items in $obj (and on errors)
This returns the first item in the @p obj's internal list of This returns the first item in the $obj's internal list of
items. items.
@see elm_gengrid_last_item_get() @see elm_gengrid_last_item_get()
@ -401,7 +401,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get <b>a list</b> of selected items in a given gengrid Get <b>a list</b> of selected items in a given gengrid
@return The list of selected items or @c NULL, if none is @return The list of selected items or $NULL, if none is
selected at the moment (and on errors) selected at the moment (and on errors)
This returns a list of the selected items, in the order that This returns a list of the selected items, in the order that
@ -421,10 +421,10 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get the last item in a given gengrid widget Get the last item in a given gengrid widget
@return The last item's handle or @c NULL, if there are no @return The last item's handle or $NULL, if there are no
items in @p obj (and on errors) items in $obj (and on errors)
This returns the last item in the @p obj's internal list of This returns the last item in the $obj's internal list of
items. items.
@see elm_gengrid_first_item_get() @see elm_gengrid_first_item_get()
@ -450,7 +450,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get a value whether mouse wheel is enabled or not. Get a value whether mouse wheel is enabled or not.
@return @c true means gengrid wheel is disabled. @c false indicates @return $true means gengrid wheel is disabled. $false indicates
it is enabled. it is enabled.
Mouse wheel can be used for the user to scroll up and down the gengrid. Mouse wheel can be used for the user to scroll up and down the gengrid.
@ -460,7 +460,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@ingroup Gengrid */ @ingroup Gengrid */
} }
values { values {
disabled: bool; /*@ Use @c true to disable mouse wheel or @c false disabled: bool; /*@ Use $true to disable mouse wheel or $false
to enable it. */ to enable it. */
} }
} }
@ -468,7 +468,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Insert an item before another in a gengrid widget Insert an item before another in a gengrid widget
@return A handle to the item added or @c NULL, on errors. @return A handle to the item added or $NULL, on errors.
This inserts an item before another in the gengrid. This inserts an item before another in the gengrid.
@ -486,7 +486,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@in relative: Elm.Widget_Item *; /*@ The item to place this new one before. */ @in relative: Elm.Widget_Item *; /*@ The item to place this new one before. */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is
selected. */ selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to @p func. */ @in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
} }
} }
realized_items_update { realized_items_update {
@ -509,7 +509,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Insert an item after another in a gengrid widget Insert an item after another in a gengrid widget
@return A handle to the item added or @c NULL, on errors. @return A handle to the item added or $NULL, on errors.
This inserts an item after another in the gengrid. This inserts an item after another in the gengrid.
@ -527,7 +527,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@in relative: Elm.Widget_Item *; /*@ The item to place this new one after. */ @in relative: Elm.Widget_Item *; /*@ The item to place this new one after. */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is
selected. */ selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to @p func. */ @in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
} }
} }
items_count @const { items_count @const {
@ -549,11 +549,11 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
This returns the item at the given coordinates (which are canvas This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate, relative, not object-relative). If an item is at that coordinate,
that item handle is returned, and if @p xposret is not NULL, the that item handle is returned, and if $xposret is not NULL, the
integer pointed to is set to a value of -1, 0 or 1, depending if integer pointed to is set to a value of -1, 0 or 1, depending if
the coordinate is on the left portion of that item (-1), on the the coordinate is on the left portion of that item (-1), on the
middle section (0) or on the right part (1). middle section (0) or on the right part (1).
if @p yposret is not NULL, the if $yposret is not NULL, the
integer pointed to is set to a value of -1, 0 or 1, depending if integer pointed to is set to a value of -1, 0 or 1, depending if
the coordinate is on the upper portion of that item (-1), on the the coordinate is on the upper portion of that item (-1), on the
middle section (0) or on the lower part (1). If NULL is returned as middle section (0) or on the lower part (1). If NULL is returned as
@ -574,7 +574,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Append a new item in a given gengrid widget. Append a new item in a given gengrid widget.
@return A handle to the item added or @c NULL, on errors. @return A handle to the item added or $NULL, on errors.
This adds an item to the beginning of the gengrid. This adds an item to the beginning of the gengrid.
@ -591,14 +591,14 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@in data: const(void)*; /*@ The item data. */ @in data: const(void)*; /*@ The item data. */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is
selected. */ selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to @p func. */ @in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
} }
} }
item_prepend { item_prepend {
/*@ /*@
Prepend a new item in a given gengrid widget. Prepend a new item in a given gengrid widget.
@return A handle to the item added or @c NULL, on errors. @return A handle to the item added or $NULL, on errors.
This adds an item to the end of the gengrid. This adds an item to the end of the gengrid.
@ -615,14 +615,14 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@in data: const(void)*; /*@ The item data. */ @in data: const(void)*; /*@ The item data. */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is
selected. */ selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to @p func. */ @in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
} }
} }
clear { clear {
/*@ /*@
Remove all items from a given gengrid widget Remove all items from a given gengrid widget
This removes (and deletes) all items in @p obj, leaving it This removes (and deletes) all items in $obj, leaving it
empty. empty.
@see elm_object_item_del(), to remove just one item. @see elm_object_item_del(), to remove just one item.
@ -634,10 +634,10 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Insert an item in a gengrid widget using a user-defined sort function. Insert an item in a gengrid widget using a user-defined sort function.
@return A handle to the item added or @c NULL, on errors. @return A handle to the item added or $NULL, on errors.
This inserts an item in the gengrid based on user defined comparison This inserts an item in the gengrid based on user defined comparison
function. The two arguments passed to the function @p func are gengrid function. The two arguments passed to the function $func are gengrid
item handles to compare. item handles to compare.
@see elm_gengrid_item_append() @see elm_gengrid_item_append()
@ -655,7 +655,7 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
@in comp: Eina_Compare_Cb; /*@ User defined comparison function that defines the sort order @in comp: Eina_Compare_Cb; /*@ User defined comparison function that defines the sort order
based on gengrid item and its data. */ based on gengrid item and its data. */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected. */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to @p func. */ @in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
} }
} }
search_by_text_item_get { search_by_text_item_get {

20
legacy/elementary/src/lib/elm_gengrid_item.eo
View File

@ -33,7 +33,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
Get the @b previous item in a gengrid widget's internal list of items, Get the @b previous item in a gengrid widget's internal list of items,
given a handle to one of those items. given a handle to one of those items.
This returns the item placed before the @p item, on the container This returns the item placed before the $item, on the container
gengrid. gengrid.
@see elm_gengrid_item_next_get() @see elm_gengrid_item_next_get()
@ -42,7 +42,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ @return The item before @p item, or @c NULL if there's none (and on errors) */ item: Elm.Widget_Item *; /*@ @return The item before $item, or $NULL if there's none (and on errors) */
} }
} }
@property next { @property next {
@ -51,7 +51,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
Get the @b next item in a gengrid widget's internal list of items, Get the @b next item in a gengrid widget's internal list of items,
given a handle to one of those items. given a handle to one of those items.
This returns the item placed after the @p item, on the container This returns the item placed after the $item, on the container
gengrid. gengrid.
@see elm_gengrid_item_prev_get() @see elm_gengrid_item_prev_get()
@ -60,7 +60,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ @return The item after @p item, or @c NULL if there's none (and on errors) */ item: Elm.Widget_Item *; /*@ @return The item after $item, or $NULL if there's none (and on errors) */
} }
} }
@property selected { @property selected {
@ -80,7 +80,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
Set whether a given gengrid item is selected or not Set whether a given gengrid item is selected or not
This sets the selected state of an item. If multi-selection is This sets the selected state of an item. If multi-selection is
not enabled on the containing gengrid and @p selected is @c not enabled on the containing gengrid and $selected is @c
true, any other previously selected items will get true, any other previously selected items will get
unselected in favor of this new one. unselected in favor of this new one.
@ -90,7 +90,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
*/ */
} }
values { values {
selected: bool; /*@ the selected state (@c true selected, @c false not selected) */ selected: bool; /*@ the selected state ($true selected, $false not selected) */
} }
} }
@property item_class { @property item_class {
@ -127,7 +127,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
gengrid's grid area. gengrid's grid area.
This returns the "logical" position of the item within the This returns the "logical" position of the item within the
gengrid. For example, @c (0, 1) would stand for first row, gengrid. For example, $(0, 1) would stand for first row,
second column. second column.
@ingroup Gengrid @ingroup Gengrid
@ -191,7 +191,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
item, @b immediately. item, @b immediately.
This causes gengrid to @b redraw its viewport's contents to the This causes gengrid to @b redraw its viewport's contents to the
region containing the given @p item item, if it is not fully region containing the given $item item, if it is not fully
visible. visible.
@see elm_gengrid_item_bring_in() @see elm_gengrid_item_bring_in()
@ -207,7 +207,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
Animatedly bring in, to the visible area of a gengrid, a given Animatedly bring in, to the visible area of a gengrid, a given
item on it. item on it.
This causes gengrid to jump to the given @p item and show This causes gengrid to jump to the given $item and show
it (by scrolling), if it is not fully visible. This will use it (by scrolling), if it is not fully visible. This will use
animation to do so and take a period of time to complete. animation to do so and take a period of time to complete.
@ -260,7 +260,7 @@ class Elm.Gengrid_Item(Elm.Widget_Item)
This sets another class of the item, changing the way that it is This sets another class of the item, changing the way that it is
displayed. After changing the item class, elm_gengrid_item_update() is displayed. After changing the item class, elm_gengrid_item_update() is
called on the item @p it. called on the item $it.
@ingroup Gengrid @ingroup Gengrid
*/ */

36
legacy/elementary/src/lib/elm_genlist.eo
View File

@ -139,7 +139,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@ /*@
Enable or disable multi-selection in the genlist Enable or disable multi-selection in the genlist
This enables (@c true) or disables (@c false) multi-selection in This enables ($true) or disables ($false) multi-selection in
the list. This allows more than 1 item to be selected. To retrieve the list the list. This allows more than 1 item to be selected. To retrieve the list
of selected items, use elm_genlist_selected_items_get(). of selected items, use elm_genlist_selected_items_get().
@ -153,7 +153,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
Get if multi-selection in genlist is enabled or disabled. Get if multi-selection in genlist is enabled or disabled.
@return Multi-select enabled/disabled @return Multi-select enabled/disabled
(@c true = enabled/@c false = disabled). Default is @c false. ($true = enabled/$false = disabled). Default is $false.
@see elm_genlist_multi_select_set() @see elm_genlist_multi_select_set()
@ -320,15 +320,15 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@ /*@
Get whether the genlist items' should be highlighted when item selected. Get whether the genlist items' should be highlighted when item selected.
@return @c true means items can be highlighted. @c false indicates @return $true means items can be highlighted. $false indicates
they can't. If @p obj is @c NULL, @c false is returned. they can't. If $obj is $NULL, $false is returned.
@see elm_genlist_highlight_mode_set() for details. @see elm_genlist_highlight_mode_set() for details.
@ingroup Genlist */ @ingroup Genlist */
} }
values { values {
highlight: bool; /*@ @c true to enable highlighting or @c false to highlight: bool; /*@ $true to enable highlighting or $false to
disable it. */ disable it. */
} }
} }
@ -381,7 +381,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@ /*@
Get active genlist mode item Get active genlist mode item
@return The active item for that current mode. Or @c NULL if no item is @return The active item for that current mode. Or $NULL if no item is
activated with any mode. activated with any mode.
This function returns the item that was activated with a mode, by the This function returns the item that was activated with a mode, by the
@ -487,7 +487,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@ /*@
Insert an item before another in a genlist widget Insert an item before another in a genlist widget
@return A handle to the item added or @c NULL if not possible @return A handle to the item added or $NULL if not possible
This inserts an item before another in the list. It will be in the This inserts an item before another in the list. It will be in the
same tree level or group as the item it is inserted before. same tree level or group as the item it is inserted before.
@ -507,7 +507,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
@in before_it: Elm.Widget_Item *; /*@ The item to place this new one before. */ @in before_it: Elm.Widget_Item *; /*@ The item to place this new one before. */
@in type: Elm_Genlist_Item_Type; /*@ Item type */ @in type: Elm_Genlist_Item_Type; /*@ Item type */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */
@in func_data: const(void)* @optional; /*@ Data passed to @p func above. */ @in func_data: const(void)* @optional; /*@ Data passed to $func above. */
} }
} }
realized_items_update { realized_items_update {
@ -530,7 +530,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@ /*@
Insert an item after another in a genlist widget Insert an item after another in a genlist widget
@return A handle to the item added or @c NULL if not possible @return A handle to the item added or $NULL if not possible
This inserts an item after another in the list. It will be in the This inserts an item after another in the list. It will be in the
same tree level or group as the item it is inserted after. same tree level or group as the item it is inserted after.
@ -550,7 +550,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
@in after_it: Elm.Widget_Item *; /*@ The item to place this new one after. */ @in after_it: Elm.Widget_Item *; /*@ The item to place this new one after. */
@in type: Elm_Genlist_Item_Type; /*@ Item type */ @in type: Elm_Genlist_Item_Type; /*@ Item type */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */
@in func_data: const(void)* @optional; /*@ Data passed to @p func above. */ @in func_data: const(void)* @optional; /*@ Data passed to $func above. */
} }
} }
at_xy_item_get @const { at_xy_item_get @const {
@ -561,7 +561,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
This returns the item at the given coordinates (which are canvas This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate, relative, not object-relative). If an item is at that coordinate,
that item handle is returned, and if @p posret is not NULL, the that item handle is returned, and if $posret is not NULL, the
integer pointed to is set to a value of -1, 0 or 1, depending if integer pointed to is set to a value of -1, 0 or 1, depending if
the coordinate is on the upper portion of that item (-1), on the the coordinate is on the upper portion of that item (-1), on the
middle section (0) or on the lower part (1). If NULL is returned as middle section (0) or on the lower part (1). If NULL is returned as
@ -611,14 +611,14 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
@in parent: Elm.Widget_Item * @nullable; /*@ The parent item, or NULL if none */ @in parent: Elm.Widget_Item * @nullable; /*@ The parent item, or NULL if none */
@in type: Elm_Genlist_Item_Type; /*@ Item type */ @in type: Elm_Genlist_Item_Type; /*@ Item type */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */
@in func_data: const(void)* @optional; /*@ Data passed to @p func above. */ @in func_data: const(void)* @optional; /*@ Data passed to $func above. */
} }
} }
clear { clear {
/*@ /*@
Remove all items from a given genlist widget. Remove all items from a given genlist widget.
This removes (and deletes) all items in @p obj, leaving it empty. This removes (and deletes) all items in $obj, leaving it empty.
@see elm_object_item_del(), to remove just one item. @see elm_object_item_del(), to remove just one item.
@ -629,10 +629,10 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
/*@ /*@
Append a new item in a given genlist widget. Append a new item in a given genlist widget.
@return A handle to the item added or @c NULL if not possible @return A handle to the item added or $NULL if not possible
This adds the given item to the end of the list or the end of This adds the given item to the end of the list or the end of
the children list if the @p parent is given. the children list if the $parent is given.
@see elm_genlist_item_prepend() @see elm_genlist_item_prepend()
@see elm_genlist_item_insert_before() @see elm_genlist_item_insert_before()
@ -648,7 +648,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
@in parent: Elm.Widget_Item * @nullable; /*@ The parent item, or NULL if none */ @in parent: Elm.Widget_Item * @nullable; /*@ The parent item, or NULL if none */
@in type: Elm_Genlist_Item_Type; /*@ Item type */ @in type: Elm_Genlist_Item_Type; /*@ Item type */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when the item is selected */
@in func_data: const(void)* @optional; /*@ Data passed to @p func above. */ @in func_data: const(void)* @optional; /*@ Data passed to $func above. */
} }
} }
item_sorted_insert { item_sorted_insert {
@ -658,7 +658,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
@return A handle to the item added or NULL if not possible @return A handle to the item added or NULL if not possible
This inserts an item in the genlist based on user defined comparison This inserts an item in the genlist based on user defined comparison
function. The two arguments passed to the function @p func are genlist item function. The two arguments passed to the function $func are genlist item
handles to compare. handles to compare.
@see elm_genlist_item_append() @see elm_genlist_item_append()
@ -676,7 +676,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
@in type: Elm_Genlist_Item_Type; /*@ Item type */ @in type: Elm_Genlist_Item_Type; /*@ Item type */
@in comp: Eina_Compare_Cb; /*@ The function called for the sort */ @in comp: Eina_Compare_Cb; /*@ The function called for the sort */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */
@in func_data: const(void)* @optional; /*@ Data passed to @p func above. */ @in func_data: const(void)* @optional; /*@ Data passed to $func above. */
} }
} }
search_by_text_item_get { search_by_text_item_get {

36
legacy/elementary/src/lib/elm_genlist_item.eo
View File

@ -46,7 +46,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
Get the @b previous item in a genlist widget's internal list of items, Get the @b previous item in a genlist widget's internal list of items,
given a handle to one of those items. given a handle to one of those items.
This returns the item placed before the @p item, on the container This returns the item placed before the $item, on the container
genlist. genlist.
@see elm_genlist_item_next_get() @see elm_genlist_item_next_get()
@ -55,7 +55,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ @return The item before @p item, or @c NULL if there's none (and on errors) */ item: Elm.Widget_Item *; /*@ @return The item before $item, or $NULL if there's none (and on errors) */
} }
} }
@property next { @property next {
@ -64,7 +64,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
Get the @b next item in a genlist widget's internal list of items, Get the @b next item in a genlist widget's internal list of items,
given a handle to one of those items. given a handle to one of those items.
This returns the item placed after the @p item, on the container This returns the item placed after the $item, on the container
genlist. genlist.
@see elm_genlist_item_prev_get() @see elm_genlist_item_prev_get()
@ -73,7 +73,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ @return The item after @p item, or @c NULL if there's none (and on errors) */ item: Elm.Widget_Item *; /*@ @return The item after $item, or $NULL if there's none (and on errors) */
} }
} }
@property parent { @property parent {
@ -81,14 +81,14 @@ class Elm.Genlist_Item(Elm.Widget_Item)
/*@ /*@
Get the parent item of the given item Get the parent item of the given item
This returns the item that was specified as parent of the item @p it on This returns the item that was specified as parent of the item $it on
elm_genlist_item_append() and insertion related functions. elm_genlist_item_append() and insertion related functions.
@ingroup Genlist @ingroup Genlist
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ @return The parent of the item or @c NULL if it has no parent. */ item: Elm.Widget_Item *; /*@ @return The parent of the item or $NULL if it has no parent. */
} }
} }
@property subitems { @property subitems {
@ -103,7 +103,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
*/ */
} }
values { values {
subitems: const (list<Elm.Widget_Item *>) *; /*@ @return The list of subitems, @c NULL on error */ subitems: const (list<Elm.Widget_Item *>) *; /*@ @return The list of subitems, $NULL on error */
} }
} }
@property selected { @property selected {
@ -111,7 +111,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
/*@ /*@
Get whether a given genlist item is selected or not Get whether a given genlist item is selected or not
@return @c true, if it's selected, @c false otherwise @return $true, if it's selected, $false otherwise
@see elm_genlist_item_selected_set() for more details @see elm_genlist_item_selected_set() for more details
@ -122,10 +122,10 @@ class Elm.Genlist_Item(Elm.Widget_Item)
/*@ /*@
Set whether a given genlist item is selected or not Set whether a given genlist item is selected or not
Use @c true, to make it selected, @c false to make it unselected Use $true, to make it selected, $false to make it unselected
This sets the selected state of an item. If multi selection is This sets the selected state of an item. If multi selection is
not enabled on the containing genlist and @p selected is @c not enabled on the containing genlist and $selected is @c
true, any other previously selected items will get true, any other previously selected items will get
unselected in favor of this new one. unselected in favor of this new one.
@ -135,7 +135,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
*/ */
} }
values { values {
selected: bool; /*@ the selected state (@c true selected, @c false not selected) */ selected: bool; /*@ the selected state ($true selected, $false not selected) */
} }
} }
@property expanded { @property expanded {
@ -171,7 +171,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
*/ */
} }
values { values {
expanded: bool; /*@ The expanded state (@c true expanded, @c false not expanded). */ expanded: bool; /*@ The expanded state ($true expanded, $false not expanded). */
} }
} }
@property expanded_depth { @property expanded_depth {
@ -238,7 +238,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
Get the flip state of a given genlist item. Get the flip state of a given genlist item.
This function returns the flip state of a given genlist item. This function returns the flip state of a given genlist item.
If the parameter is invalid, it returns @c false. If the parameter is invalid, it returns $false.
@see elm_genlist_item_flip_set() @see elm_genlist_item_flip_set()
@ -249,7 +249,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
/*@ /*@
Set the flip state of a given genlist item. Set the flip state of a given genlist item.
(@c true = on, @c false = off) ($true = on, $false = off)
This function sets the flip state of a given genlist item. This function sets the flip state of a given genlist item.
Flip mode overrides current item object. Flip mode overrides current item object.
@ -348,7 +348,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
@param it The item @param it The item
This removes all items that are children (and their descendants) of the This removes all items that are children (and their descendants) of the
given item @p it. given item $it.
@see elm_genlist_clear() @see elm_genlist_clear()
@see elm_object_item_del() @see elm_object_item_del()
@ -379,7 +379,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
Show the portion of a genlist's internal list containing a given Show the portion of a genlist's internal list containing a given
item, immediately. item, immediately.
This causes genlist to jump to the given item @p it and show it (by This causes genlist to jump to the given item $it and show it (by
jumping to that position), if it is not fully visible. jumping to that position), if it is not fully visible.
@see elm_genlist_item_bring_in() @see elm_genlist_item_bring_in()
@ -396,7 +396,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
Animatedly bring in, to the visible area of a genlist, a given Animatedly bring in, to the visible area of a genlist, a given
item on it. item on it.
This causes genlist to jump to the given item @p it and show it (by This causes genlist to jump to the given item $it and show it (by
animatedly scrolling), if it is not fully visible. animatedly scrolling), if it is not fully visible.
This may use animation and take a some time to do so. This may use animation and take a some time to do so.
@ -473,7 +473,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
This sets another class of the item, changing the way that it is This sets another class of the item, changing the way that it is
displayed. After changing the item class, elm_genlist_item_update() is displayed. After changing the item class, elm_genlist_item_update() is
called on the item @p it. called on the item $it.
@ingroup Genlist @ingroup Genlist
*/ */

2
legacy/elementary/src/lib/elm_gesture_layer.eo
View File

@ -126,7 +126,7 @@ class Elm.Gesture_Layer (Elm.Widget)
chooses. This will be object @a obj will listen all mouse and key chooses. This will be object @a obj will listen all mouse and key
events from, to report the gestures made upon it back. events from, to report the gestures made upon it back.
@return @c true, on success, @c false otherwise. @return $true, on success, $false otherwise.
@ingroup Elm_Gesture_Layer @ingroup Elm_Gesture_Layer
*/ */

2
legacy/elementary/src/lib/elm_hoversel.eo
View File

@ -75,7 +75,7 @@ class Elm.Hoversel (Elm.Button, Evas.Selectable_Interface,
/* FIXME: Make the hoversel_item reference in the doc a real ref. */ /* FIXME: Make the hoversel_item reference in the doc a real ref. */
/* FIXME-doc /* FIXME-doc
For more information on what @p icon_file and @p icon_type are, see the For more information on what $icon_file and $icon_type are, see the
@ref Icon "icon documentation". */ @ref Icon "icon documentation". */
return: Elm.Widget_Item *; [[A handle to the added item.]] return: Elm.Widget_Item *; [[A handle to the added item.]]
params { params {

68
legacy/elementary/src/lib/elm_image.eo
View File

@ -27,7 +27,7 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
@ingroup Image */ @ingroup Image */
} }
values { values {
set: bool; /*@ Turn on or off editability. Default is @c false. */ set: bool; /*@ Turn on or off editability. Default is $false. */
} }
} }
@property resize_down { @property resize_down {
@ -97,15 +97,15 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Get the smooth effect for an image. Get the smooth effect for an image.
@return @c true if smooth scaling is enabled, @c false otherwise. @return $true if smooth scaling is enabled, $false otherwise.
@see elm_image_smooth_set() @see elm_image_smooth_set()
@ingroup Image */ @ingroup Image */
} }
values { values {
smooth: bool; /*@ @c true if smooth scaling should be used, @c false smooth: bool; /*@ $true if smooth scaling should be used, $false
otherwise. Default is @c true. */ otherwise. Default is $true. */
} }
} }
@property no_scale { @property no_scale {
@ -128,15 +128,15 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Get whether scaling is disabled on the object. Get whether scaling is disabled on the object.
@return @c true if scaling is disabled, @c false otherwise @return $true if scaling is disabled, $false otherwise
@see elm_image_no_scale_set() @see elm_image_no_scale_set()
@ingroup Image */ @ingroup Image */
} }
values { values {
no_scale: bool; /*@ @c true if the object is not scalable, @c false no_scale: bool; /*@ $true if the object is not scalable, $false
otherwise. Default is @c false. */ otherwise. Default is $false. */
} }
} }
@property scale { @property scale {
@ -167,7 +167,7 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Set the resize method for the object's internal image when maintaining a given aspect ratio. Set the resize method for the object's internal image when maintaining a given aspect ratio.
If @p fill_inside is true, image does not overflow the widget and If $fill_inside is true, image does not overflow the widget and
blank spaces are added to fill the space that is still free. If it blank spaces are added to fill the space that is still free. If it
is false, the image overflows the image will fill all space and is false, the image overflows the image will fill all space and
overflow in its larger dimension. overflow in its larger dimension.
@ -218,14 +218,14 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Get if the object retains the original aspect ratio. Get if the object retains the original aspect ratio.
@return @c true if the object keeps the original aspect, @c false @return $true if the object keeps the original aspect, $false
otherwise. otherwise.
@ingroup Image */ @ingroup Image */
} }
values { values {
fixed: bool; /*@ @c true if the image should retain the aspect, fixed: bool; /*@ $true if the image should retain the aspect,
@c false otherwise. */ $false otherwise. */
} }
} }
@property orient { @property orient {
@ -263,12 +263,12 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
When the image should keep its aspect ratio even if resized to another When the image should keep its aspect ratio even if resized to another
aspect ratio, there are two possibilities to resize it: keep the entire aspect ratio, there are two possibilities to resize it: keep the entire
image inside the limits of height and width of the object (@p fill_outside image inside the limits of height and width of the object ($fill_outside
is @c false) or let the extra width or height go outside of the object, is $false) or let the extra width or height go outside of the object,
and the image will fill the entire object (@p fill_outside is @c true). and the image will fill the entire object ($fill_outside is $true).
@note This option will have no effect if @note This option will have no effect if
elm_image_aspect_fixed_set() is set to @c false. elm_image_aspect_fixed_set() is set to $false.
@see elm_image_fill_inside_get() @see elm_image_fill_inside_get()
@see elm_image_fill_inside_set() @see elm_image_fill_inside_set()
@ -281,7 +281,7 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Get if the object is filled outside Get if the object is filled outside
@return @c true if the object is filled outside, @c false otherwise. @return $true if the object is filled outside, $false otherwise.
@see elm_image_fill_inside_get() @see elm_image_fill_inside_get()
@see elm_image_fill_inside_set() @see elm_image_fill_inside_set()
@ -290,8 +290,8 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
@ingroup Image */ @ingroup Image */
} }
values { values {
fill_outside: bool; /*@ @c true if the object is filled outside, fill_outside: bool; /*@ $true if the object is filled outside,
@c false otherwise. Default is @c false. */ $false otherwise. Default is $false. */
} }
} }
@property resizable { @property resizable {
@ -299,9 +299,9 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Set if the object is (up/down) resizable. Set if the object is (up/down) resizable.
This function limits the image resize ability. If @p size_up is set to This function limits the image resize ability. If $size_up is set to
@c false, the object can't have its height or width resized to a value $false, the object can't have its height or width resized to a value
higher than the original image size. Same is valid for @p size_down. higher than the original image size. Same is valid for $size_down.
@see elm_image_resizable_get() @see elm_image_resizable_get()
@ -317,9 +317,9 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
} }
values { values {
up: bool; /*@ A bool to set if the object is resizable up. Default is up: bool; /*@ A bool to set if the object is resizable up. Default is
@c true. */ $true. */
down: bool; /*@ A bool to set if the object is resizable down. Default down: bool; /*@ A bool to set if the object is resizable down. Default
is @c true. */ is $true. */
} }
} }
@property preload_disabled { @property preload_disabled {
@ -338,16 +338,16 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
/*@ /*@
Set the file that will be used as the image's source. Set the file that will be used as the image's source.
@return (@c true = success, @c false = error) @return ($true = success, $false = error)
@see elm_image_file_set() @see elm_image_file_set()
@note This function will trigger the Edje file case based on the @note This function will trigger the Edje file case based on the
extension of the @a file string use to create the Eina_File (expects extension of the @a file string use to create the Eina_File (expects
@c ".edj", for this case). $".edj", for this case).
@note If you use animated gif image and create multiple image objects with @note If you use animated gif image and create multiple image objects with
one gif image file, you should set the @p group differently for each object. one gif image file, you should set the $group differently for each object.
Or image objects will share one evas image cache entry and you will get Or image objects will share one evas image cache entry and you will get
unwanted frames. unwanted frames.
@ -371,13 +371,13 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
This function is handy when the contents of an image file are This function is handy when the contents of an image file are
mapped in memory, for example. mapped in memory, for example.
The @p format string should be something like @c "png", @c "jpg", The $format string should be something like $"png", $"jpg",
@c "tga", @c "tiff", @c "bmp" etc, when provided (@c NULL, on the $"tga", $"tiff", $"bmp" etc, when provided ($NULL, on the
contrary). This improves the loader performance as it tries the contrary). This improves the loader performance as it tries the
"correct" loader first, before trying a range of other possible "correct" loader first, before trying a range of other possible
loaders until one succeeds. loaders until one succeeds.
@return (@c true = success, @c false = error) @return ($true = success, $false = error)
@since 1.7 @since 1.7
@ -386,10 +386,10 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
} }
values { values {
img: const(void)*; /*@ The binary data that will be used as image source */ img: const(void)*; /*@ The binary data that will be used as image source */
size: size; /*@ The size of binary data blob @p img */ size: size; /*@ The size of binary data blob $img */
format: const(char)* @optional; /*@ (Optional) expected format of @p img bytes */ format: const(char)* @optional; /*@ (Optional) expected format of $img bytes */
key: const(char)* @optional; /*@ Optional indexing key of @p img to be passed to the key: const(char)* @optional; /*@ Optional indexing key of $img to be passed to the
image loader (eg. if @p img is a memory-mapped EET file) */ image loader (eg. if $img is a memory-mapped EET file) */
} }
} }
@property object { @property object {
@ -399,7 +399,7 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
@return The inlined image object, or NULL if none exists @return The inlined image object, or NULL if none exists
This function allows one to get the underlying @c Evas_Object of type This function allows one to get the underlying $Evas_Object of type
Image from this elementary widget. It can be useful to do things like get Image from this elementary widget. It can be useful to do things like get
the pixel data, save the image to a file, etc. the pixel data, save the image to a file, etc.

96
legacy/elementary/src/lib/elm_index.eo
View File

@ -15,14 +15,14 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Get whether auto hiding feature is enabled or not for a given index widget. Get whether auto hiding feature is enabled or not for a given index widget.
@return @c true, if auto hiding is disabled, @c false otherwise @return $true, if auto hiding is disabled, $false otherwise
@see elm_index_autohide_disabled_set() for more details @see elm_index_autohide_disabled_set() for more details
@ingroup Index */ @ingroup Index */
} }
values { values {
disabled: bool; /*@ @c true to disable auto hiding, @c false to enable */ disabled: bool; /*@ $true to disable auto hiding, $false to enable */
} }
} }
@property omit_enabled { @property omit_enabled {
@ -40,7 +40,7 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Get whether omit feature is enabled or not for a given index widget. Get whether omit feature is enabled or not for a given index widget.
@return @c true, if omit feature is enabled, @c false otherwise @return $true, if omit feature is enabled, $false otherwise
@see elm_index_omit_enabled_set() @see elm_index_omit_enabled_set()
@ -49,7 +49,7 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
@ingroup Index */ @ingroup Index */
} }
values { values {
enabled: bool; /*@ @c true to enable omit feature, @c false to disable */ enabled: bool; /*@ $true to enable omit feature, $false to disable */
} }
} }
@property priority { @property priority {
@ -77,7 +77,7 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
@ingroup Index */ @ingroup Index */
} }
values { values {
priority: int; /*@ @c priority target priority value in index */ priority: int; /*@ $priority target priority value in index */
} }
} }
@ -99,16 +99,16 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Get a value whether horizontal mode is enabled or not. Get a value whether horizontal mode is enabled or not.
@return @c true means horizontal mode selection is enabled. @return $true means horizontal mode selection is enabled.
@c false indicates it's disabled. If @p obj is @c NULL, $false indicates it's disabled. If $obj is $NULL,
@c false is returned. $false is returned.
@see elm_index_horizontal_set() for details. @see elm_index_horizontal_set() for details.
@ingroup Index */ @ingroup Index */
} }
values { values {
horizontal: bool; /*@ @c true to enable horizontal or @c false to horizontal: bool; /*@ $true to enable horizontal or $false to
disable it, i.e., to enable vertical mode. it's an area one @ref Fingers disable it, i.e., to enable vertical mode. it's an area one @ref Fingers
"finger" wide on the bottom side of the index widget's container. */ "finger" wide on the bottom side of the index widget's container. */
} }
@ -160,7 +160,7 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
@ingroup Index */ @ingroup Index */
} }
values { values {
disabled: bool; /*@ @c true to disable it, @c false to enable it */ disabled: bool; /*@ $true to disable it, $false to enable it */
} }
} }
@property item_level { @property item_level {
@ -176,14 +176,14 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Get the items level set for a given index widget. Get the items level set for a given index widget.
@return @c 0 or @c 1, which are the levels @p obj might be at. @return $0 or $1, which are the levels $obj might be at.
@see elm_index_item_level_set() for more information @see elm_index_item_level_set() for more information
@ingroup Index */ @ingroup Index */
} }
values { values {
level: int; /*@ @c 0 or @c 1, the currently implemented levels. */ level: int; /*@ $0 or $1, the currently implemented levels. */
} }
} }
level_go { level_go {
@ -199,21 +199,21 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
@ingroup Index */ @ingroup Index */
params { params {
@in level: int; /*@ The index level (one of @c 0 or @c 1) where changes were made */ @in level: int; /*@ The index level (one of $0 or $1) where changes were made */
} }
} }
item_prepend { item_prepend {
/*@ /*@
Prepend a new item on a given index widget. Prepend a new item on a given index widget.
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
Despite the most common usage of the @p letter argument is for Despite the most common usage of the $letter argument is for
single char strings, one could use arbitrary strings as index single char strings, one could use arbitrary strings as index
entries. entries.
@c item will be the pointer returned back on @c "changed", @c $item will be the pointer returned back on $"changed", @c
"delay,changed" and @c "selected" smart events. "delay,changed" and $"selected" smart events.
@ingroup Index */ @ingroup Index */
@ -229,25 +229,25 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
Removes @b all items from a given index widget. Removes @b all items from a given index widget.
If deletion callbacks are set, via elm_object_item_del_cb_set(), If deletion callbacks are set, via elm_object_item_del_cb_set(),
that callback function will be called for each item in @p obj. that callback function will be called for each item in $obj.
@ingroup Index */ @ingroup Index */
} }
item_insert_after { item_insert_after {
/*@ /*@
Insert a new item into the index object after item @p after. Insert a new item into the index object after item $after.
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
Despite the most common usage of the @p letter argument is for Despite the most common usage of the $letter argument is for
single char strings, one could use arbitrary strings as index single char strings, one could use arbitrary strings as index
entries. entries.
@c item will be the pointer returned back on @c "changed", @c $item will be the pointer returned back on $"changed", @c
"delay,changed" and @c "selected" smart events. "delay,changed" and $"selected" smart events.
@note If @p relative is @c NULL this function will behave as @note If $relative is $NULL this function will behave as
elm_index_item_append(). elm_index_item_append().
@ingroup Index */ @ingroup Index */
@ -264,7 +264,7 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Find a given index widget's item, <b>using item data</b>. Find a given index widget's item, <b>using item data</b>.
@return The index item handle, if found, or @c NULL otherwise @return The index item handle, if found, or $NULL otherwise
@ingroup Index */ @ingroup Index */
@ -275,18 +275,18 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
} }
item_insert_before { item_insert_before {
/*@ /*@
Insert a new item into the index object before item @p before. Insert a new item into the index object before item $before.
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
Despite the most common usage of the @p letter argument is for Despite the most common usage of the $letter argument is for
single char strings, one could use arbitrary strings as index single char strings, one could use arbitrary strings as index
entries. entries.
@c item will be the pointer returned back on @c "changed", @c $item will be the pointer returned back on $"changed", @c
"delay,changed" and @c "selected" smart events. "delay,changed" and $"selected" smart events.
@note If @p relative is @c NULL this function will behave as @note If $relative is $NULL this function will behave as
elm_index_item_prepend(). elm_index_item_prepend().
@ingroup Index */ @ingroup Index */
@ -303,14 +303,14 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Append a new item on a given index widget. Append a new item on a given index widget.
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
Despite the most common usage of the @p letter argument is for Despite the most common usage of the $letter argument is for
single char strings, one could use arbitrary strings as index single char strings, one could use arbitrary strings as index
entries. entries.
@c item will be the pointer returned back on @c "changed", @c $item will be the pointer returned back on $"changed", @c
"delay,changed" and @c "selected" smart events. "delay,changed" and $"selected" smart events.
@ingroup Index */ @ingroup Index */
@ -325,27 +325,27 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
/*@ /*@
Returns the last selected item, for a given index widget. Returns the last selected item, for a given index widget.
@return The last item @b selected on @p obj (or @c NULL, on errors). @return The last item @b selected on $obj (or $NULL, on errors).
@ingroup Index */ @ingroup Index */
return: Elm.Widget_Item *; return: Elm.Widget_Item *;
params { params {
@in level: int; /*@ @c 0 or @c 1, the currently implemented levels. */ @in level: int; /*@ $0 or $1, the currently implemented levels. */
} }
} }
item_sorted_insert { item_sorted_insert {
/*@ /*@
Insert a new item into the given index widget, using @p cmp_func Insert a new item into the given index widget, using $cmp_func
function to sort items (by item handles). function to sort items (by item handles).
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
Despite the most common usage of the @p letter argument is for Despite the most common usage of the $letter argument is for
single char strings, one could use arbitrary strings as index single char strings, one could use arbitrary strings as index
entries. entries.
@c item will be the pointer returned back on @c "changed", @c $item will be the pointer returned back on $"changed", @c
"delay,changed" and @c "selected" smart events. "delay,changed" and $"selected" smart events.
@ingroup Index */ @ingroup Index */
@ -358,16 +358,16 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
items <b>by index item handles</b> */ items <b>by index item handles</b> */
@in cmp_data_func: Eina_Compare_Cb @optional; /*@ A @b fallback function to be called for the @in cmp_data_func: Eina_Compare_Cb @optional; /*@ A @b fallback function to be called for the
sorting of index items <b>by item data</b>). It will be used sorting of index items <b>by item data</b>). It will be used
when @p cmp_func returns @c 0 (equality), which means an index when $cmp_func returns $0 (equality), which means an index
item with provided item data already exists. To decide which item with provided item data already exists. To decide which
data item should be pointed to by the index item in question, @p data item should be pointed to by the index item in question, @p
cmp_data_func will be used. If @p cmp_data_func returns a cmp_data_func will be used. If $cmp_data_func returns a
non-negative value, the previous index item data will be non-negative value, the previous index item data will be
replaced by the given @p item pointer. If the previous data need replaced by the given $item pointer. If the previous data need
to be freed, it should be done by the @p cmp_data_func function, to be freed, it should be done by the $cmp_data_func function,
because all references to it will be lost. If this function is because all references to it will be lost. If this function is
not provided (@c NULL is given), index items will be @b not provided ($NULL is given), index items will be @b
duplicated, if @p cmp_func returns @c 0. */ duplicated, if $cmp_func returns $0. */
} }
} }
} }

4
legacy/elementary/src/lib/elm_interface_scrollable.eo
View File

@ -148,8 +148,8 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart)
* @brief Currently visible content region * @brief Currently visible content region
* *
* This gets the current region in the content object that is visible through * This gets the current region in the content object that is visible through
* the scroller. The region co-ordinates are returned in the @p x, @p y, @p * the scroller. The region co-ordinates are returned in the $x, $y, @p
* w, @p h values pointed to. * w, $h values pointed to.
* *
* @note All coordinates are relative to the content. * @note All coordinates are relative to the content.
* *

2
legacy/elementary/src/lib/elm_inwin.eo
View File

@ -7,7 +7,7 @@ class Elm.Inwin (Elm.Layout)
/*@ /*@
Activates an inwin object, ensuring its visibility Activates an inwin object, ensuring its visibility
This function will make sure that the inwin @p obj is completely visible This function will make sure that the inwin $obj is completely visible
by calling evas_object_show() and evas_object_raise() on it, to bring it by calling evas_object_show() and evas_object_raise() on it, to bring it
to the front. It also sets the keyboard focus to it, which will be passed to the front. It also sets the keyboard focus to it, which will be passed
onto its content. onto its content.

4
legacy/elementary/src/lib/elm_label.eo
View File

@ -70,7 +70,7 @@ class Elm.Label (Elm.Layout)
@brief Set the slide mode of the label widget. @brief Set the slide mode of the label widget.
elm_label_slide_mode_set() changes label slide mode. elm_label_slide_mode_set() changes label slide mode.
By default, slide mode is none. Possible values for @p mode are: By default, slide mode is none. Possible values for $mode are:
@li #ELM_LABEL_SLIDE_MODE_NONE - no slide effect @li #ELM_LABEL_SLIDE_MODE_NONE - no slide effect
@li #ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than @li #ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
the text width length the text width length
@ -135,7 +135,7 @@ class Elm.Label (Elm.Layout)
/*@ /*@
@brief Set the wrapping behavior of the label @brief Set the wrapping behavior of the label
By default no wrapping is done. Possible values for @p wrap are: By default no wrapping is done. Possible values for $wrap are:
@li #ELM_WRAP_NONE - No wrapping @li #ELM_WRAP_NONE - No wrapping
@li #ELM_WRAP_CHAR - wrap between characters @li #ELM_WRAP_CHAR - wrap between characters
@li #ELM_WRAP_WORD - wrap between words @li #ELM_WRAP_WORD - wrap between words

40
legacy/elementary/src/lib/elm_layout.eo
View File

@ -8,8 +8,8 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Set accessibility to all texblock(text) parts in the layout object Set accessibility to all texblock(text) parts in the layout object
@return @c true on success or @c false on failure. If @p obj is not @return $true on success or $false on failure. If $obj is not
a proper layout object, @c false is returned. a proper layout object, $false is returned.
@since 1.7 @since 1.7
@ -20,9 +20,9 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Get accessibility state of texblock(text) parts in the layout object Get accessibility state of texblock(text) parts in the layout object
@return @c true, if all textblock(text) parts in the layout can be accessible @return $true, if all textblock(text) parts in the layout can be accessible
@c EINA_FALSET if those cannot be accessible. If @p obj is not a proper layout $EINA_FALSET if those cannot be accessible. If $obj is not a proper layout
object, @c false is returned. object, $false is returned.
@see elm_layout_edje_object_access_set() @see elm_layout_edje_object_access_set()
@ -31,8 +31,8 @@ class Elm.Layout (Elm.Container, Efl.File)
@ingroup Layout */ @ingroup Layout */
} }
values { values {
can_access: bool; /*@ makes all textblock(text) parts in the layout @p obj possible can_access: bool; /*@ makes all textblock(text) parts in the layout $obj possible
to have accessibility. @c true means textblock(text) parts can be accessible */ to have accessibility. $true means textblock(text) parts can be accessible */
} }
} }
@property theme { @property theme {
@ -106,7 +106,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Remove all children of the given part box. Remove all children of the given part box.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
The objects will be removed from the box part and their lifetime will The objects will be removed from the box part and their lifetime will
not be handled by the layout anymore. This is equivalent to not be handled by the layout anymore. This is equivalent to
@ -289,7 +289,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Set the text of the given part Set the text of the given part
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@ingroup Layout */ @ingroup Layout */
@ -303,7 +303,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Get the text set in the given part Get the text set in the given part
@return The text set in @p part @return The text set in $part
@ingroup Layout */ @ingroup Layout */
return: const(char)*; return: const(char)*;
@ -362,7 +362,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Insert child to layout box part before a reference object. Insert child to layout box part before a reference object.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
Once the object is inserted, it will become child of the layout. Its Once the object is inserted, it will become child of the layout. Its
lifetime will be bound to the layout, whenever the layout dies the child lifetime will be bound to the layout, whenever the layout dies the child
@ -387,7 +387,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Insert child to layout box part at a given position. Insert child to layout box part at a given position.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
Once the object is inserted, it will become child of the layout. Its Once the object is inserted, it will become child of the layout. Its
lifetime will be bound to the layout, whenever the layout dies the child lifetime will be bound to the layout, whenever the layout dies the child
@ -447,7 +447,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Append child to layout box part. Append child to layout box part.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
Once the object is appended, it will become child of the layout. Its Once the object is appended, it will become child of the layout. Its
lifetime will be bound to the layout, whenever the layout dies the child lifetime will be bound to the layout, whenever the layout dies the child
@ -472,11 +472,11 @@ class Elm.Layout (Elm.Container, Efl.File)
Remove a signal-triggered callback from a given layout widget. Remove a signal-triggered callback from a given layout widget.
@return The data pointer of the signal callback (passed on @return The data pointer of the signal callback (passed on
elm_layout_signal_callback_add()) or @c NULL, on errors. elm_layout_signal_callback_add()) or $NULL, on errors.
This function removes the @b last callback attached to a signal This function removes the @b last callback attached to a signal
emitted by the undelying Edje object of @a obj, with parameters @a emitted by the undelying Edje object of @a obj, with parameters @a
emission, @a source and @c func matching exactly those passed to a emission, @a source and $func matching exactly those passed to a
previous call to elm_layout_signal_callback_add(). The data pointer previous call to elm_layout_signal_callback_add(). The data pointer
that was passed to this call will be returned. that was passed to this call will be returned.
@ -509,7 +509,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Prepend child to layout box part. Prepend child to layout box part.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
Once the object is prepended, it will become child of the layout. Its Once the object is prepended, it will become child of the layout. Its
lifetime will be bound to the layout, whenever the layout dies the child lifetime will be bound to the layout, whenever the layout dies the child
@ -549,14 +549,14 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Insert child to layout table part. Insert child to layout table part.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
Once the object is inserted, it will become child of the table. Its Once the object is inserted, it will become child of the table. Its
lifetime will be bound to the layout, and whenever the layout dies the lifetime will be bound to the layout, and whenever the layout dies the
child will be deleted automatically. One should use child will be deleted automatically. One should use
elm_layout_table_unpack() to make this layout forget about the object. elm_layout_table_unpack() to make this layout forget about the object.
If @p colspan or @p rowspan are bigger than 1, that object will occupy If $colspan or $rowspan are bigger than 1, that object will occupy
more space than a single cell. For instance, the following code: more space than a single cell. For instance, the following code:
@code @code
elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1); elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
@ -587,7 +587,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Unsets a cursor previously set with elm_layout_part_cursor_set(). Unsets a cursor previously set with elm_layout_part_cursor_set().
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@ingroup Layout */ @ingroup Layout */
@ -601,7 +601,7 @@ class Elm.Layout (Elm.Container, Efl.File)
/*@ /*@
Remove all the child objects of the given part table. Remove all the child objects of the given part table.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
The objects will be removed from the table part and their lifetime will The objects will be removed from the table part and their lifetime will
not be handled by the layout anymore. This is equivalent to not be handled by the layout anymore. This is equivalent to

66
legacy/elementary/src/lib/elm_list.eo
View File

@ -62,16 +62,16 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get a value whether horizontal mode is enabled or not. Get a value whether horizontal mode is enabled or not.
@return @c true means horizontal mode selection is enabled. @return $true means horizontal mode selection is enabled.
@c false indicates it's disabled. If @p obj is @c NULL, $false indicates it's disabled. If $obj is $NULL,
@c false is returned. $false is returned.
@see elm_list_horizontal_set() for details. @see elm_list_horizontal_set() for details.
@ingroup List */ @ingroup List */
} }
values { values {
horizontal: bool; /*@ @c true to enable horizontal or @c false to horizontal: bool; /*@ $true to enable horizontal or $false to
disable it, i.e., to enable vertical mode. */ disable it, i.e., to enable vertical mode. */
} }
} }
@ -156,14 +156,14 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
@see elm_list_multi_select_set() for details. @see elm_list_multi_select_set() for details.
@return @c true means multiple items selection is enabled. @return $true means multiple items selection is enabled.
@c false indicates it's disabled. If @p obj is @c NULL, $false indicates it's disabled. If $obj is $NULL,
@c false is returned. $false is returned.
@ingroup List */ @ingroup List */
} }
values { values {
multi: bool; /*@ @c true to enable multi selection or @c false to multi: bool; /*@ $true to enable multi selection or $false to
disable it. */ disable it. */
} }
} }
@ -261,8 +261,8 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Get a list of all the list items. Get a list of all the list items.
@return A @c list of list items, #Elm.Widget_Item, @return A $list of list items, #Elm.Widget_Item,
or @c NULL on failure. or $NULL on failure.
@see elm_list_item_append() @see elm_list_item_append()
@see elm_object_item_del() @see elm_object_item_del()
@ -290,8 +290,8 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Return a list of the currently selected list items. Return a list of the currently selected list items.
@return An @c list of list items, #Elm.Widget_Item, @return An $list of list items, #Elm.Widget_Item,
or @c NULL on failure. or $NULL on failure.
Multiple items can be selected if multi select is enabled. It can be Multiple items can be selected if multi select is enabled. It can be
done with elm_list_multi_select_set(). done with elm_list_multi_select_set().
@ -318,16 +318,16 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
} }
item_insert_before { item_insert_before {
/*@ /*@
Insert a new item into the list object before item @p before. Insert a new item into the list object before item $before.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and added to the list. Its position in A new item will be created and added to the list. Its position in
this list will be just before item @p before. this list will be just before item $before.
Items created with this method can be deleted with elm_object_item_del(). Items created with this method can be deleted with elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
@ -335,7 +335,7 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
If always select is enabled it will call this function every time If always select is enabled it will call this function every time
user clicks over an item (already selected or not). user clicks over an item (already selected or not).
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
@note Remember that the label parameter is copied inside the list. So if an @note Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the application dynamically allocated the label, the application should free the
@ -383,16 +383,16 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
} }
item_insert_after { item_insert_after {
/*@ /*@
Insert a new item into the list object after item @p after. Insert a new item into the list object after item $after.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and added to the list. Its position in A new item will be created and added to the list. Its position in
this list will be just after item @p after. this list will be just after item $after.
Items created with this method can be deleted with elm_object_item_del(). Items created with this method can be deleted with elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
@ -400,7 +400,7 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
If always select is enabled it will call this function every time If always select is enabled it will call this function every time
user clicks over an item (already selected or not). user clicks over an item (already selected or not).
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
@note Remember that the label parameter is copied inside the list. So if an @note Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the application dynamically allocated the label, the application should free the
@ -436,7 +436,7 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
This returns the item at the given coordinates (which are canvas This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate, relative, not object-relative). If an item is at that coordinate,
that item handle is returned, and if @p posret is not NULL, the that item handle is returned, and if $posret is not NULL, the
integer pointed to is set to a value of -1, 0 or 1, depending if integer pointed to is set to a value of -1, 0 or 1, depending if
the coordinate is on the upper portion of that item (-1), on the the coordinate is on the upper portion of that item (-1), on the
middle section (0) or on the lower part (1). If NULL is returned as middle section (0) or on the lower part (1). If NULL is returned as
@ -457,14 +457,14 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Append a new item to the list object. Append a new item to the list object.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and appended to the list, i.e., will A new item will be created and appended to the list, i.e., will
be set as @b last item. be set as @b last item.
Items created with this method can be deleted with elm_object_item_del(). Items created with this method can be deleted with elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
@ -472,7 +472,7 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
If always select is enabled it will call this function every time If always select is enabled it will call this function every time
user clicks over an item (already selected or not). user clicks over an item (already selected or not).
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
@note Remember that the label parameter is copied inside the list. So if an @note Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the application dynamically allocated the label, the application should free the
@ -513,14 +513,14 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Prepend a new item to the list object. Prepend a new item to the list object.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and prepended to the list, i.e., will A new item will be created and prepended to the list, i.e., will
be set as @b first item. be set as @b first item.
Items created with this method can be deleted with elm_object_item_del(). Items created with this method can be deleted with elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
@ -528,7 +528,7 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
If always select is enabled it will call this function every time If always select is enabled it will call this function every time
user clicks over an item (already selected or not). user clicks over an item (already selected or not).
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
@note Remember that the label parameter is copied inside the list. So if an @note Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the application dynamically allocated the label, the application should free the
@ -569,18 +569,18 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
/*@ /*@
Insert a new item into the sorted list object. Insert a new item into the sorted list object.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
@note This function inserts values into a list object assuming it was @note This function inserts values into a list object assuming it was
sorted and the result will be sorted. sorted and the result will be sorted.
A new item will be created and added to the list. Its position in A new item will be created and added to the list. Its position in
this list will be found comparing the new item with previously inserted this list will be found comparing the new item with previously inserted
items using function @p cmp_func. items using function $cmp_func.
Items created with this method can be deleted with elm_object_item_del(). Items created with this method can be deleted with elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
@ -588,7 +588,7 @@ class Elm.List (Elm.Layout, Elm_Interface_Scrollable,
If always select is enabled it will call this function every time If always select is enabled it will call this function every time
user clicks over an item (already selected or not). user clicks over an item (already selected or not).
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
@note Remember that the label parameter is copied inside the list. So if an @note Remember that the label parameter is copied inside the list. So if an
application dynamically allocated the label, the application should free the application dynamically allocated the label, the application should free the

58
legacy/elementary/src/lib/elm_map.eo
View File

@ -49,7 +49,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Pause or unpause the map. Pause or unpause the map.
This sets the paused state to on (@c true) or off (@c false) This sets the paused state to on ($true) or off ($false)
for map. for map.
The default is off. The default is off.
@ -65,7 +65,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Get a value whether map is paused or not. Get a value whether map is paused or not.
@return @c true means map is pause. @c false indicates @return $true means map is pause. $false indicates
it is not. it is not.
This gets the current paused state for the map object. This gets the current paused state for the map object.
@ -75,7 +75,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
@ingroup Map */ @ingroup Map */
} }
values { values {
paused: bool; /*@ Use @c true to pause the map @p obj or @c false paused: bool; /*@ Use $true to pause the map $obj or $false
to unpause it. */ to unpause it. */
} }
} }
@ -96,7 +96,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Get a value whether mouse wheel is enabled or not. Get a value whether mouse wheel is enabled or not.
@return @c true means map is disabled. @c false indicates @return $true means map is disabled. $false indicates
it is enabled. it is enabled.
Mouse wheel can be used for the user to zoom in or zoom out the map. Mouse wheel can be used for the user to zoom in or zoom out the map.
@ -106,7 +106,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
@ingroup Map */ @ingroup Map */
} }
values { values {
disabled: bool; /*@ Use @c true to disable mouse wheel or @c false disabled: bool; /*@ Use $true to disable mouse wheel or $false
to enable it. */ to enable it. */
} }
} }
@ -165,8 +165,8 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
User agent is a client application implementing a network protocol used User agent is a client application implementing a network protocol used
in communications within a clientserver distributed computing system in communications within a clientserver distributed computing system
The @p user_agent identification string will transmitted in a header The $user_agent identification string will transmitted in a header
field @c User-Agent. field $User-Agent.
@see elm_map_user_agent_get() @see elm_map_user_agent_get()
@ -273,7 +273,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Return all overlays in the map object. Return all overlays in the map object.
@return The list of all overlays or @c NULL upon failure. @return The list of all overlays or $NULL upon failure.
This list includes group overlays also. This list includes group overlays also.
So this can be changed dynamically while zooming and panning. So this can be changed dynamically while zooming and panning.
@ -316,7 +316,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
This web service can be set with this method This web service can be set with this method
for #ELM_MAP_SOURCE_TYPE_NAME type. for #ELM_MAP_SOURCE_TYPE_NAME type.
The @p source_name need to match one of the names provided by The $source_name need to match one of the names provided by
elm_map_sources_get(). elm_map_sources_get().
The current source can be get using elm_map_source_get(). The current source can be get using elm_map_source_get().
@ -350,19 +350,19 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Add a new route to the map object. Add a new route to the map object.
@return The created route or @c NULL upon failure. @return The created route or $NULL upon failure.
A route will be traced by point on coordinates (@p flat, @p flon) A route will be traced by point on coordinates ($flat, $flon)
to point on coordinates (@p tlat, @p tlon), using the route service to point on coordinates ($tlat, $tlon), using the route service
set with elm_map_source_set(). set with elm_map_source_set().
It will take @p type on consideration to define the route, It will take $type on consideration to define the route,
depending if the user will be walking or driving, the route may vary. depending if the user will be walking or driving, the route may vary.
One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE,
or #ELM_MAP_ROUTE_TYPE_FOOT need to be used. or #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
Another parameter is what the route should prioritize, the minor distance Another parameter is what the route should prioritize, the minor distance
or the less time to be spend on the route. So @p method should be one or the less time to be spend on the route. So $method should be one
of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST. of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
Routes created with this method can be deleted with Routes created with this method can be deleted with
@ -425,7 +425,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new circle overlay to the map object. Add a new circle overlay to the map object.
This overlay has a circle type. This overlay has a circle type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
Overlay created with this method can be deleted with elm_map_overlay_del(). Overlay created with this method can be deleted with elm_map_overlay_del().
@ -445,7 +445,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new class overlay to the map object. Add a new class overlay to the map object.
This overlay has a class type. This overlay has a class type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
This overlay is not shown before overlay members are appended. This overlay is not shown before overlay members are appended.
if overlay members in the same class are close, group overlays if overlay members in the same class are close, group overlays
@ -472,7 +472,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new bubble overlay to the map object. Add a new bubble overlay to the map object.
This overlay has a bubble type. This overlay has a bubble type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
A bubble will not be displayed before geographic coordinates are set or A bubble will not be displayed before geographic coordinates are set or
any other overlays are followed. any other overlays are followed.
@ -528,7 +528,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new polygon overlay to the map object. Add a new polygon overlay to the map object.
This overlay has a polygon type. This overlay has a polygon type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
At least 3 regions should be added to show the polygon overlay. At least 3 regions should be added to show the polygon overlay.
@ -546,7 +546,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new line overlay to the map object. Add a new line overlay to the map object.
This overlay has a line type. This overlay has a line type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
Overlay created with this method can be deleted with elm_map_overlay_del(). Overlay created with this method can be deleted with elm_map_overlay_del().
@ -567,7 +567,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Show the given coordinates at the center of the map, @b immediately. Show the given coordinates at the center of the map, @b immediately.
This causes map to @b redraw its viewport's contents to the This causes map to @b redraw its viewport's contents to the
region containing the given @p lat and @p lon, that will be moved to the region containing the given $lat and $lon, that will be moved to the
center of the map. center of the map.
@see elm_map_region_bring_in() for a function to move with animation. @see elm_map_region_bring_in() for a function to move with animation.
@ -587,9 +587,9 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
@return name A #Elm_Map_Name handle for this coordinate. @return name A #Elm_Map_Name handle for this coordinate.
If you want to get address from geographic coordinates, set input @p address If you want to get address from geographic coordinates, set input $address
as @c NULL and set @p lon, @p lat as you want to convert. as $NULL and set $lon, $lat as you want to convert.
If address is set except NULL, @p lon and @p lat are checked. If address is set except NULL, $lon and $lat are checked.
To get the string for this address, elm_map_name_address_get() To get the string for this address, elm_map_name_address_get()
should be used after callback or "name,loaded" signal is called. should be used after callback or "name,loaded" signal is called.
@ -627,7 +627,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Animatedly bring in given coordinates to the center of the map. Animatedly bring in given coordinates to the center of the map.
This causes map to jump to the given @p lat and @p lon coordinates This causes map to jump to the given $lat and $lon coordinates
and show it (by scrolling) in the center of the viewport, if it is not and show it (by scrolling) in the center of the viewport, if it is not
already centered. This will use animation to do so and take a period already centered. This will use animation to do so and take a period
of time to complete. of time to complete.
@ -648,7 +648,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
to the center of the map. to the center of the map.
This causes map to zoom into specific zoom level and also move to the This causes map to zoom into specific zoom level and also move to the
given @p lat and @p lon coordinates and show it (by scrolling) in the given $lat and $lon coordinates and show it (by scrolling) in the
center of the viewport concurrently. center of the viewport concurrently.
@since 1.11 @since 1.11
@ -679,7 +679,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new route overlay to the map object. Add a new route overlay to the map object.
This overlay has a route type. This overlay has a route type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
This overlay has a route style layout and icon or content can not This overlay has a route style layout and icon or content can not
be set. be set.
@ -705,7 +705,7 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
Add a new scale overlay to the map object. Add a new scale overlay to the map object.
This overlay has a scale type. This overlay has a scale type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
The scale overlay shows the ratio of a distance on the map to the corresponding distance. The scale overlay shows the ratio of a distance on the map to the corresponding distance.
@ -725,10 +725,10 @@ class Elm.Map (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Add a new overlay to the map object. This overlay has a default type. Add a new overlay to the map object. This overlay has a default type.
@return The created overlay or @c NULL upon failure. @return The created overlay or $NULL upon failure.
A overlay will be created and shown in a specific point of the map, defined A overlay will be created and shown in a specific point of the map, defined
by @p lon and @p lat. by $lon and $lat.
The created overlay has a default style layout before content or The created overlay has a default style layout before content or
icon is set. icon is set.

16
legacy/elementary/src/lib/elm_multibuttonentry.eo
View File

@ -15,14 +15,14 @@ class Elm.Multibuttonentry (Elm.Layout)
/*@ /*@
Get whether the multibuttonentry is editable or not. Get whether the multibuttonentry is editable or not.
@return @c true if the multibuttonentry is editable by the user. @c false if not. @return $true if the multibuttonentry is editable by the user. $false if not.
@ingroup Multibuttonentry @ingroup Multibuttonentry
@since 1.7 */ @since 1.7 */
} }
values { values {
editable: bool; /*@ If @c true, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable. */ editable: bool; /*@ If $true, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable. */
} }
} }
@property expanded { @property expanded {
@ -40,13 +40,13 @@ class Elm.Multibuttonentry (Elm.Layout)
In expanded state, the complete entry will be displayed. In expanded state, the complete entry will be displayed.
Otherwise, only single line of the entry will be displayed. Otherwise, only single line of the entry will be displayed.
@return @c true if the widget is in expanded state. @c false if not. @return $true if the widget is in expanded state. $false if not.
@ingroup Multibuttonentry */ @ingroup Multibuttonentry */
} }
values { values {
expanded: bool; /*@ the value of expanded state. expanded: bool; /*@ the value of expanded state.
Set this to @c true for expanded state. Set this to $true for expanded state.
Set this to false for single line state. */ Set this to false for single line state. */
} }
} }
@ -56,8 +56,8 @@ class Elm.Multibuttonentry (Elm.Layout)
Set a function to format the string that will be used to display Set a function to format the string that will be used to display
the hidden items counter. the hidden items counter.
If @a format_function is @c NULL, the default format will be used, If @a format_function is $NULL, the default format will be used,
which is @c "... + %d". which is $"... + %d".
@see elm_multibuttonentry_format_function_set @see elm_multibuttonentry_format_function_set
@since 1.9 @since 1.9
@ -209,7 +209,7 @@ class Elm.Multibuttonentry (Elm.Layout)
params { params {
@in func: Elm_Multibuttonentry_Item_Filter_Cb; /*@ The function to use as text filter */ @in func: Elm_Multibuttonentry_Item_Filter_Cb; /*@ The function to use as text filter */
@in data: void *; /*@ User data to pass to @p func */ @in data: void *; /*@ User data to pass to $func */
} }
} }
item_filter_append { item_filter_append {
@ -228,7 +228,7 @@ class Elm.Multibuttonentry (Elm.Layout)
params { params {
@in func: Elm_Multibuttonentry_Item_Filter_Cb; /*@ The function to use as item filter */ @in func: Elm_Multibuttonentry_Item_Filter_Cb; /*@ The function to use as item filter */
@in data: void *; /*@ User data to pass to @p func */ @in data: void *; /*@ User data to pass to $func */
} }
} }
item_insert_after { item_insert_after {

46
legacy/elementary/src/lib/elm_naviframe.eo
View File

@ -7,7 +7,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Set the event enabled when pushing/popping items @brief Set the event enabled when pushing/popping items
If @p enabled is @c true, the contents of the naviframe item will If $enabled is $true, the contents of the naviframe item will
receives events from mouse and keyboard during view changing such as receives events from mouse and keyboard during view changing such as
item push/pop. item push/pop.
@ -23,14 +23,14 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Get the value of event enabled status. @brief Get the value of event enabled status.
@return @c true, when event is enabled @return $true, when event is enabled
@see elm_naviframe_event_enabled_set() @see elm_naviframe_event_enabled_set()
@ingroup Naviframe */ @ingroup Naviframe */
} }
values { values {
enabled: bool; /*@ Events are received when enabled is @c true, and enabled: bool; /*@ Events are received when enabled is $true, and
ignored otherwise. */ ignored otherwise. */
} }
} }
@ -47,14 +47,14 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Get a value whether preserve mode is enabled or not. @brief Get a value whether preserve mode is enabled or not.
@return If @c true, preserve mode is enabled @return If $true, preserve mode is enabled
@see also elm_naviframe_content_preserve_on_pop_set() @see also elm_naviframe_content_preserve_on_pop_set()
@ingroup Naviframe */ @ingroup Naviframe */
} }
values { values {
preserve: bool; /*@ Enable the preserve mode if @c true, disable otherwise */ preserve: bool; /*@ Enable the preserve mode if $true, disable otherwise */
} }
} }
@property prev_btn_auto_pushed { @property prev_btn_auto_pushed {
@ -71,7 +71,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@brief Get a value whether prev button(back button) will be auto pushed or @brief Get a value whether prev button(back button) will be auto pushed or
not. not.
@return If @c true, prev button will be auto pushed. @return If $true, prev button will be auto pushed.
@see also elm_naviframe_item_push() @see also elm_naviframe_item_push()
elm_naviframe_prev_btn_auto_pushed_set() elm_naviframe_prev_btn_auto_pushed_set()
@ -79,8 +79,8 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@ingroup Naviframe */ @ingroup Naviframe */
} }
values { values {
auto_pushed: bool; /*@ If @c true, the previous button(back button) will auto_pushed: bool; /*@ If $true, the previous button(back button) will
be created internally when you pass the @c NULL to the prev_btn be created internally when you pass the $NULL to the prev_btn
parameter in elm_naviframe_item_push */ parameter in elm_naviframe_item_push */
} }
} }
@ -90,7 +90,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@brief Get a list of all the naviframe items. @brief Get a list of all the naviframe items.
@return A list of naviframe items, #Elm.Widget_Item, @return A list of naviframe items, #Elm.Widget_Item,
or @c NULL on failure. or $NULL on failure.
@note The returned list MUST be freed. @note The returned list MUST be freed.
@ingroup Naviframe */ @ingroup Naviframe */
@ -102,7 +102,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Get a top item on the naviframe stack @brief Get a top item on the naviframe stack
@return The top item on the naviframe stack or @c NULL, if the stack is @return The top item on the naviframe stack or $NULL, if the stack is
empty empty
@ingroup Naviframe */ @ingroup Naviframe */
@ -114,7 +114,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Get a bottom item on the naviframe stack @brief Get a bottom item on the naviframe stack
@return The bottom item on the naviframe stack or @c NULL, if the stack is @return The bottom item on the naviframe stack or $NULL, if the stack is
empty empty
@ingroup Naviframe */ @ingroup Naviframe */
@ -125,7 +125,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Pop an item that is on top of the stack @brief Pop an item that is on top of the stack
@return @c NULL or the content object(if the @return $NULL or the content object(if the
elm_naviframe_content_preserve_on_pop_get is true). elm_naviframe_content_preserve_on_pop_get is true).
This pops an item that is on the top(visible) of the naviframe, makes it This pops an item that is on the top(visible) of the naviframe, makes it
@ -141,9 +141,9 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
} }
item_insert_before { item_insert_before {
/*@ /*@
@brief Insert a new item into the naviframe before item @p before. @brief Insert a new item into the naviframe before item $before.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
The item is inserted into the naviframe straight away without any The item is inserted into the naviframe straight away without any
transition operations. This item will be deleted when it is popped. transition operations. This item will be deleted when it is popped.
@ -153,7 +153,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@see also elm_naviframe_item_insert_after() @see also elm_naviframe_item_insert_after()
The following styles are available for this item: The following styles are available for this item:
@li @c "default" @li $"default"
@ingroup Naviframe */ @ingroup Naviframe */
@ -170,14 +170,14 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
"elm.swallow.next_btn" */ "elm.swallow.next_btn" */
@in content: Evas.Object *; /*@ The main content object. The name of content part is @in content: Evas.Object *; /*@ The main content object. The name of content part is
"elm.swallow.content" */ "elm.swallow.content" */
@in item_style: const(char)* @nullable; /*@ The current item style name. @c NULL would be default. */ @in item_style: const(char)* @nullable; /*@ The current item style name. $NULL would be default. */
} }
} }
item_push { item_push {
/*@ /*@
@brief Push a new item to the top of the naviframe stack (and show it). @brief Push a new item to the top of the naviframe stack (and show it).
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
The item pushed becomes one page of the naviframe, this item will be The item pushed becomes one page of the naviframe, this item will be
deleted when it is popped. deleted when it is popped.
@ -187,7 +187,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@see also elm_naviframe_item_insert_after() @see also elm_naviframe_item_insert_after()
The following styles are available for this item: The following styles are available for this item:
@li @c "default" @li $"default"
@ingroup Naviframe */ @ingroup Naviframe */
@ -203,7 +203,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
"elm.swallow.next_btn" */ "elm.swallow.next_btn" */
@in content: Evas.Object *; /*@ The main content object. The name of content part is @in content: Evas.Object *; /*@ The main content object. The name of content part is
"elm.swallow.content" */ "elm.swallow.content" */
@in item_style: const(char)* @nullable; /*@ The current item style name. @c NULL would be default. */ @in item_style: const(char)* @nullable; /*@ The current item style name. $NULL would be default. */
} }
} }
item_simple_promote { item_simple_promote {
@ -218,9 +218,9 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
} }
item_insert_after { item_insert_after {
/*@ /*@
@brief Insert a new item into the naviframe after item @p after. @brief Insert a new item into the naviframe after item $after.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
The item is inserted into the naviframe straight away without any The item is inserted into the naviframe straight away without any
transition operations. This item will be deleted when it is popped. transition operations. This item will be deleted when it is popped.
@ -230,7 +230,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@see also elm_naviframe_item_insert_before() @see also elm_naviframe_item_insert_before()
The following styles are available for this item: The following styles are available for this item:
@li @c "default" @li $"default"
@ingroup Naviframe */ @ingroup Naviframe */
@ -247,7 +247,7 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
"elm.swallow.next_btn" */ "elm.swallow.next_btn" */
@in content: Evas.Object *; /*@ The main content object. The name of content part is @in content: Evas.Object *; /*@ The main content object. The name of content part is
"elm.swallow.content" */ "elm.swallow.content" */
@in item_style: const(char)* @nullable; /*@ The current item style name. @c NULL would be default. */ @in item_style: const(char)* @nullable; /*@ The current item style name. $NULL would be default. */
} }
} }
} }

8
legacy/elementary/src/lib/elm_popup.eo
View File

@ -67,14 +67,14 @@ class Elm.Popup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
@brief Returns value indicating whether allow event is enabled or not @brief Returns value indicating whether allow event is enabled or not
@return @c false if Blocked event area is present else @c true @return $false if Blocked event area is present else $true
@ingroup Popup @ingroup Popup
@see elm_popup_allow_events_set() @see elm_popup_allow_events_set()
@note By default the Blocked event area is present */ @note By default the Blocked event area is present */
} }
values { values {
allow: bool; /*@ @c true Events are passed to lower objects, else not */ allow: bool; /*@ $true Events are passed to lower objects, else not */
} }
} }
@property content_text_wrap_type { @property content_text_wrap_type {
@ -163,7 +163,7 @@ class Elm.Popup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
Both an item list and a content could not be set at the same time! Both an item list and a content could not be set at the same time!
once you add an item, the previous content will be removed. once you add an item, the previous content will be removed.
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
@ingroup Popup @ingroup Popup
@warning When the first item is appended to popup object, any previous content @warning When the first item is appended to popup object, any previous content
@ -175,7 +175,7 @@ class Elm.Popup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@in label: const(char)*; /*@ The Label of the new item */ @in label: const(char)*; /*@ The Label of the new item */
@in icon: Evas.Object * @optional; /*@ Icon to be set on new item */ @in icon: Evas.Object * @optional; /*@ Icon to be set on new item */
@in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */ @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */
@in data: const(void)* @optional; /*@ Data passed to @p func above */ @in data: const(void)* @optional; /*@ Data passed to $func above */
} }
} }
} }

38
legacy/elementary/src/lib/elm_prefs.eo
View File

@ -7,7 +7,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
/*@ /*@
Set user data for a given prefs widget Set user data for a given prefs widget
@return @c true, on success, @c false otherwise @return $true, on success, $false otherwise
Once a prefs widget is created, after elm_prefs_file_set() is Once a prefs widget is created, after elm_prefs_file_set() is
issued on it, all of its UI elements will get default values, when issued on it, all of its UI elements will get default values, when
@ -41,7 +41,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Get user data for a given prefs widget Get user data for a given prefs widget
@return A pointer to the user data of a given prefs widget on success. @return A pointer to the user data of a given prefs widget on success.
@c NULL otherwise. $NULL otherwise.
@see elm_prefs_data_set() for more details @see elm_prefs_data_set() for more details
@ -58,7 +58,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
the user data file, if set) automatically on every UI element the user data file, if set) automatically on every UI element
changes. changes.
If @a autosave is @c true, every call to If @a autosave is $true, every call to
elm_prefs_item_value_set(), every elm_prefs_item_value_set(), every
Elm_Prefs_Data_Event_Type.ELM_PREFS_DATA_EVENT_ITEM_CHANGED event Elm_Prefs_Data_Event_Type.ELM_PREFS_DATA_EVENT_ITEM_CHANGED event
coming for its prefs data and every UI element direct value coming for its prefs data and every UI element direct value
@ -76,15 +76,15 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Get whether a given prefs widget is saving its values back Get whether a given prefs widget is saving its values back
automatically on changes. automatically on changes.
@return @c true if @a prefs is saving automatically, @return $true if @a prefs is saving automatically,
@c false otherwise. $false otherwise.
@see elm_prefs_autosave_set(), for more details @see elm_prefs_autosave_set(), for more details
@since 1.8 */ @since 1.8 */
} }
values { values {
autosave: bool; /*@ @c true to save automatically, @c false autosave: bool; /*@ $true to save automatically, $false
otherwise. */ otherwise. */
} }
} }
@ -94,7 +94,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
As can be seen on #Elm_Prefs_Reset_Mode, there are two possible As can be seen on #Elm_Prefs_Reset_Mode, there are two possible
actions to be taken by this call -- either to reset @a prefs' actions to be taken by this call -- either to reset @a prefs'
values to the defaults (declared on the @c .epb file it is bound values to the defaults (declared on the $.epb file it is bound
to) or to reset to the state they were before the last modification to) or to reset to the state they were before the last modification
it got. it got.
@ -108,7 +108,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
/*@ /*@
Set the value on a given prefs widget's item. Set the value on a given prefs widget's item.
@return @c true, on success, @c false otherwise @return $true, on success, $false otherwise
This will change the value of item named @a name programatically. This will change the value of item named @a name programatically.
@ -129,7 +129,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
/*@ /*@
Get the value of a given prefs widget's item. Get the value of a given prefs widget's item.
@return @c true, on success, @c false otherwise @return $true, on success, $false otherwise
This will retrieve the value of item named @a name. This will retrieve the value of item named @a name.
@ -150,7 +150,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Get the Elementary widget bound to a given prefs widget's Get the Elementary widget bound to a given prefs widget's
item. item.
@return A valid widget handle, on success, or @c NULL, otherwise @return A valid widget handle, on success, or $NULL, otherwise
This will retrieve a handle to the real widget implementing a given This will retrieve a handle to the real widget implementing a given
item of @a prefs, <b>for read-only</b> actions. item of @a prefs, <b>for read-only</b> actions.
@ -180,7 +180,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
params { params {
@in name: const(char)*; /*@ The name of the item (as declared in the prefs @in name: const(char)*; /*@ The name of the item (as declared in the prefs
collection) to act on */ collection) to act on */
@in disabled: bool; /*@ @c true, to make it disabled, @c false @in disabled: bool; /*@ $true, to make it disabled, $false
otherwise */ otherwise */
} }
} }
@ -189,7 +189,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Get whether the widget bound to a given prefs widget's item is Get whether the widget bound to a given prefs widget's item is
disabled or not. disabled or not.
@return @c true, if it is disabled, @c false @return $true, if it is disabled, $false
otherwise otherwise
@see elm_prefs_item_disabled_set() @see elm_prefs_item_disabled_set()
@ -205,7 +205,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
/*@ /*@
"Swallows" an object into a SWALLOW item of a prefs widget. "Swallows" an object into a SWALLOW item of a prefs widget.
@return @c true, on success, @c false otherwise @return $true, on success, $false otherwise
@see elm_prefs_item_swallow() for more details @see elm_prefs_item_swallow() for more details
@ -223,7 +223,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Set whether the widget bound to a given prefs widget's item is Set whether the widget bound to a given prefs widget's item is
editable or not. editable or not.
@note Only @c TEXT or @c TEXTAREA items' default widgets implement @note Only $TEXT or $TEXTAREA items' default widgets implement
the 'editable' property. Custom registered widgets may as well the 'editable' property. Custom registered widgets may as well
implement them. implement them.
@ -234,7 +234,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
params { params {
@in name: const(char)*; /*@ The name of the item (as declared in the prefs @in name: const(char)*; /*@ The name of the item (as declared in the prefs
collection) to act on */ collection) to act on */
@in editable: bool; /*@ @c true, to make it editable, @c false @in editable: bool; /*@ $true, to make it editable, $false
otherwise */ otherwise */
} }
} }
@ -243,7 +243,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Get whether the widget bound to a given prefs widget's item is Get whether the widget bound to a given prefs widget's item is
editable or not. editable or not.
@return @c true, if it is editable, @c false @return $true, if it is editable, $false
otherwise otherwise
@see elm_prefs_item_editable_set() for more details @see elm_prefs_item_editable_set() for more details
@ -277,7 +277,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
visible or not. visible or not.
Each prefs item may have a default visibility state, declared on Each prefs item may have a default visibility state, declared on
the @c .epb @a prefs it was loaded with. By this call one may alter the $.epb @a prefs it was loaded with. By this call one may alter
that state, programatically. that state, programatically.
@see elm_prefs_item_visible_get() @see elm_prefs_item_visible_get()
@ -287,7 +287,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
params { params {
@in name: const(char)*; /*@ The name of the item (as declared in the prefs @in name: const(char)*; /*@ The name of the item (as declared in the prefs
collection) to change visibility of */ collection) to change visibility of */
@in visible: bool; /*@ @c true, to make it visible, @c false @in visible: bool; /*@ $true, to make it visible, $false
otherwise */ otherwise */
} }
} }
@ -296,7 +296,7 @@ class Elm.Prefs (Elm.Widget, Efl.File)
Get whether the widget bound to a given prefs widget's item is Get whether the widget bound to a given prefs widget's item is
visible or not. visible or not.
@return @c true, if it is visible, @c false @return $true, if it is visible, $false
otherwise otherwise
@see elm_prefs_item_visible_set() for more details @see elm_prefs_item_visible_set() for more details

50
legacy/elementary/src/lib/elm_progressbar.eo
View File

@ -10,13 +10,13 @@ class Elm.Progressbar (Elm.Layout)
This sets the minimum width (when in horizontal mode) or height This sets the minimum width (when in horizontal mode) or height
(when in vertical mode) of the actual bar area of the progress (when in vertical mode) of the actual bar area of the progress
bar @p obj. This in turn affects the object's minimum size. Use bar $obj. This in turn affects the object's minimum size. Use
this when you're not setting other size hints expanding on the this when you're not setting other size hints expanding on the
given direction (like weight and alignment hints) and you would given direction (like weight and alignment hints) and you would
like it to have a specific size. like it to have a specific size.
@note Icon, label and unit text around @p obj will require their @note Icon, label and unit text around $obj will require their
own space, which will make @p obj to require more the @p size, own space, which will make $obj to require more the $size,
actually. actually.
@see elm_progressbar_span_size_get() @see elm_progressbar_span_size_get()
@ -31,7 +31,7 @@ class Elm.Progressbar (Elm.Layout)
@return The length of the progress bar's bar region @return The length of the progress bar's bar region
If that size was not set previously, with If that size was not set previously, with
elm_progressbar_span_size_set(), this call will return @c 0. elm_progressbar_span_size_set(), this call will return $0.
@ingroup Progressbar */ @ingroup Progressbar */
} }
@ -65,14 +65,14 @@ class Elm.Progressbar (Elm.Layout)
Get whether a given progress bar widget is at "pulsing mode" or Get whether a given progress bar widget is at "pulsing mode" or
not. not.
@return @c true, if @p obj is in pulsing mode, @c false @return $true, if $obj is in pulsing mode, $false
if it's in the default one (and on errors) if it's in the default one (and on errors)
@ingroup Progressbar */ @ingroup Progressbar */
} }
values { values {
pulse: bool; /*@ @c true to put @p obj in pulsing mode, pulse: bool; /*@ $true to put $obj in pulsing mode,
@c false to put it back to its default one */ $false to put it back to its default one */
} }
} }
@property value { @property value {
@ -101,7 +101,7 @@ class Elm.Progressbar (Elm.Layout)
@ingroup Progressbar */ @ingroup Progressbar */
} }
values { values {
val: double; /*@ The progress value (@b must be between @c 0.0 and @c val: double; /*@ The progress value (@b must be between $0.0 and @c
1.0) */ 1.0) */
} }
} }
@ -125,16 +125,16 @@ class Elm.Progressbar (Elm.Layout)
Get whether a given progress bar widget's displaying values are Get whether a given progress bar widget's displaying values are
inverted or not inverted or not
@return @c true, if @p obj has inverted values, @return $true, if $obj has inverted values,
@c false otherwise (and on errors) $false otherwise (and on errors)
@see elm_progressbar_inverted_set() for more details @see elm_progressbar_inverted_set() for more details
@ingroup Progressbar */ @ingroup Progressbar */
} }
values { values {
inverted: bool; /*@ Use @c true to make @p obj inverted, inverted: bool; /*@ Use $true to make $obj inverted,
@c false to bring it back to default, non-inverted values. */ $false to bring it back to default, non-inverted values. */
} }
} }
@property horizontal { @property horizontal {
@ -153,16 +153,16 @@ class Elm.Progressbar (Elm.Layout)
/*@ /*@
Get the orientation of a given progress bar widget Get the orientation of a given progress bar widget
@return @c true, if @p obj is set to be @b horizontal, @return $true, if $obj is set to be @b horizontal,
@c false if it's @b vertical (and on errors) $false if it's @b vertical (and on errors)
@see elm_progressbar_horizontal_set() for more details @see elm_progressbar_horizontal_set() for more details
@ingroup Progressbar */ @ingroup Progressbar */
} }
values { values {
horizontal: bool; /*@ Use @c true to make @p obj to be horizontal: bool; /*@ Use $true to make $obj to be
@b horizontal, @c false to make it @b vertical */ @b horizontal, $false to make it @b vertical */
} }
} }
@property unit_format { @property unit_format {
@ -171,7 +171,7 @@ class Elm.Progressbar (Elm.Layout)
Set the format string for a given progress bar widget's units Set the format string for a given progress bar widget's units
label label
If @c NULL is passed on @p format, it will make @p obj's units If $NULL is passed on $format, it will make $obj's units
area to be hidden completely. If not, it'll set the <b>format area to be hidden completely. If not, it'll set the <b>format
string</b> for the units label's @b text. The units label is string</b> for the units label's @b text. The units label is
provided a floating point value, so the units text is up display provided a floating point value, so the units text is up display
@ -180,7 +180,7 @@ class Elm.Progressbar (Elm.Layout)
example. example.
@note The default format string for a progress bar is an integer @note The default format string for a progress bar is an integer
percentage, as in @c "%.0f %%". percentage, as in $"%.0f %%".
@see elm_progressbar_unit_format_get() @see elm_progressbar_unit_format_get()
@ -191,15 +191,15 @@ class Elm.Progressbar (Elm.Layout)
Get the format string set for a given progress bar widget's Get the format string set for a given progress bar widget's
units label units label
@return The format set string for @p obj's units label or @return The format set string for $obj's units label or
@c NULL, if none was set (and on errors) $NULL, if none was set (and on errors)
@see elm_progressbar_unit_format_set() for more details @see elm_progressbar_unit_format_set() for more details
@ingroup Progressbar */ @ingroup Progressbar */
} }
values { values {
units: const(char)* @nullable; /*@ The format string for @p obj's units label */ units: const(char)* @nullable; /*@ The format string for $obj's units label */
} }
} }
@property unit_format_function { @property unit_format_function {
@ -233,7 +233,7 @@ class Elm.Progressbar (Elm.Layout)
params { params {
@in part: const(char)*; /*@ The partname to which val have to set */ @in part: const(char)*; /*@ The partname to which val have to set */
@in val: double; /*@ The progress value (@b must be between @c 0.0 and @c @in val: double; /*@ The progress value (@b must be between $0.0 and @c
1.0) */ 1.0) */
} }
} }
@ -259,15 +259,15 @@ class Elm.Progressbar (Elm.Layout)
Start/stop a given progress bar "pulsing" animation, if its Start/stop a given progress bar "pulsing" animation, if its
under that mode under that mode
@note This call won't do anything if @p obj is not under "pulsing mode". @note This call won't do anything if $obj is not under "pulsing mode".
@see elm_progressbar_pulse_set() for more details. @see elm_progressbar_pulse_set() for more details.
@ingroup Progressbar */ @ingroup Progressbar */
params { params {
@in state: bool; /*@ @c true, to @b start the pulsing animation, @in state: bool; /*@ $true, to @b start the pulsing animation,
@c false to @b stop it */ $false to @b stop it */
} }
} }
} }

26
legacy/elementary/src/lib/elm_segment_control.eo
View File

@ -9,7 +9,7 @@ class Elm.Segment_Control (Elm.Layout)
@return Segment items count. @return Segment items count.
It will just return the number of items added to segment control @p obj. It will just return the number of items added to segment control $obj.
@ingroup SegmentControl */ @ingroup SegmentControl */
return: int; return: int;
@ -20,7 +20,7 @@ class Elm.Segment_Control (Elm.Layout)
/*@ /*@
Get the selected item. Get the selected item.
@return The selected item or @c NULL if none of segment items is @return The selected item or $NULL if none of segment items is
selected. selected.
The selected item can be unselected with function The selected item can be unselected with function
@ -36,12 +36,12 @@ class Elm.Segment_Control (Elm.Layout)
/*@ /*@
Get the label of item. Get the label of item.
@return The label of the item at @p index. @return The label of the item at $index.
The return value is a pointer to the label associated to the item when The return value is a pointer to the label associated to the item when
it was created, with function elm_segment_control_item_add(), or later it was created, with function elm_segment_control_item_add(), or later
with function elm_object_item_text_set. If no label with function elm_object_item_text_set. If no label
was passed as argument, it will return @c NULL. was passed as argument, it will return $NULL.
@see elm_object_item_text_set() for more details. @see elm_object_item_text_set() for more details.
@see elm_segment_control_item_add() @see elm_segment_control_item_add()
@ -56,9 +56,9 @@ class Elm.Segment_Control (Elm.Layout)
/*@ /*@
Insert a new item to the segment control object at specified position. Insert a new item to the segment control object at specified position.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
Index values must be between @c 0, when item will be prepended to Index values must be between $0, when item will be prepended to
segment control, and items count, that can be get with segment control, and items count, that can be get with
elm_segment_control_item_count_get(), case when item will be appended elm_segment_control_item_count_get(), case when item will be appended
to segment control, just like elm_segment_control_item_add(). to segment control, just like elm_segment_control_item_add().
@ -66,7 +66,7 @@ class Elm.Segment_Control (Elm.Layout)
Items created with this function can be deleted with function Items created with this function can be deleted with function
elm_object_item_del() or elm_segment_control_item_del_at(). elm_object_item_del() or elm_segment_control_item_del_at().
@note @p label set to @c NULL is different from empty string "". @note $label set to $NULL is different from empty string "".
If an item If an item
only has icon, it will be displayed bigger and centered. If it has only has icon, it will be displayed bigger and centered. If it has
icon and label, even that an empty string, icon will be smaller and icon and label, even that an empty string, icon will be smaller and
@ -91,10 +91,10 @@ class Elm.Segment_Control (Elm.Layout)
/*@ /*@
Get the item placed at specified index. Get the item placed at specified index.
@return The segment control item or @c NULL on failure. @return The segment control item or $NULL on failure.
Index is the position of an item in segment control widget. Its Index is the position of an item in segment control widget. Its
range is from @c 0 to <tt> count - 1 </tt>. range is from $0 to <tt> count - 1 </tt>.
Count is the number of items, that can be get with Count is the number of items, that can be get with
elm_segment_control_item_count_get(). elm_segment_control_item_count_get().
@ -122,7 +122,7 @@ class Elm.Segment_Control (Elm.Layout)
/*@ /*@
Append a new item to the segment control object. Append a new item to the segment control object.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and appended to the segment control, i.e., will A new item will be created and appended to the segment control, i.e., will
be set as @b last item. be set as @b last item.
@ -133,7 +133,7 @@ class Elm.Segment_Control (Elm.Layout)
Items created with this function can be deleted with function Items created with this function can be deleted with function
elm_object_item_del() or elm_object_item_del_at(). elm_object_item_del() or elm_object_item_del_at().
@note @p label set to @c NULL is different from empty string "". @note $label set to $NULL is different from empty string "".
If an item If an item
only has icon, it will be displayed bigger and centered. If it has only has icon, it will be displayed bigger and centered. If it has
icon and label, even that an empty string, icon will be smaller and icon and label, even that an empty string, icon will be smaller and
@ -167,12 +167,12 @@ class Elm.Segment_Control (Elm.Layout)
/*@ /*@
Get the icon associated to the item. Get the icon associated to the item.
@return The left side icon associated to the item at @p index. @return The left side icon associated to the item at $index.
The return value is a pointer to the icon associated to the item when The return value is a pointer to the icon associated to the item when
it was created, with function elm_segment_control_item_add(), or later it was created, with function elm_segment_control_item_add(), or later
with function elm_object_item_part_content_set(). If no icon with function elm_object_item_part_content_set(). If no icon
was passed as argument, it will return @c NULL. was passed as argument, it will return $NULL.
@see elm_segment_control_item_add() @see elm_segment_control_item_add()
@see elm_object_item_part_content_set() @see elm_object_item_part_content_set()

44
legacy/elementary/src/lib/elm_slider.eo
View File

@ -21,16 +21,16 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
/*@ /*@
Get the orientation of a given slider widget Get the orientation of a given slider widget
@return @c true, if @p obj is set to be @b horizontal, @return $true, if $obj is set to be @b horizontal,
@c false if it's @b vertical (and on errors). $false if it's @b vertical (and on errors).
@see elm_slider_horizontal_set() for more details. @see elm_slider_horizontal_set() for more details.
@ingroup Slider */ @ingroup Slider */
} }
values { values {
horizontal: bool; /*@ Use @c true to make @p obj to be horizontal: bool; /*@ Use $true to make $obj to be
@b horizontal, @c false to make it @b vertical. */ @b horizontal, $false to make it @b vertical. */
} }
} }
@property value { @property value {
@ -75,7 +75,7 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
for example, above the slider knob that is dragged around. This function for example, above the slider knob that is dragged around. This function
sets the format string used for this. sets the format string used for this.
If @c NULL, indicator label won't be visible. If not it sets the format If $NULL, indicator label won't be visible. If not it sets the format
string for the label text. To the label text is provided a floating point string for the label text. To the label text is provided a floating point
value, so the label text can display up to 1 floating point value. value, so the label text can display up to 1 floating point value.
Note that this is optional. Note that this is optional.
@ -128,16 +128,16 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
Get whether a given slider widget's displaying values are Get whether a given slider widget's displaying values are
inverted or not. inverted or not.
@return @c true, if @p obj has inverted values, @return $true, if $obj has inverted values,
@c false otherwise (and on errors). $false otherwise (and on errors).
@see elm_slider_inverted_set() for more details. @see elm_slider_inverted_set() for more details.
@ingroup Slider */ @ingroup Slider */
} }
values { values {
inverted: bool; /*@ Use @c true to make @p obj inverted, inverted: bool; /*@ Use $true to make $obj inverted,
@c false to bring it back to default, non-inverted values. */ $false to bring it back to default, non-inverted values. */
} }
} }
@property indicator_show { @property indicator_show {
@ -156,15 +156,15 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
/*@ /*@
Get whether a given slider widget's enlarging indicator or not. Get whether a given slider widget's enlarging indicator or not.
@return @c true, if @p obj is enlarging indicator, or @return $true, if $obj is enlarging indicator, or
@c false otherwise (and on errors). $false otherwise (and on errors).
@see elm_slider_indicator_show_set() for details. @see elm_slider_indicator_show_set() for details.
@ingroup Slider */ @ingroup Slider */
} }
values { values {
show: bool; /*@ @c true will make it enlarge, @c false will show: bool; /*@ $true will make it enlarge, $false will
let the knob always at default size. */ let the knob always at default size. */
} }
} }
@ -175,8 +175,8 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
Define the allowed range of values to be selected by the user. Define the allowed range of values to be selected by the user.
If actual value is less than @p min, it will be updated to @p min. If it If actual value is less than $min, it will be updated to $min. If it
is bigger then @p max, will be updated to @p max. Actual value can be is bigger then $max, will be updated to $max. Actual value can be
get with elm_slider_value_get(). get with elm_slider_value_get().
By default, min is equal to 0.0, and max is equal to 1.0. By default, min is equal to 0.0, and max is equal to 1.0.
@ -193,7 +193,7 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
Get the minimum and maximum values of the slider. Get the minimum and maximum values of the slider.
@note If only one value is needed, the other pointer can be passed @note If only one value is needed, the other pointer can be passed
as @c NULL. as $NULL.
@see elm_slider_min_max_set() for details. @see elm_slider_min_max_set() for details.
@ -212,7 +212,7 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
Unit label is displayed all the time, if set, after slider's bar. Unit label is displayed all the time, if set, after slider's bar.
In horizontal mode, at right and in vertical mode, at bottom. In horizontal mode, at right and in vertical mode, at bottom.
If @c NULL, unit label won't be visible. If not it sets the format If $NULL, unit label won't be visible. If not it sets the format
string for the label text. To the label text is provided a floating point string for the label text. To the label text is provided a floating point
value, so the label text can display up to 1 floating point value. value, so the label text can display up to 1 floating point value.
Note that this is optional. Note that this is optional.
@ -255,8 +255,8 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
/*@ /*@
Get whether the indicator of the slider is set or not Get whether the indicator of the slider is set or not
@return @c true, if indicator is set @return $true, if indicator is set
@c false otherwise. $false otherwise.
@ingroup Slider */ @ingroup Slider */
} }
@ -271,14 +271,14 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
This sets the minimum width (when in horizontal mode) or height This sets the minimum width (when in horizontal mode) or height
(when in vertical mode) of the actual bar area of the slider (when in vertical mode) of the actual bar area of the slider
@p obj. This in turn affects the object's minimum size. Use $obj. This in turn affects the object's minimum size. Use
this when you're not setting other size hints expanding on the this when you're not setting other size hints expanding on the
given direction (like weight and alignment hints) and you would given direction (like weight and alignment hints) and you would
like it to have a specific size. like it to have a specific size.
@note Icon, end, label, indicator and unit text around @p obj @note Icon, end, label, indicator and unit text around $obj
will require their will require their
own space, which will make @p obj to require more the @p size, own space, which will make $obj to require more the $size,
actually. actually.
@see elm_slider_span_size_get() @see elm_slider_span_size_get()
@ -292,7 +292,7 @@ class Elm.Slider (Elm.Layout, Elm_Interface_Atspi_Value,
@return The length of the slider's bar region. @return The length of the slider's bar region.
If that size was not set previously, with If that size was not set previously, with
elm_slider_span_size_set(), this call will return @c 0. elm_slider_span_size_set(), this call will return $0.
@ingroup Slider */ @ingroup Slider */
} }

80
legacy/elementary/src/lib/elm_slideshow.eo
View File

@ -8,7 +8,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
Set the number of items to cache, on a given slideshow widget, Set the number of items to cache, on a given slideshow widget,
<b>after the current item</b> <b>after the current item</b>
The default value for this property is @c 2. See The default value for this property is $2. See
@ref Slideshow_Caching "slideshow caching" for more details. @ref Slideshow_Caching "slideshow caching" for more details.
@see elm_slideshow_cache_after_get() @see elm_slideshow_cache_after_get()
@ -36,7 +36,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
Set the number of items to cache, on a given slideshow widget, Set the number of items to cache, on a given slideshow widget,
<b>before the current item</b> <b>before the current item</b>
The default value for this property is @c 2. See The default value for this property is $2. See
@ref Slideshow_Caching "slideshow caching" for more details. @ref Slideshow_Caching "slideshow caching" for more details.
@see elm_slideshow_cache_before_get() @see elm_slideshow_cache_before_get()
@ -63,7 +63,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Set the current slide layout in use for a given slideshow widget Set the current slide layout in use for a given slideshow widget
If @p layout is implemented in @p obj's theme (i.e., is contained If $layout is implemented in $obj's theme (i.e., is contained
in the list returned by elm_slideshow_layouts_get()), this new in the list returned by elm_slideshow_layouts_get()), this new
images layout will be used on the widget. images layout will be used on the widget.
@ -91,7 +91,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
Set the current slide transition/effect in use for a given Set the current slide transition/effect in use for a given
slideshow widget slideshow widget
If @p transition is implemented in @p obj's theme (i.e., is If $transition is implemented in $obj's theme (i.e., is
contained in the list returned by contained in the list returned by
elm_slideshow_transitions_get()), this new sliding effect will elm_slideshow_transitions_get()), this new sliding effect will
be used on the widget. be used on the widget.
@ -135,16 +135,16 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
Get if, after a slideshow is started, for a given slideshow Get if, after a slideshow is started, for a given slideshow
widget, its items are to be displayed cyclically or not. widget, its items are to be displayed cyclically or not.
@return @c true, if the items in @p obj will be cycled @return $true, if the items in $obj will be cycled
through or @c false, otherwise through or $false, otherwise
@see elm_slideshow_loop_set() for more details @see elm_slideshow_loop_set() for more details
@ingroup Slideshow */ @ingroup Slideshow */
} }
values { values {
loop: bool; /*@ Use @c true to make it cycle through items or loop: bool; /*@ Use $true to make it cycle through items or
@c false for it to stop at the end of @p obj's internal $false for it to stop at the end of $obj's internal
list of items */ list of items */
} }
} }
@ -157,13 +157,13 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
After this call, the slideshow widget will start cycling its After this call, the slideshow widget will start cycling its
view, sequentially and automatically, with the images of the view, sequentially and automatically, with the images of the
items it has. The time between each new image displayed is going items it has. The time between each new image displayed is going
to be @p timeout, in @b seconds. If a different timeout was set to be $timeout, in @b seconds. If a different timeout was set
previously and an slideshow was in progress, it will continue previously and an slideshow was in progress, it will continue
with the new time between transitions, after this call. with the new time between transitions, after this call.
@note A value less than or equal to 0 on @p timeout will disable @note A value less than or equal to 0 on $timeout will disable
the widget's internal timer, thus halting any slideshow which the widget's internal timer, thus halting any slideshow which
could be happening on @p obj. could be happening on $obj.
@see elm_slideshow_timeout_get() @see elm_slideshow_timeout_get()
@ -190,13 +190,13 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
Get the internal list of items in a given slideshow widget. Get the internal list of items in a given slideshow widget.
@return The list of items (#Elm.Widget_Item as data) or @return The list of items (#Elm.Widget_Item as data) or
@c NULL on errors. $NULL on errors.
This list is @b not to be modified in any way and must not be This list is @b not to be modified in any way and must not be
freed. Use the list members with functions like freed. Use the list members with functions like
elm_object_item_del(), elm_object_item_data_get(). elm_object_item_del(), elm_object_item_data_get().
@warning This list is only valid until @p obj object's internal @warning This list is only valid until $obj object's internal
items list is changed. It should be fetched again with another items list is changed. It should be fetched again with another
call to this function when changes happen. call to this function when changes happen.
@ -213,22 +213,22 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
@return The list of transitions (list of @b stringshared strings @return The list of transitions (list of @b stringshared strings
as data) as data)
The transitions, which come from @p obj's theme, must be an EDC The transitions, which come from $obj's theme, must be an EDC
data item named @c "transitions" on the theme file, with (prefix) data item named $"transitions" on the theme file, with (prefix)
names of EDC programs actually implementing them. names of EDC programs actually implementing them.
The available transitions for slideshows on the default theme are: The available transitions for slideshows on the default theme are:
- @c "fade" - the current item fades out, while the new one - $"fade" - the current item fades out, while the new one
fades in to the slideshow's viewport. fades in to the slideshow's viewport.
- @c "black_fade" - the current item fades to black, and just - $"black_fade" - the current item fades to black, and just
then, the new item will fade in. then, the new item will fade in.
- @c "horizontal" - the current item slides horizontally, until - $"horizontal" - the current item slides horizontally, until
it gets out of the slideshow's viewport, while the new item it gets out of the slideshow's viewport, while the new item
comes from the left to take its place. comes from the left to take its place.
- @c "vertical" - the current item slides vertically, until it - $"vertical" - the current item slides vertically, until it
gets out of the slideshow's viewport, while the new item comes gets out of the slideshow's viewport, while the new item comes
from the bottom to take its place. from the bottom to take its place.
- @c "square" - the new item starts to appear from the middle of - $"square" - the new item starts to appear from the middle of
the current one, but with a tiny size, growing until its the current one, but with a tiny size, growing until its
target (full) size and covering the old one. target (full) size and covering the old one.
@ -251,7 +251,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Get the number of items stored in a given slideshow widget Get the number of items stored in a given slideshow widget
@return The number of items on @p obj, at the moment of this call @return The number of items on $obj, at the moment of this call
@ingroup Slideshow */ @ingroup Slideshow */
return: uint; return: uint;
@ -262,8 +262,8 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Returns the currently displayed item, in a given slideshow widget Returns the currently displayed item, in a given slideshow widget
@return A handle to the item being displayed in @p obj or @return A handle to the item being displayed in $obj or
@c NULL, if none is (and on errors) $NULL, if none is (and on errors)
@ingroup Slideshow */ @ingroup Slideshow */
return: Elm.Widget_Item *; return: Elm.Widget_Item *;
@ -282,15 +282,15 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
image item in its viewport, with regard to cropping, scaling, image item in its viewport, with regard to cropping, scaling,
etc. etc.
The layouts, which come from @p obj's theme, must be an EDC The layouts, which come from $obj's theme, must be an EDC
data item name @c "layouts" on the theme file, with (prefix) data item name $"layouts" on the theme file, with (prefix)
names of EDC programs actually implementing them. names of EDC programs actually implementing them.
The available layouts for slideshows on the default theme are: The available layouts for slideshows on the default theme are:
- @c "fullscreen" - item images with original aspect, scaled to - $"fullscreen" - item images with original aspect, scaled to
touch top and down slideshow borders or, if the image's height touch top and down slideshow borders or, if the image's height
is not enough, left and right slideshow borders. is not enough, left and right slideshow borders.
- @c "not_fullscreen" - the same behavior as the @c "fullscreen" - $"not_fullscreen" - the same behavior as the $"fullscreen"
one, but always leaving 10% of the slideshow's dimensions of one, but always leaving 10% of the slideshow's dimensions of
distance between the item image's borders and the slideshow distance between the item image's borders and the slideshow
borders, for each axis. borders, for each axis.
@ -310,7 +310,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Slide to the @b previous item, in a given slideshow widget Slide to the @b previous item, in a given slideshow widget
The sliding animation @p obj is set to use will be the The sliding animation $obj is set to use will be the
transition effect used, after this call is issued. transition effect used, after this call is issued.
@note If the beginning of the slideshow's internal list of items @note If the beginning of the slideshow's internal list of items
@ -322,9 +322,9 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
item_nth_get @const { item_nth_get @const {
/*@ /*@
Get the the item, in a given slideshow widget, placed at Get the the item, in a given slideshow widget, placed at
position @p nth, in its internal items list position $nth, in its internal items list
@return The item stored in @p obj at position @p nth or @c NULL, @return The item stored in $obj at position $nth or $NULL,
if there's no item with that index (and on errors) if there's no item with that index (and on errors)
@ingroup Slideshow */ @ingroup Slideshow */
@ -338,7 +338,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Slide to the @b next item, in a given slideshow widget Slide to the @b next item, in a given slideshow widget
The sliding animation @p obj is set to use will be the The sliding animation $obj is set to use will be the
transition effect used, after this call is issued. transition effect used, after this call is issued.
@note If the end of the slideshow's internal list of items is @note If the end of the slideshow's internal list of items is
@ -351,7 +351,7 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Remove all items from a given slideshow widget Remove all items from a given slideshow widget
This removes (and deletes) all items in @p obj, leaving it This removes (and deletes) all items in $obj, leaving it
empty. empty.
@see elm_object_item_del(), to remove just one item. @see elm_object_item_del(), to remove just one item.
@ -363,12 +363,12 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
/*@ /*@
Add (append) a new item in a given slideshow widget. Add (append) a new item in a given slideshow widget.
@return A handle to the item added or @c NULL, on errors @return A handle to the item added or $NULL, on errors
Add a new item to @p obj's internal list of items, appending it. Add a new item to $obj's internal list of items, appending it.
The item's class must contain the function really fetching the The item's class must contain the function really fetching the
image object to show for this item, which could be an Evas image image object to show for this item, which could be an Evas image
object or an Elementary photo, for example. The @p data object or an Elementary photo, for example. The $data
parameter is going to be passed to both class functions of the parameter is going to be passed to both class functions of the
item. item.
@ -386,17 +386,17 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
} }
item_sorted_insert { item_sorted_insert {
/*@ /*@
Insert a new item into the given slideshow widget, using the @p func Insert a new item into the given slideshow widget, using the $func
function to sort items (by item handles). function to sort items (by item handles).
@return Returns The slideshow item handle, on success, or @return Returns The slideshow item handle, on success, or
@c NULL, on errors $NULL, on errors
Add a new item to @p obj's internal list of items, in a position Add a new item to $obj's internal list of items, in a position
determined by the @p func comparing function. The item's class determined by the $func comparing function. The item's class
must contain the function really fetching the image object to must contain the function really fetching the image object to
show for this item, which could be an Evas image object or an show for this item, which could be an Evas image object or an
Elementary photo, for example. The @p data parameter is going to Elementary photo, for example. The $data parameter is going to
be passed to both class functions of the item. be passed to both class functions of the item.
@see #Elm_Slideshow_Item_Class @see #Elm_Slideshow_Item_Class

30
legacy/elementary/src/lib/elm_spinner.eo
View File

@ -9,8 +9,8 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
Define the allowed range of values to be selected by the user. Define the allowed range of values to be selected by the user.
If actual value is less than @p min, it will be updated to @p min. If it If actual value is less than $min, it will be updated to $min. If it
is bigger then @p max, will be updated to @p max. Actual value can be is bigger then $max, will be updated to $max. Actual value can be
get with elm_spinner_value_get(). get with elm_spinner_value_get().
By default, min is equal to 0, and max is equal to 100. By default, min is equal to 0, and max is equal to 100.
@ -26,7 +26,7 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
Get the minimum and maximum values of the spinner. Get the minimum and maximum values of the spinner.
@note If only one value is needed, the other pointer can be passed @note If only one value is needed, the other pointer can be passed
as @c NULL. as $NULL.
@see elm_spinner_min_max_set() for details. @see elm_spinner_min_max_set() for details.
@ -96,7 +96,7 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
@li displayed value = 20 @li displayed value = 20
When the user decrement value (using left or bottom arrow), it will When the user decrement value (using left or bottom arrow), it will
displays @c 50. displays $50.
@see elm_spinner_wrap_get(). @see elm_spinner_wrap_get().
@ -107,15 +107,15 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
Get whether the spinner should wrap when it reaches its Get whether the spinner should wrap when it reaches its
minimum or maximum value. minimum or maximum value.
@return @c true means wrap is enabled. @c false indicates @return $true means wrap is enabled. $false indicates
it's disabled. If @p obj is @c NULL, @c false is returned. it's disabled. If $obj is $NULL, $false is returned.
@see elm_spinner_wrap_set() for details. @see elm_spinner_wrap_set() for details.
@ingroup Spinner */ @ingroup Spinner */
} }
values { values {
wrap: bool; /*@ @c true to enable wrap or @c false to wrap: bool; /*@ $true to enable wrap or $false to
disable it. */ disable it. */
} }
} }
@ -134,10 +134,10 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
The calculation for the next change interval value, starting from The calculation for the next change 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
@c 1.05, so it decreases a little bit. $1.05, so it decreases a little bit.
The default starting interval value for automatic changes is The default starting interval value for automatic changes is
@c 0.85 seconds. $0.85 seconds.
@see elm_spinner_interval_get() @see elm_spinner_interval_get()
@ -210,15 +210,15 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
/*@ /*@
Get whether the spinner can be directly edited by the user or not. Get whether the spinner can be directly edited by the user or not.
@return @c true means edition is enabled. @c false indicates @return $true means edition is enabled. $false indicates
it's disabled. If @p obj is @c NULL, @c false is returned. it's disabled. If $obj is $NULL, $false is returned.
@see elm_spinner_editable_set() for details. @see elm_spinner_editable_set() for details.
@ingroup Spinner */ @ingroup Spinner */
} }
values { values {
editable: bool; /*@ @c true to allow users to edit it or @c false to editable: bool; /*@ $true to allow users to edit it or $false to
don't allow users to edit it directly. */ don't allow users to edit it directly. */
} }
} }
@ -234,7 +234,7 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
Where rounded_val, value and base are doubles, and round is an integer. Where rounded_val, value and base are doubles, and round is an integer.
This means that things will be rounded to increments (or decrements) of This means that things will be rounded to increments (or decrements) of
"round" starting from value @p base. The default base for rounding is 0. "round" starting from value $base. The default base for rounding is 0.
Example: round = 3, base = 2 Example: round = 3, base = 2
Values: ..., -2, 0, 2, 5, 8, 11, 14, ... Values: ..., -2, 0, 2, 5, 8, 11, 14, ...
@ -300,7 +300,7 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
/*@ /*@
Set the format string of the displayed label. Set the format string of the displayed label.
If @c NULL, this sets the format to "%.0f". If not it sets the format If $NULL, this sets the format to "%.0f". If not it sets the format
string for the label text. The label text is provided a floating point string for the label text. The label text is provided a floating point
value, so the label text can display up to 1 floating point value. value, so the label text can display up to 1 floating point value.
Note that this is optional. Note that this is optional.
@ -345,7 +345,7 @@ class Elm.Spinner (Elm.Layout, Elm_Interface_Atspi_Value, Elm_Interface_Atspi_Wi
evas_object_show(sp); evas_object_show(sp);
@endcode @endcode
@note If another label was previously set to @p value, it will be replaced @note If another label was previously set to $value, it will be replaced
by the new label. by the new label.
@see elm_spinner_special_value_get(). @see elm_spinner_special_value_get().

4
legacy/elementary/src/lib/elm_table.eo
View File

@ -95,7 +95,7 @@ class Elm.Table (Elm.Widget)
@note All positioning inside the table is relative to rows and columns, so @note All positioning inside the table is relative to rows and columns, so
a value of 0 for col and row, means the top left cell of the table, and a a value of 0 for col and row, means the top left cell of the table, and a
value of 1 for colspan and rowspan means @p subobj only takes that 1 cell. value of 1 for colspan and rowspan means $subobj only takes that 1 cell.
@ingroup Table */ @ingroup Table */
@ -141,7 +141,7 @@ class Elm.Table (Elm.Widget)
@note All positioning inside the table is relative to rows and columns, so @note All positioning inside the table is relative to rows and columns, so
a value of 0 for x and y, means the top left cell of the table, and a a value of 0 for x and y, means the top left cell of the table, and a
value of 1 for w and h means @p subobj only takes that 1 cell. value of 1 for w and h means $subobj only takes that 1 cell.
Note that columns and rows only guarantee 16bit unsigned values at best. Note that columns and rows only guarantee 16bit unsigned values at best.
That means that col + colspan AND row + rowspan must fit inside 16bit That means that col + colspan AND row + rowspan must fit inside 16bit

54
legacy/elementary/src/lib/elm_toolbar.eo
View File

@ -52,7 +52,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
} }
values { values {
homogeneous: bool; /*@ Assume the items within the toolbar are of the homogeneous: bool; /*@ Assume the items within the toolbar are of the
same size (true = on, false = off). Default is @c false. */ same size (true = on, false = off). Default is $false. */
} }
} }
@property align { @property align {
@ -125,7 +125,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Set the icon size, in pixels, to be used by toolbar items. Set the icon size, in pixels, to be used by toolbar items.
@note Default value is @c 32. It reads value from elm config. @note Default value is $32. It reads value from elm config.
@see elm_toolbar_icon_size_get() @see elm_toolbar_icon_size_get()
@ -155,12 +155,12 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
get { get {
/*@ /*@
Get a toolbar's orientation Get a toolbar's orientation
@return If @c true, the toolbar is horizontal @return If $true, the toolbar is horizontal
By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical. By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
@ingroup Toolbar */ @ingroup Toolbar */
} }
values { values {
horizontal: bool; /*@ If @c true, the toolbar is horizontal */ horizontal: bool; /*@ If $true, the toolbar is horizontal */
} }
} }
@property icon_order_lookup { @property icon_order_lookup {
@ -193,7 +193,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
@property shrink_mode { @property shrink_mode {
set { set {
/*@ /*@
Set the item displaying mode of a given toolbar widget @p obj. Set the item displaying mode of a given toolbar widget $obj.
The toolbar won't scroll under #ELM_TOOLBAR_SHRINK_NONE mode, but The toolbar won't scroll under #ELM_TOOLBAR_SHRINK_NONE mode, but
it will enforce a minimum size, so that all the items will fit it will enforce a minimum size, so that all the items will fit
@ -210,7 +210,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
} }
get { get {
/*@ /*@
Get the shrink mode of toolbar @p obj. Get the shrink mode of toolbar $obj.
@return Toolbar's items display behavior. @return Toolbar's items display behavior.
@ -266,7 +266,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
get { get {
/*@ /*@
Get the standard_priority of visible items in a toolbar Get the standard_priority of visible items in a toolbar
@return The standard priority of items in @p obj toolbar @return The standard priority of items in $obj toolbar
@see elm_toolbar_standard_priority_set() @see elm_toolbar_standard_priority_set()
@ -299,7 +299,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
Get the first item in the given toolbar widget's list of Get the first item in the given toolbar widget's list of
items. items.
@return The first item or @c NULL, if it has no items (and on @return The first item or $NULL, if it has no items (and on
errors) errors)
@see elm_toolbar_item_append() @see elm_toolbar_item_append()
@ -331,7 +331,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
Get the last item in the given toolbar widget's list of Get the last item in the given toolbar widget's list of
items. items.
@return The last item or @c NULL, if it has no items (and on @return The last item or $NULL, if it has no items (and on
errors) errors)
@see elm_toolbar_item_prepend() @see elm_toolbar_item_prepend()
@ -343,23 +343,23 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
} }
item_insert_before { item_insert_before {
/*@ /*@
Insert a new item into the toolbar object before item @p before. Insert a new item into the toolbar object before item $before.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and added to the toolbar. Its position in A new item will be created and added to the toolbar. Its position in
this toolbar will be just before item @p before. this toolbar will be just before item $before.
Items created with this method can be deleted with Items created with this method can be deleted with
elm_object_item_del(). elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
is selected, i.e., the user clicks over an unselected item. is selected, i.e., the user clicks over an unselected item.
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
Toolbar will load icon image from fdo or current theme. Toolbar will load icon image from fdo or current theme.
This behavior can be set by elm_toolbar_icon_order_lookup_set() function. This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
@ -383,23 +383,23 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
} }
item_insert_after { item_insert_after {
/*@ /*@
Insert a new item into the toolbar object after item @p after. Insert a new item into the toolbar object after item $after.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and added to the toolbar. Its position in A new item will be created and added to the toolbar. Its position in
this toolbar will be just after item @p after. this toolbar will be just after item $after.
Items created with this method can be deleted with Items created with this method can be deleted with
elm_object_item_del(). elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
is selected, i.e., the user clicks over an unselected item. is selected, i.e., the user clicks over an unselected item.
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
Toolbar will load icon image from fdo or current theme. Toolbar will load icon image from fdo or current theme.
This behavior can be set by elm_toolbar_icon_order_lookup_set() function. This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
@ -425,7 +425,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Append item to the toolbar. Append item to the toolbar.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and appended to the toolbar, i.e., will A new item will be created and appended to the toolbar, i.e., will
be set as @b last item. be set as @b last item.
@ -433,13 +433,13 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
Items created with this method can be deleted with Items created with this method can be deleted with
elm_object_item_del(). elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
is selected, i.e., the user clicks over an unselected item. is selected, i.e., the user clicks over an unselected item.
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
Toolbar will load icon image from fdo or current theme. Toolbar will load icon image from fdo or current theme.
This behavior can be set by elm_toolbar_icon_order_lookup_set() function. This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
@ -463,7 +463,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
items_count @const { items_count @const {
/*@ /*@
Get the number of items in a toolbar Get the number of items in a toolbar
@return The number of items in @p obj toolbar @return The number of items in $obj toolbar
@ingroup Toolbar */ @ingroup Toolbar */
return: uint; return: uint;
} }
@ -471,7 +471,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Prepend item to the toolbar. Prepend item to the toolbar.
@return The created item or @c NULL upon failure. @return The created item or $NULL upon failure.
A new item will be created and prepended to the toolbar, i.e., will A new item will be created and prepended to the toolbar, i.e., will
be set as @b first item. be set as @b first item.
@ -479,13 +479,13 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
Items created with this method can be deleted with Items created with this method can be deleted with
elm_object_item_del(). elm_object_item_del().
Associated @p data can be properly freed when item is deleted if a Associated $data can be properly freed when item is deleted if a
callback function is set with elm_object_item_del_cb_set(). callback function is set with elm_object_item_del_cb_set().
If a function is passed as argument, it will be called every time this item If a function is passed as argument, it will be called every time this item
is selected, i.e., the user clicks over an unselected item. is selected, i.e., the user clicks over an unselected item.
If such function isn't needed, just passing If such function isn't needed, just passing
@c NULL as @p func is enough. The same should be done for @p data. $NULL as $func is enough. The same should be done for $data.
Toolbar will load icon image from fdo or current theme. Toolbar will load icon image from fdo or current theme.
This behavior can be set by elm_toolbar_icon_order_lookup_set() function. This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
@ -510,7 +510,7 @@ class Elm.Toolbar (Elm.Widget, Elm_Interface_Scrollable,
/*@ /*@
Returns a pointer to a toolbar item by its label. Returns a pointer to a toolbar item by its label.
@return The pointer to the toolbar item matching @p label or @c NULL @return The pointer to the toolbar item matching $label or $NULL
on failure. on failure.
@ingroup Toolbar */ @ingroup Toolbar */

92
legacy/elementary/src/lib/elm_toolbar_item.eo
View File

@ -17,9 +17,9 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
@property prev { @property prev {
get { get {
/*@ /*@
Get the item before @p item in toolbar. Get the item before $item in toolbar.
@note If it is the first item, @c NULL will be returned. @note If it is the first item, $NULL will be returned.
@see elm_toolbar_item_prepend() @see elm_toolbar_item_prepend()
@ -27,15 +27,15 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ The item before @p item, or @c NULL if none or on failure. */ item: Elm.Widget_Item *; /*@ The item before $item, or $NULL if none or on failure. */
} }
} }
@property next { @property next {
get { get {
/*@ /*@
Get the item after @p item in toolbar. Get the item after $item in toolbar.
@note If it is the last item, @c NULL will be returned. @note If it is the last item, $NULL will be returned.
@see elm_toolbar_item_append() @see elm_toolbar_item_append()
@ -43,7 +43,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/ */
} }
values { values {
item: Elm.Widget_Item *; /*@ The item after @p item, or @c NULL if none or on failure. */ item: Elm.Widget_Item *; /*@ The item after $item, or $NULL if none or on failure. */
} }
} }
@property priority { @property priority {
@ -73,16 +73,16 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/ */
} }
values { values {
priority: int; /*@ The @p item priority. The default is zero for set and 0 is returned on failure. */ priority: int; /*@ The $item priority. The default is zero for set and 0 is returned on failure. */
} }
} }
@property selected { @property selected {
get { get {
/*@ /*@
Get whether the @p item is selected or not. Get whether the $item is selected or not.
@return @c true means item is selected. @c false indicates @return $true means item is selected. $false indicates
it's not. If @p obj is @c NULL, @c false is returned. it's not. If $obj is $NULL, $false is returned.
@see elm_toolbar_selected_item_set() for details. @see elm_toolbar_selected_item_set() for details.
@see elm_toolbar_item_selected_get() @see elm_toolbar_item_selected_get()
@ -94,8 +94,8 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
/*@ /*@
Set the selected state of an item. Set the selected state of an item.
This sets the selected state of the given item @p it. This sets the selected state of the given item $it.
@c true for selected, @c false for not selected. $true for selected, $false for not selected.
If a new item is selected the previously selected will be unselected. If a new item is selected the previously selected will be unselected.
Previously selected item can be get with function Previously selected item can be get with function
@ -116,7 +116,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
@property icon { @property icon {
get { get {
/*@ /*@
Get the string used to set the icon of @p item. Get the string used to set the icon of $item.
@return The string associated with the icon object. @return The string associated with the icon object.
@ -127,7 +127,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
} }
set { set {
/*@ /*@
Set the icon associated with @p item. Set the icon associated with $item.
@param icon A string with icon name or the absolute path of an image file. @param icon A string with icon name or the absolute path of an image file.
@ -151,19 +151,19 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
get { get {
/*@ /*@
Get the real Evas(Edje) object created to implement the view of a given Get the real Evas(Edje) object created to implement the view of a given
toolbar @p item. toolbar $item.
@ingroup Toolbar @ingroup Toolbar
*/ */
} }
values { values {
obj: Evas.Object *; /*@ The base Edje object associated with @p it. */ obj: Evas.Object *; /*@ The base Edje object associated with $it. */
} }
} }
@property icon_object { @property icon_object {
get { get {
/*@ /*@
Get the icon object of @p item. Get the icon object of $item.
@see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(), @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
or elm_toolbar_item_icon_memfile_set() for details. or elm_toolbar_item_icon_memfile_set() for details.
@ -180,8 +180,8 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
/*@ /*@
Get a value whether item is a separator or not. Get a value whether item is a separator or not.
@return @c true means item @p it is a separator. @c false @return $true means item $it is a separator. $false
indicates it's not. If @p it is @c NULL, @c false is returned. indicates it's not. If $it is $NULL, $false is returned.
@see elm_toolbar_item_separator_set() for details. @see elm_toolbar_item_separator_set() for details.
@ -192,8 +192,8 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
/*@ /*@
Set or unset item as a separator. Set or unset item as a separator.
@param separator @c true to set item @p item as separator or @param separator $true to set item $item as separator or
@c false to unset, i.e., item will be used as a regular item. $false to unset, i.e., item will be used as a regular item.
Items aren't set as separator by default. Items aren't set as separator by default.
@ -214,7 +214,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
/*@ /*@
Get toolbar item's menu. Get toolbar item's menu.
If @p item wasn't set as menu item with elm_toolbar_item_menu_set(), If $item wasn't set as menu item with elm_toolbar_item_menu_set(),
this function will set it. this function will set it.
@see elm_toolbar_item_menu_set() for details. @see elm_toolbar_item_menu_set() for details.
@ -223,15 +223,15 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/ */
} }
values { values {
menu: Evas.Object *; /*@ Item's menu object or @c NULL on failure. */ menu: Evas.Object *; /*@ Item's menu object or $NULL on failure. */
} }
} }
@property state { @property state {
get { get {
/*@ /*@
Get the current state of @p it. Get the current state of $it.
@return The selected state or @c NULL if none is selected or on failure. @return The selected state or $NULL if none is selected or on failure.
@see elm_toolbar_item_state_set() for details. @see elm_toolbar_item_state_set() for details.
@see elm_toolbar_item_state_unset() @see elm_toolbar_item_state_unset()
@ -242,12 +242,12 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
} }
set { set {
/*@ /*@
Set @p state as the current state of @p it. Set $state as the current state of $it.
@param state The state to use. @param state The state to use.
@return @c true on success or @c false on failure. @return $true on success or $false on failure.
If @p state is @c NULL, it won't select any state and the default item's If $state is $NULL, it won't select any state and the default item's
icon and label will be used. It's the same behaviour than icon and label will be used. It's the same behaviour than
elm_toolbar_item_state_unset(). elm_toolbar_item_state_unset().
@ -269,7 +269,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
}*/ }*/
icon_memfile_set { icon_memfile_set {
/*@ /*@
Set the icon associated with @p item to an image in a binary buffer. Set the icon associated with $item to an image in a binary buffer.
@note The icon image set by this function can be changed by @note The icon image set by this function can be changed by
elm_toolbar_item_icon_set(). elm_toolbar_item_icon_set().
@ -278,15 +278,15 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/ */
params { params {
@in img: const (void) *; /*@ The binary data that will be used as an image */ @in img: const (void) *; /*@ The binary data that will be used as an image */
@in size: size_t; /*@ The size of binary data @p img */ @in size: size_t; /*@ The size of binary data $img */
@in format: const (char) *; /*@ Optional format of @p img to pass to the image loader */ @in format: const (char) *; /*@ Optional format of $img to pass to the image loader */
@in key: const (char) *; /*@ Optional key of @p img to pass to the image loader (eg. if @p img is an edje file) */ @in key: const (char) *; /*@ Optional key of $img to pass to the image loader (eg. if $img is an edje file) */
} }
return: bool; /*@ (@c true = success, @c false = error) */ return: bool; /*@ ($true = success, $false = error) */
} }
icon_file_set { icon_file_set {
/*@ /*@
Set the icon associated with @p item to an image in a binary buffer. Set the icon associated with $item to an image in a binary buffer.
@note The icon image set by this function can be changed by @note The icon image set by this function can be changed by
elm_toolbar_item_icon_set(). elm_toolbar_item_icon_set().
@ -295,13 +295,13 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/ */
params { params {
@in file: const (char) *; /*@ The file that contains the image */ @in file: const (char) *; /*@ The file that contains the image */
@in key: const (char) *; /*@ Optional key of @p img to pass to the image loader (eg. if @p img is an edje file) */ @in key: const (char) *; /*@ Optional key of $img to pass to the image loader (eg. if $img is an edje file) */
} }
return: bool; /*@ (@c true = success, @c false = error) */ return: bool; /*@ ($true = success, $false = error) */
} }
state_add { state_add {
/*@ /*@
Add a new state to @p item. Add a new state to $item.
Toolbar will load icon image from fdo or current theme. Toolbar will load icon image from fdo or current theme.
This behavior can be set by elm_toolbar_icon_order_lookup_set() function. This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
@ -322,22 +322,22 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
@in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked when this * state is selected. */ @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked when this * state is selected. */
@in data: const (void) * @optional; /*@ The data to associate with the state. */ @in data: const (void) * @optional; /*@ The data to associate with the state. */
} }
return: Elm_Toolbar_Item_State *; /*@ The toolbar item state, or @c NULL upon failure. */ return: Elm_Toolbar_Item_State *; /*@ The toolbar item state, or $NULL upon failure. */
} }
state_del { state_del {
/*@ /*@
Delete a previously added state to @p item. Delete a previously added state to $item.
@see elm_toolbar_item_state_add() @see elm_toolbar_item_state_add()
*/ */
params { params {
@in state: Elm_Toolbar_Item_State *; /*@ The state to be deleted. */ @in state: Elm_Toolbar_Item_State *; /*@ The state to be deleted. */
} }
return: bool; /*@ @c true on success or @c false on failure. */ return: bool; /*@ $true on success or $false on failure. */
} }
state_next { state_next {
/*@ /*@
Get the state after selected state in toolbar's @p item. Get the state after selected state in toolbar's $item.
If last state is selected, this function will return first state. If last state is selected, this function will return first state.
@ -346,11 +346,11 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
@ingroup Toolbar @ingroup Toolbar
*/ */
return: Elm_Toolbar_Item_State *; /*@ The state after current state, or @c NULL on failure. */ return: Elm_Toolbar_Item_State *; /*@ The state after current state, or $NULL on failure. */
} }
state_prev { state_prev {
/*@ /*@
Get the state before selected state in toolbar's @p item. Get the state before selected state in toolbar's $item.
If first state is selected, this function will return last state. If first state is selected, this function will return last state.
@ -360,7 +360,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
@ingroup Toolbar @ingroup Toolbar
*/ */
return: Elm_Toolbar_Item_State *; /*@ The state before current state, or @c NULL on failure. */ return: Elm_Toolbar_Item_State *; /*@ The state before current state, or $NULL on failure. */
} }
show { show {
/*@ /*@
@ -396,7 +396,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
Once it is set to be a menu, it can be manipulated through the Once it is set to be a menu, it can be manipulated through the
menu-like function elm_toolbar_menu_parent_set() and the other menu-like function elm_toolbar_menu_parent_set() and the other
elm_menu functions, using the Evas_Object @c menu returned by elm_menu functions, using the Evas_Object $menu returned by
elm_toolbar_item_menu_get(). elm_toolbar_item_menu_get().
So, items to be displayed in this item's menu should be added with So, items to be displayed in this item's menu should be added with
@ -419,7 +419,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
@ingroup Toolbar @ingroup Toolbar
*/ */
params { params {
@in menu: bool; /*@ If @c true, @p item will opens a menu when selected. */ @in menu: bool; /*@ If $true, $item will opens a menu when selected. */
} }
} }
} }

66
legacy/elementary/src/lib/elm_web.eo
View File

@ -10,7 +10,7 @@ class Elm.Web (Elm.Widget)
If enabled, marks set with elm_web_text_matches_mark() will be If enabled, marks set with elm_web_text_matches_mark() will be
highlighted. highlighted.
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@ingroup Web */ @ingroup Web */
return: bool; return: bool;
@ -19,7 +19,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Get whether highlighting marks is enabled Get whether highlighting marks is enabled
@return @c true is marks are set to be highlighted, @c false @return $true is marks are set to be highlighted, $false
otherwise otherwise
@ingroup Web */ @ingroup Web */
@ -55,7 +55,7 @@ class Elm.Web (Elm.Widget)
It must be a full URL, with resource included, in the form It must be a full URL, with resource included, in the form
http://www.enlightenment.org or file:///tmp/something.html http://www.enlightenment.org or file:///tmp/something.html
@return @c true if the URL could be set, @c false if an error occurred. @return $true if the URL could be set, $false if an error occurred.
@ingroup Web */ @ingroup Web */
return: bool; return: bool;
@ -67,7 +67,7 @@ class Elm.Web (Elm.Widget)
The returned string must not be freed and is guaranteed to be The returned string must not be freed and is guaranteed to be
stringshared. stringshared.
@return A stringshared internal string with the current URL, or @c NULL on @return A stringshared internal string with the current URL, or $NULL on
failure failure
@ingroup Web */ @ingroup Web */
@ -117,12 +117,12 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Get whether Inwin mode is set for the current object Get whether Inwin mode is set for the current object
@return @c true if Inwin mode is set, @c false otherwise @return $true if Inwin mode is set, $false otherwise
@ingroup Web */ @ingroup Web */
} }
values { values {
value: bool; /*@ @c true to use Inwin, @c false to use a normal window */ value: bool; /*@ $true to use Inwin, $false to use a normal window */
} }
} }
@property tab_propagate { @property tab_propagate {
@ -142,7 +142,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Get the status of the tab propagation Get the status of the tab propagation
@return @c true if tab propagation is enabled, @c false otherwise @return $true if tab propagation is enabled, $false otherwise
@see elm_web_tab_propagate_set() @see elm_web_tab_propagate_set()
@ -163,7 +163,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Get whether browsing history is enabled for the given object Get whether browsing history is enabled for the given object
@return @c true if history is enabled, @c false otherwise @return $true if history is enabled, $false otherwise
@ingroup Web */ @ingroup Web */
} }
@ -255,7 +255,7 @@ class Elm.Web (Elm.Widget)
This hook will be called when a request to create a new window is This hook will be called when a request to create a new window is
issued from the web page loaded. issued from the web page loaded.
There is no default implementation for this feature, so leaving this There is no default implementation for this feature, so leaving this
unset or passing @c NULL in @p func will prevent new windows from unset or passing $NULL in $func will prevent new windows from
opening. opening.
@ingroup Web */ @ingroup Web */
@ -272,7 +272,7 @@ class Elm.Web (Elm.Widget)
This hook will be called when a JavaScript file selector dialog is This hook will be called when a JavaScript file selector dialog is
requested. requested.
If no function is set or @c NULL is passed in @p func, the default If no function is set or $NULL is passed in $func, the default
implementation will take place. implementation will take place.
@see elm_web_inwin_mode_set() @see elm_web_inwin_mode_set()
@ -290,7 +290,7 @@ class Elm.Web (Elm.Widget)
Sets the function to call when an confirm dialog Sets the function to call when an confirm dialog
This hook will be called when a JavaScript confirm dialog is requested. This hook will be called when a JavaScript confirm dialog is requested.
If no function is set or @c NULL is passed in @p func, the default If no function is set or $NULL is passed in $func, the default
implementation will take place. implementation will take place.
@see elm_web_inwin_mode_set() @see elm_web_inwin_mode_set()
@ -325,7 +325,7 @@ class Elm.Web (Elm.Widget)
Sets the function to call when an prompt dialog Sets the function to call when an prompt dialog
This hook will be called when a JavaScript prompt dialog is requested. This hook will be called when a JavaScript prompt dialog is requested.
If no function is set or @c NULL is passed in @p func, the default If no function is set or $NULL is passed in $func, the default
implementation will take place. implementation will take place.
@see elm_web_inwin_mode_set() @see elm_web_inwin_mode_set()
@ -343,7 +343,7 @@ class Elm.Web (Elm.Widget)
Sets the function to call when an alert dialog Sets the function to call when an alert dialog
This hook will be called when a JavaScript alert dialog is requested. This hook will be called when a JavaScript alert dialog is requested.
If no function is set or @c NULL is passed in @p func, the default If no function is set or $NULL is passed in $func, the default
implementation will take place. implementation will take place.
@see elm_web_inwin_mode_set() @see elm_web_inwin_mode_set()
@ -360,7 +360,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Queries whether it's possible to go forward in history Queries whether it's possible to go forward in history
@return @c true if it's possible to forward in history, @c false @return $true if it's possible to forward in history, $false
otherwise otherwise
@ingroup Web */ @ingroup Web */
@ -377,7 +377,7 @@ class Elm.Web (Elm.Widget)
return the internal reference. Be careful using it as it may return the internal reference. Be careful using it as it may
interfere with elm_web behavior. interfere with elm_web behavior.
@return The internal ewk_view object or @c NULL if it does not @return The internal ewk_view object or $NULL if it does not
exist. (Failure to create or Elementary compiled without exist. (Failure to create or Elementary compiled without
ewebkit) ewebkit)
@ -392,7 +392,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Queries whether it's possible to go back in history Queries whether it's possible to go back in history
@return @c true if it's possible to back in history, @c false @return $true if it's possible to back in history, $false
otherwise otherwise
@ingroup Web */ @ingroup Web */
@ -422,7 +422,7 @@ class Elm.Web (Elm.Widget)
The string returned must be freed by the user when it's done with it. The string returned must be freed by the user when it's done with it.
@return A newly allocated string, or @c NULL if nothing is selected or an @return A newly allocated string, or $NULL if nothing is selected or an
error occurred error occurred
@ingroup Web */ @ingroup Web */
@ -437,7 +437,7 @@ class Elm.Web (Elm.Widget)
The returned string must not be freed and is guaranteed to be The returned string must not be freed and is guaranteed to be
stringshared. stringshared.
@return A stringshared internal string with the current title, or @c NULL on @return A stringshared internal string with the current title, or $NULL on
failure failure
@ingroup Web */ @ingroup Web */
@ -448,10 +448,10 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Jumps the given number of steps in the browsing history Jumps the given number of steps in the browsing history
The @p steps value can be a negative integer to back in history, or a The $steps value can be a negative integer to back in history, or a
positive to move forward. positive to move forward.
@return @c true on success, @c false on error or if not enough @return $true on success, $false on error or if not enough
history exists to jump the given number of steps history exists to jump the given number of steps
@see elm_web_history_enabled_set() @see elm_web_history_enabled_set()
@ -471,7 +471,7 @@ class Elm.Web (Elm.Widget)
This is equivalent to calling elm_web_object_navigate(obj, -1); This is equivalent to calling elm_web_object_navigate(obj, -1);
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@see elm_web_history_enabled_set() @see elm_web_history_enabled_set()
@see elm_web_back_possible() @see elm_web_back_possible()
@ -486,7 +486,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Loads the specified @a html string as the content of the web object Loads the specified @a html string as the content of the web object
@return @c true if it the HTML was successfully loaded, @c false otherwise @return $true if it the HTML was successfully loaded, $false otherwise
External objects such as stylesheets or images referenced in the HTML External objects such as stylesheets or images referenced in the HTML
document are located relative to @a base_url. document are located relative to @a base_url.
@ -509,7 +509,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Searches the given string in a document. Searches the given string in a document.
@return @c true if the given string was found, @c false if not @return $true if the given string was found, $false if not
or failure or failure
@ingroup Web */ @ingroup Web */
@ -530,7 +530,7 @@ class Elm.Web (Elm.Widget)
will later emit an "popup,willdelete" signal to notify the user that will later emit an "popup,willdelete" signal to notify the user that
any memory and objects related to this popup can be freed. any memory and objects related to this popup can be freed.
@return @c true if the menu was successfully destroyed, or @c false @return $true if the menu was successfully destroyed, or $false
if there was no menu to destroy if there was no menu to destroy
@ingroup Web */ @ingroup Web */
@ -556,7 +556,7 @@ class Elm.Web (Elm.Widget)
This is equivalent to calling elm_web_object_navigate(obj, 1); This is equivalent to calling elm_web_object_navigate(obj, 1);
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@see elm_web_history_enabled_set() @see elm_web_history_enabled_set()
@see elm_web_forward_possible_get() @see elm_web_forward_possible_get()
@ -605,9 +605,9 @@ class Elm.Web (Elm.Widget)
Cancels the loading of the current page in the web object. This will Cancels the loading of the current page in the web object. This will
cause a "load,error" signal to be emitted, with the is_cancellation cause a "load,error" signal to be emitted, with the is_cancellation
flag set to @c true. flag set to $true.
@return @c true if the cancel was successful, @c false otherwise @return $true if the cancel was successful, $false otherwise
@ingroup Web */ @ingroup Web */
@ -617,11 +617,11 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Queries whether it's possible to jump the given number of steps Queries whether it's possible to jump the given number of steps
The @p steps value can be a negative integer to back in history, or a The $steps value can be a negative integer to back in history, or a
positive to move forward. positive to move forward.
@return @c true if enough history exists to perform the given jump, @return $true if enough history exists to perform the given jump,
@c false otherwise $false otherwise
@ingroup Web */ @ingroup Web */
@ -634,7 +634,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Requests a reload of the current document, avoiding any existing caches Requests a reload of the current document, avoiding any existing caches
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@ingroup Web */ @ingroup Web */
@ -644,7 +644,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Clears all marked matches in the document Clears all marked matches in the document
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@ingroup Web */ @ingroup Web */
@ -654,7 +654,7 @@ class Elm.Web (Elm.Widget)
/*@ /*@
Requests a reload of the current document in the object Requests a reload of the current document in the object
@return @c true on success, @c false otherwise @return $true on success, $false otherwise
@ingroup Web */ @ingroup Web */

40
legacy/elementary/src/lib/elm_widget_item.eo
View File

@ -21,10 +21,10 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
This function allows a tooltip to expand beyond its parent window's canvas. This function allows a tooltip to expand beyond its parent window's canvas.
It will instead be limited only by the size of the display. It will instead be limited only by the size of the display.
*/ */
return: bool; /*@ @c false on failure, @c true on success */ return: bool; /*@ $false on failure, $true on success */
} }
values { values {
disable: bool; /*@ If @c true, size restrictions are disabled */ disable: bool; /*@ If $true, size restrictions are disabled */
} }
} }
@property tooltip_style { @property tooltip_style {
@ -126,7 +126,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
*/ */
} }
values { values {
style: const (char) *; /*@ the <b>theme style</b> to use/in use (e.g. @c "default", @c "transparent", etc) */ style: const (char) *; /*@ the <b>theme style</b> to use/in use (e.g. $"default", $"transparent", etc) */
} }
} }
@property cursor_engine_only { @property cursor_engine_only {
@ -136,8 +136,8 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
searched in its theme, also, or is only relying on the rendering searched in its theme, also, or is only relying on the rendering
engine. engine.
@return @c true, if cursors are being looked for only on @return $true, if cursors are being looked for only on
those provided by the rendering engine, @c false if they those provided by the rendering engine, $false if they
are being searched on the widget's theme, as well. are being searched on the widget's theme, as well.
@see elm_object_item_cursor_engine_only_set(), for more details @see elm_object_item_cursor_engine_only_set(), for more details
@ -161,8 +161,8 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
*/ */
} }
values { values {
engine_only: bool; /*@ Use @c true to have cursors looked for only engine_only: bool; /*@ Use $true to have cursors looked for only
on those provided by the rendering engine, @c false on those provided by the rendering engine, $false
to have them searched on the widget's theme, as well. */ to have them searched on the widget's theme, as well. */
} }
} }
@ -243,7 +243,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
@property focus { @property focus {
get { get {
/*@ /*@
Get whether the @p it is focused or not. Get whether the $it is focused or not.
@see elm_object_item_focus_set() @see elm_object_item_focus_set()
@ -315,7 +315,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
*/ */
} }
values { values {
disable: bool; /*@ @c true, if the widget item is disabled, @c false if it's enabled (or on errors) */ disable: bool; /*@ $true, if the widget item is disabled, $false if it's enabled (or on errors) */
} }
} }
access_order_get { access_order_get {
@ -453,7 +453,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
This function removes the @b last callback, previously attached to This function removes the @b last callback, previously attached to
a signal emitted by an underlying Edje object of @a it, whose a signal emitted by an underlying Edje object of @a it, whose
parameters @a emission, @a source and @c func match exactly with parameters @a emission, @a source and $func match exactly with
those passed to a previous call to those passed to a previous call to
elm_object_item_signal_callback_add(). The data pointer that was passed elm_object_item_signal_callback_add(). The data pointer that was passed
to this call will be returned. to this call will be returned.
@ -468,7 +468,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
source: const (char) *; /*@ The signal's source. */ source: const (char) *; /*@ The signal's source. */
func: Elm_Object_Item_Signal_Cb; /*@ The callback function to be executed when the signal is emitted. */ func: Elm_Object_Item_Signal_Cb; /*@ The callback function to be executed when the signal is emitted. */
} }
return: void*; /*@ The data pointer of the signal callback or @c NULL, on errors. */ return: void*; /*@ The data pointer of the signal callback or $NULL, on errors. */
} }
signal_emit { signal_emit {
/*@ /*@
@ -508,14 +508,14 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
/*@ /*@
Set the text for an object item's part, marking it as translatable. Set the text for an object item's part, marking it as translatable.
The string to set as @p text must be the original one. Do not pass the The string to set as $text must be the original one. Do not pass the
return of @c gettext() here. Elementary will translate the string return of $gettext() here. Elementary will translate the string
internally and set it on the object item using internally and set it on the object item using
elm_object_item_part_text_set(), also storing the original string so that it elm_object_item_part_text_set(), also storing the original string so that it
can be automatically translated when the language is changed with can be automatically translated when the language is changed with
elm_language_set(). The @p domain will be stored along to find the elm_language_set(). The $domain will be stored along to find the
translation in the correct catalog. It can be NULL, in which case it will use translation in the correct catalog. It can be NULL, in which case it will use
whatever domain was set by the application with @c textdomain(). This is whatever domain was set by the application with $textdomain(). This is
useful in case you are building a library on top of Elementary that will have useful in case you are building a library on top of Elementary that will have
its own translatable strings, that should not be mixed with those of programs its own translatable strings, that should not be mixed with those of programs
using the library. using the library.
@ -534,7 +534,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
Get the original string set as translatable for an object item. Get the original string set as translatable for an object item.
When setting translated strings, the function elm_object_item_part_text_get() When setting translated strings, the function elm_object_item_part_text_get()
will return the translation returned by @c gettext(). To get the original will return the translation returned by $gettext(). To get the original
string use this function. string use this function.
@ingroup General @ingroup General
@ -570,7 +570,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
params { params {
part: const (char) *; /*@ The part name of the translatable text */ part: const (char) *; /*@ The part name of the translatable text */
domain: const (char) *; /*@ The translation domain to use */ domain: const (char) *; /*@ The translation domain to use */
translatable: bool; /*@ @c true, the part text will be translated internally. @c false, otherwise. */ translatable: bool; /*@ $true, the part text will be translated internally. $false, otherwise. */
} }
} }
track { track {
@ -582,7 +582,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
can call the evas apis such as evas_object_geometry_get(), can call the evas apis such as evas_object_geometry_get(),
evas_object_visible_get() to the track object. Note that all of the evas_object_visible_get() to the track object. Note that all of the
widget items may/may not have the internal object so this api may widget items may/may not have the internal object so this api may
return @c NULL if the widget item doesn't have it. Additionally, the return $NULL if the widget item doesn't have it. Additionally, the
widget item is managed/controlled by the widget, the widget item could widget item is managed/controlled by the widget, the widget item could
be changed(moved, resized even deleted) anytime by it's own widget's be changed(moved, resized even deleted) anytime by it's own widget's
decision. So please dont' change the track object as well as don't decision. So please dont' change the track object as well as don't
@ -668,7 +668,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
Set the content to be shown in the tooltip item. Set the content to be shown in the tooltip item.
Setup the tooltip to item. The item can have only one tooltip, Setup the tooltip to item. The item can have only one tooltip,
so any previous tooltip data is removed. @p func(with @p data) will so any previous tooltip data is removed. $func(with $data) will
be called every time that need show the tooltip and it should be called every time that need show the tooltip and it should
return a valid Evas_Object. This object is then managed fully by return a valid Evas_Object. This object is then managed fully by
tooltip system and is deleted when the tooltip is gone. tooltip system and is deleted when the tooltip is gone.
@ -684,7 +684,7 @@ class Elm.Widget_Item(Eo.Base, Elm_Interface_Atspi_Accessible,
another callback replaces @a func, the tooltip is unset with another callback replaces @a func, the tooltip is unset with
elm_object_item_tooltip_unset() or the owner @a item elm_object_item_tooltip_unset() or the owner @a item
dies. This callback receives as the first parameter the dies. This callback receives as the first parameter the
given @a data, and @p event_info is the item. */ given @a data, and $event_info is the item. */
} }
} }

58
legacy/elementary/src/lib/elm_win.eo
View File

@ -189,9 +189,9 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
this event occurred and the developer can take any action, which may this event occurred and the developer can take any action, which may
include, or not, destroying the window object. include, or not, destroying the window object.
When the @p autodel parameter is set, the window will be automatically When the $autodel parameter is set, the window will be automatically
destroyed when this event occurs, after the signal is emitted. destroyed when this event occurs, after the signal is emitted.
If @p autodel is @c false, then the window will not be destroyed If $autodel is $false, then the window will not be destroyed
and is up to the program to do so when it's required. and is up to the program to do so when it's required.
@ingroup Win */ @ingroup Win */
@ -240,7 +240,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Set the override state of a window. Set the override state of a window.
A window with @p override set to true will not be managed by the A window with $override set to true will not be managed by the
Window Manager. This means that no decorations of any kind will be shown Window Manager. This means that no decorations of any kind will be shown
for it, moving and resizing must be handled by the application, as well for it, moving and resizing must be handled by the application, as well
as the window visibility. as the window visibility.
@ -475,7 +475,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
Set the style for the focus highlight on this window Set the style for the focus highlight on this window
Sets the style to use for theming the highlight of focused objects on Sets the style to use for theming the highlight of focused objects on
the given window. If @p style is NULL, the default will be used. the given window. If $style is NULL, the default will be used.
@ingroup Win */ @ingroup Win */
} }
@ -521,14 +521,14 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Constrain the maximum width and height of a window to the width and height of its screen Constrain the maximum width and height of a window to the width and height of its screen
When @p constrain is true, @p obj will never resize larger than the screen. When $constrain is true, $obj will never resize larger than the screen.
@ingroup Win */ @ingroup Win */
} }
get { get {
/*@ /*@
Get the constraints on the maximum width and height of a window relative to the width and height of its screen Get the constraints on the maximum width and height of a window relative to the width and height of its screen
When this function returns true, @p obj will never resize larger than the screen. When this function returns true, $obj will never resize larger than the screen.
@return true to restrict the window's maximum size, false to disable restriction @return true to restrict the window's maximum size, false to disable restriction
@ingroup Win */ @ingroup Win */
@ -614,7 +614,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Set the alpha channel state of a window. Set the alpha channel state of a window.
If @p alpha is true, the alpha channel of the canvas will be enabled If $alpha is true, the alpha channel of the canvas will be enabled
possibly making parts of the window completely or partially transparent. possibly making parts of the window completely or partially transparent.
This is also subject to the underlying system supporting it, like for This is also subject to the underlying system supporting it, like for
example, running under a compositing manager. If no compositing is example, running under a compositing manager. If no compositing is
@ -668,7 +668,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
Most engines only work with multiples of 90. Most engines only work with multiples of 90.
This function is used to set the orientation of the window @p obj to This function is used to set the orientation of the window $obj to
match that of the screen. The window itself will be resized to adjust match that of the screen. The window itself will be resized to adjust
to the new geometry of its contents. If you want to keep the window size, to the new geometry of its contents. If you want to keep the window size,
see elm_win_rotation_with_resize_set(). see elm_win_rotation_with_resize_set().
@ -756,7 +756,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Set the sticky state of the window. Set the sticky state of the window.
Hints the Window Manager that the window in @p obj should be left fixed Hints the Window Manager that the window in $obj should be left fixed
at its position even when the virtual desktop it's on moves or changes. at its position even when the virtual desktop it's on moves or changes.
@ingroup Win */ @ingroup Win */
@ -898,7 +898,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Set the preferred rotation value. Set the preferred rotation value.
This function is used to set the orientation of window @p obj to spicific angle fixed. This function is used to set the orientation of window $obj to spicific angle fixed.
@see elm_win_wm_rotation_preferred_rotation_get() @see elm_win_wm_rotation_preferred_rotation_get()
@ -933,7 +933,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
What this means exactly will depend on the underlying engine used. What this means exactly will depend on the underlying engine used.
In the case of X11 backed engines, the value in @p layer has the In the case of X11 backed engines, the value in $layer has the
following meanings: following meanings:
@li < 3: The window will be placed below all others. @li < 3: The window will be placed below all others.
@li > 5: The window will be placed above all others. @li > 5: The window will be placed above all others.
@ -984,7 +984,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
Shaped windows, when supported, will render the parts of the window that Shaped windows, when supported, will render the parts of the window that
has no content, transparent. has no content, transparent.
If @p shaped is false, then it is strongly advised to have some If $shaped is false, then it is strongly advised to have some
background object or cover the entire window in any other way, or the background object or cover the entire window in any other way, or the
parts of the canvas that have no data will show framebuffer artifacts. parts of the canvas that have no data will show framebuffer artifacts.
@ -1048,7 +1048,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
This function is used to get the state of manual rotation done mode. This function is used to get the state of manual rotation done mode.
@return @c true manual rotationn done mode, @c false otherwise. @return $true manual rotationn done mode, $false otherwise.
@see elm_win_wm_rotation_manual_rotation_done_set() @see elm_win_wm_rotation_manual_rotation_done_set()
@see elm_win_wm_rotation_manual_rotation_done() @see elm_win_wm_rotation_manual_rotation_done()
@ -1205,7 +1205,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
The window manager rotation allows the WM to controls the rotation of application windows. The window manager rotation allows the WM to controls the rotation of application windows.
It is designed to support synchronized rotation for the multiple application windows at same time. It is designed to support synchronized rotation for the multiple application windows at same time.
@return @c true if the window manager rotation is supported, @c false otherwise. @return $true if the window manager rotation is supported, $false otherwise.
@see elm_win_wm_rotation_supported_get() @see elm_win_wm_rotation_supported_get()
@see elm_win_wm_rotation_preferred_rotation_set() @see elm_win_wm_rotation_preferred_rotation_set()
@ -1226,7 +1226,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Get the Ecore_X_Window of an Evas_Object Get the Ecore_X_Window of an Evas_Object
@return The Ecore_X_Window of @p obj @return The Ecore_X_Window of $obj
@ingroup Win */ @ingroup Win */
return: Ecore_X_Window; return: Ecore_X_Window;
@ -1271,7 +1271,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Get the Ecore_Wl_Window of an Evas_Object Get the Ecore_Wl_Window of an Evas_Object
@return The Ecore_Wl_Window of @p obj @return The Ecore_Wl_Window of $obj
@ingroup Win */ @ingroup Win */
return: Ecore_Wl_Window *; return: Ecore_Wl_Window *;
@ -1463,7 +1463,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
return: bool; return: bool;
params { params {
@in svcname: const(char)*; /*@ The name of the service to be advertised. ensure that it is unique (when combined with @p svcnum) otherwise creation may fail. */ @in svcname: const(char)*; /*@ The name of the service to be advertised. ensure that it is unique (when combined with $svcnum) otherwise creation may fail. */
@in svcnum: int; /*@ A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. */ @in svcnum: int; /*@ A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. */
@in svcsys: bool; /*@ A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service. */ @in svcsys: bool; /*@ A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service. */
} }
@ -1491,7 +1491,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
Activate a window object. Activate a window object.
This function sends a request to the Window Manager to activate the This function sends a request to the Window Manager to activate the
window pointed by @p obj. If honored by the WM, the window will receive window pointed by $obj. If honored by the WM, the window will receive
the keyboard focus. the keyboard focus.
@note This is just a request that a Window Manager may ignore, so calling @note This is just a request that a Window Manager may ignore, so calling
@ -1503,11 +1503,11 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
} }
resize_object_add { resize_object_add {
/*@ /*@
Add @p subobj as a resize object of window @p obj. Add $subobj as a resize object of window $obj.
Setting an object as a resize object of the window means that the Setting an object as a resize object of the window means that the
@p subobj child's size and position will be controlled by the window $subobj child's size and position will be controlled by the window
directly. That is, the object will be resized to match the window size directly. That is, the object will be resized to match the window size
and should never be moved or resized manually by the developer. and should never be moved or resized manually by the developer.
@ -1536,7 +1536,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Raise a window object. Raise a window object.
Places the window pointed by @p obj at the top of the stack, so that it's Places the window pointed by $obj at the top of the stack, so that it's
not covered by any other window. not covered by any other window.
If elm_win_override_set() is not set, the Window Manager may ignore this If elm_win_override_set() is not set, the Window Manager may ignore this
@ -1549,7 +1549,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Lower a window object. Lower a window object.
Places the window pointed by @p obj at the bottom of the stack, so that Places the window pointed by $obj at the bottom of the stack, so that
no other window is covered by it. no other window is covered by it.
If elm_win_override_set() is not set, the Window Manager may ignore this If elm_win_override_set() is not set, the Window Manager may ignore this
@ -1560,10 +1560,10 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
} }
resize_object_del { resize_object_del {
/*@ /*@
Delete @p subobj as a resize object of window @p obj. Delete $subobj as a resize object of window $obj.
This function removes the object @p subobj from the resize objects of This function removes the object $subobj from the resize objects of
the window @p obj. It will not delete the object itself, which will be the window $obj. It will not delete the object itself, which will be
left unmanaged and should be deleted by the developer, manually handled left unmanaged and should be deleted by the developer, manually handled
or set as child of some other container. or set as child of some other container.
@ -1577,8 +1577,8 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Center a window on its screen Center a window on its screen
This function centers window @p obj horizontally and/or vertically based on the values This function centers window $obj horizontally and/or vertically based on the values
of @p h and @p v. of $h and $v.
@ingroup Win */ @ingroup Win */
params { params {
@ -1590,7 +1590,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Set keygrab value of the window Set keygrab value of the window
This function grabs the @p key of window using @p grab_mode. This function grabs the $key of window using $grab_mode.
@ingroup Win */ @ingroup Win */
return: bool; return: bool;
@ -1606,7 +1606,7 @@ class Elm.Win (Elm.Widget, Elm_Interface_Atspi_Window,
/*@ /*@
Unset keygrab value of the window Unset keygrab value of the window
This function unset keygrab value. Ungrab @p key of window. This function unset keygrab value. Ungrab $key of window.
@ingroup Win */ @ingroup Win */
return: bool; return: bool;