inc/FAppIActiveAppEventListener.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  * @file        FAppIActiveAppEventListener.h
  19  * @brief       This is the header file for the %IActiveAppEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IActiveAppEventListener interface.
  22  */
  23
  24 #ifndef _FAPP_IACTIVE_APP_EVENT_LISTENER_H_
  25 #define _FAPP_IACTIVE_APP_EVENT_LISTENER_H_
  26
  27 #include <FBaseTypes.h>
  28 #include <FAppTypes.h>
  29 #include <FBaseRtIEventListener.h>
  30
  31
  32 namespace Tizen { namespace App
  33 {
  34
  35 /**
  36  * @interface   IActiveAppEventListener
  37  * @brief               This interface is the listener interface for receiving the AppId of active application.
  38  *
  39  * @since       2.0
  40  *
  41  *
  42  * The %IActiveAppEventListener interface is the listener interface for receiving the active application change events.
  43  * The class that processes an active application change event implements this interface and registers using
  44  * the AppManager::AddActiveAppEventListener() method.
  45  *
  46  */
  47 class _OSP_EXPORT_ IActiveAppEventListener
  48         : virtual public Tizen::Base::Runtime::IEventListener
  49 {
  50 public:
  51         /**
  52          * This polymorphic destructor should be overridden if required. This way,
  53          * the destructors of the derived classes are called when the destructor of this interface is called.
  54          *
  55          * @since       2.0
  56          *
  57          */
  58         virtual ~IActiveAppEventListener(void) {}
  59
  60         /**
  61          * Called when the active application is changed.
  62          *
  63          * @since       2.0
  64          *
  65          * @param[in]   appId           The AppId of the active application
  66          */
  67         virtual void OnActiveAppChanged(const AppId& appId) = 0;
  68
  69 protected:
  70         //
  71         // This method is for internal use only. Using this method can cause behavioral,
  72         // security-related, and consistency-related issues in the application.
  73         //
  74         // @since       2.0
  75         //
  76         virtual void IActiveAppEventListener_Reserved1(void) {}
  77
  78         //
  79         // This method is for internal use only. Using this method can cause behavioral,
  80         // security-related, and consistency-related issues in the application.
  81         //
  82         // @since       2.0
  83         //
  84         virtual void IActiveAppEventListener_Reserved2(void) {}
  85
  86         //
  87         // This method is for internal use only. Using this method can cause behavioral,
  88         // security-related, and consistency-related issues in the application.
  89         //
  90         // @since       2.0
  91         //
  92         virtual void IActiveAppEventListener_Reserved3(void) {}
  93
  94 }; // IActiveAppEventListener
  95 } } // Tizen::App
  96
  97 #endif // _FAPP_IACTIVE_APP_EVENT_LISTENER_H_