Class KeyEvent

Defines a key event.

Inheritance

object

Event

KeyEvent

Inherited Members

Event.Type

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Sharpie

Assembly: sharpie.dll

Syntax

[PublicAPI]
public sealed class KeyEvent : Event

Properties

Char

The character that was pressed. Only valid if Key is Character.

Declaration

public Rune Char { get; }

Property Value

Type	Description
Rune

Key

The key that was pressed. If the value is Character then Char contains the actual code of the key.

Declaration

public Key Key { get; }

Property Value

Type	Description
Key

Modifiers

The modifier keys that were present at the time.

Declaration

public ModifierKey Modifiers { get; }

Property Value

Type	Description
ModifierKey

Name

The printable name of the key.

Declaration

public string? Name { get; }

Property Value

Type	Description
string

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

Event.Equals(object?)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

Event.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

Event.ToString()