src/ui/inc/FUiCtrl_IFrameEventListener.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_IFrameEventListener.h
  19  * @brief               This is the header file for the _IFrameEventListener class.
  20  *
  21  * This header file contains the declarations of the _IFrameEventListener class. @n
  22  * If a frame lifecycle event is generated, a method of this class is called. @n
  23  * So, if an application needs to perform some jobs related to the frame event,
  24  * provide the implementation of the methods declared in this interface.
  25  */
  26 #ifndef _FUI_CTRL_INTERNAL_IFRAME_EVENT_LISTENER_H_
  27 #define _FUI_CTRL_INTERNAL_IFRAME_EVENT_LISTENER_H_
  28
  29 #include <FOspConfig.h>
  30 #include <FBaseRtIEventListener.h>
  31
  32 namespace Tizen { namespace Ui { namespace Controls
  33 {
  34 class _Frame;
  35
  36 /**
  37  * @interface   _IFrameEventListener
  38  * @brief               This interface implements the listener for the frame lifecycle event.
  39  * @since               1.0
  40  *
  41  * The listener interface for receiving frame lifecycle events.
  42  *
  43  */
  44 class _IFrameEventListener
  45         : virtual public Tizen::Base::Runtime::IEventListener
  46 {
  47 public:
  48         /**
  49          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  50          *
  51          * @since               1.0
  52          */
  53         virtual ~_IFrameEventListener(void) {}
  54
  55         virtual void OnFrameActivated(const Tizen::Ui::Controls::_Frame& source) = 0;
  56         virtual void OnFrameDeactivated(const Tizen::Ui::Controls::_Frame& source) = 0;
  57
  58 }; // _IFrameEventListener
  59
  60 }}} // Tizen::Ui::Controls
  61
  62 #endif // _FUI_CTRL_INTERNAL_IFRAME_EVENT_LISTENER_H_