Update TableView classes doxygen

Change-Id: Iee1af696cc8c846f3e09e8354ac9c77a71492c98
Signed-off-by: jaewon7.cho <jaewon7.cho@samsung.com>

diff --git a/inc/FUiCtrlGroupedTableView.h b/inc/FUiCtrlGroupedTableView.h
old mode 100644 (file)
new mode 100755 (executable)
index ee7ee73..daae50b
--- a/inc/FUiCtrlGroupedTableView.h
+++ b/inc/FUiCtrlGroupedTableView.h
@@ -392,7 +392,7 @@ public:
        * @exception E_SUCCESS             The method is successful.
        * @exception E_OUT_OF_RANGE        A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result ExpandGroup(int groupIndex);
@@ -407,7 +407,7 @@ public:
        * @exception E_SUCCESS         The method is successful.
        * @exception E_OUT_OF_RANGE           A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result CollapseGroup(int groupIndex);
@@ -420,7 +420,7 @@ public:
        * @return An error code
        * @exception E_SUCCESS             The method is successful.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        */
        result ExpandAllGroups(void);
 
@@ -432,7 +432,7 @@ public:
        * @return An error code
        * @exception E_SUCCESS             The method is successful.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        */
        result CollapseAllGroups(void);
 
@@ -683,7 +683,7 @@ public:
        * @exception E_OUT_OF_RANGE        A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
        * @remarks If the specified item. itemIndex is -1, then the method is applied to the group item with the given index. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result ScrollToItem(int groupIndex, int itemIndex, TableViewScrollItemAlignment itemAlignment = TABLE_VIEW_SCROLL_ITEM_ALIGNMENT_TOP);
@@ -702,7 +702,7 @@ public:
        * @exception E_OUT_OF_RANGE           A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The item is disabled or the current state of the instance prohibits the execution of the specified operation.
        * @remarks This method works only when the annex style of the item allows selection. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result SetItemChecked(int groupIndex, int itemIndex, bool check);
@@ -736,7 +736,7 @@ public:
        * @exception E_SUCCESS   The method is successful.
        * @exception E_OUT_OF_RANGE  A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result SetItemEnabled(int groupIndex, int itemIndex, bool enable);
@@ -795,7 +795,7 @@ public:
        * @remarks If the specified item. itemIndex is -1, then the method is applied to the group item with the given index.
        * Note that if TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE option is used to a group item, all the items in the group (including the group item itself) are
        * removed from the table view. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        */
        result RefreshItem(int groupIndex, int itemIndex, TableViewRefreshType type);
 
@@ -812,14 +812,16 @@ public:
        result RefreshAllItems(void);
 
        /**
-       * Updates all the items of a table view.
+       * Updates all the items of a table view. @n
+       * This method deletes all the items in the table view and invokes the methods of the item provider again to update the table view.
        *
        * @since 2.0
        *
        * @exception E_SUCCESS The method is successful.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method clears all the items in the table view and invokes the methods of the item provider again to update the table view. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method will delete all the items and recreate them, so it should not be called from the inside of 
+       * OnGroupedTableViewItemStateChanged() callback as this leads to self deletion. If you need to update an Item, you should use RefreshItem() method.
+       * @remarks This method should not be called from IGroupedTableViewItemProvider implementation because of recursion.
        * @remarks The specific error code can be accessed using the GetLastResult() method.
        */
        void UpdateTableView(void);
@@ -921,7 +923,7 @@ public:
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
        * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
        * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        */
        result ScrollByPixel(int pixel);
 
@@ -937,7 +939,7 @@ public:
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
        * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
        * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the IGroupedTableViewItemProvider call-back procedure.
        */
        result ScrollByPixel(float pixel);
 

diff --git a/inc/FUiCtrlSectionTableView.h b/inc/FUiCtrlSectionTableView.h
index 15ab035..89fe7f0 100755 (executable)
--- a/inc/FUiCtrlSectionTableView.h
+++ b/inc/FUiCtrlSectionTableView.h
@@ -539,7 +539,7 @@ public:
        * @exception E_SUCCESS                                          The method is successful.
        * @exception E_OUT_OF_RANGE                                     A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the ISectionTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result ScrollToItem(int sectionIndex, int itemIndex, TableViewScrollItemAlignment itemAlignment = TABLE_VIEW_SCROLL_ITEM_ALIGNMENT_TOP);
@@ -558,7 +558,7 @@ public:
        * @exception E_OUT_OF_RANGE            A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The item is disabled or the current state of the instance prohibits the execution of the specified operation.
        * @remarks This method works only when the annex style of the item allows selection. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the ISectionTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result SetItemChecked(int sectionIndex, int itemIndex, bool check);
@@ -592,7 +592,7 @@ public:
        * @exception E_SUCCESS   The method is successful.
        * @exception E_OUT_OF_RANGE  A specified input parameter is invalid.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method does not work during the ISectionTableViewItemProvider call-back procedure.
        * @remarks This method should be called only after TableView items are created. If this method needs to be called early in the lifecycle of the TableView, then UpdateTableView() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
        */
        result SetItemEnabled(int sectionIndex, int itemIndex, bool enable);
@@ -651,7 +651,7 @@ public:
        * @remarks If the specified item. itemIndex is -1, then the method is applied to the section item with the given index.
        *   Note that if @c TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE option is used to a section item, all the items in the section (including the section item itself) are
        *   removed from the table view. @n
-       *   This method does not work during the ITableViewItemProvider call-back procedure.
+       *   This method does not work during the ISectionTableViewItemProvider call-back procedure.
        */
        result RefreshItem(int sectionIndex, int itemIndex, TableViewRefreshType type);
 
@@ -668,14 +668,16 @@ public:
        result RefreshAllItems(void);
 
        /**
-       * Updates all the items of a table view.
+       * Updates all the items of a table view. @n
+       * This method deletes all the items in the table view and invokes the methods of the item provider again to update the table view.
        *
        * @since 2.0
        *
        * @exception E_SUCCESS The method is successful.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method clears all the items in the table view and invokes the methods of the item provider again to update the table view. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method will delete all the items and recreate them, so it should not be called from the inside of 
+       * OnSectionTableViewItemStateChanged() callback as this leads to self deletion. If you need to update an Item, you should use RefreshItem() method.
+       * @remarks This method should not be called from ISectionTableViewItemProvider implementation because of recursion.
        * @remarks The specific error code can be accessed using the GetLastResult() method.
        */
        void UpdateTableView(void);
@@ -777,7 +779,7 @@ public:
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
        * @remarks If you call %ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
        * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the ISectionTableViewItemProvider call-back procedure.
        */
        result ScrollByPixel(int pixel);
 
@@ -793,7 +795,7 @@ public:
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation
        * @remarks If you call %ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
        * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * This method does not work during the ISectionTableViewItemProvider call-back procedure.
        */
        result ScrollByPixel(float pixel);
 

diff --git a/inc/FUiCtrlTableView.h b/inc/FUiCtrlTableView.h
index 0ee7576..7db04f8 100755 (executable)
--- a/inc/FUiCtrlTableView.h
+++ b/inc/FUiCtrlTableView.h
@@ -621,14 +621,16 @@ public:
        result RefreshAllItems(void);
 
        /**
-       * Updates all the items of a table view.
+       * Updates all the items of a table view. @n
+       * This method deletes all the items in the table view and invokes the methods of the item provider again to update the table view.
        *
        * @since 2.0
        *
        * @exception E_SUCCESS The method is successful.
        * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation @b Since: @b 2.1.
-       * @remarks This method clears all the items in the table view and invokes the methods of the item provider again to update the table view. @n
-       * This method does not work during the ITableViewItemProvider call-back procedure.
+       * @remarks This method will delete all the items and recreate them, so it should not be called from the inside of 
+       * OnTableViewItemStateChanged() callback as this leads to self deletion. If you need to update an Item, you should use RefreshItem() method.
+       * @remarks This method should not be called from ITableViewItemProvider implementation because of recursion.
        * @remarks The specific error code can be accessed using the GetLastResult() method.
        */
        void UpdateTableView(void);