capi/dali-toolkit/public-api/factory/localized-control-factory.h

   1 #ifndef __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__
   2 #define __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_FACTORY_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/text-view/text-view.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class LocalizedControlFactory;
  38 }
  39
  40 /**
  41  * @brief This class provides functionality for creating controls which have localized text.
  42  *
  43  * This class keeps track of objects created using its factory methods, and updates them
  44  * when the system language changes.
  45  *
  46  * Warning: If the developer calls SetText on the object to overwrite the managed TextView,
  47  * then it leads to an inconsistent state where the object will be overwritten with the
  48  * localized text when language/locale changes.
  49  */
  50
  51 class LocalizedControlFactory : public BaseHandle
  52 {
  53 public:
  54
  55   /**
  56    * @brief Creates a localized TextView, which is automatically updated when the locale or language changes.
  57    *
  58    * @pre The LocalizedControlFactory has been initialized.
  59    *
  60    * @param textID The id of the localized text with which a platform request (gettext) for localized text can be made.
  61    * @param textDomain The text domain for the localized text. Eg "sys_string"
  62    * @param textViewTheme A string containing style info about various properties of TextView for different
  63    *        locale/language.
  64    * @return handle to a new localized TextView
  65    */
  66   static Dali::Toolkit::TextView CreateLocalizedTextView( const std::string& textID, const std::string& textDomain = "sys_string", const std::string& textViewTheme = "{}" );
  67
  68
  69 private:
  70
  71   /**
  72    * @brief Create a LocalizedControlFactory handle; this can be initialised with LocalizedControlFactory::New().
  73    *
  74    * Calling member functions with an uninitialised handle is not allowed.
  75    */
  76   LocalizedControlFactory();
  77
  78   /**
  79    * @brief Destructor
  80    *
  81    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  82    */
  83   ~LocalizedControlFactory();
  84
  85   /**
  86    * @brief Get the singleton of LocalizedControlFactory object.
  87    *
  88    * @return A handle to the LocalizedControlFactory control.
  89    */
  90   static LocalizedControlFactory Get();
  91
  92   /**
  93    * @brief Allows the creation of this Control from an Internal::LocalizedControlFactory pointer.
  94    *
  95    * @param[in]  impl  A pointer to the internal LocalizedControlFactory.
  96    */
  97   LocalizedControlFactory(Internal::LocalizedControlFactory *impl);
  98 }; // class LocalizedControlFactory
  99
 100 } // namespace Toolkit
 101
 102 } // namespace Dali
 103
 104 /**
 105  * @}
 106  */
 107 #endif // __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__