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.
18 * @file FUiCtrlIFastScrollListener.h
19 * @brief This is the header file for the %IFastScrollListener interface.
21 * This header file contains the declarations of the %IFastScrollListener interface. @n
22 * If item event is generated, a method of this class will be called. @n
23 * Applications that perform tasks related to the item event call methods of this class.
26 #ifndef _FUI_CTRL_IFAST_SCROLL_LISTENER_H_
27 #define _FUI_CTRL_IFAST_SCROLL_LISTENER_H_
29 #include <FBaseRtIEventListener.h>
30 #include <FBaseString.h>
32 namespace Tizen { namespace Ui
37 namespace Tizen { namespace Ui { namespace Controls
43 * The string constant representing the index of the magnifying icon in a fast scroll.
45 * @brief <i> [Deprecated] </i>
46 * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
47 * Instead of using this object, it is recommended to use FAST_SCROLL_SEARCH_ICON_INDEX_STRING.
51 _OSP_EXPORT_ extern const Tizen::Base::String FAST_SCROLL_SEARCH_ICON_INDEX;
55 * The string constant representing the index of the magnifying icon in a fast scroll.
59 _OSP_EXPORT_ extern const wchar_t* const FAST_SCROLL_SEARCH_ICON_INDEX_STRING;
62 * @interface IFastScrollListener
63 * @brief This interface implements the listener for the fast scroll event.
67 * The %IFastScrollListener interface is the listener interface for receiving fast scroll events.
68 * The class that processes a fast scroll event implements this interface, and the instance created with that class is registered
69 * with a UI control, using the control's AddFastScrollListener() method. When the fast scroll event occurs, the
70 * OnFastScrollIndexChanged() method of that instance is invoked.
72 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_listviews.htm">ListViews</a>.
75 class _OSP_EXPORT_ IFastScrollListener
76 : public Tizen::Base::Runtime::IEventListener
81 * This is the destructor for this class.
85 virtual ~IFastScrollListener(void) {}
88 * Called when an index is selected.
92 * @param[in] source The source of the event
93 * @param[in] index The index
95 * @remarks When the search icon index is enabled, you can check whether the search icon index is touched by comparing @c index with the string
96 * constant ::FAST_SCROLL_SEARCH_ICON_INDEX.
100 virtual void OnFastScrollIndexSelected(Tizen::Ui::Control& source, Tizen::Base::String& index) = 0;
104 // This method is for internal use only.
105 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
107 // This method is reserved and may change its name at any time without prior notice.
109 virtual void IFastScrollListener_Reserved1(void) {}
112 // This method is for internal use only.
113 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
115 // This method is reserved and may change its name at any time without prior notice.
118 virtual void IFastScrollListener_Reserved2(void) {}
121 // This method is for internal use only.
122 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
124 // This method is reserved and may change its name at any time without prior notice.
126 virtual void IFastScrollListener_Reserved3(void) {}
127 }; // IFastScrollListener