2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://floralicense.org/license/
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 FUiCtrl_KeypadEvent.h
20 * @brief This is the header file for _KeypadEvent class.
22 * This header file contains declaration of _KeypadEvent class.
26 #ifndef _FUI_CTRL_KEYPAD_EVENT_H_
27 #define _FUI_CTRL_KEYPAD_EVENT_H_
29 #include <FBaseResult.h>
30 #include <FBaseRt_Event.h>
31 #include <FOspConfig.h>
32 #include "FUiCtrl_IKeypadEventListener.h"
34 namespace Tizen { namespace Ui
39 namespace Tizen { namespace Ui { namespace Controls
42 enum CoreKeypadEventStatus
44 CORE_KEYPAD_EVENT_STATUS_CREATED,
45 CORE_KEYPAD_EVENT_STATUS_OPEN,
46 CORE_KEYPAD_EVENT_STATUS_CLOSE,
47 CORE_KEYPAD_EVENT_STATUS_BOUNDS_CHANGED,
48 CORE_KEYPAD_EVENT_STATUS_ENTERACTION
54 * @brief This class handles a keypad event event. It is inherited from Event class.
58 : public Tizen::Base::Runtime::_Event
63 * This is the default class destructor.
66 virtual ~_KeypadEvent(void);
68 static _KeypadEvent* CreateInstanceN(const Tizen::Ui::_Control& source);
72 * This method returns the owner of this event.
74 * @return See the comment above.
76 const Tizen::Ui::_Control* GetSource(void) const;
78 static Tizen::Base::Runtime::IEventArg* CreateKeypadEventArgN(CoreKeypadAction actionId, Tizen::Ui::Controls::CoreKeypadEventStatus status);
83 * This is the default class constructor.
85 * @remarks After creating an instance of this class, you must explicitly call one of
86 * construction methods to initialize the instance.
89 _KeypadEvent(const Tizen::Ui::_Control& source);
92 * This method checks the arg and finds out the type of event. After that this method calls appopriate
95 * @param[in] listener It is a event listener related to this item event.
96 * @param[in] arg It is an argument-like instance of item event retransmitted to the listener's method
98 * @exception E_SUCCESS - The method is successful.
99 * @exception E_ARG_NULL - The listener is null.
100 * @exception E_INVALID_ARG - The argument passed to a method contains an invalid value.@n
101 * The pListener is not the instance of IItemEventListener class or
102 * the pItemEventArg is not the instance of _CustomItemEventArg class.
105 virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
109 const Tizen::Ui::_Control* __pSource;
112 }}} // Tizen::Ui::Controls
114 #endif // _FUI_CTRL_KEYPAD_EVENT_H_