Tizen 2.1 base
[framework/osp/uifw.git] / src / ui / inc / FUiCtrl_IIconListItemEventListener.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 /**
19  * @file                FUiCtrl_IIconListItemEventListener.h
20  * @brief               This is the header file for the _IIconListItemEventListener class.
21  *
22  * This header file contains the declarations of the _IIconListItemEventListener class. @n
23  * If an item event is generated, a method of this class is called. @n
24  * So, if an application does some jobs related to the item event, use the methods of this class.
25  */
26
27 #ifndef _FUI_CTRL_INTERNAL_IICONLISTITEM_EVENT_LISTENER_H_
28 #define _FUI_CTRL_INTERNAL_IICONLISTITEM_EVENT_LISTENER_H_
29
30 #include <FBaseRtIEventListener.h>
31
32 namespace Tizen { namespace Ui { namespace Controls
33 {
34
35 class _IconListViewItemEventArg;
36
37 /**
38  * @interface   _IIconListItemEventListener
39  * @brief               This interface implements the listener for the item event.
40  * @since               2.0
41  *
42  * The listener interface for receiving item events. The class that processes an item event
43  * implements this interface, and the instance created with that class is registered with a UI control, using the control's
44  * AddIIconListViewItemEventListener() method. When the item event occurs, the OnItemStateChanged() method of that instance is invoked.
45  */
46 class _IIconListItemEventListener
47         : virtual public Tizen::Base::Runtime::IEventListener
48 {
49 public:
50         /**
51          * This is the destructor for this class.
52          *
53          * @since 2.0
54          */
55         virtual ~_IIconListItemEventListener(void) {}
56
57         virtual void OnIconListItemStateChanged(_IconListViewItemEventArg* pArg) = 0;
58
59         virtual void OnIconListViewOverlayBitmapSelected(_IconListViewItemEventArg* pArg) {}
60
61         virtual void OnIconListViewItemReordered(_IconListViewItemEventArg* pArg) {}
62 }; //_IIconListItemEventListener
63
64 }}} // Tizen::Ui::Controls
65
66 #endif // _FUI_CTRL_INTERNAL_IICONLISTITEM_EVENT_LISTENER_H_