src/modules/API/WidgetDB/IWidgetFeature.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      Grzegorz Krawczyk (g.krawczyk@samsung.com)
  18  * @version     0.1
  19  * @brief
  20  */
  21
  22 #ifndef WRT_PLUGINS_WRT_ENGINE_WIDGET_FEATURE_INTERFACE_H_
  23 #define WRT_PLUGINS_WRT_ENGINE_WIDGET_FEATURE_INTERFACE_H_
  24
  25 #include <list>
  26 #include <string>
  27 #include <dpl/shared_ptr.h>
  28
  29 namespace WrtDeviceApis {
  30 namespace WidgetDB {
  31 namespace Api {
  32
  33 class IWidgetFeature
  34 {
  35   public:
  36     typedef std::pair<std::string, std::string> Param;
  37     typedef std::list<Param> Params;
  38     typedef Params::const_iterator ParamsIterator;
  39
  40   public:
  41
  42     virtual ~IWidgetFeature()
  43     {
  44     }
  45
  46     virtual std::string getName() const = 0;
  47
  48     virtual bool isRequired() const = 0;
  49
  50     virtual Params getParams() const = 0;
  51
  52     virtual void addParam(const std::string& paramName,
  53             const std::string& paramValue) = 0;
  54
  55     virtual bool isRequestedByWidget() const = 0;
  56 };
  57
  58 typedef DPL::SharedPtr<IWidgetFeature> IWidgetFeaturePtr;
  59
  60 } // Api
  61 } // WidgetDB
  62 } // WrtDeviceApis
  63
  64 #endif