dali/devel-api/events/key-event-devel.h

   1 #ifndef DALI_KEY_EVENT_DEVEL_H\r
   2 #define DALI_KEY_EVENT_DEVEL_H\r
   3 \r
   4 /*\r
   5  * Copyright (c) 2019 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 // INTERNAL INCLUDES\r
  22 #include <dali/public-api/events/key-event.h>\r
  23 \r
  24 namespace Dali\r
  25 {\r
  26 \r
  27 namespace DevelKeyEvent\r
  28 {\r
  29 \r
  30 /**\r
  31  * @brief Gets the logical key string.\r
  32  *\r
  33  * For example, when the user presses 'shift' key and '1' key together, the logical key is "exclamation".\r
  34  * Plus, the keyPressedName is "1", and the keyPressed is "!".\r
  35  *\r
  36  * @param[in] keyEvent The instance of KeyEvent.\r
  37  * @return The logical key symbol\r
  38  */\r
  39 DALI_CORE_API std::string GetLogicalKey( KeyEvent keyEvent );\r
  40 \r
  41 } // namespace DevelKeyEvent\r
  42 \r
  43 } // namespace Dali\r
  44 \r
  45 #endif // DALI_KEY_EVENT_DEVEL_H\r