shared/example.h

   1 #ifndef DALI_DEMO_EXAMPLE_H\r
   2 #define DALI_DEMO_EXAMPLE_H\r
   3 \r
   4 /*\r
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.\r
   6  *\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  *\r
  11  * http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  *\r
  19  */\r
  20 \r
  21 // EXTERNAL INCLUDES\r
  22 #include <string>\r
  23 #include <vector>\r
  24 \r
  25 /**\r
  26  * Example information\r
  27  *\r
  28  * Represents a single Example.\r
  29  */\r
  30 struct Example\r
  31 {\r
  32   // Constructors\r
  33 \r
  34   /**\r
  35    * @param[in] uniqueName unique name of example\r
  36    * @param[in] captionTitle The caption for the example to appear on a tile button.\r
  37    */\r
  38   Example(std::string uniqueName, std::string captionTitle)\r
  39   : name(uniqueName),\r
  40     title(captionTitle)\r
  41   {\r
  42   }\r
  43 \r
  44   ~Example() = default;\r
  45 \r
  46   // Data\r
  47 \r
  48   std::string name;  ///< unique name of example\r
  49   std::string title; ///< title (caption) of example to appear on tile button.\r
  50 };\r
  51 \r
  52 using ExampleList          = std::vector<Example>;\r
  53 using ExampleListConstIter = ExampleList::const_iterator;\r
  54 \r
  55 #endif // DALI_DEMO_SHARED_EXAMPLE_H\r