inc/FUiIWindowEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 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                FUiIWindowEventListener.h
  20  * @brief               This is the header file for the %IWindowEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IWindowEventListener interface. @n
  23  * If a window event is generated, a method of this interface is called. @n
  24  * So, if an application does some jobs related to the window event, use the methods of this interface.
  25  *
  26  */
  27
  28 #ifndef _FUI_IWINDOW_EVENT_LISTENER_H_
  29 #define _FUI_IWINDOW_EVENT_LISTENER_H_
  30
  31 #include <FBaseRtIEventListener.h>
  32 #include <FBaseTypes.h>
  33
  34 namespace Tizen {namespace Ui
  35 {
  36
  37 class Window;
  38
  39 /**
  40  * @interface   IWindowEventListener
  41  * @brief               This interface implements the listener for the window event.
  42  *
  43  * @since                       2.0
  44  *
  45  * The %IWindowEventListener interface is a listener interface for receiving window events. The class that processes a window event
  46  * implements this interface, and the instance created with that class is registered with a Window using the Window::AddWindowEventListener()
  47  * method. When the window event occurs, the OnWindowActivated(), or OnWindowDeactivated() method of that instance is invoked.
  48  */
  49 class _OSP_EXPORT_ IWindowEventListener
  50         : public Tizen::Base::Runtime::IEventListener
  51 {
  52 // Operation
  53 public:
  54         /**
  55          * 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.
  56          *
  57          * @since                               2.0
  58          *
  59          */
  60         virtual ~IWindowEventListener(void) {}
  61
  62         /**
  63          * Called when a window becomes the topmost window.
  64          *
  65          * @since                               2.0
  66          *
  67          * @param[in]   source          The source of the event
  68          *
  69          */
  70         virtual void OnWindowActivated(const Tizen::Ui::Window& source) = 0;
  71
  72         /**
  73          * Called when the window is no longer the topmost window.
  74          *
  75          * @since                               2.0
  76          *
  77          * @param[in]   source          The source of the event
  78          *
  79          */
  80         virtual void OnWindowDeactivated(const Tizen::Ui::Window& source) = 0;
  81
  82 protected:
  83         //
  84         // This method is for internal use only. Using this method can cause behavioral, security-related,
  85         // and consistency-related issues in the application.
  86         //
  87         // This method is reserved and may change its name at any time without
  88         // prior notice.
  89         //
  90         virtual void IWindowEventListener_Reserved1(void) {}
  91
  92         //
  93         // This method is for internal use only. Using this method can cause behavioral, security-related,
  94         // and consistency-related issues in the application.
  95         //
  96         // This method is reserved and may change its name at any time without
  97         // prior notice.
  98         //
  99         virtual void IWindowEventListener_Reserved2(void) {}
 100
 101         //
 102         // This method is for internal use only. Using this method can cause behavioral, security-related,
 103         // and consistency-related issues in the application.
 104         //
 105         // This method is reserved and may change its name at any time without
 106         // prior notice.
 107         //
 108         virtual void IWindowEventListener_Reserved3(void) {}
 109 };
 110
 111 } }; // Tizen::Ui
 112
 113 #endif // _FUI_IWINDOW_EVENT_LISTENER_H_