src/controls/FWebCtrl_WebEvent.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
  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        FWebCtrl_WebEvent.h
  20  * @brief       This is the header file for the _WebEvent class.
  21  *
  22  * This file contains the declarations of _WebEvent.
  23  */
  24 #ifndef _FWEB_CTRL_INTERNAL_WEB_EVENT_H_
  25 #define _FWEB_CTRL_INTERNAL_WEB_EVENT_H_
  26
  27 #include <FBaseRt_Event.h>
  28 #include "FWebCtrl_IWebEventListener.h"
  29
  30 namespace Tizen { namespace Base { namespace Runtime
  31 {
  32 class IEventListener;
  33 }}} // Tizen::Base::Runtime
  34
  35 namespace Tizen { namespace Web { namespace Controls
  36 {
  37
  38 /**
  39  * @class _WebEvent
  40  * @brief This class provides methods for delivering an event with an argument synchronously and asynchronously.
  41  *
  42  */
  43 class _WebEvent
  44         : public Tizen::Base::Runtime::_Event
  45 {
  46 public:
  47         /**
  48          * This is the default constructor for this class.
  49          *
  50          * @since 2.0
  51          */
  52         _WebEvent(void);
  53
  54         /**
  55          * This is the destructor for this class.
  56          *
  57          * @since 2.0
  58          */
  59         virtual ~_WebEvent(void);
  60         result Construct(const _IWebEventListener& listener);
  61
  62         result AddWebEventListener(const _IWebEventListener& listener);
  63         result RemoveWebEventListener(const _IWebEventListener& listener);
  64         /**
  65          * Implement to call the corresponding event listener's method.
  66          *
  67          * @since 2.0
  68          * @param[in]   listener        The listener instance which is currently processing
  69          * @param[in]   arg             The event argument that is fired
  70          */
  71         virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
  72
  73 }; // _WebEvent
  74
  75 }}} // Tizen::Web::Controls
  76 #endif // _FWEB_CTRL_INTERNAL_WEB_EVENT_H_