inc/FSysIDeviceEventListener.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        FSysIDeviceEventListener.h
  19  * @brief       This is the header file for the %IDeviceEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IDeviceEventListener interface.
  22  */
  23
  24 #ifndef _FSYS_IDEVICE_EVENT_LISTENER_H_
  25 #define _FSYS_IDEVICE_EVENT_LISTENER_H_
  26
  27 #include <FBaseResult.h>
  28 #include <FBaseRtIEventListener.h>
  29 #include <FSysDeviceManager.h>
  30
  31 namespace Tizen { namespace System
  32 {
  33
  34 /**
  35  * @interface   IDeviceEventListener
  36  * @brief               This interface is the listener of the device state changes.
  37  *
  38  * @since       2.0
  39  *
  40  * The %IDeviceEventListener interface must be registered and implemented by an application to receive device events from the system.
  41  *
  42  * @see DeviceManager
  43  */
  44 class _OSP_EXPORT_ IDeviceEventListener
  45         : public virtual Tizen::Base::Runtime::IEventListener
  46 {
  47 public:
  48         /**
  49          * This is the destructor for this class. @n
  50          * This polymorphic destructor should be overridden if required. @n
  51          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  52          *
  53          * @since       2.0
  54          */
  55         virtual ~IDeviceEventListener(void) {}
  56
  57         /**
  58         * Called when a device state is changed.
  59         *
  60         * @since        2.0
  61         *
  62         * @param[in]    deviceType      The device type
  63         * @param[in]    state           The device state of type Tizen::Base::String
  64         */
  65         virtual void OnDeviceStateChanged(DeviceType deviceType, const Tizen::Base::String& state) = 0;
  66
  67 protected:
  68         //
  69         // This method is for internal use only.
  70         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  71         //
  72         // @since 2.0
  73         virtual void OnIDeviceEventListener_Reserved1(void) {}
  74
  75         //
  76         // This method is for internal use only.
  77         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  78         //
  79         // @since 2.0
  80         virtual void OnIDeviceEventListener_Reserved2(void) {}
  81
  82         //
  83         // This method is for internal use only.
  84         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  85         //
  86         // @since 2.0
  87         virtual void OnIDeviceEventListener_Reserved3(void) {}
  88
  89 }; // IDeviceEventListener
  90
  91 } } // Tizen::System
  92
  93 #endif // _FSYS_IDEVICE_EVENT_LISTENER_H_