src/modules/API/Profile/IDesktop.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  * @author       Zbigniew Kostrzewa (z.kostrzewa@samsung.com)
  18  */
  19
  20 #ifndef WRTDEVICEAPIS_PROFILE_IDESKTOP_H_
  21 #define WRTDEVICEAPIS_PROFILE_IDESKTOP_H_
  22
  23 #include <dpl/shared_ptr.h>
  24 #include <Filesystem/IPath.h>
  25 #include "EventSetWallpaper.h"
  26
  27 namespace WrtDeviceApis {
  28 namespace Profile {
  29 namespace Api {
  30 class IDesktop
  31 {
  32   public:
  33     /**
  34      * Index of default desktop.
  35      */
  36     static const std::size_t DEFAULT = 0;
  37
  38   public:
  39     virtual ~IDesktop() = 0;
  40
  41     /**
  42      * Gets path to wallpaper for current desktop.
  43      * @return Path to wallpaper.
  44      * @throw PlatformException If error in platform occurs.
  45      * @throw UnsupportException If platform doesn't support such feature.
  46      */
  47     virtual Filesystem::Api::IPathPtr getWallpaper() const = 0;
  48
  49     /**
  50      * Sets wallpaper for current desktop.
  51      * @param path Path to wallpaper.
  52      * @throw PlatformException If error in platform occurs.
  53      * @throw UnsupportException If platform doesn't support such feature.
  54      */
  55     virtual void setWallpaper(const Filesystem::Api::IPathPtr& path) = 0;
  56
  57     /**
  58      * Sets wallpaper for current desktop (async version)
  59      * @param path Path to wallpaper.
  60      * @throw PlatformException If error in platform occurs.
  61      * @throw UnsupportException If platform doesn't support such feature.
  62      */
  63     virtual void setWallpaper(const EventSetWallpaperPtr& event) = 0;
  64 };
  65
  66 typedef DPL::SharedPtr< IDesktop > IDesktopPtr;
  67 } // Api
  68 } // Profile
  69 } // WrtDeviceApis
  70
  71 #endif // WRTDEVICEAPIS_PROFILE_IDESKTOP_H_