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