inc/FSysIChargingEventListener.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        FSysIChargingEventListener.h
  19  * @brief       This is the header file for the %IChargingEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IChargingEventListener interface.
  22  */
  23
  24 #ifndef _FSYS_ICHARGING_EVENT_LISTENER_H_
  25 #define _FSYS_ICHARGING_EVENT_LISTENER_H_
  26
  27 #include <FBaseResult.h>
  28 #include <FBaseRtIEventListener.h>
  29
  30 namespace Tizen { namespace System
  31 {
  32
  33 /**
  34  * @interface   IChargingEventListener
  35  * @brief       This interface is the listener of the charging event.
  36  * @since 2.0
  37  *
  38  * The %IChargingEventListener interface must be registered and implemented by an application to
  39  * receive events from the system when the device charging state changes.
  40  *
  41  */
  42 class _OSP_EXPORT_ IChargingEventListener
  43         : public virtual Tizen::Base::Runtime::IEventListener
  44 {
  45 public:
  46         /**
  47          * This is the destructor for this class. 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.
  48          *
  49          * @since 2.0
  50          */
  51         virtual ~IChargingEventListener(void) {}
  52
  53         /**
  54          * Called when the charging state is changed.
  55          *
  56          * @since 2.0
  57          *
  58          * @param[in]   charging        The charging state
  59          */
  60         virtual void OnChargingStateChanged(bool charging) = 0;
  61
  62 protected:
  63         //
  64         // This method is for internal use only.
  65         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  66         //
  67         // @since 2.0
  68         virtual void OnIChargingEventListener_Reserved1(void) {}
  69
  70         //
  71         // This method is for internal use only.
  72         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  73         //
  74         // @since 2.0
  75         virtual void OnIChargingEventListener_Reserved2(void) {}
  76
  77         //
  78         // This method is for internal use only.
  79         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  80         //
  81         // @since 2.0
  82         virtual void OnIChargingEventListener_Reserved3(void) {}
  83
  84 }; // IChargingEventListener
  85
  86 } } // Tizen::System
  87
  88 #endif // _FSYS_ICHARGING_EVENT_LISTENER_H_