src/api_new/core_module.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    core_module.cpp
  18  * @author  Przemyslaw Ciezkowski (p.ciezkowski@samsung.com)
  19  * @authir  Andrzej Surdej (a.surdej@gmail.com)
  20  * @version 1.0
  21  * @brief   File contains declarations of wrt core module.
  22  */
  23
  24 #ifndef CORE_MODULE_H_
  25 #define CORE_MODULE_H_
  26
  27 #include <dpl/wrt-dao-ro/wrt_db_types.h>
  28 #include "i_runnable_widget_object.h"
  29 #include <dpl/singleton.h>
  30 #include <memory>
  31
  32 #include <EWebKit2.h>
  33
  34 namespace WRT {
  35 class CoreModuleImpl; // forward declaration
  36
  37 class CoreModule
  38 {
  39   public:
  40     /**
  41      * Network access mode enum.
  42      */
  43     enum NetworkAccessMode
  44     {
  45         NEVER_CONNECT,
  46         ALWAYS_ASK,
  47         CONNECT_AUTOMATICALLY
  48     };
  49
  50     /**
  51      * Initialize needed by WRT components (database etc).
  52      * Will not throw exception. elm_init() is NOT called in this function.
  53      * You MUST call it before running widget.
  54      * @return true on success, false when it fails
  55      */
  56     bool Init();
  57     bool Init(Ewk_Context* ewk_context);
  58     /**
  59      * Deinitialize CoreModule. If it called without Init() some internal
  60      * asserts will fail.
  61      */
  62     void Terminate();
  63     /**
  64      * Create model with given package name.
  65      * Init must be called earlier. You MUST destroy all
  66      * RunnableWidgetObjectPtr before calling Terminate.
  67      * @param packageName
  68      * @return NULL on fail
  69      */
  70     RunnableWidgetObjectPtr getRunnableWidgetObject(
  71         const std::string& tizenId);
  72     /**
  73      * Gets from database global property of homeNetworkAccess
  74      * @return homeNetworkAccess value
  75      */
  76     NetworkAccessMode homeNetworkAccess();
  77     /**
  78      * Gets from database global property of roamingNetworkAccess
  79      * @return roamingNetworkAccess value
  80      */
  81     NetworkAccessMode roamingNetworkAccess();
  82     /**
  83      * Returns actual value of developer mode.
  84      * @return is developer mode on
  85      */
  86     bool developerMode();
  87
  88   private:
  89     CoreModule();
  90     ~CoreModule();
  91     std::unique_ptr<CoreModuleImpl> m_impl;
  92
  93     friend class DPL::Singleton<CoreModule>;
  94 };
  95
  96 typedef DPL::Singleton<CoreModule> CoreModuleSingleton;
  97 } /* namespace WRT */
  98 #endif /* CORE_MODULE_H_ */