Merged elm_genlist_item.eo for Mobile/Wearable with Others 52/104652/3
authorMyungJoo Ham <myungjoo.ham@samsung.com>
Wed, 14 Dec 2016 03:52:36 +0000 (12:52 +0900)
committerMyungJoo Ham <myungjoo.ham@samsung.com>
Wed, 14 Dec 2016 06:48:16 +0000 (15:48 +0900)
Devel packages (headers for other Tizen platform packages) should be
identical. Differences between profiles are not acceptable for Tizen 4.0
platform environment.

However,
  : Differences of headers per profile for applications are acceptable.
  : Differences of behaviors per profile for a same interface are acceptable.
  (e.g., different .so with the same .h)

Change-Id: I9715f76a1c23485f960370d95b2cb990d7fee162
Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
src/lib/elm_genlist_item.eo
src/mobile_lib/elm_genlist.c
src/mobile_lib/elm_genlist_item.eo

index df5884abbdd1033fb8ac4d6e38ef04413d7f1e3e..1237873b2f6331c82b361022d57ebc8f338075a6 100644 (file)
@@ -7,16 +7,21 @@ class Elm.Genlist_Item(Elm.Widget_Item)
       methods {
            @property prev {
                 get {
-                     [[Get the previous item in a genlist widget's internal
-                       list of items, given a handle to one of those items.
+                     [[
+                      $brief Get the $b previous item in a genlist widget's internal list of items,
+                      given a handle to one of those items.
 
-                       This returns the item placed before the $item, on
-                       the container genlist.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $remark This returns the item placed before the $p item, on the container
+                      genlist.
+
+                      $see elm_genlist_item_next_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      item: Elm.Widget_Item *; [[The item before $item, or $null if there's none (and on errors).]]
@@ -24,16 +29,21 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property next {
                 get {
-                     [[Get the next item in a genlist widget's internal lis
-                       of items, given a handle to one of those items.
+                     [[
+                      $brief Get the $b next item in a genlist widget's internal list of items,
+                      given a handle to one of those items.
 
-                       This returns the item placed after the $item, on
-                       the container genlist.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $remark This returns the item placed after the $p item, on the container
+                      genlist.
+
+                      $see elm_genlist_item_prev_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      item: Elm.Widget_Item *; [[The item after $item, or $null if there's none (and on errors).]]
@@ -41,28 +51,34 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property parent {
                 get {
-                     [[Get the parent item of the given item
+                                        [[
+                      $brief Get the parent item of the given item
 
-                       This returns the item that was specified as parent
-                       of the item $it on \@ref elm_genlist_item_append
-                       and insertion related functions.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
-                }
+                      $remark This returns the item that was specified as parent of the item $p it on
+                      elm_genlist_item_append() and insertion related functions.
+
+                      $ingroup Genlist
+                      ]]
+                               }
                 values {
                      item: Elm.Widget_Item *; [[The parent of the item or $null if it has no parent.]]
                 }
            }
            @property subitems {
-                get @internal {
-                     [[et the list of subitems of a given item
+                get {
+                     [[Get the list of subitems of a given item
 
                        This returns the list of subitems that an item
                        possesses. It cannot be changed.
 
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
                        @since 1.9
                      ]]
                 }
@@ -72,25 +88,39 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property selected {
                 get {
-                     [[Get whether a given genlist item is selected or not.
+                     [[
+                      $brief Get whether a given genlist item is selected or not
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      *return $c EINA_TRUE, if it's selected, $c EINA_FALSE otherwise
+
+                      $see elm_genlist_item_selected_set() for more details
+
+                      $ingroup Genlist
+                      ]]
                 }
                 set {
-                     [[Set whether a given genlist item is selected or not
+                     [[
+                      $brief Set whether a given genlist item is selected or not
 
-                      This sets the selected state of an item. If multi
-                      selection is not enabled on the containing genlist
-                      and $selected is $true, any other previously selected
-                      items will get unselected in favor of this new one.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $remark Use $c EINA_TRUE, to make it selected, $c EINA_FALSE to make it unselected
+
+                      $remark This sets the selected state of an item. If multi selection is
+                      not enabled on the containing genlist and $p selected is $c
+                      EINA_TRUE, any other previously selected items will get
+                      unselected in favor of this new one.
+
+                      $see elm_genlist_item_selected_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      selected: bool; [[The selected state ($true selected, $false not selected).]]
@@ -98,35 +128,43 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property expanded {
                 get {
-                     [[Get the expanded state of an item
+                     [[
+                      $brief Get the expanded state of an item
 
-                       This gets the expanded state of an item.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $remark This gets the expanded state of an item.
+
+                      $see elm_genlist_item_expanded_set()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 set {
-                     [[Sets the expanded state of an item.
+                     [[
+                      $brief Sets the expanded state of an item.
 
-                       This function flags the item of type
-                       #ELM_GENLIST_ITEM_TREE as expanded or not.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       The theme will respond to this change visually, and
-                       a signal "expanded" or "contracted" will be sent
-                       from the genlist with a pointer to the item that
-                       has been expanded/contracted.
+                      $remark This function flags the item of type #ELM_GENLIST_ITEM_TREE as
+                      expanded or not.
 
-                       Calling this function won't show or hide any child
-                       of this item (if it is a parent). You must manually
-                       delete and create them on the callbacks of
-                       the "expanded" or "contracted" signals.
+                      $remark The theme will respond to this change visually, and a signal "expanded" or
+                      "contracted" will be sent from the genlist with a pointer to the item that
+                      has been expanded/contracted.
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $remark Calling this function won't show or hide any child of this item (if it is
+                      a parent). You must manually delete and create them on the callbacks of
+                      the "expanded" or "contracted" signals.
+
+                      $see elm_genlist_item_expanded_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      expanded: bool; [[The expanded state ($true expanded, $false not expanded).]]
@@ -134,12 +172,15 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property expanded_depth {
                 get {
-                     [[Get the depth of expanded item.
+                     [[
+                      $brief Get the depth of expanded item
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      depth: int; [[The depth of expanded item.]]
@@ -147,16 +188,18 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property item_class {
                 get {
-                     [[Get the Genlist Item class for the given Genlist Item.
+                     [[
+                      $brief Get the Genlist Item class for the given Genlist Item.
 
-                       This returns the Genlist_Item_Class for the given item.
-                       It can be used to examine the function pointers and
-                       item_style.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $remark This returns the Genlist_Item_Class for the given item. It can be used to
+                      examine the function pointers and item_style.
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      itc: const (Elm_Genlist_Item_Class) *; [[Genlist Item class for the given item.]]
@@ -164,48 +207,83 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property index {
                 get {
-                     [[Get the index of the item. It is only valid once displayed.
+                     [[
+                      $brief Get the index of the item. It is only valid once displayed.
 
-                       The index start from 1.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
-                     index: int(-1); [[The position inside the list of item.]]
+                     index: int(-1); [[ *return the position inside the list of item. ]]
                 }
            }
            @property decorate_mode {
-                get @internal {
-                     [[Get the item's decorate mode.
+                get {
+                     [[
+                      $internal
 
-                       This function just returns the name of the item's
-                       decorate mode.
-                     ]]
+                      $brief Get the item's decorate mode.
+
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      $remark This function just returns the name of the item's decorate mode.
+
+                      $see elm_genlist_item_decorate_mode_set()
+                      $see elm_genlist_decorated_item_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
-                     decorate_it_type: const(char)*; [[Name of the item's decorate mode.]]
+                     decorate_it_type: const(char)*; [[ name of the item's decorate mode. ]]
                 }
            }
            @property flip {
-                get @internal {
-                     [[Get the flip state of a given genlist item.
+                get {
+                     [[
+                      $internal
 
-                       This function returns the flip state of a given
-                       genlist item. If the parameter is invalid, it
-                       returns $false.
-                     ]]
+                      $brief Get the flip state of a given genlist item.
+
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      $remark This function returns the flip state of a given genlist item.
+                      If the parameter is invalid, it returns $c EINA_FALSE.
+
+                      $see elm_genlist_item_flip_set()
+
+                      $ingroup Genlist
+                      ]]
                 }
-                set @internal {
-                     [[Set the flip state of a given genlist item.
+                set {
+                     [[
+                      $internal
 
-                       This function sets the flip state of a given genlist
-                       item. Flip mode overrides current item object.
-                       It can be used for on-the-fly item replace.
-                       Flip mode can be used with/without decorate mode.
-                     ]]
+                      $brief Set the flip state of a given genlist item.
+
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      $remark ($c EINA_TRUE = on, $c EINA_FALSE = off)
+
+                      $remark This function sets the flip state of a given genlist item.
+                      Flip mode overrides current item object.
+                      It can be used for on-the-fly item replace.
+                      Flip mode can be used with/without decorate mode.
+
+                      $see elm_genlist_item_flip_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      flip: bool; [[The flip mode.]]
@@ -213,44 +291,49 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property select_mode {
                 get {
-                     [[Get the genlist item's select mode.
-                       It's ELM_OBJECT_SELECT_MODE_MAX on failure.
+                     [[
+                      $brief Get the genlist item's select mode.
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      *return The select mode
+                      (If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)
+
+                      $see elm_genlist_item_select_mode_set()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 set {
-                     [[Set the genlist item's select mode.
-
-                       ELM_OBJECT_SELECT_MODE_DEFAULT means that the item
-                       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 the item entirely and they will neither
-                       appear selected nor call selected callback functions.
-
-                       ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY will apply
-                       no-finger-size rule with ELM_OBJECT_SELECT_MODE_NONE.
-                       No-finger-size rule makes an item can be smaller
-                       than lower limit. Clickable objects should be bigger
-                       than human touch point device (your finger) for
-                       some touch or small screen devices. So it is
-                       enabled, the item can be shrink than predefined
-                       finger-size value. And the item will be updated.
-
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                     [[
+                      $brief Set the genlist item's select mode.
+
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
+                      $remark elm_genlist_select_mode_set() changes item's select mode.
+                      - ELM_OBJECT_SELECT_MODE_DEFAULT : The item 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 the item
+                           entirely and they will neither appear selected nor call selected
+                           callback functions.
+                      - ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY : This will apply no-finger-size rule
+                           with ELM_OBJECT_SELECT_MODE_NONE. No-finger-size rule makes an item can be
+                           smaller than lower limit. Clickable objects should be bigger than
+                           human touch point device (your finger) for some touch or
+                           small screen devices. So it is enabled, the item can be shrink than
+                           predefined finger-size value. And the item will be updated.
+
+                      $see elm_genlist_item_select_mode_get()
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The selected mode.]]
@@ -258,16 +341,20 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property type {
                 get {
-                     [[Get the Item's type.
+                     [[
+                      $brief Get the Item's Type
 
-                       This function returns the item's type. Normally the
-                       item's type. If it failed, return value is
-                       ELM_GENLIST_ITEM_MAX.
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
 
-                       \@if MOBILE \@since_tizen 2.3
-                       \@elseif WEARABLE \@since_tizen 2.3.1
-                       \@endif
-                     ]]
+                      *return The item type.
+
+                      $remark This function returns the item's type. Normally the item's type.
+                      If it failed, return value is ELM_GENLIST_ITEM_MAX
+
+                      $ingroup Genlist
+                      ]]
                 }
                 values {
                      type: Elm.Genlist.Item.Type(Elm.Genlist.Item.Type.max); [[Item type.]]
@@ -289,178 +376,220 @@ class Elm.Genlist_Item(Elm.Widget_Item)
                 return: uint; [[The number of subitems, 0 on error.]]
            }
            subitems_clear{
-                [[Remove all sub-items (children) of the given item.
+                [[
+                 $brief Remove all sub-items (children) of the given item
 
-                  This removes all items that are children (and their
-                  descendants) of the given item $it.
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $param it The item
+
+                 $remark This removes all items that are children (and their descendants) of the
+                 given item $p it.
+
+                 $see elm_genlist_clear()
+                 $see elm_object_item_del()
+
+                 $ingroup Genlist
+                 ]]
            }
            promote {
-                [[Promote an item to the top of the list.
+                [[
+                 $brief Promote an item to the top of the list
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
+
+                 $param it The item
+
+                 $ingroup Genlist
+                 ]]
            }
            demote {
-                [[Demote an item to the end of the list.
+                [[
+                 $brief Demote an item to the end of the list
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
+
+                 $param it The item
+
+                 $ingroup Genlist
+                 ]]
            }
            show {
-                [[Show the portion of a genlist's internal list containing
-                  a given item, immediately.
+                [[
+                 $brief Show the portion of a genlist's internal list containing a given
+                 item, immediately.
 
-                  This causes genlist to jump to the given item $it and
-                  show it (by jumping to that position), if it is not
-                  fully visible.
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $remark This causes genlist to jump to the given item $p it and show it (by
+                 jumping to that position), if it is not fully visible.
+
+                 $see elm_genlist_item_bring_in()
+
+                 $ingroup Genlist
+                 ]]
                 params {
-                     @in type: Elm.Genlist.Item.Scrollto_Type; [[The position to bring in, the given item to.
-                                                                 \@ref Elm_Genlist_Item_Scrollto_Type.]]
+                     @in type: Elm_Genlist_Item_Scrollto_Type; [[The position to bring in, the given item to.
+                                                                 \$ref Elm_Genlist_Item_Scrollto_Type.]]
                 }
            }
            bring_in {
-                [[Animatedly bring in, to the visible area of a genlist, a
-                  given item on it.
+                [[
+                 $brief Animatedly bring in, to the visible area of a genlist, a given
+                 item on it.
 
-                  This causes genlist to jump to the given item $it and
-                  show it (by animatedly scrolling), if it is not fully
-                  visible. This may use animation and take a some time
-                  to do so.
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $remark This causes genlist to jump to the given item $p it and show it (by
+                 animatedly scrolling), if it is not fully visible.
+                 This may use animation and take a some time to do so.
+
+                 $see elm_genlist_item_show()
+
+                 $ingroup Genlist
+                 ]]
                 params {
-                     @in type: Elm.Genlist.Item.Scrollto_Type; [[The position to bring in, the given item to.
-                                                                 \@ref Elm_Genlist_Item_Scrollto_Type.]]
+                     @in type: Elm_Genlist_Item_Scrollto_Type; [[The position to bring in, the given item to.
+                                                                 \$ref Elm_Genlist_Item_Scrollto_Type.]]
                 }
            }
-           all_contents_unset {
-                [[Unset all contents fetched by the item class.
+           all_contents_unset{
+                [[
+                 $brief Unset all contents fetched by the item class
 
-                  This instructs genlist to release references to contents
-                  in the item, meaning that they will no longer be managed
-                  by genlist and are floating "orphans" that can be re-used
-                  elsewhere if the user wants to.
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $remark This instructs genlist to release references to contents in the item,
+                 meaning that they will no longer be managed by genlist and are
+                 floating "orphans" that can be re-used elsewhere if the user wants
+                 to.
+
+                 $ingroup Genlist
+                 ]]
                 params {
                      @out l: own(list<own(Evas.Object *)> *); [[The contents list to return.]]
                 }
            }
            update {
-                [[Update all the contents of an item.
-
-                  This updates an item 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.
-
-                  Use elm_genlist_realized_items_update() to update all
-                  already realized items.
-
-                  Note: This also updates internal genlist item object
-                  (edje_object as of now). So when this is called between
-                  mouse down and mouse up, mouse up event will be ignored
-                  because edje_object is deleted and created again by this
-                  API. If you want to avoid this, please use
-                  \@ref elm_genlist_item_fields_update.
-
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                [[
+                 $brief Update all the contents of an item
+
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
+
+                 $remark This updates an item 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.
+
+                 $remark Use elm_genlist_realized_items_update() to update all already realized
+                 items.
+
+                 $remark This also updates internal genlist item object(edje_object as of now).
+                 So when this is called between mouse down and mouse up, mouse up event will
+                 be ignored because edje_object is deleted and created again by this API. If
+                 you want to avoid this, please use $ref elm_genlist_item_fields_update.
+
+                 $see elm_genlist_realized_items_update()
+
+                 $ingroup Genlist
+                 ]]
            }
            fields_update {
-                [[Update the part of an item.
+                [[
+                 $brief Update the part of an item
 
-                  This updates an item's part by calling item's fetching
-                  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. Second part
-                  argument is used for globbing to match '*', '?', and '.'
-                  It can be used at updating multi fields.
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
 
-                  Use \@ref elm_genlist_realized_items_update to update an
-                  item's all property.
+                 $remark This updates an item's part by calling item's fetching 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.
+                 Second parts argument is used for globbing to match '*', '?', and '.'
+                 It can be used at updating multi fields.
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $remark Use elm_genlist_realized_items_update() to update an item's all
+                 property.
+
+                 $see elm_genlist_item_update()
+
+                 $ingroup Genlist
+                 ]]
                 params {
                      @in parts: const (char) *; [[The name of item's part.]]
                      @in itf: Elm.Genlist.Item.Field_Type; [[The type of item's part type.]]
                 }
            }
            item_class_update {
-                [[Update the item class of an item.
+                [[
+                 $brief Update the item class of an item
 
-                  This sets another class of the item, changing the way
-                  that it is displayed. After changing the item class
-                  @.update is called on the item $it.
+                 $if MOBILE $since_tizen 2.3
+                 $elseif WEARABLE $since_tizen 2.3.1
+                 $endif
 
-                  \@if MOBILE \@since_tizen 2.3
-                  \@elseif WEARABLE \@since_tizen 2.3.1
-                  \@endif
-                ]]
+                 $remark This sets another class of the item, changing the way that it is
+                 displayed. After changing the item class, elm_genlist_item_update() is
+                 called on the item $p it.
+
+                 $ingroup Genlist
+                 ]]
                 params {
                      @in itc: const (Elm_Genlist_Item_Class) *; [[The item class for the item.]]
                 }
            }
            decorate_mode_set @internal {
-                [[Activate a genlist mode on an item.
-
-                  A genlist mode is a different way of selecting an item.
-                  Once a mode is activated on an item, any other selected
-                  item is immediately unselected. This feature provides an
-                  easy way of implementing a new kind of animation for
-                  selecting an item, without having to entirely rewrite
-                  the item style theme. However, the elm_genlist_selected_*
-                  API can't be used to get what item is activate for a mode.
-
-                  The current item style will still be used, but applying
-                  a genlist mode to an item will select it using a
-                  different kind of animation.
-
-                  The current active item for a mode can be found by
-                  \@ref elm_genlist_decorated_item_get.
-
-                  Only one mode can be active at any time, and for only one
-                  item. Genlist handles deactivating other items when one
-                  item is activated. A mode is defined in the genlist theme
-                  (edc), and more modes can easily be added. A mode style
-                  and the genlist item style are different things. They
-                  can be combined to provide a default style to the item,
-                  with some kind of animation for that item when the mode
-                  is activated.
-
-                  When a mode is activated on an item, a new view for that
-                  item is created. The theme of this mode defines the
-                  animation that will be used to transit the item from
-                  the old view to the new view. This second (new) view will
-                  be active for that item while the mode is active on the
-                  item, and will be destroyed after the mode is totally
-                  deactivated from that item.
-                ]]
+                [[
+                 $internal
+
+                 $brief Activate a genlist mode on an item
+
+                 $remark A genlist mode is a different way of selecting an item. Once a mode is
+                 activated on an item, any other selected item is immediately unselected.
+                 This feature provides an easy way of implementing a new kind of animation
+                 for selecting an item, without having to entirely rewrite the item style
+                 theme. However, the elm_genlist_selected_* API can't be used to get what
+                 item is activate for a mode.
+
+                 $remark The current item style will still be used, but applying a genlist mode to
+                 an item will select it using a different kind of animation.
+
+                 $remark The current active item for a mode can be found by
+                 elm_genlist_decorated_item_get().
+
+                 $remark The characteristics of genlist mode are:
+                 - Only one mode can be active at any time, and for only one item.
+                 - Genlist handles deactivating other items when one item is activated.
+                 - A mode is defined in the genlist theme (edc), and more modes can easily
+                   be added.
+                 - A mode style and the genlist item style are different things. They
+                   can be combined to provide a default style to the item, with some kind
+                   of animation for that item when the mode is activated.
+
+                 $remark When a mode is activated on an item, a new view for that item is created.
+                 The theme of this mode defines the animation that will be used to transit
+                 the item from the old view to the new view. This second (new) view will be
+                 active for that item while the mode is active on the item, and will be
+                 destroyed after the mode is totally deactivated from that item.
+
+                 $see elm_genlist_mode_get()
+                 $see elm_genlist_decorated_item_get()
+
+                 $ingroup Genlist
+                 ]]
                 params {
                      @in decorate_it_type: const(char)*; [[Mode name.]]
                      @in decorate_it_set: bool; [[Boolean to define set or unset mode.]]
index e8e60e3206caa227598df4bceec0428597b51558..6d35eb423cc2c8ed7f5c6615206f3cb244ec8186 100644 (file)
@@ -9052,7 +9052,7 @@ _elm_genlist_elm_interface_scrollable_content_pos_set(Eo *obj, Elm_Genlist_Data
           }
      }
 }
-// TIZEN_ONLY(20161213): Dummies to provide the same programming interfaces for all profiles in Tizen platform repos. (common headers, different behaviors)
+// TIZEN_ONLY(20161213): Dummies to provide the same programming interfaces for all profiles in Tizen platform repos. (common headers, different behaviors) for elm_genlist.eo
 EOLIAN static void
 _elm_genlist_elm_widget_item_loop_enabled_set(Eo *obj EINA_UNUSED, Elm_Genlist_Data *sd EINA_UNUSED, Eina_Bool enable EINA_UNUSED)
 {}
@@ -9105,6 +9105,14 @@ _elm_genlist_search_by_text_item_get(Eo *obj EINA_UNUSED,
 }
 //
 
+// TIZEN_ONLY(20161213): Dummies to provide the same programming interfaces for all profiles in Tizen platform repos. (common headers, different behaviors) for elm_genlist_item.eo
+EOLIAN static unsigned int
+_elm_genlist_item_subitems_count(Eo *eo_item EINA_UNUSED, Elm_Gen_Item *item EINA_UNUSED)
+{
+   return 0;
+}
+//
+
 // Tizen only (20150914)
 #include "elm_genlist.eo.c"
 #include "elm_genlist_item.eo.c"
index 27c11b4a63afe536cb01a626d50dea72c56416df..1237873b2f6331c82b361022d57ebc8f338075a6 100644 (file)
@@ -70,11 +70,15 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            }
            @property subitems {
                 get {
-                     [[et the list of subitems of a given item
+                     [[Get the list of subitems of a given item
 
                        This returns the list of subitems that an item
                        possesses. It cannot be changed.
 
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
                        @since 1.9
                      ]]
                 }
@@ -198,7 +202,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
                       ]]
                 }
                 values {
-                      itc: const (Elm_Genlist_Item_Class) *; [[ Genlist Item class for the given item ]]
+                     itc: const (Elm_Genlist_Item_Class) *; [[Genlist Item class for the given item.]]
                 }
            }
            @property index {
@@ -224,6 +228,10 @@ class Elm.Genlist_Item(Elm.Widget_Item)
 
                       $brief Get the item's decorate mode.
 
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
                       $remark This function just returns the name of the item's decorate mode.
 
                       $see elm_genlist_item_decorate_mode_set()
@@ -243,6 +251,10 @@ class Elm.Genlist_Item(Elm.Widget_Item)
 
                       $brief Get the flip state of a given genlist item.
 
+                      $if MOBILE $since_tizen 2.3
+                      $elseif WEARABLE $since_tizen 2.3.1
+                      $endif
+
                       $remark This function returns the flip state of a given genlist item.
                       If the parameter is invalid, it returns $c EINA_FALSE.
 
@@ -345,7 +357,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
                       ]]
                 }
                 values {
-                     type: Elm_Genlist_Item_Type(4); [[Item type.]]
+                     type: Elm.Genlist.Item.Type(Elm.Genlist.Item.Type.max); [[Item type.]]
                 }
            }
            /*      init { FIXME
@@ -354,6 +366,15 @@ class Elm.Genlist_Item(Elm.Widget_Item)
                    const(void)* data;
                    }
                    }*/
+           subitems_count @internal {
+                [[Get the number of subitems of a given item.
+
+                  This returns the number of subitems that an item possesses.
+
+                  @since 1.9
+                ]]
+                return: uint; [[The number of subitems, 0 on error.]]
+           }
            subitems_clear{
                 [[
                  $brief Remove all sub-items (children) of the given item
@@ -509,7 +530,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
                  ]]
                 params {
                      @in parts: const (char) *; [[The name of item's part.]]
-                     @in itf: Elm_Genlist_Item_Field_Type; [[The type of item's part type.]]
+                     @in itf: Elm.Genlist.Item.Field_Type; [[The type of item's part type.]]
                 }
            }
            item_class_update {
@@ -530,7 +551,7 @@ class Elm.Genlist_Item(Elm.Widget_Item)
                      @in itc: const (Elm_Genlist_Item_Class) *; [[The item class for the item.]]
                 }
            }
-           decorate_mode_set {
+           decorate_mode_set @internal {
                 [[
                  $internal
 
@@ -602,4 +623,3 @@ class Elm.Genlist_Item(Elm.Widget_Item)
            //
       }
 }
-