#ifndef __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__
#define __DALI_TOOLKIT_LOCALIZED_CONTROL_FACTORY_H__
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
/**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_FACTORY_MODULE
* @{
*/
}
/**
- * LocalizedControlFactory
- * This class provides functionality for creating controls which have localized text.
+ * @brief This class provides functionality for creating controls which have localized text.
+ *
* This class keeps track of objects created using its factory methods, and updates them
* when the system language changes.
*
* localized text when language/locale changes.
*/
- class LocalizedControlFactory : public BaseHandle
- {
- public:
+class LocalizedControlFactory : public BaseHandle
+{
+public:
/**
- * Creates a localized TextView, which is automatically updated when the locale or language changes.
+ * @brief Creates a localized TextView, which is automatically updated when the locale or language changes.
*
* @pre The LocalizedControlFactory has been initialized.
*
* @param textDomain The text domain for the localized text. Eg "sys_string"
* @param textViewTheme A string containing style info about various properties of TextView for different
* locale/language.
+ * @return handle to a new localized TextView
*/
static Dali::Toolkit::TextView CreateLocalizedTextView( const std::string& textID, const std::string& textDomain = "sys_string", const std::string& textViewTheme = "{}" );
private:
/**
- * Create a LocalizedControlFactory handle; this can be initialised with LocalizedControlFactory::New()
+ * @brief Create a LocalizedControlFactory handle; this can be initialised with LocalizedControlFactory::New().
+ *
* Calling member functions with an uninitialised handle is not allowed.
*/
LocalizedControlFactory();
/**
- * Virtual destructor.
+ * @brief Virtual destructor.
*/
virtual ~LocalizedControlFactory();
/**
- * Get the singleton of LocalizedControlFactory object.
+ * @brief Get the singleton of LocalizedControlFactory object.
+ *
* @return A handle to the LocalizedControlFactory control.
*/
static LocalizedControlFactory Get();
/**
- * Allows the creation of this Control from an Internal::LocalizedControlFactory pointer.
+ * @brief Allows the creation of this Control from an Internal::LocalizedControlFactory pointer.
+ *
* @param[in] impl A pointer to the internal LocalizedControlFactory.
*/
LocalizedControlFactory(Internal::LocalizedControlFactory *impl);