dali/devel-api/events/key-event-devel.h

   1 #ifndef DALI_KEY_EVENT_DEVEL_H
   2 #define DALI_KEY_EVENT_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2017 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/events/key-event.h>
  23 #include <dali/devel-api/events/device.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace DevelKeyEvent
  29 {
  30
  31 /**
  32  * @brief Get the device name the key event originated from
  33  *
  34  * @param[in] keyEvent The KeyEvent to retrieve the device name from
  35  * @return The device name
  36  */
  37 DALI_IMPORT_API std::string GetDeviceName( const KeyEvent& keyEvent );
  38
  39 /**
  40  * @brief Get the device class the key event originated from
  41  *
  42  * The device class type is classification type of the input device of event received
  43  * @param[in] keyEvent The KeyEvent to retrieve the device class from
  44  * @return The type of the device class
  45  */
  46 DALI_IMPORT_API DevelDevice::Class::Type GetDeviceClass( const KeyEvent& keyEvent );
  47
  48 /**
  49  * @brief Get the device subclass the key event originated from
  50  *
  51  * The device subclass type is subclassification type of the input device of event received.
  52  * @param[in] keyEvent The KeyEvent to retrieve the device subclass from
  53  * @return The type of the device subclass
  54  */
  55 DALI_IMPORT_API DevelDevice::Subclass::Type GetDeviceSubclass( const KeyEvent& keyEvent );
  56
  57 } // namespace DevelKeyEvent
  58
  59 } // namespace Dali
  60
  61 #endif  //DALI_KEY_EVENT_DEVEL_H