dali/internal/event/events/key-event-impl.h

   1 #ifndef __DALI_INTERNAL_KEY_EVENT_H__
   2 #define __DALI_INTERNAL_KEY_EVENT_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
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 struct KeyEventImpl
  31 {
  32 public:
  33
  34   /**
  35    * @brief Constructor.
  36    */
  37   KeyEventImpl( Dali::KeyEvent* keyEvent );
  38
  39   /**
  40    * @brief Destructor.
  41    */
  42   ~KeyEventImpl();
  43
  44   /**
  45    * @brief Assignment operator.
  46    * @param[in] rhs A reference to the copied handle
  47    * @return A reference to this
  48    */
  49   KeyEventImpl& operator=( const KeyEventImpl& rhs );
  50
  51   /**
  52    * @brief Get the compose string.
  53    *
  54    * @return The compose string.
  55    */
  56    std::string GetCompose() const;
  57
  58   /**
  59    * @brief Set the compose string to the KeyEvent
  60    * A string if this keystroke has modified a string in the middle of being composed,
  61    * this string replaces the previous one.
  62    *
  63    * @param[in] compose The compose string to set
  64    */
  65   void SetCompose( const std::string& compose );
  66
  67   /**
  68    * @brief Get the device name the key event originated from
  69    *
  70    * @return The device name
  71    */
  72    std::string GetDeviceName() const;
  73
  74   /**
  75    * @brief Set the device name to the KeyEvent
  76    *
  77    * @param[in] deviceName Device name string to set
  78    */
  79   void SetDeviceName( const std::string& deviceName );
  80
  81   /**
  82    * @brief Get the device class the key event originated from
  83    *
  84    * @return The device class
  85    */
  86   Device::Class::Type GetDeviceClass() const;
  87
  88   /**
  89    * @brief Set the device class to the KeyEvent
  90    *
  91    * @param[in] deviceClass Device class to set
  92    */
  93   void SetDeviceClass( Device::Class::Type deviceClass );
  94
  95   /**
  96    * @brief Get the device subclass the key event originated from
  97    *
  98    * @return The device subclass
  99    */
 100   Device::Subclass::Type GetDeviceSubclass() const;
 101
 102   /**
 103    * @brief Set the device subclass to the KeyEvent
 104    *
 105    * @param[in] deviceClass Device subclass to set
 106    */
 107   void SetDeviceSubclass( Device::Subclass::Type deviceSubclass );
 108
 109 private:
 110
 111   // Undefined
 112   KeyEventImpl();
 113
 114   // Undefined
 115   KeyEventImpl( const KeyEventImpl& rhs );
 116
 117 private:
 118
 119   std::string mCompose;
 120   std::string mDeviceName;
 121   Device::Class::Type mDeviceClass;
 122   Device::Subclass::Type mDeviceSubclass;
 123 };
 124
 125 } // namespace Internal
 126
 127 // Helpers for public-api forwarding methods
 128
 129 Internal::KeyEventImpl* GetImplementation( KeyEvent* keyEvent );
 130
 131 const Internal::KeyEventImpl* GetImplementation( const KeyEvent* keyEvent );
 132
 133 } // namespace Dali
 134
 135 #endif // __DALI_INTERNAL_KEY_EVENT_H__