inc/FUiIFastScrollEventListener.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                FUiIFastScrollEventListener.h
  19  * @brief               This is the header file for the %IFastScrollEventListener interface.
  20  *
  21  * This header file contains declarations of the %IFastScrollEventListener interface.
  22  * If item event is generated, a method of this interface will be called.
  23  * Applications that do some jobs related to item event, call methods of this interface.
  24  *
  25  */
  26 #ifndef _FUI_IFAST_SCROLL_EVENT_LISTENER_H_
  27 #define _FUI_IFAST_SCROLL_EVENT_LISTENER_H_
  28
  29 #include <FBaseCharacter.h>
  30 #include <FBaseRtIEventListener.h>
  31 #include <FUiIItemEventListener.h>
  32
  33 namespace Tizen { namespace Ui
  34 {
  35 class Control;
  36 } }
  37
  38 namespace Tizen {namespace Ui
  39 {
  40
  41 /**
  42  * @if OSPDEPREC
  43  * @interface   IFastScrollEventListener
  44  * @brief               <i> [Deprecated] </i> This interface implements the listener for fast scroll event.
  45  *
  46  * @deprecated  This class is deprecated. Instead of using this class, use the IFastScrollListener class.
  47  * @since               2.0
  48  *
  49  *
  50  * The %IFastScrollEventListener interface for receiving item events. The class that processes a fast scroll
  51  * implements this interface, and the object created with that class is registered with a UI control, using the control's
  52  * AddFastScrollEventListener method. When an item event occurs, the object's OnItemStateChanged() method is invoked.
  53  * @endif
  54  */
  55 class _OSP_EXPORT_ IFastScrollEventListener
  56         : public Tizen::Base::Runtime::IEventListener
  57 {
  58 // Operation
  59 public:
  60         /**
  61          * @if OSPDEPREC
  62          * This is the destructor for this class.
  63          *
  64          * @brief               <i> [Deprecated] </i>
  65          * @deprecated  This class is deprecated. Instead of using this class, use the IFastScrollListener class.
  66          * @since               2.0
  67          * @endif
  68          */
  69         virtual ~IFastScrollEventListener(void) {}
  70
  71         /**
  72          * @if OSPDEPREC
  73          * Called when a main index is selected.
  74          *
  75          * @brief               <i> [Deprecated] </i>
  76          * @deprecated  This class is deprecated. Instead of using this class, use the IFastScrollListener class.
  77          * @since                               2.0
  78          *
  79          * @param[in]   source                          The source of the event
  80          * @param[in]   mainIndex                       The main index
  81          * @endif
  82          */
  83         virtual void OnMainIndexChanged(const Tizen::Ui::Control& source, Tizen::Base::Character& mainIndex) = 0;
  84
  85         /**
  86          * @if OSPDEPREC
  87          * Called when a sub index is selected.
  88          *
  89          * @brief               <i> [Deprecated] </i>
  90          * @deprecated  This class is deprecated. Instead of using this class, use the IFastScrollListener class.
  91          * @since                               2.0
  92          *
  93          * @param[in]   source                          The source of the event
  94          * @param[in]   mainIndex                       The main index
  95          * @param[in]   subIndex                        The sub index
  96          * @endif
  97          */
  98         virtual void OnSubIndexChanged(const Tizen::Ui::Control& source, Tizen::Base::Character& mainIndex, Tizen::Base::Character& subIndex) = 0;
  99
 100         /**
 101          * @if OSPDEPREC
 102          * Called when a main index is expanded.
 103          *
 104          * @brief               <i> [Deprecated] </i>
 105          * @deprecated  This class is deprecated. Instead of using this class, use the IFastScrollListener class.
 106          * @since                               2.0
 107          *
 108          * @param[in]   source                          The source of the event
 109          * @param[in]   mainIndex                       The main index
 110          * @endif
 111          */
 112         virtual void OnMainIndexSelected(const Tizen::Ui::Control& source, Tizen::Base::Character& mainIndex) = 0;
 113
 114         /**
 115          * @if OSPDEPREC
 116          * Called when a sub index is expanded.
 117          *
 118          * @brief               <i> [Deprecated] </i>
 119          * @deprecated  This class is deprecated. Instead of using this class, use the IFastScrollListener class.
 120          * @since                               2.0
 121          *
 122          * @param[in]   source                          The source of the event
 123          * @param[in]   mainIndex                       The main index
 124          * @param[in]   subIndex                        The sub index
 125          * @endif
 126          */
 127         virtual void OnSubIndexSelected(const Tizen::Ui::Control& source, Tizen::Base::Character& mainIndex, Tizen::Base::Character& subIndex) = 0;
 128
 129 protected:
 130
 131         virtual void IFastScrollEventListener_Reserved1(void) {}
 132         virtual void IFastScrollEventListener_Reserved2(void) {}
 133         virtual void IFastScrollEventListener_Reserved3(void) {}
 134 }; // IFastScrollEventListener
 135
 136 }}
 137
 138 #endif // _FUI_IFAST_SCROLL_EVENT_LISTENER_H_