1 #ifndef DALI_TOOLKIT_INTERNAL_PROPERTY_HELPER_H
2 #define DALI_TOOLKIT_INTERNAL_PROPERTY_HELPER_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/property.h>
32 * @brief Parses a Property::Value to retrieve the string.
34 * If value is a Property::STRING, then it simply extracts the required string.
35 * If value is a Property::ARRAY, then it combines all the strings it contains into one adding a newline character to each line.
36 * The second option allows users to write long strings over several lines in a JSON file.
38 * @return True if a string was extracted successfully.
40 bool GetStringFromProperty(const Property::Value& value, std::string& output);
42 } // namespace Internal
44 } // namespace Toolkit
48 #endif // DALI_TOOLKIT_INTERNAL_PROPERTY_HELPER_H