inc/FUiIGroupedItemEventListener.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 /**
  19  * @file        FUiIGroupedItemEventListener.h
  20  * @brief       This is the header file for the %IGroupedItemEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IGroupedItemEventListener interface.
  23  */
  24
  25 #ifndef _FUI_IGROUPED_ITEM_EVENT_LISTENER_H_
  26 #define _FUI_IGROUPED_ITEM_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29 #include <FUiIItemEventListener.h>
  30
  31 namespace Tizen { namespace Ui
  32 {
  33 class Control;
  34 } }
  35
  36 namespace Tizen {namespace Ui
  37 {
  38
  39 /**
  40  * @if OSPDEPREC
  41  * @interface           IGroupedItemEventListener
  42  * @brief                       <i> [Deprecated] </i> This interface implements the listener for the events on the items of GroupedList.
  43  *
  44  * @deprecated     This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
  45  * @since                       2.0
  46  *
  47  *
  48  * The %IGroupedItemEventListener interface implements a listener for detecting state changes on the item of the grouped list.
  49  * The interface is registered with a GroupedList, using the control's AddGroupedItemEventListener() method.
  50  * @endif
  51  */
  52 class _OSP_EXPORT_ IGroupedItemEventListener
  53         : public Tizen::Base::Runtime::IEventListener
  54 {
  55 public:
  56         /**
  57          * @if OSPDEPREC
  58          * This is the default constructor for this class.
  59          *
  60          * @brief               <i> [Deprecated] </i>
  61          * @deprecated  This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
  62          * @since               2.0
  63          * @endif
  64          */
  65         IGroupedItemEventListener(void) {};
  66
  67         /**
  68          * @if OSPDEPREC
  69          * This is the destructor for this class.
  70          *
  71          * @brief               <i> [Deprecated] </i>
  72          * @deprecated  This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
  73          * @since               2.0
  74          * @endif
  75          */
  76         virtual ~IGroupedItemEventListener(void) {};
  77
  78         /**
  79          * @if OSPDEPREC
  80          * Called when the state of an element in the CustomListItem instance in the GroupedList instance is changed. @n
  81          * For example, the %OnItemStateChanged() method is called when an element of %CustomListItem in %GroupedList is checked, unchecked, or selected.
  82          *
  83          * @brief               <i> [Deprecated] </i>
  84          * @deprecated  This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
  85          * @since               2.0
  86          *
  87          * @param[in]   source                  The source of the event
  88          * @param[in]   groupIndex      The index of the list group
  89          * @param[in]   itemIndex       The index of the list item in the specified group
  90          * @param[in]   itemId          The item ID
  91          * @param[in]   elementId       The element ID
  92          * @param[in]   status          The state of the element
  93          * @remarks     If GroupedList or SlidableGroupedList is constructed with CUSTOM_LIST_STYLE_RADIO_WITH_DIVIDER, this method is not called when the
  94          *                              radio button is selected. Instead, OnItemStateChanged(const Tizen::Ui::Control &source, int groupIndex, int itemIndex, int itemId,
  95          *                              Tizen::Ui::ItemStatus status) is called.
  96          * @endif
  97          */
  98         virtual void OnItemStateChanged(const Tizen::Ui::Control& source, int groupIndex, int itemIndex, int itemId, int elementId, Tizen::Ui::ItemStatus status) = 0;
  99
 100         /**
 101          * @if OSPDEPREC
 102          * Called when the state of an item in the grouped list is changed. @n
 103          * For example, the %OnItemStateChanged() method is called when an item of the GroupedList control is checked, unchecked, or selected.
 104          *
 105          * @brief               <i> [Deprecated] </i>
 106          * @deprecated  This interface is deprecated. Instead of using this interface, use the IGroupedListViewItemEventListener interface.
 107          * @since               2.0
 108          *
 109          * @param[in]   source                  The source of the event
 110          * @param[in]   groupIndex      The index of the list group
 111          * @param[in]   itemIndex       The index of the list item in the specified group
 112          * @param[in]   itemId          The item ID
 113          * @param[in]   status          The state of the item
 114          * @remarks             If GroupedList or SlidableGroupedList is constructed with CUSTOM_LIST_STYLE_RADIO_WITH_DIVIDER, this method is called when the radio
 115          *                              button is selected.
 116          * @endif
 117          */
 118         virtual void OnItemStateChanged(const Tizen::Ui::Control& source, int groupIndex, int itemIndex, int itemId, Tizen::Ui::ItemStatus status) = 0;
 119 }; //IGroupedItemEventListener
 120
 121 }} // Tizen::Ui
 122
 123 #endif //_FUI_IGROUPED_ITEM_EVENT_LISTENER_H_