src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using System.Runtime.InteropServices;
  19
  20 namespace ElmSharp
  21 {
  22     /// <summary>
  23     /// The EvasKeyEventArgs is an EvasKey EventArgs
  24     /// </summary>
  25     public class EvasKeyEventArgs : EventArgs
  26     {
  27         IntPtr _nativeEventInfo;
  28
  29         /// <summary>
  30         /// BackButton name in Platform
  31         /// </summary>
  32         public const string PlatformBackButtonName = "XF86Back";
  33         /// <summary>
  34         /// MenuButton name in Platform
  35         /// </summary>
  36         public const string PlatformMenuButtonName = "XF86Menu";
  37         /// <summary>
  38         /// HomeButton name in Platform
  39         /// </summary>
  40         public const string PlatformHomeButtonName = "XF86Home";
  41
  42         /// <summary>
  43         /// Gets the name of Key
  44         /// </summary>
  45         public string KeyName { get; private set; }
  46
  47         public EvasEventFlag Flags
  48         {
  49             get
  50             {
  51                 IntPtr offset = Marshal.OffsetOf<EvasEventKeyDown>("event_flags");
  52                 return (EvasEventFlag)Marshal.ReadIntPtr(_nativeEventInfo, (int)offset);
  53             }
  54             set
  55             {
  56                 IntPtr offset = Marshal.OffsetOf<EvasEventKeyDown>("event_flags");
  57                 Marshal.WriteIntPtr(_nativeEventInfo, (int)offset, (IntPtr)value);
  58             }
  59         }
  60
  61         EvasKeyEventArgs(IntPtr info)
  62         {
  63             _nativeEventInfo = info;
  64             var evt = Marshal.PtrToStructure<EvasEventKeyDown>(info);
  65             KeyName = evt.keyname;
  66         }
  67
  68         /// <summary>
  69         /// Creates and initializes a new instance of the EvasKeyEventArgs class.
  70         /// </summary>
  71         /// <param name="data">data info</param>
  72         /// <param name="obj"> object </param>
  73         /// <param name="info">information </param>
  74         /// <returns>EvasKey eventArgs</returns>
  75         static public EvasKeyEventArgs Create(IntPtr data, IntPtr obj, IntPtr info)
  76         {
  77             return new EvasKeyEventArgs(info);
  78         }
  79
  80         /// <summary>
  81         /// Event structure for Key Down event callbacks.
  82         /// </summary>
  83         [StructLayout(LayoutKind.Sequential)]
  84         struct EvasEventKeyDown
  85         {
  86             /// <summary>
  87             /// Name string of the key pressed
  88             /// </summary>
  89             public string keyname;
  90             /// <summary>
  91             /// Data to be passed to the event
  92             /// </summary>
  93             public IntPtr data;
  94             /// <summary>
  95             /// Modifier keys pressed during the event
  96             /// </summary>
  97             public IntPtr modifiers;
  98             /// <summary>
  99             /// Locks info
 100             /// </summary>
 101             public IntPtr locks;
 102             /// <summary>
 103             /// Logical key: (example, shift+1 == exclamation)
 104             /// </summary>
 105             public string key;
 106             /// <summary>
 107             /// UTF8 string if this keystroke has produced a visible string to be ADDED
 108             /// </summary>
 109             public string str;
 110             /// <summary>
 111             /// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one
 112             /// </summary>
 113             public string compose;
 114
 115             public uint timestamp;
 116
 117             /// <summary>
 118             /// Event_flags
 119             /// </summary>
 120             public EvasEventFlag event_flags;
 121             /// <summary>
 122             ///
 123             /// </summary>
 124             public IntPtr dev;
 125             /// <summary>
 126             /// Keycode
 127             /// </summary>
 128             public uint keycode;
 129         };
 130     }
 131
 132     /// <summary>
 133     /// Flags for Events
 134     /// </summary>
 135     [Flags]
 136     public enum EvasEventFlag
 137     {
 138         /// <summary>
 139         /// No fancy flags set
 140         /// </summary>
 141         None = 0,
 142         /// <summary>
 143         ///This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything
 144         /// </summary>
 145         OnHold = 1,
 146     }
 147
 148 }