dali/integration-api/events/key-event-integ.h

   1 #ifndef __DALI_INTEGRATION_KEY_EVENT_H__
   2 #define __DALI_INTEGRATION_KEY_EVENT_H__
   3
   4 /*
   5  * Copyright (c) 2018 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 <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/integration-api/events/event.h>
  26 #include <dali/public-api/events/key-event.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Integration
  32 {
  33
  34 /**
  35  * An instance of this class should be used by the adaptor to send a key event to
  36  * the Dali core.
  37  *
  38  */
  39 struct DALI_CORE_API KeyEvent : public Event
  40 {
  41   // Enumerations
  42   // Specifies the state of the key event.
  43   enum State
  44   {
  45     Down,        /**< Key down */
  46     Up,          /**< Key up */
  47
  48     Last
  49   };
  50
  51   /**
  52    * Default Constructor
  53    */
  54   KeyEvent();
  55
  56   /**
  57    * Constructor
  58    * @param[in]  keyName       The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
  59    * @param[in]  logicalKey    The logical key symbol (eg. shift + 1 == "exclamation")
  60    * @param[in]  keyString     A string of input characters or key pressed
  61    * @param[in]  keyCode       The unique key code for the key pressed.
  62    * @param[in]  keyModifier   The key modifier for special keys like shift and alt
  63    * @param[in]  timeStamp     The time (in ms) that the key event occurred.
  64    * @param[in]  keyState      The state of the key event.
  65    * @param[in]  compose       The key compose
  66    * @param[in]  deviceName    Name of device KeyEvent originated from
  67    * @param[in]  deviceClass   Class of device KeyEvent originated from
  68    * @param[in]  deviceSubclass  Subclass of device KeyEvent originated from
  69    */
  70   KeyEvent(const std::string& keyName,
  71            const std::string& logicalKey,
  72            const std::string& keyString,
  73            int keyCode,
  74            int keyModifier,
  75            unsigned long timeStamp,
  76            const State& keyState,
  77            const std::string& compose,
  78            const std::string& deviceName,
  79            const Device::Class::Type deviceClass,
  80            const Device::Subclass::Type deviceSubclass );
  81
  82   /**
  83    * Constructor, creates a Integration::KeyEvent from a Dali::KeyEvent
  84    * @param[in] event Dali::KeyEvent to convert from
  85    */
  86   explicit KeyEvent( const Dali::KeyEvent& event );
  87
  88   /**
  89    * Virtual destructor
  90    */
  91   virtual ~KeyEvent();
  92
  93   // Data
  94
  95   /**
  96    *@copydoc Dali::KeyEvent::keyPressedName
  97    */
  98   std::string keyName;
  99
 100   /**
 101    * The logical key symbol
 102    */
 103   std::string logicalKey;
 104
 105   /**
 106    *@copydoc Dali::KeyEvent::keyPressed
 107    */
 108   std::string keyString;
 109
 110   /**
 111    * @copydoc Dali::KeyEvent::keyCode
 112    */
 113   int  keyCode;
 114
 115   /**
 116    *@copydoc Dali::KeyEvent::keyModifier
 117    */
 118   int  keyModifier;
 119
 120   /**
 121    *@copydoc Dali::KeyEvent::time
 122    */
 123   unsigned long time;
 124
 125   /**
 126    * State of the key event.
 127    * @see State
 128    */
 129   State state;
 130
 131   /**
 132    * A string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one.
 133    */
 134   std::string compose;
 135
 136   /**
 137    * Name of device KeyEvent originated from
 138    */
 139   std::string deviceName;
 140
 141   /**
 142    * Class of device KeyEvent originated from
 143    */
 144   Device::Class::Type deviceClass;
 145
 146   /**
 147    * Subclass of device KeyEvent originated from
 148    */
 149   Device::Subclass::Type deviceSubclass;
 150 };
 151
 152 } // namespace Integration
 153
 154 } // namespace Dali
 155
 156 #endif // __DALI_INTEGRATION_KEY_EVENT_H__