inc/FUiCtrlISectionTableViewItemEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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 FUiCtrlISectionTableViewItemEventListener.h
  19 * @brief This is the header file for the %ISectionTableViewItemEventListener interface.
  20 *
  21 * This header file contains the declarations of the %ISectionTableViewItemEventListener 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_ISECTION_TABLE_VIEW_ITEM_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_ISECTION_TABLE_VIEW_ITEM_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30
  31 namespace Tizen { namespace Ui { namespace Controls
  32 {
  33 class SectionTableView;
  34 class TableViewItem;
  35 class TableViewContextItem;
  36
  37
  38 /**
  39 * @interface ISectionTableViewItemEventListener
  40 * @brief  This interface implements the listener for item event.
  41 *
  42 * @since 2.0
  43 *
  44 * The %ISectionTableViewItemEventListener interface implements a listener for receiving item change events.
  45 * The class that is interested in processing an item event implements this interface,
  46 * and the instance created with that class is registered with a UI control, using the control's
  47 * AddSectionTableViewItemEventListener() method. When the item event occurs, the OnItemStateChanged() method of that object is invoked.
  48 */
  49 class _OSP_EXPORT_ ISectionTableViewItemEventListener
  50         : virtual public Tizen::Base::Runtime::IEventListener
  51 {
  52 public:
  53         /**
  54         * This polymorphic destructor should be overridden if required.@n
  55         * 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 ~ISectionTableViewItemEventListener(void) {}
  61         /**
  62         * Called when the state of a TableViewItem in the SectionTableView is changed.
  63         *
  64         * @since 2.0
  65         *
  66         * @param[in] tableView                          The source of the event
  67         * @param[in] sectionIndex                       The section index
  68         * @param[in] itemIndex                          The item 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 TableViewItem in the SectionTableView is checked, unchecked, or selected.
  72         */
  73         virtual void OnSectionTableViewItemStateChanged(Tizen::Ui::Controls::SectionTableView& tableView, int sectionIndex, int itemIndex, Tizen::Ui::Controls::TableViewItem* pItem, Tizen::Ui::Controls::TableViewItemStatus status) = 0;
  74
  75         /**
  76         * Called when the TableViewContextItem is opened or closed.
  77         *
  78         * @since 2.0
  79         *
  80         * @param[in] tableView                          The source of the event
  81         * @param[in] sectionIndex                       The section index
  82         * @param[in] itemIndex                          The item index
  83         * @param[in] pContextItem                       The context item which is opened or closed
  84         * @param[in] activated                          @c true if a context item is opened, @n
  85         *                                  else @c false
  86         */
  87         virtual void OnSectionTableViewContextItemActivationStateChanged(Tizen::Ui::Controls::SectionTableView& tableView, int sectionIndex, int itemIndex, Tizen::Ui::Controls::TableViewContextItem* pContextItem, bool activated) = 0;
  88
  89 protected:
  90         //
  91         // This method is for internal use only. Using this method can cause behavioral, security-related,
  92         // and consistency-related issues in the application.
  93         //
  94         // This method is reserved and may change its name at any time without prior notice.
  95         //
  96         // @since 2.0
  97         //
  98         virtual void ISectionTableViewItemEventListener_Reserved1(void) {}
  99
 100         //
 101         // This method is for internal use only. Using this method can cause behavioral, security-related,
 102         // and consistency-related issues in the application.
 103         //
 104         // This method is reserved and may change its name at any time without prior notice.
 105         //
 106         // @since 2.0
 107         //
 108         virtual void ISectionTableViewItemEventListener_Reserved2(void) {}
 109
 110         //
 111         // This method is for internal use only. Using this method can cause behavioral, security-related,
 112         // and consistency-related issues in the application.
 113         //
 114         // This method is reserved and may change its name at any time without prior notice.
 115         //
 116         // @since 2.0
 117         //
 118         virtual void ISectionTableViewItemEventListener_Reserved3(void) {}
 119 }; // ISectionTableViewItemEventListener
 120
 121 }}} //Tizen::Ui::Controls
 122
 123 #endif // _FUI_CTRL_ISECTION_TABLE_VIEW_ITEM_EVENT_LISTENER_H_