mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
443 lines
11 KiB
C#
443 lines
11 KiB
C#
//
|
|
// Evemts.cs: Events, Key mappings
|
|
//
|
|
// Authors:
|
|
// Miguel de Icaza (miguel@gnome.org)
|
|
//
|
|
using System;
|
|
|
|
namespace Terminal {
|
|
|
|
/// <summary>
|
|
/// The Key enumeration contains special encoding for some keys, but can also
|
|
/// encode all the unicode values that can be passed.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// If the SpecialMask is set, then the value is that of the special mask,
|
|
/// otherwise, the value is the one of the lower bits (as extracted by CharMask)
|
|
/// </para>
|
|
/// <para>
|
|
/// Control keys are the values between 1 and 26 corresponding to Control-A to Control-Z
|
|
/// </para>
|
|
/// <para>
|
|
/// Unicode runes are also stored here, the letter 'A" for example is encoded as a value 65 (not surfaced in the enum).
|
|
/// </para>
|
|
/// </remarks>
|
|
public enum Key : uint {
|
|
CharMask = 0xfffff,
|
|
|
|
/// <summary>
|
|
/// If the SpecialMask is set, then the value is that of the special mask,
|
|
/// otherwise, the value is the one of the lower bits (as extracted by CharMask).
|
|
/// </summary>
|
|
SpecialMask = 0xfff00000,
|
|
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-A
|
|
/// </summary>
|
|
ControlA = 1,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-B
|
|
/// </summary>
|
|
ControlB,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-C
|
|
/// </summary>
|
|
ControlC,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-D
|
|
/// </summary>
|
|
ControlD,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-E
|
|
/// </summary>
|
|
ControlE,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-F
|
|
/// </summary>
|
|
ControlF,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-G
|
|
/// </summary>
|
|
ControlG,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-H
|
|
/// </summary>
|
|
ControlH,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-I (same as the tab key).
|
|
/// </summary>
|
|
ControlI,
|
|
/// <summary>
|
|
/// The key code for the user pressing the tab key (same as pressing Control-I).
|
|
/// </summary>
|
|
Tab = ControlI,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-J
|
|
/// </summary>
|
|
ControlJ,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-K
|
|
/// </summary>
|
|
ControlK,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-L
|
|
/// </summary>
|
|
ControlL,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-M
|
|
/// </summary>
|
|
ControlM,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-N (same as the return key).
|
|
/// </summary>
|
|
ControlN,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-O
|
|
/// </summary>
|
|
ControlO,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-P
|
|
/// </summary>
|
|
ControlP,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-Q
|
|
/// </summary>
|
|
ControlQ,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-R
|
|
/// </summary>
|
|
ControlR,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-S
|
|
/// </summary>
|
|
ControlS,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-T
|
|
/// </summary>
|
|
ControlT,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-U
|
|
/// </summary>
|
|
ControlU,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-V
|
|
/// </summary>
|
|
ControlV,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-W
|
|
/// </summary>
|
|
ControlW,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-X
|
|
/// </summary>
|
|
ControlX,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-Y
|
|
/// </summary>
|
|
ControlY,
|
|
/// <summary>
|
|
/// The key code for the user pressing Control-Z
|
|
/// </summary>
|
|
ControlZ,
|
|
|
|
/// <summary>
|
|
/// The key code for the user pressing the escape key
|
|
/// </summary>
|
|
Esc = 27,
|
|
|
|
/// <summary>
|
|
/// The key code for the user pressing the return key.
|
|
/// </summary>
|
|
Enter = '\n',
|
|
|
|
/// <summary>
|
|
/// The key code for the user pressing the space bar
|
|
/// </summary>
|
|
Space = 32,
|
|
|
|
/// <summary>
|
|
/// The key code for the user pressing the delete key.
|
|
/// </summary>
|
|
Delete = 127,
|
|
|
|
/// <summary>
|
|
/// When this value is set, the Key encodes the sequence Alt-KeyValue.
|
|
/// And the actual value must be extracted by removing the AltMask.
|
|
/// </summary>
|
|
AltMask = 0x80000000,
|
|
|
|
/// <summary>
|
|
/// Backspace key.
|
|
/// </summary>
|
|
Backspace = 0x100000,
|
|
|
|
/// <summary>
|
|
/// Cursor up key
|
|
/// </summary>
|
|
CursorUp,
|
|
/// <summary>
|
|
/// Cursor down key.
|
|
/// </summary>
|
|
CursorDown,
|
|
/// <summary>
|
|
/// Cursor left key.
|
|
/// </summary>
|
|
CursorLeft,
|
|
/// <summary>
|
|
/// Cursor right key.
|
|
/// </summary>
|
|
CursorRight,
|
|
/// <summary>
|
|
/// Page Up key.
|
|
/// </summary>
|
|
PageUp,
|
|
/// <summary>
|
|
/// Page Down key.
|
|
/// </summary>
|
|
PageDown,
|
|
/// <summary>
|
|
/// Home key
|
|
/// </summary>
|
|
Home,
|
|
/// <summary>
|
|
/// End key
|
|
/// </summary>
|
|
End,
|
|
/// <summary>
|
|
/// Delete character key
|
|
/// </summary>
|
|
DeleteChar,
|
|
/// <summary>
|
|
/// Insert character key
|
|
/// </summary>
|
|
InsertChar,
|
|
/// <summary>
|
|
/// F1 key.
|
|
/// </summary>
|
|
F1,
|
|
/// <summary>
|
|
/// F2 key.
|
|
/// </summary>
|
|
F2,
|
|
/// <summary>
|
|
/// F3 key.
|
|
/// </summary>
|
|
F3,
|
|
/// <summary>
|
|
/// F4 key.
|
|
/// </summary>
|
|
F4,
|
|
/// <summary>
|
|
/// F5 key.
|
|
/// </summary>
|
|
F5,
|
|
/// <summary>
|
|
/// F6 key.
|
|
/// </summary>
|
|
F6,
|
|
/// <summary>
|
|
/// F7 key.
|
|
/// </summary>
|
|
F7,
|
|
/// <summary>
|
|
/// F8 key.
|
|
/// </summary>
|
|
F8,
|
|
/// <summary>
|
|
/// F9 key.
|
|
/// </summary>
|
|
F9,
|
|
/// <summary>
|
|
/// F10 key.
|
|
/// </summary>
|
|
F10,
|
|
/// <summary>
|
|
/// Shift-tab key (backwards tab key).
|
|
/// </summary>
|
|
BackTab,
|
|
/// <summary>
|
|
/// A key with an unknown mapping was raised.
|
|
/// </summary>
|
|
Unknown
|
|
}
|
|
|
|
/// <summary>
|
|
/// Describes a keyboard event.
|
|
/// </summary>
|
|
public struct KeyEvent {
|
|
|
|
/// <summary>
|
|
/// Symb olid definition for the key.
|
|
/// </summary>
|
|
public Key Key;
|
|
|
|
/// <summary>
|
|
/// The key value cast to an integer, you will typicall use this for
|
|
/// extracting the Unicode rune value out of a key, when none of the
|
|
/// symbolic options are in use.
|
|
/// </summary>
|
|
public int KeyValue => (int)Key;
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the Alt key was pressed (real or synthesized)
|
|
/// </summary>
|
|
/// <value><c>true</c> if is alternate; otherwise, <c>false</c>.</value>
|
|
public bool IsAlt => (Key & Key.AltMask) != 0;
|
|
|
|
/// <summary>
|
|
/// Determines whether the value is a control key
|
|
/// </summary>
|
|
/// <value><c>true</c> if is ctrl; otherwise, <c>false</c>.</value>
|
|
public bool IsCtrl => ((uint)Key >= 1) && ((uint)Key <= 26);
|
|
|
|
/// <summary>
|
|
/// Constructs a new KeyEvent from the provided Key value - can be a rune cast into a Key value
|
|
/// </summary>
|
|
public KeyEvent (Key k)
|
|
{
|
|
Key = k;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mouse flags reported in MouseEvent.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// They just happen to map to the ncurses ones.
|
|
/// </remarks>
|
|
[Flags]
|
|
public enum MouseFlags {
|
|
/// <summary>
|
|
/// The first mouse button was pressed.
|
|
/// </summary>
|
|
Button1Pressed = unchecked((int)0x2),
|
|
/// <summary>
|
|
/// The first mouse button was released.
|
|
/// </summary>
|
|
Button1Released = unchecked((int)0x1),
|
|
/// <summary>
|
|
/// The first mouse button was clicked (press+release).
|
|
/// </summary>
|
|
Button1Clicked = unchecked((int)0x4),
|
|
/// <summary>
|
|
/// The first mouse button was double-clicked.
|
|
/// </summary>
|
|
Button1DoubleClicked = unchecked((int)0x8),
|
|
/// <summary>
|
|
/// The first mouse button was tripple-clicked.
|
|
/// </summary>
|
|
Button1TripleClicked = unchecked((int)0x10),
|
|
/// <summary>
|
|
/// The second mouse button was pressed.
|
|
/// </summary>
|
|
Button2Pressed = unchecked((int)0x80),
|
|
/// <summary>
|
|
/// The second mouse button was released.
|
|
/// </summary>
|
|
Button2Released = unchecked((int)0x40),
|
|
/// <summary>
|
|
/// The second mouse button was clicked (press+release).
|
|
/// </summary>
|
|
Button2Clicked = unchecked((int)0x100),
|
|
/// <summary>
|
|
/// The second mouse button was double-clicked.
|
|
/// </summary>
|
|
Button2DoubleClicked = unchecked((int)0x200),
|
|
/// <summary>
|
|
/// The second mouse button was tripple-clicked.
|
|
/// </summary>
|
|
Button2TrippleClicked = unchecked((int)0x400),
|
|
/// <summary>
|
|
/// The third mouse button was pressed.
|
|
/// </summary>
|
|
Button3Pressed = unchecked((int)0x2000),
|
|
/// <summary>
|
|
/// The third mouse button was released.
|
|
/// </summary>
|
|
Button3Released = unchecked((int)0x1000),
|
|
/// <summary>
|
|
/// The third mouse button was clicked (press+release).
|
|
/// </summary>
|
|
Button3Clicked = unchecked((int)0x4000),
|
|
/// <summary>
|
|
/// The third mouse button was double-clicked.
|
|
/// </summary>
|
|
Button3DoubleClicked = unchecked((int)0x8000),
|
|
/// <summary>
|
|
/// The third mouse button was tripple-clicked.
|
|
/// </summary>
|
|
Button3TripleClicked = unchecked((int)0x10000),
|
|
/// <summary>
|
|
/// The fourth mouse button was pressed.
|
|
/// </summary>
|
|
Button4Pressed = unchecked((int)0x80000),
|
|
/// <summary>
|
|
/// The fourth mouse button was released.
|
|
/// </summary>
|
|
Button4Released = unchecked((int)0x40000),
|
|
/// <summary>
|
|
/// The fourth button was clicked (press+release).
|
|
/// </summary>
|
|
Button4Clicked = unchecked((int)0x100000),
|
|
/// <summary>
|
|
/// The fourth button was double-clicked.
|
|
/// </summary>
|
|
Button4DoubleClicked = unchecked((int)0x200000),
|
|
/// <summary>
|
|
/// The fourth button was tripple-clicked.
|
|
/// </summary>
|
|
Button4TripleClicked = unchecked((int)0x400000),
|
|
/// <summary>
|
|
/// The fourth button was pressed.
|
|
/// </summary>
|
|
ButtonShift = unchecked((int)0x2000000),
|
|
/// <summary>
|
|
/// Flag: the shift key was pressed when the mouse button took place.
|
|
/// </summary>
|
|
ButtonCtrl = unchecked((int)0x1000000),
|
|
/// <summary>
|
|
/// Flag: the alt key was pressed when the mouse button took place.
|
|
/// </summary>
|
|
ButtonAlt = unchecked((int)0x4000000),
|
|
/// <summary>
|
|
/// The mouse position is being reported in this event.
|
|
/// </summary>
|
|
ReportMousePosition = unchecked((int)0x8000000),
|
|
/// <summary>
|
|
/// Mask that captures all the events.
|
|
/// </summary>
|
|
AllEvents = unchecked((int)0x7ffffff),
|
|
}
|
|
|
|
/// <summary>
|
|
/// Describes a mouse event
|
|
/// </summary>
|
|
public struct MouseEvent {
|
|
/// <summary>
|
|
/// The X (column) location for the mouse event.
|
|
/// </summary>
|
|
public int X;
|
|
|
|
/// <summary>
|
|
/// The Y (column) location for the mouse event.
|
|
/// </summary>
|
|
public int Y;
|
|
|
|
/// <summary>
|
|
/// Flags indicating the kind of mouse event that is being posted.
|
|
/// </summary>
|
|
public MouseFlags Flags;
|
|
|
|
/// <summary>
|
|
/// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:Terminal.MouseEvent"/>.
|
|
/// </summary>
|
|
/// <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:Terminal.MouseEvent"/>.</returns>
|
|
public override string ToString()
|
|
{
|
|
return $"({X},{Y}:{Flags}";
|
|
}
|
|
}
|
|
}
|