X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fstyling%2Fstyle-manager-devel.h;h=23c799947e4900e55acc304e658fa604a88f0829;hp=faf3c57b3a5b26004cfeb182b7a81e8c85285d28;hb=HEAD;hpb=765016b04068a92516c8dca016fd2bd72fd3ae4c diff --git a/dali-toolkit/devel-api/styling/style-manager-devel.h b/dali-toolkit/devel-api/styling/style-manager-devel.h index faf3c57..42a614e 100644 --- a/dali-toolkit/devel-api/styling/style-manager-devel.h +++ b/dali-toolkit/devel-api/styling/style-manager-devel.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_STYLE_MANAGER_DEVEL_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2023 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. @@ -18,18 +18,29 @@ * */ +// EXTERNAL INCLUDES +#include + // INTERNAL INCLUDES #include namespace Dali { - namespace Toolkit { - namespace DevelStyleManager { +/** + * @brief The Type of BrokenImage + */ +enum class BrokenImageType +{ + SMALL, + NORMAL, + LARGE +}; +using BrokenImageChangedSignalType = Signal; /** * @brief Gets all currently defined configurations. @@ -38,7 +49,44 @@ namespace DevelStyleManager * @param[in] styleManager The instance of StyleManager * @return A property map to the currently defined configurations **/ -DALI_IMPORT_API const Property::Map GetConfigurations( StyleManager styleManager ); +DALI_TOOLKIT_API const Property::Map& GetConfigurations(StyleManager styleManager); + +/** + * @brief Sets an image to be used when a visual has failed to correctly render + * @param[in] styleManager The instance of StyleManager + * @param[in] brokenImageType The type of broken image + * @param[in] brokenImageUrl The broken image url + */ +DALI_TOOLKIT_API void SetBrokenImageUrl(StyleManager styleManager, DevelStyleManager::BrokenImageType brokenImageType, const std::string& brokenImageUrl); + +/** + * @brief Gets an image to be used when a visual has failed to correctly render + * @param[in] styleManager The instance of StyleManager + * @param[in] brokenImageType BrokenImage type + */ +DALI_TOOLKIT_API std::string GetBrokenImageUrl(StyleManager styleManager, DevelStyleManager::BrokenImageType brokenImageType); + +/** + * @brief Get the Broken Image Url List + * + * This list is broken images stored in order of SMALL, NORMAL, and LARGE values except if the value is empty. + * This API just makes the list without comparing size, so the application must set a value that matches the size. + * @param styleManager The instance of StyleManager + * @return A List of Broken Image Url + */ +DALI_TOOLKIT_API std::vector GetBrokenImageUrlList(StyleManager styleManager); + +/** + * @brief This signal is emitted when the URL of the broken image is set + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName(StyleManager styleManager) + * @endcode + * @param styleManager The instance of StyleManager + * @return The signal to connect to + */ +DALI_TOOLKIT_API BrokenImageChangedSignalType& BrokenImageChangedSignal(StyleManager styleManager); } // namespace DevelStyleManager