2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 * @file FUiIScrollPanelEventListener.h
20 * @brief This is the header file for the %IScrollPanelEventListener interface.
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.
27 #ifndef _FUI_ISCROLL_PANEL_EVENT_LISTENER_H_
28 #define _FUI_ISCROLL_PANEL_EVENT_LISTENER_H_
31 #include <FBaseObject.h>
32 #include <FBaseRtIEventListener.h>
34 namespace Tizen { namespace Ui
39 namespace Tizen {namespace Ui
43 * @interface IScrollPanelEventListener
44 * @brief This interface implements a listener for %ScrollPanel events.
48 * The %IScrollPanelEventListener interface is the listener interface for receiving change events related to controls (especially an overlay keypad) within the
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.
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>.
56 class _OSP_EXPORT_ IScrollPanelEventListener
57 : public Tizen::Base::Runtime::IEventListener
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.
66 virtual ~IScrollPanelEventListener(void) {}
69 * Called when an overlay keypad is created on the ScrollPanel control.
73 * @param[in] source The source of the event
75 virtual void OnOverlayControlCreated(const Tizen::Ui::Control& source) = 0;
78 * Called when an overlay keypad is opened on the ScrollPanel control.
82 * @param[in] source The source of the event
84 virtual void OnOverlayControlOpened(const Tizen::Ui::Control& source) = 0;
87 * Called when an overlay keypad is closed on the ScrollPanel control.
91 * @param[in] source The source of the event
93 virtual void OnOverlayControlClosed(const Tizen::Ui::Control& source) = 0;
96 * Called when a control is selected on the ScrollPanel control .
100 * @param[in] source The source of the event
102 virtual void OnOtherControlSelected(const Tizen::Ui::Control& source) = 0;
108 // This method is for internal use only. Using this method can cause behavioral, security-related,
109 // and consistency-related issues in the application.
111 // This method is reserved and may change its name at any time without
116 virtual void IScrollPanelEventListener_Reserved1(void) { }
119 // This method is for internal use only. Using this method can cause behavioral, security-related,
120 // and consistency-related issues in the application.
122 // This method is reserved and may change its name at any time without
127 virtual void IScrollPanelEventListener_Reserved2(void) { }
130 // This method is for internal use only. Using this method can cause behavioral, security-related,
131 // and consistency-related issues in the application.
133 // This method is reserved and may change its name at any time without
138 virtual void IScrollPanelEventListener_Reserved3(void) { }
140 }; // IScrollPanelEventListener
145 #endif // _FUI_ISCROLL_PANEL_EVENT_LISTENER_H_