1 #ifndef __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__
2 #define __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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
11 // http://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_FACTORY_MODULE
26 #include <dali-toolkit/public-api/controls/text-view/text-view.h>
28 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
36 class LocalizedControlFactory;
40 * @brief This class provides functionality for creating controls which have localized text.
42 * This class keeps track of objects created using its factory methods, and updates them
43 * when the system language changes.
45 * Warning: If the developer calls SetText on the object to overwrite the managed TextView,
46 * then it leads to an inconsistent state where the object will be overwritten with the
47 * localized text when language/locale changes.
50 class LocalizedControlFactory : public BaseHandle
55 * @brief Creates a localized TextView, which is automatically updated when the locale or language changes.
57 * @pre The LocalizedControlFactory has been initialized.
59 * @param textID The id of the localized text with which a platform request (gettext) for localized text can be made.
60 * @param textDomain The text domain for the localized text. Eg "sys_string"
61 * @param textViewTheme A string containing style info about various properties of TextView for different
63 * @return handle to a new localized TextView
65 static Dali::Toolkit::TextView CreateLocalizedTextView( const std::string& textID, const std::string& textDomain = "sys_string", const std::string& textViewTheme = "{}" );
71 * @brief Create a LocalizedControlFactory handle; this can be initialised with LocalizedControlFactory::New().
73 * Calling member functions with an uninitialised handle is not allowed.
75 LocalizedControlFactory();
78 * @brief Virtual destructor.
80 virtual ~LocalizedControlFactory();
83 * @brief Get the singleton of LocalizedControlFactory object.
85 * @return A handle to the LocalizedControlFactory control.
87 static LocalizedControlFactory Get();
90 * @brief Allows the creation of this Control from an Internal::LocalizedControlFactory pointer.
92 * @param[in] impl A pointer to the internal LocalizedControlFactory.
94 LocalizedControlFactory(Internal::LocalizedControlFactory *impl);
95 }; // class LocalizedControlFactory
97 } // namespace Toolkit
104 #endif // __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__