src/system/inc/FSys_IPowerManagerEventListener.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 /**
  19  * @file        FSys_IPowerManagerEventListener.h
  20  * @brief       This is the header file for the %_IPowerManagerEventListener interface.
  21  *
  22  * This header file contains the declarations of the %_IPowerManagerEventListener interface.
  23  */
  24
  25 #ifndef _FSYS_INTERNAL_IPOWERMANAGER_EVENT_LISTENER_H_
  26 #define _FSYS_INTERNAL_IPOWERMANAGER_EVENT_LISTENER_H_
  27
  28 #include <FBaseResult.h>
  29 #include <FBaseRtIEventListener.h>
  30
  31 namespace Tizen { namespace System
  32 {
  33
  34 /**
  35  * @interface   _IPowerManagerEventListener
  36  * @brief       This interface is the listener of internal PowerManager event.
  37  *
  38  * @sinces2.1
  39  *
  40  * The %_IPowerManagerEventListener interface must be registered and implemented by an application to receive PowerManager events from the system.
  41  */
  42
  43 class _OSP_EXPORT_ _IPowerManagerEventListener
  44         : public virtual Tizen::Base::Runtime::IEventListener
  45 {
  46 public:
  47         /**
  48          * 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.
  49          *
  50          * @sinces2.1
  51          */
  52
  53         virtual ~_IPowerManagerEventListener(void) {}
  54
  55         /**
  56          * Called when the screen state is changed.
  57          *
  58          * @sinces2.1
  59          * @param[in]   state   The screen state whether screen is on or off.
  60          */
  61         virtual void OnScreenStateChanged(bool state) = 0;
  62 }; // _IPowerManagerEventListener
  63
  64 } } // Osp::System
  65
  66 #endif //