src/ui/inc/FUiCtrl_IActionEventListener.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_IActionEventListener.h
  19  * @brief               This is the header file for the _IActionEventListener class.
  20  *
  21  * This header file contains the declarations of the _IActionEventListener 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 _FUI_CTRL_INTERNAL_IACTION_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_INTERNAL_IACTION_EVENT_LISTENER_H_
  28
  29 #include <FOspConfig.h>
  30 #include <FBaseRtIEventListener.h>
  31
  32 namespace Tizen { namespace Ui
  33 {
  34 class _Control;
  35 } } // Tizen::Ui
  36
  37 namespace Tizen {namespace Ui { namespace Controls
  38 {
  39 /**
  40  * @interface   _IActionEventListener
  41  * @brief               This interface implements the listener for _action event.
  42  * @since               1.0
  43  *
  44  * The listener interface for receiving the action events. The class that processes an action event
  45  * implements this interface, and the object created with that class is registered with a _control, using the _control's
  46  * AddActionEventListener() method. When the action event occurs, the OnActionPerformed() method of that object is invoked.
  47  */
  48 class _IActionEventListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52         /**
  53          * This is the destructor for this class.
  54          *
  55          * @since               1.0
  56          */
  57         virtual ~_IActionEventListener(void) {}
  58
  59         /**
  60          * Notifies when an action event occurs.
  61          *
  62          * @since                               1.0
  63          * @param[in]   source          The source of the event
  64          * @param[in]   actionId        The information about the action event
  65          */
  66         virtual void OnActionPerformed(const Tizen::Ui::_Control& source, int actionId) = 0;
  67
  68 }; // _IActionEventListener
  69
  70 }}} // Tizen::Ui::Controls
  71
  72 #endif // _FUI_CTRL_INTERNAL_IACTION_EVENT_LISTENER_H_