-#ifndef __DALI_TOOLKIT_STYLE_MANAGER_H__
-#define __DALI_TOOLKIT_STYLE_MANAGER_H__
+#ifndef DALI_TOOLKIT_STYLE_MANAGER_H
+#define DALI_TOOLKIT_STYLE_MANAGER_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
* If the application wants to customize the theme, RequestThemeChange
* needs to be called.
*
+ * To supply resource paths ( in json ) the following constant is available: APPLICATION_RESOURCE_PATH.
+ * It provides the path to the application resource root folder, from there the filename can an be specified along with
+ * any sub folders, e.g Images, Models etc.
+ * The APPLICATION_RESOURCE_PATH can be retrieved using Application::GetResourcePath()
+ *
* Signals
* | %Signal Name | Method |
* |------------------------------------------------------------|
* | styleChanged | @ref StyleChangedSignal() |
* @SINCE_1_1.32
*/
-class DALI_IMPORT_API StyleManager : public BaseHandle
+class DALI_TOOLKIT_API StyleManager : public BaseHandle
{
public:
- /// @brief Style Changed signal. Emitted after controls have been updated
+ /// @brief Style Changed signal. Emitted after controls have been updated.
typedef Signal< void ( StyleManager, StyleChange::Type ) > StyleChangedSignalType;
/**
- * @brief Create a StyleManager handle; this can be initialised with StyleManager::Get()
+ * @brief Creates a StyleManager handle; this can be initialized with StyleManager::Get().
*
- * Calling member functions with an uninitialised handle is not allowed.
+ * Calling member functions with an uninitialized handle is not allowed.
* @SINCE_1_1.32
*/
StyleManager();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_1.32
~StyleManager();
/**
- * @brief Get the singleton of StyleManager object.
+ * @brief Gets the singleton of StyleManager object.
*
* @SINCE_1_1.32
- * @return A handle to the StyleManager control.
+ * @return A handle to the StyleManager control
*/
static StyleManager Get();
/**
- * @brief Apply a new theme to the application. This will be merged
+ * @brief Applies a new theme to the application. This will be merged
* on top of the default Toolkit theme.
*
* If the application theme file doesn't style all controls that the
* On application startup, it is suggested that the theme file name is
* passed to Application::New instead of using this API to prevent
* controls being styled more than once.
- * @sa Application::New()
+ * @sa Application::New().
*
* @SINCE_1_1.32
* @param[in] themeFile If a relative path is specified, then this is relative
- * to the directory returned by app_get_resource_path().
+ * to the directory returned by Application::GetResourcePath()
*/
void ApplyTheme( const std::string& themeFile );
/**
- * @brief Apply the default Toolkit theme.
+ * @brief Applies the default Toolkit theme.
*
* Request that any application specific styling is removed
* and that the default Toolkit theme is re-applied.
void ApplyDefaultTheme();
/**
- * @brief Set a constant for use when building styles
+ * @brief Sets a constant for use when building styles.
*
* A constant is used in JSON files e.g. "myImage":"{RELATIVE_PATH}/image.jpg"
* where the string "{RELATIVE_PATH}" is substituted with the value.
void SetStyleConstant( const std::string& key, const Property::Value& value );
/**
- * @brief Return the style constant set for a specific key
+ * @brief Returns the style constant set for a specific key.
*
* @SINCE_1_1.32
* @param[in] key The key of the constant
* @param[out] valueOut The value of the constant if it exists
*
- * @return If the constant for key exists then return the constant in valueOut and return true
+ * @return If the constant for key exists, then return the constant in valueOut and return true
*/
bool GetStyleConstant( const std::string& key, Property::Value& valueOut );
/**
- * @brief Apply the specified style to the control.
+ * @brief Applies the specified style to the control.
*
* @SINCE_1_1.32
- * @param[in] control The control to which to apply the style.
+ * @param[in] control The control to which to apply the style
* @param[in] jsonFileName The name of the JSON style file to apply. If a
* relative path is specified, then this is relative to the directory
- * returned by app_get_resource_path().
- * @param[in] styleName The name of the style within the JSON file to apply.
+ * returned by Application::GetResourcePath()
+ * @param[in] styleName The name of the style within the JSON file to apply
*/
void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
* @code
* void YourCallbackName( StyleManager styleManager, StyleChange change );
* @endcode
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
StyleChangedSignalType& StyleChangedSignal();
*
* @note Not intended for application developers
* @SINCE_1_1.32
- * @param[in] impl A pointer to the object.
+ * @param[in] impl A pointer to the object
*/
explicit DALI_INTERNAL StyleManager( Internal::StyleManager *impl );
/// @endcond
/**
* @}
*/
+
} // namespace Toolkit
} // namespace Dali
-
-#endif /* __DALI_TOOLKIT_STYLE_MANAGER_H__ */
+#endif // DALI_TOOLKIT_STYLE_MANAGER_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff