src/modules/API/Power/IBacklight.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   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  * @file        IBacklight.h
  18  * @author      Shi Hezhang (hezhang.shi@samsung.com)
  19  * @version     0.1
  20  */
  21
  22 #ifndef WRTDEVICEAPIS_POWER_IBACKALIGHT_H_
  23 #define WRTDEVICEAPIS_POWER_IBACKALIGHT_H_
  24
  25 #include <dpl/noncopyable.h>
  26 #include <dpl/shared_ptr.h>
  27 #include <Power/EventLight.h>
  28 #include <Power/Enums.h>
  29
  30 namespace WrtDeviceApis {
  31 namespace Power {
  32 namespace Api {
  33
  34 /**
  35  * Represents battery unit on the device.
  36  */
  37 class IBacklight : private DPL::Noncopyable
  38 {
  39   public:
  40     virtual ~IBacklight() = 0;
  41
  42     /**
  43      * @see Api::Power::IBacklight::changeState()
  44      */
  45     virtual int changeState(BacklightStatus state,
  46                             unsigned int timeout) = 0;
  47
  48     /**
  49      * @see Api::Power::IBacklight::changeState()
  50      */
  51     virtual void changeState(const EventLightPtr& event) = 0;
  52 };
  53
  54 typedef DPL::SharedPtr<IBacklight> IBacklightPtr;
  55
  56 } // Api
  57 } // Power
  58 } // WrtDeviceApis
  59
  60 #endif // WRTDEVICEAPIS_POWER_IBACKALIGHT_H_
  61