inc/FUiCtrlIScrollEventListener.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                FUiCtrlIScrollEventListener.h
  19  * @brief       This is the header file for the %IScrollEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IScrollEventListener interface. @n
  22  * If a change event is generated, a method of this interface is called. @n
  23  * The applications that perform tasks related to the change events, call the methods of this interface.
  24  *
  25  */
  26 #ifndef _FUI_CTRL_ISCROLL_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_ISCROLL_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30 #include <FUiCtrlScrollEventTypes.h>
  31
  32 namespace Tizen { namespace Ui
  33 {
  34 class Control;
  35 }}      // Tizen::Ui
  36
  37 namespace Tizen {namespace Ui { namespace Controls
  38 {
  39
  40 /**
  41  * @interface   IScrollEventListener
  42  * @brief       This interface implements a listener for scroll events.
  43  *
  44  * @since       2.0
  45  *
  46  * The %IScrollEventListener interface is the listener interface for receiving scroll events.
  47  * The class that processes a scroll event implements this interface, and the instance created with that class is registered with
  48  * a UI control, using the control(GroupedListView, GroupedTableView, IconListView,  ListView, ScrollPanel, SectionTableView, TableView)'s AddScrollEventListener() method.
  49  * When the scroll event occurs, the OnScrollEndReached()
  50  * method of that instance is invoked.
  51  *
  52  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_panels.htm">Panels</a> and
  53  * <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_listviews.htm">ListViews</a>.
  54  */
  55 class _OSP_EXPORT_ IScrollEventListener
  56         : public Tizen::Base::Runtime::IEventListener
  57 {
  58 // Operation
  59 public:
  60         /**
  61          * This polymorphic destructor should be overridden if required.@n
  62          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  63          *
  64          * @since 2.0
  65          *
  66          */
  67         virtual ~IScrollEventListener(void) {}
  68
  69         /**
  70          * Called when the scroll reaches the top, bottom, left or right end.
  71          *
  72          * @since           2.0
  73          *
  74          * @param[in]           source        The source of the event
  75          * @param[in]           type          The type of scroll end event
  76          */
  77         virtual void OnScrollEndReached(Tizen::Ui::Control& source, Tizen::Ui::Controls::ScrollEndEvent type) = 0;
  78
  79         /**
  80          * Called continuously when the control is being scrolled.
  81          *
  82          * @since 2.0
  83          *
  84          *@param[in]               source        The control being scrolled
  85          *@param[in]               scrollPosition     The scrolled position
  86          */
  87         virtual void OnScrollPositionChanged(Tizen::Ui::Control& source, int scrollPosition) {};
  88
  89         /**
  90          * Called when the control's scroll movement has come to a stop.
  91          *
  92          * @since 2.0
  93          *
  94          * @param[in]               source        The control being scrolled
  95          */
  96         virtual void OnScrollStopped(Tizen::Ui::Control& source) {};
  97
  98 protected:
  99         //
 100         // This method is for internal use only.
 101         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 102         //
 103         // This method is reserved and may change its name at any time without prior notice.
 104         //
 105         virtual void ScrollEventListener_Reserved1(void) {}
 106
 107         //
 108         // This method is for internal use only.
 109         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 110         //
 111         // This method is reserved and may change its name at any time without prior notice.
 112         //
 113         virtual void ScrollEventListener_Reserved2(void) {}
 114
 115         //
 116         // This method is for internal use only.
 117         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 118         //
 119         // This method is reserved and may change its name at any time without prior notice.
 120         //
 121         virtual void ScrollEventListener_Reserved3(void) {}
 122
 123 }; // IScrollEventListener
 124
 125 }}}     // Tizen::Ui::Controls
 126
 127 #endif // _FUI_CTRL_ISCROLL_EVENT_LISTENER_H_