inc/FUiCtrlIGroupedTableViewItemEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://floralicense.org/license/
  10 //
  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.
  16 //
  17 /**
  18 * @file FUiCtrlIGroupedTableViewItemEventListener.h
  19 * @brief This is the header file for the %IGroupedTableViewItemEventListener interface.
  20 *
  21 * This header file contains the declarations of the %IGroupedTableViewItemEventListener interface. @n
  22 * If an item event is generated, a method of this interface is called.
  23 * So, if an application does some jobs related to the item event, use the methods of this interface.
  24 *
  25 */
  26 #ifndef _FUI_CTRL_IGROUPED_TABLE_VIEW_ITEM_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_IGROUPED_TABLE_VIEW_ITEM_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30
  31 namespace Tizen { namespace Ui { namespace Controls
  32 {
  33 class GroupedTableView;
  34 class TableViewItem;
  35 class TableViewGroupItem;
  36 class TableViewContextItem;
  37
  38
  39 /**
  40 * @interface IGroupedTableViewItemEventListener
  41 * @brief  This interface implements the listener for item event.
  42 *
  43 * @since 2.0
  44 *
  45 * The %IGroupedTableViewItemEventListener interface implements a listener for receiving item change events.
  46 * The class that is interested in processing an item event implements this interface,
  47 * and the instance created with that class is registered with a UI control, using the control's
  48 * AddGroupedTableViewItemEventListener() method. When the item event occurs, the OnItemStateChanged() method of that object is invoked.
  49 */
  50 class _OSP_EXPORT_ IGroupedTableViewItemEventListener
  51         : virtual public Tizen::Base::Runtime::IEventListener
  52 {
  53 public:
  54         /**
  55         * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  56         *
  57         * @since 2.0
  58         */
  59
  60         virtual ~IGroupedTableViewItemEventListener(void) {}
  61
  62         /**
  63         * Called when the state of a TableViewGroupItem is changed.
  64         *
  65         * @since 2.0
  66         *
  67         * @param[in] tableView             The source of the event
  68         * @param[in] groupIndex            The group index
  69         * @param[in] pItem                 The target item
  70         * @param[in] status                The status of the item
  71         * @remarks  This method is called when the TableViewGroupItem in the GroupedTableView is checked, unchecked, or selected.
  72         */
  73         virtual void OnGroupedTableViewGroupItemStateChanged(Tizen::Ui::Controls::GroupedTableView& tableView, int groupIndex, Tizen::Ui::Controls::TableViewGroupItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status) = 0;
  74
  75         /**
  76         * Called when the state of a TableViewItem in the GroupedTableView is changed.
  77         *
  78         * @since 2.0
  79         *
  80         * @param[in] tableView             The source of the event
  81         * @param[in] groupIndex            The group index
  82         * @param[in] itemIndex             The item index
  83         * @param[in] pItem                 The target item
  84         * @param[in] status                The status of the item
  85         * @remarks  This method is called when the TableViewItem in the GroupedTableView is checked, unchecked, or selected.
  86         */
  87         virtual void OnGroupedTableViewItemStateChanged(Tizen::Ui::Controls::GroupedTableView& tableView, int groupIndex, int itemIndex, Tizen::Ui::Controls::TableViewItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status) = 0;
  88
  89         /**
  90         * Called when the TableViewContextItem is opened or closed.
  91         *
  92         * @since 2.0
  93         *
  94         * @param[in] tableView                          The source of the event
  95         * @param[in] groupIndex                         The group index
  96         * @param[in] itemIndex                          The item index
  97         * @param[in] pContextItem                       The context item which is opened or closed
  98         * @param[in] activated                          @c true if a context item is opened, @n
  99         *                                   else @c false
 100         */
 101         virtual void OnGroupedTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::GroupedTableView& tableView, int groupIndex, int itemIndex, Tizen::Ui::Controls::TableViewContextItem* pContextItem, bool activated) = 0;
 102
 103         /**
 104         * Called when the item is reordered.
 105         *
 106         * @since 2.1
 107         *
 108         * @param[in] tableView                          The source of the event
 109         * @param[in] groupIndexFrom                     The source group index of the item
 110         * @param[in] itemIndexFrom                      The source item index of the item
 111         * @param[in] groupIndexTo                       The target group index of the item
 112         * @param[in] itemIndexTo                        The target item index of the item
 113         */
 114         virtual void OnGroupedTableViewItemReordered(Tizen::Ui::Controls::GroupedTableView& tableView, int groupIndexFrom, int itemIndexFrom, int groupIndexTo, int itemIndexTo) {}
 115
 116 protected:
 117         //
 118         // This method is for internal use only. Using this method can cause behavioral, security-related,
 119         // and consistency-related issues in the application.
 120         //
 121         // The following method is reserved, and its name can be changed at any time without prior notice.
 122         //
 123         // @since 2.0
 124         //
 125         virtual void IGroupedTableViewItemEventListener_Reserved1(void) {}
 126
 127         //
 128         // This method is for internal use only. Using this method can cause behavioral, security-related,
 129         // and consistency-related issues in the application.
 130         //
 131         // The following method is reserved, and its name can be changed at any time without prior notice.
 132         //
 133         // @since 2.0
 134         //
 135         virtual void IGroupedTableViewItemEventListener_Reserved2(void) {}
 136
 137 }; // IGroupedTableViewItemEventListener
 138
 139 }}} //Tizen::Ui::Controls
 140
 141 #endif // _FUI_CTRL_IGROUPED_TABLE_VIEW_ITEM_EVENT_LISTENER_H_