mcs/class/Managed.Windows.Forms/System.Windows.Forms/KeyEventArgs.cs

   1 // Permission is hereby granted, free of charge, to any person obtaining
   2 // a copy of this software and associated documentation files (the
   3 // "Software"), to deal in the Software without restriction, including
   4 // without limitation the rights to use, copy, modify, merge, publish,
   5 // distribute, sublicense, and/or sell copies of the Software, and to
   6 // permit persons to whom the Software is furnished to do so, subject to
   7 // the following conditions:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 //
  20 // Copyright (c) 2004-2005 Novell, Inc.
  21 //
  22 // Authors:
  23 //      Peter Bartok    pbartok@novell.com
  24 //
  25 //
  26
  27
  28 // COMPLETE
  29
  30 using System.Runtime.InteropServices;
  31
  32 namespace System.Windows.Forms {
  33         [ComVisible(true)]
  34         public class KeyEventArgs : EventArgs {
  35                 private Keys    key_data;
  36                 private bool    event_handled;
  37
  38 #if NET_2_0
  39                 private bool    supress_key_press;
  40 #endif
  41
  42                 #region Public Constructors
  43                 public KeyEventArgs(Keys keyData) {
  44                         this.key_data=keyData | XplatUI.State.ModifierKeys;
  45                         this.event_handled=false;
  46                 }
  47                 #endregion      // Public Constructors
  48
  49                 #region Public Instance Properties
  50                 public virtual bool Alt {
  51                         get {
  52                                 if ((this.key_data & Keys.Alt)==0) {
  53                                         return false;
  54                                 } else {
  55                                         return true;
  56                                 }
  57                         }
  58                 }
  59
  60                 public bool Control {
  61                         get {
  62                                 if ((this.key_data & Keys.Control)==0) {
  63                                         return false;
  64                                 } else {
  65                                         return true;
  66                                 }
  67                         }
  68                 }
  69
  70                 public bool Handled {
  71                         get {
  72                                 return this.event_handled;
  73                         }
  74
  75                         set {
  76                                 this.event_handled=value;
  77                         }
  78                 }
  79
  80                 public Keys KeyCode {
  81                         get {
  82                                 return (this.key_data & Keys.KeyCode);
  83                         }
  84                 }
  85
  86                 public Keys KeyData {
  87                         get {
  88                                 return this.key_data;
  89                         }
  90                 }
  91
  92                 public int KeyValue {
  93                         get {
  94                                 return Convert.ToInt32(this.key_data);
  95                         }
  96                 }
  97
  98                 public Keys Modifiers {
  99                         get {
 100                                 return (this.key_data & Keys.Modifiers);
 101                         }
 102                 }
 103
 104                 public virtual bool Shift {
 105                         get {
 106                                 if ((this.key_data & Keys.Shift)==0) {
 107                                         return false;
 108                                 } else {
 109                                         return true;
 110                                 }
 111                         }
 112                 }
 113
 114 #if NET_2_0
 115                 public bool SuppressKeyPress {
 116                         get {
 117                                 return supress_key_press;
 118                         }
 119                         set {
 120                                 supress_key_press = value;
 121                                 event_handled = value;
 122                         }
 123                 }
 124 #endif
 125                 #endregion      // Public Instance Properties
 126         }
 127 }