inc/FSysISettingEventListener.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file        FSysISettingEventListener.h
  19  * @brief       This is the header file for the %ISettingEventListener interface.
  20  *
  21  * This header file contains the declarations of the %ISettingEventListener interface.
  22  */
  23
  24 #ifndef _FSYS_ISETTING_EVENT_LISTENER_H_
  25 #define _FSYS_ISETTING_EVENT_LISTENER_H_
  26
  27 #include <FBaseResult.h>
  28 #include <FBaseRtIEventListener.h>
  29
  30 namespace Tizen { namespace System
  31 {
  32
  33 /**
  34  * @interface   ISettingEventListener
  35  * @brief               This interface is the listener of the setting event.
  36  *
  37  * @since 2.0
  38  *
  39  * The %ISettingEventListener interface must be registered and implemented by an application to receive setting events from the system.
  40  *
  41  */
  42 class _OSP_EXPORT_ ISettingEventListener
  43         : public virtual Tizen::Base::Runtime::IEventListener
  44 {
  45 public:
  46         /**
  47          * This is the destructor for this class. @n
  48          * This polymorphic destructor should be overridden if required. @n This way,
  49          * the destructors of the derived classes are called when the destructor of this interface is called.
  50          *
  51          * @since       2.0
  52          */
  53         virtual ~ISettingEventListener(void) {}
  54         /**
  55          * Called when a setting value has been changed.
  56          *
  57          * @since       2.0
  58          *
  59          * @param[in]   key             The key name of the changed setting information
  60          * @remarks     Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value
  61          *                              corresponding to the given key.
  62          */
  63         virtual void OnSettingChanged(Tizen::Base::String& key) = 0;
  64
  65 protected:
  66         //
  67         // This method is for internal use only.
  68         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  69         //
  70         // @since 2.0
  71         virtual void OnISettingEventListener_Reserved1(void) {}
  72
  73         //
  74         // This method is for internal use only.
  75         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  76         //
  77         // @since 2.0
  78         virtual void OnISettingEventListener_Reserved2(void) {}
  79
  80         //
  81         // This method is for internal use only.
  82         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  83         //
  84         // @since 2.0
  85         virtual void OnISettingEventListener_Reserved3(void) {}
  86
  87 }; // ISettingEventListener
  88
  89 } } // Tizen::System
  90
  91 #endif // _FSYS_ISETTING_EVENT_LISTENER_H_