dali-toolkit/internal/helpers/property-helper.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_PROPERTY_HELPER_H
   2 #define DALI_TOOLKIT_INTERNAL_PROPERTY_HELPER_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/property.h>
  23 #include <string>
  24
  25 namespace Dali
  26 {
  27 namespace Toolkit
  28 {
  29 namespace Internal
  30 {
  31 /**
  32  * @brief Parses a Property::Value to retrieve the string.
  33  *
  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.
  37  *
  38  * @return True if a string was extracted successfully.
  39  */
  40 bool GetStringFromProperty(const Property::Value& value, std::string& output);
  41
  42 } // namespace Internal
  43
  44 } // namespace Toolkit
  45
  46 } // namespace Dali
  47
  48 #endif // DALI_TOOLKIT_INTERNAL_PROPERTY_HELPER_H