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. 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.
  50          *
  51          * @since       2.0
  52          */
  53         virtual ~IDeviceEventListener(void) {}
  54
  55         /**
  56         * Called when a device state is changed.
  57         *
  58         * @since        2.0
  59         *
  60         * @param[in]    deviceType      The types of a device
  61         * @param[in]    state           The device state of type Tizen::Base::String
  62         */
  63         virtual void OnDeviceStateChanged(DeviceType deviceType, const Tizen::Base::String& state) = 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 OnIDeviceEventListener_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 OnIDeviceEventListener_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 OnIDeviceEventListener_Reserved3(void) {}
  86
  87 }; // IDeviceEventListener
  88
  89 } } // Tizen::System
  90
  91 #endif // _FSYS_IDEVICE_EVENT_LISTENER_H_