docs/latex/wx/keyevent.tex

   1 \section{\class{wxKeyEvent}}\label{wxkeyevent}
   2
   3 This event class contains information about keypress (character) events.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxEvent}{wxevent}
   8
   9 \wxheading{Include files}
  10
  11 <wx/event.h>
  12
  13 \wxheading{Event table macros}
  14
  15 To process a key event, use these event handler macros to direct input to member
  16 functions that take a wxKeyEvent argument.
  17
  18 \twocolwidtha{7cm}
  19 \begin{twocollist}\itemsep=0pt
  20 \twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event (a non-modifier key has been pressed).}
  21 \twocolitem{{\bf EVT\_KEY\_DOWN(func)}}{Process a wxEVT\_KEY\_DOWN event (any key has been pressed).}
  22 \twocolitem{{\bf EVT\_KEY\_UP(func)}}{Process a wxEVT\_KEY\_UP event (any key has been released).}
  23 \twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event.}
  24 \twocolitem{{\bf EVT\_CHAR\_HOOK(func)}}{Process a wxEVT\_CHAR\_HOOK event.}
  25 \end{twocollist}%
  26
  27 \wxheading{See also}
  28
  29 \helpref{wxWindow::OnChar}{wxwindowonchar},
  30 \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},
  31 \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},
  32 \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}
  33
  34 \latexignore{\rtfignore{\wxheading{Members}}}
  35
  36 \membersection{wxKeyEvent::m\_altDown}
  37
  38 \member{bool}{m\_altDown}
  39
  40 TRUE if the Alt key is pressed down.
  41
  42 \membersection{wxKeyEvent::m\_controlDown}
  43
  44 \member{bool}{m\_controlDown}
  45
  46 TRUE if control is pressed down.
  47
  48 \membersection{wxKeyEvent::m\_keyCode}
  49
  50 \member{long}{m\_keyCode}
  51
  52 Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
  53
  54 \membersection{wxKeyEvent::m\_metaDown}
  55
  56 \member{bool}{m\_metaDown}
  57
  58 TRUE if the Meta key is pressed down.
  59
  60 \membersection{wxKeyEvent::m\_shiftDown}
  61
  62 \member{bool}{m\_shiftDown}
  63
  64 TRUE if shift is pressed down.
  65
  66 \membersection{wxKeyEvent::m\_x}
  67
  68 \member{int}{m\_x}
  69
  70 X position of the event.
  71
  72 \membersection{wxKeyEvent::m\_y}
  73
  74 \member{int}{m\_y}
  75
  76 Y position of the event.
  77
  78 \membersection{wxKeyEvent::wxKeyEvent}
  79
  80 \func{}{wxKeyEvent}{\param{WXTYPE}{ keyEventType}}
  81
  82 Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CHAR\_HOOK.
  83
  84 \membersection{wxKeyEvent::AltDown}
  85
  86 \constfunc{bool}{AltDown}{\void}
  87
  88 Returns TRUE if the Alt key was down at the time of the key event.
  89
  90 \membersection{wxKeyEvent::ControlDown}
  91
  92 \constfunc{bool}{ControlDown}{\void}
  93
  94 Returns TRUE if the control key was down at the time of the key event.
  95
  96 \membersection{wxKeyEvent::GetKeyCode}
  97
  98 \constfunc{int}{GetKeyCode}{\void}
  99
 100 Returns the virtual key code. ASCII events return normal ASCII values,
 101 while non-ASCII events return values such as {\bf WXK\_LEFT} for the
 102 left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual key codes.
 103
 104 \membersection{wxKeyEvent::GetX}
 105
 106 \constfunc{long}{GetX}{\void}
 107
 108 Returns the X position of the event.
 109
 110 \membersection{wxKeyEvent::GetY}
 111
 112 \constfunc{long}{GetY}{\void}
 113
 114 Returns the Y position of the event.
 115
 116 \membersection{wxKeyEvent::MetaDown}
 117
 118 \constfunc{bool}{MetaDown}{\void}
 119
 120 Returns TRUE if the Meta key was down at the time of the key event.
 121
 122 \membersection{wxKeyEvent::GetPosition}
 123
 124 \constfunc{wxPoint}{GetPosition}{\void}
 125
 126 \constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
 127
 128 Obtains the position at which the key was pressed.
 129
 130 \membersection{wxKeyEvent::HasModifiers}
 131
 132 \constfunc{bool}{HasModifiers}{\void}
 133
 134 Returns TRUE if either of {\sc Ctrl}, {\sc Alt} or {\sc Meta} keys was down
 135 at the time of the key event. Note that this function does not take into
 136 account the {\sc Shift} key state.
 137
 138 \membersection{wxKeyEvent::ShiftDown}
 139
 140 \constfunc{bool}{ShiftDown}{\void}
 141
 142 Returns TRUE if the shift key was down at the time of the key event.
 143
 144