src/domain/widget_model.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    widget_model.h
  18  * @author  Przemyslaw Dobrowolski (p.dobrowolsk@samsung.com)
  19  * @version 1.0
  20  * @brief   Header file for widget model
  21  */
  22 #ifndef SRC_DOMAIN_WIDGET_MODEL_H
  23 #define SRC_DOMAIN_WIDGET_MODEL_H
  24
  25 #include <dpl/event/model.h>
  26 #include <dpl/event/property.h>
  27 #include <dpl/optional.h>
  28 #include <string>
  29
  30 #include "widget_data_types.h"
  31
  32 #include <dpl/wrt-dao-ro/wrt_db_types.h> // definition of WidgetHandle
  33
  34 /**
  35  * @brief Widget model
  36  *
  37  * Widget model is the core object that hold information about
  38  * properties of widget. After wrt launch each widget contained in database is
  39  * mapped to WidgetModel.
  40  *
  41  * Widget model is a type of MVC model, so it is possible to listen for it's
  42  * changes.
  43  *
  44  */
  45 class WidgetModel : public DPL::Event::Model
  46 {
  47   public:
  48
  49     /**
  50      * @brief Tizen id
  51      *
  52      *  ex> "TizenIDabc.appname"
  53      *
  54      *  - TizenId / AppId : "TizenIDabc.appname"
  55      *  - TzPkgId         : "TizenIDabc"
  56      *  - App name        : "appname"
  57      *
  58      */
  59     DPL::String TizenId;
  60     DPL::Event::Property<WrtDB::TizenPkgId,
  61                          DPL::Event::PropertyReadOnly,
  62                          DPL::Event::PropertyStorageDynamicCached> TzPkgId;
  63
  64     /**
  65      * @brief Widget type
  66      *
  67      * Note: This is a readonly property
  68      */
  69     DPL::Event::Property<WrtDB::WidgetType,
  70                          DPL::Event::PropertyReadOnly,
  71                          DPL::Event::PropertyStorageDynamicCached> Type;
  72
  73     /**
  74      * @brief Config file based csp policy
  75      */
  76     DPL::Event::Property<DPL::OptionalString,
  77                          DPL::Event::PropertyReadOnly,
  78                          DPL::Event::PropertyStorageDynamicCached> CspPolicy;
  79
  80     /**
  81      * @brief Current widget actual size
  82      */
  83     DPL::Event::Property<WidgetSize> ActualSize;
  84
  85     /**
  86      * @brief Current widget preferred size
  87      */
  88     DPL::Event::Property<WidgetSize,
  89                          DPL::Event::PropertyReadOnly,
  90                          DPL::Event::PropertyStorageDynamicCached>
  91     PreferredSize;
  92
  93     /**
  94      * @brief Start URL for widget
  95      */
  96     DPL::Event::Property<DPL::OptionalString> StartURL;
  97
  98     /**
  99      * @brief Start URL information for widget
 100      */
 101     DPL::Event::Property<OptionalWidgetStartFileInfo> StartFileInfo;
 102
 103     /**
 104      * @brief Prefix URL for widget
 105      *
 106      * This is a prefix address of html file that widget is displaying.
 107      * The whole address is PrefixURL + StartURL.
 108      */
 109     DPL::Event::Property<DPL::String, DPL::Event::PropertyReadOnly> PrefixURL;
 110
 111     /**
 112      * @brief Install path for widget
 113      *
 114      * Gets path in which files of widget are being kept
 115      */
 116     DPL::Event::Property<DPL::String,
 117                          DPL::Event::PropertyReadOnly,
 118                          DPL::Event::PropertyStorageDynamicCached> InstallPath;
 119
 120     /**
 121      * @brief Path to widget's persistent storage.
 122      *
 123      * Gets path in which widget may store its persistent private data.
 124      */
 125     DPL::Event::Property<DPL::String,
 126                          DPL::Event::PropertyReadOnly> PersistentStoragePath;
 127
 128     /**
 129      * @brief Path to widget's temporary storage.
 130      *
 131      * Gets path in which widget may store its temporary private data.
 132      */
 133     DPL::Event::Property<DPL::String,
 134                          DPL::Event::PropertyReadOnly> TemporaryStoragePath;
 135
 136     /**
 137      * @brief Widget defaultlocale
 138      */
 139     DPL::Event::Property<DPL::OptionalString,
 140                          DPL::Event::PropertyReadOnly,
 141                          DPL::Event::PropertyStorageDynamicCached>
 142     defaultlocale;
 143
 144     /**
 145      * @brief Widget name
 146      */
 147     DPL::Event::Property<DPL::OptionalString> Name;
 148
 149     /**
 150      * @brief Widget short name
 151      */
 152     DPL::Event::Property<DPL::OptionalString> ShortName;
 153
 154     /**
 155      * @brief Widget description
 156      */
 157     DPL::Event::Property<DPL::OptionalString> Description;
 158
 159     /**
 160      * @brief Widget license
 161      */
 162     DPL::Event::Property<DPL::OptionalString> License;
 163
 164     /**
 165      * @brief Widget license href
 166      */
 167     DPL::Event::Property<DPL::OptionalString> LicenseHref;
 168
 169     /**
 170      * @brief Widget icon
 171      */
 172     DPL::Event::Property<OptionalWidgetIcon> Icon;
 173
 174     /**
 175      * @brief Widget splash image src
 176      */
 177     DPL::Event::Property<DPL::OptionalString,
 178                          DPL::Event::PropertyReadOnly,
 179                          DPL::Event::PropertyStorageDynamicCached> SplashImg;
 180
 181     /**
 182      * @brief window mode
 183      */
 184     DPL::Event::Property<WrtDB::WindowModeList,
 185                          DPL::Event::PropertyReadOnly,
 186                          DPL::Event::PropertyStorageDynamic> WindowModes;
 187
 188     //    /**
 189     //     * @brief Value of network element.
 190     //     */
 191     //    DPL::Event::Property<bool,
 192     //                  DPL::Event::PropertyReadOnly> AccessNetwork;
 193
 194     //    /**
 195     //     * @brief Does widget contain WARP definitions.
 196     //     */
 197     //    DPL::Event::Property<bool> WarpDefinitionEmpty;
 198
 199     /**
 200      * @brief Is back supported
 201      */
 202     DPL::Event::Property<bool,
 203                          DPL::Event::PropertyReadOnly,
 204                          DPL::Event::PropertyStorageDynamicCached>
 205     BackSupported;
 206
 207     /**
 208      * @brief Widget access list
 209      */
 210     DPL::Event::Property<WidgetAccessList> AccessList;
 211
 212     /**
 213      * @brief Is this DeveloperWidget
 214      */
 215     DPL::Event::Property<bool,
 216                          DPL::Event::PropertyReadOnly,
 217                          DPL::Event::PropertyStorageDynamicCached> IsTestWidget;
 218
 219     DPL::Event::Property<WidgetSettingList> SettingList;
 220
 221     /**
 222      * @brief Widget Application Service list
 223      */
 224     DPL::Event::Property<WidgetApplicationServiceList> AppServiceList;
 225
 226     WidgetModel(const std::string &tizenId);
 227
 228   private:
 229     // Custom read write delegates
 230     static DPL::String           getTimestamp();
 231
 232     DPL::String getTizenId() const;
 233 };
 234
 235 #endif // SRC_DOMAIN_WIDGET_MODEL_H