1 #ifndef __DALI_INTEGRATION_KEY_EVENT_H__
2 #define __DALI_INTEGRATION_KEY_EVENT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include <dali/integration-api/events/event.h>
26 #include <dali/public-api/events/key-event.h>
27 #include <dali/devel-api/events/key-event-devel.h>
29 namespace Dali DALI_IMPORT_API
36 * An instance of this class should be used by the adaptor to send a key event to
40 struct KeyEvent : public Event
43 // Specifies the state of the key event.
46 Down, /**< Key down */
59 * @param[in] keyName The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
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] deviceName Name of device KeyEvent originated from
66 * @param[in] deviceClass Class of device KeyEvent originated from
68 KeyEvent(const std::string& keyName,
69 const std::string& keyString,
72 unsigned long timeStamp,
73 const State& keyState,
74 const std::string deviceName,
75 const DevelKeyEvent::DeviceClass::Type deviceClass );
78 * Constructor, creates a Integration::KeyEvent from a Dali::KeyEvent
79 * @param[in] event Dali::KeyEvent to convert from
81 explicit KeyEvent( const Dali::KeyEvent& event );
91 *@copydoc Dali::KeyEvent::keyPressedName
96 *@copydoc Dali::KeyEvent::keyPressed
98 std::string keyString;
101 * @copydoc Dali::KeyEvent::keyCode
106 *@copydoc Dali::KeyEvent::keyModifier
111 *@copydoc Dali::KeyEvent::time
116 * State of the key event.
122 * Name of device KeyEvent originated from
124 std::string deviceName;
127 * Class of device KeyEvent originated from
129 DevelKeyEvent::DeviceClass::Type deviceClass;
132 } // namespace Integration
136 #endif // __DALI_INTEGRATION_KEY_EVENT_H__