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>
27 namespace Dali DALI_IMPORT_API
34 * An instance of this class should be used by the adaptor to send a key event to
38 struct KeyEvent : public Event
41 // Specifies the state of the key event.
44 Down, /**< Key down */
57 * @param[in] keyName The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
58 * @param[in] keyString A string of input characters or key pressed
59 * @param[in] keyCode The unique key code for the key pressed.
60 * @param[in] keyModifier The key modifier for special keys like shift and alt
61 * @param[in] timeStamp The time (in ms) that the key event occurred.
62 * @param[in] keyState The state of the key event.
64 KeyEvent(const std::string& keyName,
65 const std::string& keyString,
68 unsigned long timeStamp,
69 const State& keyState);
79 *@copydoc Dali::KeyEvent::keyPressedName
84 *@copydoc Dali::KeyEvent::keyPressed
86 std::string keyString;
89 * @copydoc Dali::KeyEvent::keyCode
94 *@copydoc Dali::KeyEvent::keyModifier
99 *@copydoc Dali::KeyEvent::time
104 * State of the key event.
111 } // namespace Integration
115 #endif // __DALI_INTEGRATION_KEY_EVENT_H__