src/modules/API/DEPRACATED/Gallery/IGallery.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 #ifndef WRTPLUGINS_GALLERY_IGALLERY_H_
  17 #define WRTPLUGINS_GALLERY_IGALLERY_H_
  18
  19 #include <list>
  20 #include <dpl/shared_ptr.h>
  21 #include <commons/Exception.h>
  22 #include <platform/commons/EventReceiver.h>
  23 #include "IMediaItem.h"
  24 #include "IViewProperties.h"
  25
  26 namespace WrtPlugins {
  27 namespace Api {
  28 namespace Gallery {
  29 class IGallery
  30 {
  31   public:
  32     virtual ~IGallery() = 0;
  33
  34     virtual unsigned int getNumberOfItems() const = 0;
  35     virtual std::string  getName() const = 0;
  36     virtual void         open() = 0;
  37     virtual bool         isOpen() const = 0;
  38     virtual void         close() = 0;
  39     virtual void         refresh() = 0;
  40     virtual void         changeView(const IViewProperties &props) = 0;
  41     virtual const IMediaItemsSetPtr getMediaItems() const = 0;
  42     virtual const IMediaItemPtr     getMediaItemById(unsigned long id) const =
  43         0;
  44
  45   protected:
  46     IGallery();
  47 };
  48
  49 typedef DPL::SharedPtr<IGallery> IGalleryPtr;
  50 typedef std::list<IGalleryPtr> IGallerySet;
  51 typedef DPL::SharedPtr<IGallerySet> IGallerySetPtr;
  52 typedef std::list<IGalleryPtr>::iterator IGallerySetIterator;
  53 } // Gallery
  54 } // Api
  55 } // WrtPlugins
  56
  57 #endif // WRTPLUGINS_GALLERY_IGALLERY_H_