src/ui/inc/FUiCtrl_IInputPadEventListener.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_IInputPadEventListener.h
  20  * @brief               This is the header file for the _IInputPadEventListener class.
  21  *
  22  * This header file contains the declarations of the _IInputPadEventListener class.
  23  * If a change event is generated, a method of this class is called.
  24  * Applications that do jobs related to change events call the methods of this class.
  25  *
  26  */
  27
  28 #ifndef _FUI_CTRL_INTERNAL_IINPUTPAD_EVENT_LISTENER_H_
  29 #define _FUI_CTRL_INTERNAL_IINPUTPAD_EVENT_LISTENER_H_
  30
  31 #include <FOspConfig.h>
  32 #include <FBaseRtIEventListener.h>
  33
  34 namespace Tizen { namespace Ui
  35 {
  36 class _Control;
  37 } }
  38
  39 namespace Tizen { namespace Ui { namespace Controls
  40 {
  41
  42 /**
  43  * @interface   IInputPadEventListener
  44  * @brief       This interface implements a listener for InputPadPanel events.
  45  * @since       2.0
  46  *
  47  * The interface implements a listener for receiving changes to the Control's the behavior of the InputPad.
  48  * The class that displays and controls InputPad implements this interface, and the instance created with
  49  * that class is registered with a UI control, using the control's AddInputPadEventListener() method.
  50  */
  51 class _IInputPadEventListener
  52         : virtual public Tizen::Base::Runtime::IEventListener
  53 {
  54 public:
  55         /**
  56          * This is the destructor for this class.
  57          *
  58          * @since 2.0
  59          *
  60          */
  61         virtual ~_IInputPadEventListener(void) {}
  62
  63         /**
  64          * Notifies when the InputPad reached on one of top, bottom, left or right end
  65          *
  66          * @since           2.0
  67          *
  68          * @param[in]           source        The source of the event
  69          * @param[in]           inputPadReturnValue          The return value
  70          */
  71         virtual void OnInputPadValueChanged(const Tizen::Ui::_Control& source, int inputPadReturnValue) = 0;
  72 }; // _IInputPadEventListener
  73
  74 }}} // Tizen::Ui::Controls
  75
  76 #endif // _FUI_CTRL_INTERNAL_IINPUTPAD_EVENT_LISTENER_H_