1 #ifndef __DALI_INTERNAL_KEY_EVENT_H__
2 #define __DALI_INTERNAL_KEY_EVENT_H__
5 * Copyright (c) 2017 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.
22 #include <dali/public-api/events/key-event.h>
37 KeyEventImpl( Dali::KeyEvent* keyEvent );
45 * @brief Assignment operator.
46 * @param[in] rhs A reference to the copied handle
47 * @return A reference to this
49 KeyEventImpl& operator=( const KeyEventImpl& rhs );
52 * @brief Get the key symbol string.
53 * @return The key symbol
55 std::string GetLogicalKey() const;
58 * @brief Set the key symbol string to the KeyEvent.
59 * @param[in] key The key symbol to set
61 void SetLogicalKey( const std::string& logicalKey );
64 * @brief Get the compose string.
66 * @return The compose string.
68 std::string GetCompose() const;
71 * @brief Set the compose string to the KeyEvent
72 * A string if this keystroke has modified a string in the middle of being composed,
73 * this string replaces the previous one.
75 * @param[in] compose The compose string to set
77 void SetCompose( const std::string& compose );
80 * @brief Get the device name the key event originated from
82 * @return The device name
84 std::string GetDeviceName() const;
87 * @brief Set the device name to the KeyEvent
89 * @param[in] deviceName Device name string to set
91 void SetDeviceName( const std::string& deviceName );
94 * @brief Get the device class the key event originated from
96 * @return The device class
98 Device::Class::Type GetDeviceClass() const;
101 * @brief Set the device class to the KeyEvent
103 * @param[in] deviceClass Device class to set
105 void SetDeviceClass( Device::Class::Type deviceClass );
108 * @brief Get the device subclass the key event originated from
110 * @return The device subclass
112 Device::Subclass::Type GetDeviceSubclass() const;
115 * @brief Set the device subclass to the KeyEvent
117 * @param[in] deviceClass Device subclass to set
119 void SetDeviceSubclass( Device::Subclass::Type deviceSubclass );
127 KeyEventImpl( const KeyEventImpl& rhs );
131 std::string mLogicalKey;
132 std::string mCompose;
133 std::string mDeviceName;
134 Device::Class::Type mDeviceClass;
135 Device::Subclass::Type mDeviceSubclass;
138 } // namespace Internal
140 // Helpers for public-api forwarding methods
142 Internal::KeyEventImpl* GetImplementation( KeyEvent* keyEvent );
144 const Internal::KeyEventImpl* GetImplementation( const KeyEvent* keyEvent );
148 #endif // __DALI_INTERNAL_KEY_EVENT_H__