Tizen 2.1 base
[framework/osp/uifw.git] / src / ui / inc / FUiCtrl_IExpandableEditAreaEventListener.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  * @file                FUiCtrl_IExpandableEditAreaEventListener.h
19  * @brief               This is the header file for the _IExpandableEditAreaEventListener class.
20  *
21  * This header file contains the declarations of the _IExpandableEditAreaEventListener class. @n
22  * If an action event is generated, a method of this class is called.
23  * So, if the application does some jobs related to the action event, use the methods of this class.
24  *
25  */
26 #ifndef _FUICTRL_INTERNAL_IEXPANDABLE_EDITAREA_EVENT_LISTENER_H_
27 #define _FUICTRL_INTERNAL_IEXPANDABLE_EDITAREA_EVENT_LISTENER_H_
28
29 // Includes
30 #include <FBaseRtIEventListener.h>
31 #include <FOspConfig.h>
32
33 namespace Tizen { namespace Ui
34 {
35 class _Control;
36 }} // Tizen::Ui
37
38 namespace Tizen { namespace Ui { namespace Controls
39 {
40
41 /**
42  * @interface   _IExpandableEditAreaEventListener
43  * @brief               This interface implements the listener for _kmjaction event.
44  * @since 2.0
45  *
46  * The interface provides a listener to receive events related to ExpandableEditArea.
47  *
48  */
49 class _IExpandableEditAreaEventListener
50         : virtual public Tizen::Base::Runtime::IEventListener
51 {
52
53 // Operation
54 public:
55         /**
56          * This is the destructor for this class.
57          *
58          * @since               1.0
59          */
60         virtual ~_IExpandableEditAreaEventListener(void) {}
61
62 public:
63         /**
64          * Notifies the application that a new line is added to ExpandableEditArea.
65          *
66          * @since       2.0
67          * @param[in]   source          The source of the event
68          * @param[in]   newLineCount    The new line count
69          */
70         virtual void OnExpandableEditAreaLineAdded(const Tizen::Ui::_Control& source, int newLineCount) = 0;
71
72         /**
73          * Notifies the application that a line is removed from ExpandableEditArea.
74          *
75          * @since       2.0
76          * @param[in]   source          The source of the event
77          * @param[in]   newLineCount    The new line count
78          */
79         virtual void OnExpandableEditAreaLineRemoved(const Tizen::Ui::_Control& source, int newLineCount) = 0;
80 };      // _IExpandableEditAreaEventListener
81
82 }}}  // Tizen::Ui::Controls
83
84 #endif // _FUICTRL_INTERNAL_IEXPANDABLE_EDITAREA_EVENT_LISTENER_H_