src/ui/inc/FUi_ResourceManager.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18  * @file                FUi_ResourceManager.h
  19  * @brief               This is the header file for _ResourceManager class.
  20  * @version             3.0
  21  *
  22  * This header file contains declaration of _ResourceManager class.
  23  * The ActionEvent class can call listener's method. So, when event occurred,
  24  * application can handle it appropriately.
  25  *
  26  */
  27 #ifndef _FUI_INTERNAL_RESOURCE_MANAGER_H_
  28 #define _FUI_INTERNAL_RESOURCE_MANAGER_H_
  29
  30 #include <FOspConfig.h>
  31 #include <FBaseString.h>
  32 #include <FGrpBitmap.h>
  33 #include "FUi_ControlManager.h"
  34 #include "FUi_ResourceConfigTypes.h"
  35
  36 namespace Tizen { namespace Base
  37 {
  38 class Integer;
  39 class Float;
  40 }}//Tizen::Base::
  41
  42 namespace Tizen { namespace Base { namespace Collection
  43 {
  44 template<class Type> class ArrayListT;
  45 }}}
  46
  47 namespace Tizen { namespace Graphics
  48 {
  49 class Bitmap;
  50 class FloatDimension;
  51 class Dimension;
  52 class Color;
  53 class _ICoordinateSystemTransformer;
  54 }}//Tizen::Graphics
  55
  56 namespace Tizen { namespace Ui { namespace _Resource
  57 {
  58 class StringLoader;
  59 class ConfigLoader;
  60 class MapContainer;
  61 }}}
  62
  63 namespace Tizen { namespace Ui
  64 {
  65
  66 enum _ResourceFeedbackStatus
  67 {
  68         _RESOURCE_FEEDBACK_STATUS_INIT = 0,
  69         _RESOURCE_FEEDBACK_STATUS_PLAYED
  70 };// enum _ResourceFeedbackPattern
  71
  72 enum _ResourceFeedbackPattern
  73 {
  74         _RESOURCE_FEEDBACK_PATTERN_TAP = 0,
  75         _RESOURCE_FEEDBACK_PATTERN_SIP,
  76         _RESOURCE_FEEDBACK_PATTERN_SIP_BACKSPACE,
  77         _RESOURCE_FEEDBACK_PATTERN_MAX_CHARACTER,
  78         _RESOURCE_FEEDBACK_PATTERN_KEY0,
  79         _RESOURCE_FEEDBACK_PATTERN_KEY1,
  80         _RESOURCE_FEEDBACK_PATTERN_KEY2,
  81         _RESOURCE_FEEDBACK_PATTERN_KEY3,
  82         _RESOURCE_FEEDBACK_PATTERN_KEY4,
  83         _RESOURCE_FEEDBACK_PATTERN_KEY5,
  84         _RESOURCE_FEEDBACK_PATTERN_KEY6,
  85         _RESOURCE_FEEDBACK_PATTERN_KEY7,
  86         _RESOURCE_FEEDBACK_PATTERN_KEY8,
  87         _RESOURCE_FEEDBACK_PATTERN_KEY9,
  88         _RESOURCE_FEEDBACK_PATTERN_KEY_STAR,
  89         _RESOURCE_FEEDBACK_PATTERN_KEY_SHARP,
  90         _RESOURCE_FEEDBACK_PATTERN_HOLD,
  91         _RESOURCE_FEEDBACK_PATTERN_MULTI_TAP,
  92         _RESOURCE_FEEDBACK_PATTERN_HW_TAP,
  93         _RESOURCE_FEEDBACK_PATTERN_HW_HOLD,
  94         _RESOURCE_FEEDBACK_PATTERN_MESSAGE,
  95         _RESOURCE_FEEDBACK_PATTERN_MESSAGE_ON_CALL,
  96         _RESOURCE_FEEDBACK_PATTERN_EMAIL,
  97         _RESOURCE_FEEDBACK_PATTERN_EMAIL_ON_CALL,
  98         _RESOURCE_FEEDBACK_PATTERN_WAKEUP,
  99         _RESOURCE_FEEDBACK_PATTERN_WAKEUP_ON_CALL,
 100         _RESOURCE_FEEDBACK_PATTERN_SCHEDULE,
 101         _RESOURCE_FEEDBACK_PATTERN_SCHEDULE_ON_CALL,
 102         _RESOURCE_FEEDBACK_PATTERN_TIMER,
 103         _RESOURCE_FEEDBACK_PATTERN_TIMER_ON_CALL,
 104         _RESOURCE_FEEDBACK_PATTERN_GENERAL,
 105         _RESOURCE_FEEDBACK_PATTERN_GENERAL_ON_CALL,
 106         _RESOURCE_FEEDBACK_PATTERN_POWERON,
 107         _RESOURCE_FEEDBACK_PATTERN_POWEROFF,
 108         _RESOURCE_FEEDBACK_PATTERN_CHARGERCONN,
 109         _RESOURCE_FEEDBACK_PATTERN_CHARGERCONN_ON_CALL,
 110         _RESOURCE_FEEDBACK_PATTERN_FULLCHARGED,
 111         _RESOURCE_FEEDBACK_PATTERN_FULLCHARGED_ON_CALL,
 112         _RESOURCE_FEEDBACK_PATTERN_LOWBATT,
 113         _RESOURCE_FEEDBACK_PATTERN_LOWBATT_ON_CALL,
 114         _RESOURCE_FEEDBACK_PATTERN_LOCK,
 115         _RESOURCE_FEEDBACK_PATTERN_UNLOCK,
 116         _RESOURCE_FEEDBACK_PATTERN_CALLCONNECT,
 117         _RESOURCE_FEEDBACK_PATTERN_DISCALLCONNECT,
 118         _RESOURCE_FEEDBACK_PATTERN_MINUTEMINDER,
 119         _RESOURCE_FEEDBACK_PATTERN_VIBRATION,
 120         _RESOURCE_FEEDBACK_PATTERN_SHUTTER,
 121         _RESOURCE_FEEDBACK_PATTERN_LIST_REORDER,
 122         _RESOURCE_FEEDBACK_PATTERN_SLIDER_SWEEP
 123 }; // enum _ResourceFeedbackPattern
 124
 125         namespace Controls { namespace __Internal
 126         {
 127         const int OVERLAY_REGION_MIN_LENGTH = 16;
 128         }}//Tizen::Ui::Controls::__Internal
 129
 130 #define GET_SHAPE_CONFIG(shapeId, orientation, x)\
 131         Tizen::Ui::_ResourceManager::GetInstance()->GetShape(Tizen::Ui::_Resource::_##shapeId##_SHAPE, orientation, x)
 132
 133 #define GET_DIMENSION_CONFIG(dimensionId, orientation, x)\
 134         Tizen::Ui::_ResourceManager::GetInstance()->GetDimension(Tizen::Ui::_Resource::_##dimensionId##_DIMENSION, orientation, x)
 135
 136 #define GET_COLOR_CONFIG(colorId, x) \
 137         Tizen::Ui::_ResourceManager::GetInstance()->GetColor(Tizen::Ui::_Resource::_##colorId##_COLOR, x)
 138
 139 #define GET_BITMAP_CONFIG_N(bitmapId, pixelFormat, pOutBitmap)\
 140         Tizen::Ui::_ResourceManager::GetInstance()->GetBitmapN(Tizen::Ui::_Resource::_##bitmapId##_IMAGE, pixelFormat, _CONTROL_ORIENTATION_PORTRAIT, pOutBitmap)
 141
 142 #define GET_STRING_CONFIG(stringId, string)\
 143         Tizen::Ui::_ResourceManager::GetInstance()->GetString(#stringId, string)
 144
 145 #define GET_FIXED_VALUE_CONFIG(fixedValueId, orientation, x)\
 146         Tizen::Ui::_ResourceManager::GetInstance()->GetFixedValue(Tizen::Ui::_Resource::_##fixedValueId##_FIXED_VALUE, orientation, x)
 147
 148 #define GET_ANIMATION_CONFIG_N(animationId, x)\
 149         Tizen::Ui::_ResourceManager::GetInstance()->GetAnimationN(Tizen::Ui::_Resource::_##animationId##_ANIMATION, x)
 150
 151 #define IS_CUSTOM_BITMAP(bitmapId) \
 152         Tizen::Ui::_ResourceManager::GetInstance()->IsCustomBitmap(Tizen::Ui::_Resource::_##bitmapId##_IMAGE)
 153
 154 #define IS_CUSTOM_COLOR(colorId) \
 155         Tizen::Ui::_ResourceManager::GetInstance()->IsCustomColor(Tizen::Ui::_Resource::_##colorId##_COLOR)
 156
 157 #define PLAY_FEEDBACK(pattern) \
 158         Tizen::Ui::_ResourceManager::GetInstance()->PlayFeedback(pattern)
 159
 160 #define IS_PLAYED_FEEDBACK() \
 161         Tizen::Ui::_ResourceManager::GetInstance()->IsFeedbackPlayed()
 162
 163 class _OSP_EXPORT_ _ResourceManager
 164 {
 165 public:
 166         static _ResourceManager* GetInstance(void);
 167         result GetBitmapN(int bitmapId, Tizen::Graphics::BitmapPixelFormat pixelFormat, _ControlOrientation orientation, Tizen::Graphics::Bitmap*& pBitmap);
 168         result GetString(const Tizen::Base::String& stringId, Tizen::Base::String& string);
 169         result GetColor(int colorId, Tizen::Graphics::Color& color);
 170         result GetShape(int shapeId, _ControlOrientation orientation, int& value);
 171         result GetFixedValue(int shapeId, _ControlOrientation orientation, int& value);
 172         result GetDimension(int dimensionId, _ControlOrientation orientation, Tizen::Graphics::Dimension& dimension);
 173         result GetShape(int shapeId, _ControlOrientation orientation, float& value);
 174         result GetFixedValue(int shapeId, _ControlOrientation orientation, float& value);
 175         result GetDimension(int dimensionId, _ControlOrientation orientation, Tizen::Graphics::FloatDimension& dimension);
 176         result GetAnimationN(int animationId, Tizen::Base::Collection::ArrayList*& pList);
 177         void GetThemeName(Tizen::Base::String& systemTheme, Tizen::Base::String& userTheme) const;
 178         void ReloadTheme(Tizen::Base::String& themeName, bool userdefine);
 179         bool IsCustomColor(int colorId);
 180         bool IsCustomBitmap(int bitmapId);
 181         result PlayFeedback(_ResourceFeedbackPattern pattern);
 182         bool IsFeedbackPlayed(void);
 183         void AcquireFeedback(void);
 184         void ReleaseFeedback(void);
 185         void ResetFeedback(void);
 186
 187 private:
 188         _ResourceManager(void);
 189         ~_ResourceManager(void);
 190         static void CreateInstance(void);
 191
 192         void DoPostInitialization(void);
 193
 194         _ResourceManager(const _ResourceManager& rhs);
 195         _ResourceManager& operator =(const _ResourceManager& rhs);
 196
 197         enum MapContainerType
 198         {
 199                 MAP_CONTAINER_TYPE_APP_BASE_PORTRAIT = 0,
 200                 MAP_CONTAINER_TYPE_APP_BASE_LANDSCAPE = 1,
 201                 MAP_CONTAINER_TYPE_DEFAULT_PORTRAIT = 2,
 202                 MAP_CONTAINER_TYPE_DEFAULT_LANDSCAPE = 3,
 203                 MAP_CONTAINER_TYPE_MAX = 4,
 204         };
 205         result GetBitmapInternalN(const Tizen::Base::String& fileName, Tizen::Graphics::BitmapPixelFormat pixelFormat, _ControlOrientation orientation, Tizen::Graphics::Bitmap*& pBitmap);
 206         result GetDefaultShapeWithScaling(int shapeId, _ControlOrientation orientation, int& value);
 207         result GetDefaultShapeWithScaling(int shapeId, _ControlOrientation orientation, Tizen::Graphics::Dimension& value);
 208         result GetDefaultShapeWithScaling(int shapeId, _ControlOrientation orientation, float& value);
 209         result GetDefaultShapeWithScaling(int shapeId, _ControlOrientation orientation, Tizen::Graphics::FloatDimension& value);
 210         result LoadThemeInformation(Tizen::Base::String& systemTheme, Tizen::Base::String& userTheme);
 211         bool InitializeTheme(_Resource::MapContainer& mapContainer);
 212         void LoadConfig(const Tizen::Base::String& resolution, _Resource::MapContainer& mapContainer, int width, int height);
 213         _Resource::MapContainer* GetMapContainer(MapContainerType type);
 214         void SetSystemColor(void);
 215         Tizen::Base::String FindImagePath(const Tizen::Base::String& fileName, int& findFolder);
 216         bool GetDensityDirectory(const Tizen::Base::String& directoryName, float& scaleFactor);
 217         bool GetResolutionDirectory(const Tizen::Base::String& directoryName, float& scaleFactor);
 218
 219 private:
 220
 221         struct ResourceFallbackItem
 222         {
 223                 float scaleFactor;
 224                 Tizen::Base::String directoryName;
 225         };
 226
 227         _Resource::StringLoader* __pStringLoader;
 228         _Resource::MapContainer* __pMapContainer[MAP_CONTAINER_TYPE_MAX];
 229         Tizen::Graphics::_ICoordinateSystemTransformer* __pTransformer;
 230         Tizen::Base::String __appBasePortraitMode;
 231         Tizen::Base::String __appBaseLandscapeMode;
 232         Tizen::Base::String __targetPortraitMode;
 233         Tizen::Base::String __targetLandscapeMode;
 234         Tizen::Base::String __defaultPortraitMode;
 235         Tizen::Base::String __defaultLandscapeMode;
 236         Tizen::Base::String __systemTheme;
 237         Tizen::Base::String __userTheme;
 238         bool __appliedUserTheme;
 239         bool __initializeFeedback;
 240         int __appBaseWidth;
 241         int __appBaseHeight;
 242         int __targetWidth;
 243         int __targetHeight;
 244         int __deviceDPI;
 245         int __logicalWidth;
 246         int __logicalHeight;
 247         _ResourceFeedbackStatus __feedbackStatus;
 248         int __feedbackAcquireCount;
 249         Tizen::Base::Collection::ArrayListT<ResourceFallbackItem*>* __pFallbackList;
 250 };
 251
 252 }}//Tizen::Ui
 253
 254 #endif // _FUI_INTERNAL_RESOURCE_MANAGER_H_