dali/internal/input/common/key-impl.h

   1 #ifndef DALI_KEY_IMPL_H
   2 #define DALI_KEY_IMPL_H
   3
   4 /*
   5  * Copyright (c) 2019 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/adaptor-framework/key.h>
  23 #include <dali/devel-api/adaptor-framework/key-extension-plugin.h>
  24 #include <dali/devel-api/adaptor-framework/key-devel.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal
  30 {
  31
  32 namespace Adaptor
  33 {
  34
  35 /**
  36  * Implementation of the Key matching
  37  */
  38 namespace KeyLookup
  39 {
  40
  41 struct KeyLookup
  42 {
  43   const char* keyName;          ///< XF86 key name
  44   const Dali::KEY daliKeyCode;  ///< Dali key code
  45   const bool  deviceButton;     ///< Whether the key is from a button on the device
  46 };
  47
  48 extern KeyLookup KeyLookupTable[];
  49 extern const std::size_t KEY_LOOKUP_COUNT;
  50
  51 /**
  52  * @copydoc Dali::IsKey()
  53  */
  54 bool IsKey( const Dali::KeyEvent& keyEvent, Dali::KEY daliKey );
  55
  56 /**
  57  * Check if a the given key name string is a button on the device itself.
  58  * @param keyName A pointer to the key name
  59  * @return true if the key is matched, false if not
  60  */
  61 bool IsDeviceButton( const char* keyName );
  62
  63 /**
  64  * Get a key name from a dali key code.
  65  * @param daliKey The dali key code
  66  * @return The key name. NULL if the daliKey does not exist in the supported key lookup table.
  67  */
  68 const char* GetKeyName( Dali::KEY daliKey );
  69
  70 /**
  71  * @brief Get the key code from a key name.
  72  * @param[in] keyName The key name
  73  * @return The key code. -1 if the daliKey does not exist in the supported key lookup table.
  74  */
  75 int GetDaliKeyCode( const char* keyName );
  76
  77 } // namespace KeyLookup
  78
  79 } // namespace Adaptor
  80
  81 } // namespace Internal
  82
  83 } // namespace Dali
  84
  85 #endif // DALI_KEY_IMPL_H