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

gengrid: convert docs

This commit is contained in:
Daniel Kolesa 2015-08-13 16:05:38 +01:00
parent cddca56dc1
commit 84fcf40c56
1 changed files with 300 additions and 480 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,78 +8,58 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
methods {
@property align {
set {
/*@
Set the items grid's alignment within a given gengrid widget
[[Set the items grid's alignment within a given gengrid widget.
This sets the alignment of the whole grid of items of a gengrid
within its given viewport. By default, those values are both
0.5, meaning that the gengrid will have its items grid placed
exactly in the middle of its viewport.
This sets the alignment of the whole grid of items of a gengrid
within its given viewport. By default, those values are both
0.5, meaning that the gengrid will have its items grid placed
exactly in the middle of its viewport.
@note If given alignment values are out of the cited ranges,
they'll be changed to the nearest boundary values on the valid
ranges.
@see elm_gengrid_align_get()
@ingroup Gengrid */
Note: If given alignment values are out of the cited ranges,
they'll be changed to the nearest boundary values on the valid
ranges.
]]
}
get {
/*@
Get the items grid's alignment values within a given gengrid
widget
[[Get the items grid's alignment values within a given gengrid
widget.
@note Use $NULL pointers on the alignment values you're not
interested in: they'll be ignored by the function.
@see elm_gengrid_align_set() for more details
@ingroup Gengrid */
Note: Use $null pointers on the alignment values you're not
interested in: they'll be ignored by the function.
]]
}
values {
align_x: double; /*@ Alignment in the horizontal axis (0 <= align_x <= 1). */
align_y: double; /*@ Alignment in the vertical axis (0 <= align_y <= 1). */
align_x: double; [[Alignment in the horizontal axis (0 <= align_x <= 1).]]
align_y: double; [[Alignment in the vertical axis (0 <= align_y <= 1).]]
}
}
@property filled {
set {
/*@
Set how the items grid's filled within a given gengrid widget
[[Set how the items grid's filled within a given gengrid widget
This sets the fill state of the whole grid of items of a gengrid
within its given viewport. By default, this value is false, meaning
that if the first line of items grid's isn't filled, the items are
centered with the alignment
@see elm_gengrid_filled_get()
@ingroup Gengrid */
This sets the fill state of the whole grid of items of a
gengrid within its given viewport. By default, this value
is false, meaning that if the first line of items grid's
isn't filled, the items are centered with the alignment.
]]
}
get {
/*@
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 $true, if filled is on, $false if it's
off
@note Use $NULL pointers on the alignment values you're not
interested in: they'll be ignored by the function.
@see elm_gengrid_align_set() for more details
@ingroup Gengrid */
Note: Use $null pointers on the alignment values you're not
interested in: they'll be ignored by the function.
]]
}
values {
fill: bool; /*@ Filled if True */
fill: bool;
}
}
@property page_relative {
set {
/*@ Set a given gengrid widget's scrolling page size, relative to its viewport size. */
}
get {
/*@ Get a given gengrid widget's scrolling page size, relative to its viewport size. */
}
[[Control a given gengrid widget's scrolling page size, relative
to its viewport size.
]]
set {}
get {}
values {
h_pagerel: double;
v_pagerel: double;
@ -87,256 +67,188 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
}
@property multi_select {
set {
/*@
Enable or disable multi-selection in a given gengrid widget
[[Enable or disable multi-selection in a given gengrid widget.
Multi-selection is the ability to have @b more than one
item selected, on a given gengrid, simultaneously. When it is
enabled, a sequence of clicks on different items will make them
all selected, progressively. A click on an already selected item
will unselect it. If interacting via the keyboard,
multi-selection is enabled while holding the "Shift" key.
Multi-selection is the ability to have more than one item
selected, on a given gengrid, simultaneously. When it is
enabled, a sequence of clicks on different items will make
them all selected, progressively. A click on an already
selected item will unselect it. If interacting via the
keyboard, multi-selection is enabled while holding the
"Shift" key.
@note By default, multi-selection is @b disabled on gengrids
@see elm_gengrid_multi_select_get()
@ingroup Gengrid */
Note: By default, multi-selection is disabled on gengrids.
]]
}
get {
/*@
Get whether multi-selection is enabled or disabled for a given
gengrid widget
@return $true, if multi-selection is enabled, @c
false otherwise
@see elm_gengrid_multi_select_set() for more details
@ingroup Gengrid */
[[Get whether multi-selection is enabled or disabled for a given
gengrid widget.
]]
}
values {
multi: bool; /*@ $true, to enable multi-selection,
$false to disable it. */
multi: bool;
}
}
@property group_item_size {
set {
/*@
Set the size for the group items of a given gengrid widget
[[Set the size for the group items of a given gengrid widget.
A gengrid, after creation, has still no information on the size
to give to each of its cells. So, you most probably will end up
with squares one @ref Fingers "finger" wide, the default
size. Use this function to force a custom size for you group items,
making them as big as you wish.
@see elm_gengrid_group_item_size_get()
@ingroup Gengrid */
A gengrid, after creation, has still no information on the size
to give to each of its cells. So, you most probably will end up
with squares one \@ref Fingers "finger" wide, the default
size. Use this function to force a custom size for you group
items, making them as big as you wish.
]]
}
get {
/*@
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 $NULL pointers on the size values you're not
interested in: they'll be ignored by the function.
@see elm_gengrid_group_item_size_get() for more details
@ingroup Gengrid */
Note: Use $null pointers on the size values you're not
interested in: they'll be ignored by the function.
]]
}
values {
w: Evas.Coord; /*@ The group items' width. */
h: Evas.Coord; /*@ The group items' height. */
w: Evas.Coord; [[The group items' width.]]
h: Evas.Coord; [[The group items' height.]]
}
}
@property select_mode {
set {
/*@
Set the gengrid select mode.
[[Set the gengrid select mode.
elm_gengrid_select_mode_set() changes item select mode in the gengrid widget.
- #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
callback when first becoming selected. Any further clicks will
do nothing, unless you set always select mode.
- #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
every click will make the selected callbacks be called.
- #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
entirely and they will neither appear selected nor call selected
callback functions.
@see elm_gengrid_select_mode_get()
@ingroup Gengrid */
This changes item select mode in the gengrid widget.
#ELM_OBJECT_SELECT_MODE_DEFAULT means that items will only
call their selection func and callback when first becoming
selected. Any further clicks will do nothing, unless you set
always select mode. #ELM_OBJECT_SELECT_MODE_ALWAYS means that
even if selected, every click will make the selected callbacks
be called. #ELM_OBJECT_SELECT_MODE_NONE will turn off the
ability to select items entirely and they will neither appear
selected nor call selected callback functions.
]]
}
get {
/*@
Get the gengrid select mode.
@return The select mode
(If getting mode fails, it returns #ELM_OBJECT_SELECT_MODE_MAX)
@see elm_gengrid_select_mode_set()
@ingroup Gengrid */
[[Get the gengrid select mode.]]
}
values {
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); /*@ The select mode */
mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The select mode.]]
}
}
@property reorder_mode {
set {
/*@
Set whether a given gengrid widget is or not able have items
@b reordered
[[Set whether a given gengrid widget is or not able have items
reordered.
If a gengrid is set to allow reordering, a click held for more
than 0.5 over a given item will highlight it specially,
signaling the gengrid has entered the reordering state. From
that time on, the user will be able to, while still holding the
mouse button down, move the item freely in the gengrid's
viewport, replacing to said item to the locations it goes to.
The replacements will be animated and, whenever the user
releases the mouse button, the item being replaced gets a new
definitive place in the grid.
@see elm_gengrid_reorder_mode_get()
@ingroup Gengrid */
If a gengrid is set to allow reordering, a click held for more
than 0.5 over a given item will highlight it specially,
signaling the gengrid has entered the reordering state. From
that time on, the user will be able to, while still holding the
mouse button down, move the item freely in the gengrid's
viewport, replacing to said item to the locations it goes to.
The replacements will be animated and, whenever the user
releases the mouse button, the item being replaced gets a new
definitive place in the grid.
]]
}
get {
/*@
Get whether a given gengrid widget is or not able have items
@b reordered
@return $true, if reordering is on, $false if it's
off
@see elm_gengrid_reorder_mode_set() for more details
@ingroup Gengrid */
[[Get whether a given gengrid widget is or not able have items
reordered.
]]
}
values {
reorder_mode: bool; /*@ Use $true to turn reordering on,
$false to turn it off */
reorder_mode: bool; [[Use $true to turn reordering on,
$false to turn it off.]]
}
}
@property highlight_mode {
set {
/*@ Set whether the gengrid items' should be highlighted when item selected. */
}
get {
/*@ Get whether the gengrid items' should be highlighted when item selected. */
}
[[Control whether the gengrid items' should be highlighted when
item selected.
]]
set {}
get {}
values {
highlight: bool;
}
}
@property item_size {
set {
/*@
Set the size for the items of a given gengrid widget
[[Set the size for the items of a given gengrid widget.
A gengrid, after creation, has still no information on the size
to give to each of its cells. So, you most probably will end up
with squares one @ref Fingers "finger" wide, the default
size. Use this function to force a custom size for you items,
making them as big as you wish.
@see elm_gengrid_item_size_get()
@ingroup Gengrid */
A gengrid, after creation, has still no information on the size
to give to each of its cells. So, you most probably will end up
with squares one \@ref Fingers "finger" wide, the default
size. Use this function to force a custom size for you items,
making them as big as you wish.
]]
}
get {
/*@
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 $NULL pointers on the size values you're not
interested in: they'll be ignored by the function.
@see elm_gengrid_item_size_get() for more details
@ingroup Gengrid */
Note: Use $null pointers on the size values you're not
interested in: they'll be ignored by the function.
]]
}
values {
w: Evas.Coord; /*@ The items' width. */
h: Evas.Coord; /*@ The items' height. */
w: Evas.Coord; [[The items' width.]]
h: Evas.Coord; [[The items' height.]]
}
}
@property multi_select_mode {
set {
/*@
Set the gengrid multi select mode.
[[Set the gengrid multi select mode.
- #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each
item is clicked.
- #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected
although multi-selection is enabled, if clicked without pressing control
key. This mode is only available with multi-selection.
#ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT means that
select/unselect items whenever each item is clicked.
#ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL means that
only one item will be selected although multi-selection
is enabled, if clicked without pressing control key. This
mode is only available with multi-selection.
@see elm_gengrid_multi_select_set()
@see elm_gengrid_multi_select_mode_get()
@ingroup Gengrid
@since 1.8 */
@since 1.8
]]
}
get {
/*@
Get the gengrid multi select mode.
[[Get the gengrid multi select mode.
@return The multi select mode
(If getting mode fails, it returns #ELM_OBJECT_MULTI_SELECT_MODE_MAX)
If getting mode fails, it returns
#ELM_OBJECT_MULTI_SELECT_MODE_MAX.
@see elm_gengrid_multi_select_set()
@see elm_gengrid_multi_select_mode_set()
@ingroup Gengrid
@since 1.8 */
@since 1.8
]]
}
values {
mode: Elm.Object.Multi_Select_Mode(Elm.Object.Multi_Select_Mode.max); /*@ The multi select mode */
mode: Elm.Object.Multi_Select_Mode(Elm.Object.Multi_Select_Mode.max); [[The multi select mode.]]
}
}
@property horizontal {
set {
/*@
Set the direction in which a given gengrid widget will expand while
placing its items.
[[Set the direction in which a given gengrid widget will
expand while placing its items.
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
started on the right, thus expanding the grid horizontally. When in
"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
started below, thus expanding the grid vertically.
When in "horizontal mode" ($true), items will be placed in
columns, 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 "vertical mode" ($false),
though, items will be placed in rows, from left to right
and, when the space for a row is filled, another one is
started below, thus expanding the grid vertically.
@note By default, gengrid is in vertical mode, $false.
@see elm_gengrid_horizontal_get()
@ingroup Gengrid */
Note: By default, gengrid is in vertical mode, $false.
]]
}
get {
/*@
Get for what direction a given gengrid widget will expand while
placing its items.
@return $true, if $obj is set to expand horizontally,
$false if it's set to expand vertically.
@see elm_gengrid_horizontal_set() for more details
@ingroup Gengrid */
[[Get for what direction a given gengrid widget will expand while
placing its items.
]]
}
values {
horizontal: bool; /*@ $true to make the gengrid expand horizontally,
$false to expand vertically. */
horizontal: bool; [[$true to make the gengrid expand horizontally,
$false to expand vertically.]]
}
}
@property page_size {
set {
/*@ Set a given gengrid widget's scrolling page size */
[[Set a given gengrid widget's scrolling page size.]]
}
values {
h_pagesize: Evas.Coord;
@ -345,341 +257,249 @@ class Elm.Gengrid (Elm.Layout, Elm_Interface_Scrollable,
}
@property selected_item {
get {
/*@
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 $NULL, if none is
selected at the moment (and on errors)
This returns the selected item in $obj. If multi selection is
enabled on $obj (@see elm_gengrid_multi_select_set()), only
the first item in the list is selected, which might not be very
useful. For that case, see elm_gengrid_selected_items_get().
@ingroup Gengrid */
return: Elm.Widget_Item *;
This returns the selected item in $obj. If multi selection is
enabled on $obj (See @.multi_select.set), only the first item
in the list is selected, which might not be very useful. For
that case, see @.selected_items.get.
]]
return: Elm.Widget_Item *; [[The selected item's handle or $null
if none is selected at the moment
(and on errors).]]
}
}
@property realized_items {
get {
/*@
Get a list of realized items in gengrid
[[Get a list of realized items in gengrid.
@return The list of realized items, nor NULL if none are realized.
This returns a list of the realized items in the gengrid. The list
contains gengrid item pointers. The list must be freed by the
caller when done with eina_list_free(). The item pointers in the
list are only valid so long as those items are not deleted or the
gengrid is not deleted.
@see elm_gengrid_realized_items_update()
@ingroup Gengrid */
return: free(own(list<Elm_Gen_Item *> *), eina_list_free) @warn_unused;
This returns a list of the realized items in the gengrid. The
list contains gengrid item pointers. The list must be freed by
the caller when done with eina_list_free(). The item pointers
in the list are only valid so long as those items are not
deleted or the gengrid is not deleted.
]]
return: free(own(list<Elm_Gen_Item *> *), eina_list_free) @warn_unused; [[
The list of realized items or $null if none are realized.
]]
}
}
@property first_item {
get {
/*@
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 $NULL, if there are no
items in $obj (and on errors)
This returns the first item in the $obj's internal list of
items.
@see elm_gengrid_last_item_get()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This returns the first item in the $obj's internal list of
items.
]]
return: Elm.Widget_Item *; [[
The first item's handle or $null, if there are no
items in $obj (and on errors)
]]
}
}
@property selected_items {
get {
/*@
Get <b>a list</b> of selected items in a given gengrid
[[Get a list of selected items in a given gengrid.
@return The list of selected items or $NULL, if none is
selected at the moment (and on errors)
This returns a list of the selected items, in the order that
they appear in the grid. This list is only valid as long as no
more items are selected or unselected (or unselected implicitly
by deletion). The list contains Gengrid item pointers as
data, naturally.
@see elm_gengrid_selected_item_get()
@ingroup Gengrid */
return: const(list<Elm.Widget_Item *>)*;
This returns a list of the selected items, in the order that
they appear in the grid. This list is only valid as long as no
more items are selected or unselected (or unselected implicitly
by deletion). The list contains Gengrid item pointers as
data, naturally.
]]
return: const(list<Elm.Widget_Item *>)*; [[
The list of selected items or $null, if none is
selected at the moment (and on errors).
]]
}
}
@property last_item {
get {
/*@
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 $NULL, if there are no
items in $obj (and on errors)
This returns the last item in the $obj's internal list of
items.
@see elm_gengrid_first_item_get()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This returns the last item in the $obj's internal list of
items.
]]
return: Elm.Widget_Item *; [[The last item's handle or $null
if there are no items in $obj
(and on errors).]]
}
}
@property wheel_disabled {
set {
/*@
Enable or disable mouse wheel to be used to scroll the gengrid.
[[Enable or disable mouse wheel to be used to scroll the gengrid.
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.
Wheel is enabled by default.
@see elm_gengrid_wheel_disabled_get()
@ingroup Gengrid */
Wheel is enabled by default.
]]
}
get {
/*@
Get a value whether mouse wheel is enabled or not.
[[Get a value whether mouse wheel is enabled or not.
@return $true means gengrid wheel is disabled. $false indicates
it is enabled.
Mouse wheel can be used for the user to scroll up and down the gengrid.
@see elm_gengrid_wheel_disabled_set()
@ingroup Gengrid */
Mouse wheel can be used for the user to scroll up and down
the gengrid.
]]
}
values {
disabled: bool; /*@ Use $true to disable mouse wheel or $false
to enable it. */
disabled: bool; [[Use $true to disable mouse wheel or $false
to enable it.]]
}
}
item_insert_before {
/*@
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 $NULL, on errors.
This inserts an item before another in the gengrid.
@see elm_gengrid_item_append()
@see elm_gengrid_item_prepend()
@see elm_gengrid_item_insert_after()
@see elm_object_item_del()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This inserts an item before another in the gengrid.
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
@in itc: const(Elm_Gengrid_Item_Class)*; /*@ The item class for the item. */
@in data: const(void)*; /*@ The item data. */
@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
selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
@in itc: const(Elm_Gengrid_Item_Class)*; [[The item class for the item.]]
@in data: const(void)*; [[The item data.]]
@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 selected.]]
@in func_data: const(void)* @optional; [[Data to be passed to $func.]]
}
}
realized_items_update {
/*@
Update the contents of all realized items.
[[Update the contents of all realized items.
This updates all realized items by calling all the item class functions again
to get the contents, texts and states. Use this when the original
item data has changed and the changes are desired to be reflected.
To update just one item, use elm_gengrid_item_update().
@see elm_gengrid_realized_items_get()
@see elm_gengrid_item_update()
@ingroup Gengrid */
This updates all realized items by calling all the item class
functions again to get the contents, texts and states. Use this
when the original item data has changed and the changes are
desired to be reflected.
To update just one item, use \@ref elm_gengrid_item_update.
]]
}
item_insert_after {
/*@
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 $NULL, on errors.
This inserts an item after another in the gengrid.
@see elm_gengrid_item_append()
@see elm_gengrid_item_prepend()
@see elm_gengrid_item_insert_after()
@see elm_object_item_del()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This inserts an item after another in the gengrid.
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on error.]]
params {
@in itc: const(Elm_Gengrid_Item_Class)*; /*@ The item class for the item. */
@in data: const(void)*; /*@ The item data. */
@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
selected. */
@in func_data: const(void)* @optional; /*@ Data to be passed to $func. */
@in itc: const(Elm_Gengrid_Item_Class)*; [[The item class for the item.]]
@in data: const(void)*; [[The item data.]]
@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 selected.]]
@in func_data: const(void)* @optional; [[Data to be passed to $func.]]
}
}
items_count @const {
/*@
Return how many items are currently in a list
[[Return how many items are currently in a list
@return The total number of list items in the list
This behavior is O(1) and includes items which may or may not be realized.
@ingroup Gengrid */
This behavior is O(1) and includes items which may or may not
be realized.
]]
return: uint;
}
at_xy_item_get @const {
/*@
Get the item that is at the x, y canvas coords.
[[Get the item that is at the x, y canvas coords.
@return The item at the coordinates or NULL if none
This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate,
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
the coordinate is on the left portion of that item (-1), on the
middle section (0) or on the right part (1).
This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate,
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
the coordinate is on the left portion of that item (-1), on the
middle section (0) or on the right part (1).
if $yposret is not NULL, the
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
middle section (0) or on the lower part (1). If NULL is returned as
an item (no item found there), then posret may indicate -1 or 1
based if the coordinate is above or below all items respectively in
the gengrid.
@ingroup Gengrid */
return: Elm.Widget_Item *;
If $yposret is not $null, the 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 middle section (0) or on the
lower part (1). If NULL is returned as an item (no item found
there), then posret may indicate -1 or 1 based if the coordinate
is above or below all items respectively in the gengrid.
]]
return: Elm.Widget_Item *; [[The item at the coordinates or $null if none.]]
params {
@in x: Evas.Coord; /*@ The input x coordinate */
@in y: Evas.Coord; /*@ The input y coordinate */
@out xposret: int; /*@ The position relative to the item returned here */
@out yposret: int; /*@ The position relative to the item returned here */
@in x: Evas.Coord; [[The input x coordinate.]]
@in y: Evas.Coord; [[The input y coordinate.]]
@out xposret: int; [[The position relative to the item returned here.]]
@out yposret: int; [[The position relative to the item returned here.]]
}
}
item_append {
/*@
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 $NULL, on errors.
This adds an item to the beginning of the gengrid.
@see elm_gengrid_item_prepend()
@see elm_gengrid_item_insert_before()
@see elm_gengrid_item_insert_after()
@see elm_object_item_del()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This adds an item to the beginning of the gengrid.
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
@in itc: const(Elm_Gengrid_Item_Class)*; /*@ The item class for the item. */
@in data: const(void)*; /*@ The item data. */
@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 $func. */
@in itc: const(Elm_Gengrid_Item_Class)*; [[The item class for the item.]]
@in data: const(void)*; [[The item data.]]
@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 $func.]]
}
}
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 $NULL, on errors.
This adds an item to the end of the gengrid.
@see elm_gengrid_item_append()
@see elm_gengrid_item_insert_before()
@see elm_gengrid_item_insert_after()
@see elm_object_item_del()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This adds an item to the end of the gengrid.
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
@in itc: const(Elm_Gengrid_Item_Class)*; /*@ The item class for the item. */
@in data: const(void)*; /*@ The item data. */
@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 $func. */
@in itc: const(Elm_Gengrid_Item_Class)*; [[The item class for the item.]]
@in data: const(void)*; [[The item data.]]
@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 $func.]]
}
}
clear {
/*@
Remove all items from a given gengrid widget
[[Remove all items from a given gengrid widget.
This removes (and deletes) all items in $obj, leaving it
empty.
@see elm_object_item_del(), to remove just one item.
@ingroup Gengrid */
This removes (and deletes) all items in $obj, leaving it empty.
See \@ref elm_gengrid_item_del to remove just one item.
]]
}
item_sorted_insert {
/*@
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 $NULL, on errors.
This inserts an item in the gengrid based on user defined comparison
function. The two arguments passed to the function $func are gengrid
item handles to compare.
@see elm_gengrid_item_append()
@see elm_gengrid_item_prepend()
@see elm_gengrid_item_insert_after()
@see elm_object_item_data_get()
@see elm_object_item_del()
@ingroup Gengrid */
return: Elm.Widget_Item *;
This inserts an item in the gengrid based on user defined
comparison function. The two arguments passed to the function
$func are gengrid item handles to compare.
]]
return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
params {
@in itc: const(Elm_Gengrid_Item_Class)*; /*@ The item class for the item. */
@in data: const(void)*; /*@ The item data. */
@in comp: Eina_Compare_Cb; /*@ User defined comparison function that defines the sort order
based on gengrid item and its data. */
@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 $func. */
@in itc: const(Elm_Gengrid_Item_Class)*; [[The item class for the item.]]
@in data: const(void)*; [[The item data.]]
@in comp: Eina_Compare_Cb; [[User defined comparison function
that defines the sort order based
on gengrid item and its data.
]]
@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 $func.]]
}
}
search_by_text_item_get {
/*@
Get gengrid item by given string.
[[Get gengrid item by given string.
@return Pointer to the gengrid item which matches search_string in case of success, otherwise returns NULL.
It takes pointer to the gengrid item that will be used to start
search from it.
It takes pointer to the gengrid item that will be used to start
search from it.
This function uses globs (like "*.jpg") for searching and takes
search flags as last parameter That is a bitfield with values
to be ored together or 0 for no flags.
This function uses globs (like "*.jpg") for searching and takes
search flags as last parameter That is a bitfield with values
to be ored together or 0 for no flags.
@ingroup Gengrid
@since 1.11 */
return: Elm.Widget_Item *;
@since 1.11
]]
return: Elm.Widget_Item *; [[Pointer to the gengrid item which matches
search_string in case of success,
otherwise $null.]]
params {
@in item_to_search_from: Elm.Widget_Item * @optional; /*@ Pointer to item to start search from. If NULL search will be started from the first item of the gengrid. */
@in part_name: const(char) *; /*@ Name of the TEXT part of gengrid item to search string in. */
@in pattern: const(char) *; /*@ The search pattern. */
@in flags: Elm_Glob_Match_Flags; /*@ Search flags */
@in item_to_search_from: Elm.Widget_Item * @optional; [[
Pointer to item to start search from. If $null, search will
be started from the first item of the gengrid.
]]
@in part_name: const(char) *; [[Name of the TEXT part of gengrid item to search string in.]]
@in pattern: const(char) *; [[The search pattern.]]
@in flags: Elm_Glob_Match_Flags; [[Search flags.]]
}
}
}