inc/FUiIScrollPanelEventListener.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 /**
  19  * @file                FUiIScrollPanelEventListener.h
  20  * @brief               This is the header file for the %IScrollPanelEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IScrollPanelEventListener interface. @n
  23  * If a change event is generated, a method of this interface is called. @n
  24  * Applications that do jobs related to change events call the methods of this interface.
  25  *
  26  */
  27 #ifndef _FUI_ISCROLL_PANEL_EVENT_LISTENER_H_
  28 #define _FUI_ISCROLL_PANEL_EVENT_LISTENER_H_
  29
  30 // Includes
  31 #include <FBaseObject.h>
  32 #include <FBaseRtIEventListener.h>
  33
  34 namespace Tizen { namespace Ui
  35 {
  36 class Control;
  37 }} // Tizen::Ui
  38
  39 namespace Tizen {namespace Ui
  40 {
  41
  42 /**
  43  * @interface   IScrollPanelEventListener
  44  * @brief               This interface implements a listener for ScrollPanel events.
  45  *
  46  * @since               2.0
  47  *
  48  * The %IScrollPanelEventListener interface is the listener interface for receiving change events related to controls (especially an overlay keypad) within
  49  * ScrollPanel. The class that processes a change event implements this interface, and the instance created with that class is
  50  * registered with a UI control, using the control's AddScrollPanelEventListener() method. When the change event occurs, a method
  51  * of that instance is invoked.
  52  * @n
  53  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_panels.htm">Panels</a> and <a href="../org.tizen.native.appprogramming/html/tutorials/ui_tutorial/using_overlay_keypad_with_scroll.htm">Using EditArea or EditField Overlay Keypad with ScrollPanel</a>.
  54
  55  */
  56 class _OSP_EXPORT_ IScrollPanelEventListener
  57         : public Tizen::Base::Runtime::IEventListener
  58 {
  59 // Operation
  60 public:
  61         /**
  62          * 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.
  63          *
  64          * @since               2.0
  65          */
  66         virtual ~IScrollPanelEventListener(void) {}
  67
  68         /**
  69          * Called when an overlay keypad is created on the ScrollPanel control.
  70          *
  71          * @since               2.0
  72          *
  73          * @param[in]   source                          The source of the event
  74          */
  75         virtual void OnOverlayControlCreated(const Tizen::Ui::Control& source) = 0;
  76
  77         /**
  78          * Called when an overlay keypad is opened on the ScrollPanel control.
  79          *
  80          * @since               2.0
  81          *
  82          * @param[in]   source                          The source of the event
  83          */
  84         virtual void OnOverlayControlOpened(const Tizen::Ui::Control& source) = 0;
  85
  86         /**
  87          * Called when an overlay keypad is closed on the ScrollPanel control.
  88          *
  89          * @since               2.0
  90          *
  91          * @param[in]   source                          The source of the event
  92          */
  93         virtual void OnOverlayControlClosed(const Tizen::Ui::Control& source) = 0;
  94
  95         /**
  96          * Called when a control is selected on the ScrollPanel control .
  97          *
  98          * @since               2.0
  99          *
 100          * @param[in]   source                          The source of the event
 101          */
 102         virtual void OnOtherControlSelected(const Tizen::Ui::Control& source) = 0;
 103
 104         // Reserves
 105 protected:
 106
 107         //
 108         // This method is for internal use only. Using this method can cause behavioral, security-related,
 109         // and consistency-related issues in the application.
 110         //
 111         // This method is reserved and may change its name at any time without
 112         // prior notice.
 113         //
 114         // @since 2.0
 115         //
 116         virtual void IScrollPanelEventListener_Reserved1(void) { }
 117
 118         //
 119         // This method is for internal use only. Using this method can cause behavioral, security-related,
 120         // and consistency-related issues in the application.
 121         //
 122         // This method is reserved and may change its name at any time without
 123         // prior notice.
 124         //
 125         // @since 2.0
 126         //
 127         virtual void IScrollPanelEventListener_Reserved2(void) { }
 128
 129         //
 130         // This method is for internal use only. Using this method can cause behavioral, security-related,
 131         // and consistency-related issues in the application.
 132         //
 133         // This method is reserved and may change its name at any time without
 134         // prior notice.
 135         //
 136         // @since 2.0
 137         //
 138         virtual void IScrollPanelEventListener_Reserved3(void) { }
 139
 140 }; // IScrollPanelEventListener
 141
 142
 143 }} // Tizen::Ui
 144
 145 #endif // _FUI_ISCROLL_PANEL_EVENT_LISTENER_H_