2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Flora License, Version 1.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://floralicense.org/license/
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an AS IS BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
20 * @file FUiCtrlIGroupedListViewItemProviderF.h
21 * @brief This is the header file for the %IGroupedListViewItemProviderF interface.
23 * This header file contains the declarations of the %IGroupedListViewItemProviderF interface. @n
24 * If an event is generated, a method of this class is called. @n
25 * Therefore, if an application performs jobs related to the item events, it uses the methods of this class.
28 #ifndef _FUI_CTRL_IGROUPED_LIST_VIEW_ITEM_PROVIDERF_H_
29 #define _FUI_CTRL_IGROUPED_LIST_VIEW_ITEM_PROVIDERF_H_
31 #include <FUiCtrlGroupItem.h>
32 #include <FUiCtrlListItemBase.h>
34 namespace Tizen {namespace Ui { namespace Controls
38 * @interface IGroupedListViewItemProviderF
39 * @brief This interface implements the provider for the events generated by the GroupedListView control.
43 * The %IGroupedListViewItemProviderF interface is the interface for handling GroupedListView items.
44 * The class that handles list items implements this interface, and the instance created using the GroupedListView's Construct()
47 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_listviews.htm">ListViews</a>.
49 class _OSP_EXPORT_ IGroupedListViewItemProviderF
54 * This polymorphic destructor should be overridden if required.
55 * This way, the destructors of the derived classes are called
56 * when the destructor of this interface is called.
60 virtual ~IGroupedListViewItemProviderF(void) {}
63 * Gets the total number of groups.
67 * @return The total number of groups
68 * @remarks This method must be implemented so that it returns the total number of groups in the GroupedListView control.
70 virtual int GetGroupCount(void) = 0;
73 * Gets the total number of items in the specified group.
77 * @return The total number of items in the specified group
78 * @param[in] groupIndex The index of the group
79 * @remarks This method must be implemented so that it returns the total number of items for the specified group in the GroupedListView control.
81 virtual int GetItemCount(int groupIndex) = 0;
84 * Creates the group item for the specified index from the item provider.
88 * @return A group item of the GroupedListView control
89 * @param[in] groupIndex The index of the group
90 * @param[in] itemWidth The width of the item
91 * @remarks An application that uses the GroupedListView control must implement this method. This method is expected to return a group item that is
92 * allocated on a heap memory. @n
93 * Note that when the item is not required, the GroupedListView control calls %IGroupedListViewItemProvider::DeleteGroupItem() and the
94 * application deallocates the item.
96 virtual Tizen::Ui::Controls::GroupItem* CreateGroupItem(int groupIndex, float itemWidth) = 0;
99 * Deletes the specified group item.
103 * @return @c true if the item is deallocated by this method, @n
105 * @param[in] groupIndex The index of the group
106 * @param[in] pItem The pointer to GroupItem that is to be deleted
107 * @param[in] itemWidth The width of the item
108 * @remarks An application that uses the %GroupedListView control must implement this method. @n
109 * Using this method, an application can deallocate the item. @n
110 * If an application deallocates the item, this method must return true. This notifies the GroupedListView control not to release the
111 * item. Otherwise, the item is deallocated by the GroupedListView control.
114 virtual bool DeleteGroupItem(int groupIndex, Tizen::Ui::Controls::GroupItem* pItem, float itemWidth) = 0;
117 * Creates the specified item.
121 * @return An item of the list
122 * @param[in] groupIndex The index of the group
123 * @param[in] itemIndex The index of the item
124 * @param[in] itemWidth The width of the item
125 * @remarks An application that uses the GroupedListView control must implement this method. @n
126 * This method is expected to return an item that is allocated on a heap memory. @n
127 * The returned item can be a simple or custom item. @n
128 * Note that when the item is not required, the GroupedListView control calls %IGroupedListViewItemProvider::DeleteItem() and the application
129 * deallocates the item.
132 virtual Tizen::Ui::Controls::ListItemBase* CreateItem(int groupIndex, int itemIndex, float itemWidth) = 0;
135 * Deletes the specified item.
139 * @return @c true if the item is deallocated by this method, @n
141 * @param[in] groupIndex The index of the group
142 * @param[in] itemIndex The index of the item
143 * @param[in] pItem The pointer to ListItemBase that is to be deleted
144 * @param[in] itemWidth The width of the item
145 * @remarks An application that uses the GroupedListView control must implement this method. @n
146 * Using this method, an application can deallocate the item. @n
147 * If the application deallocates the item, this method must return true. This notifies the %GroupedListView control not to release the
148 * item. Otherwise, the item is deallocated by the %GroupedListView control.
151 virtual bool DeleteItem(int groupIndex, int itemIndex, Tizen::Ui::Controls::ListItemBase* pItem, float itemWidth) = 0;
154 * Checks whether the item can be reordered.
158 * @return @c true if the item can be reordered, else @c false
159 * @param[in] groupIndexFrom The source group index of the item
160 * @param[in] groupIndexTo The target group index of the item
162 virtual bool IsReorderable(int groupIndexFrom, int groupIndexTo);
166 // Following methods are reserved and may change its name at any time without prior notice.
168 virtual void IGroupedListViewItemProvider_Reserved1(void) {}
169 virtual void IGroupedListViewItemProvider_Reserved2(void) {}
170 virtual void IGroupedListViewItemProvider_Reserved3(void) {}
171 }; // IGroupedListViewItemProviderF
173 }}} // Tizen::Ui::Controls
175 #endif // _FUI_CTRL_IGROUPED_LIST_VIEW_ITEM_PROVIDERF_H_