Vixen
02b45cc4
csharp
public sealed class KeyEvent

A key going down or coming up.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

⚠ A key is a position, not a character. Key is the physical key by its US-QWERTY legend — the same HID usage Vixen.Input reports — so a control that wants Escape, Tab or the arrows reads this, and a control that wants the letter somebody typed reads TextInputEvent instead. On an AZERTY keyboard the key that types a is Q, and a text box that built its content out of key codes would be unusable in France.

Routed like anything else, from the focus outwards. That is what lets a dialog handle Escape without every control inside it knowing the dialog exists, and what makes a shortcut on a panel work while the focus is on a field inside it.

Fields and properties (5)

  • public InputKey Key

    Which physical key.

  • public KeyAction Action

    Whether it went down or came up.

  • public ModifierKeys Modifiers

    What was held at the time.

  • public bool IsRepeat

    Whether this is the platform's auto-repeat rather than a fresh press.

  • public TimeSpan Timestamp

    When it happened, on the same clock as Timestamp.

Methods (1)

  • public bool Has(ModifierKeys modifiers)

    Whether exactly these modifiers were held, and no others.

Used by (59, showing 40)

  • AccessKeyTestsVixen.Ui.Tests
  • AdvancedFixtureVixen.Ui.Controls.Advanced.Tests
  • ButtonBaseVixen.Ui.Controls
  • CodeEditorVixen.Ui.Controls.Advanced
  • ColorInputVixen.Ui.Controls.Advanced
  • ControlVixen.Ui.Controls
  • ControlFixtureVixen.Ui.Controls.Tests
  • CurveEditorVixen.Ui.Controls.Advanced
  • DataGridVixen.Ui.Controls.Advanced
  • GradientEditorVixen.Ui.Controls.Advanced
  • InteractionTestsVixen.Ui.Testing.Tests
  • KeyboardTestsVixen.Ui.Tests
  • MenuVixen.Ui.Controls
  • NodeCanvasVixen.Ui.Controls.Advanced
  • NumericInputVixen.Ui.Controls
  • OverlayVixen.Ui.Controls
  • PlatformInputVixen.Platform.Ui
  • RadialMenuVixen.Ui.Controls
  • RadioGroupVixen.Ui.Controls
  • RangeSliderVixen.Ui.Controls
  • ScrollViewVixen.Ui.Controls
  • SelectBaseVixen.Ui.Controls
  • SliderVixen.Ui.Controls
  • TabsVixen.Ui.Controls
  • TextFieldVixen.Ui.Controls
  • TimelineVixen.Ui.Controls.Advanced
  • TreeViewVixen.Ui.Controls.Advanced
  • UiDocumentVixen.Ui
  • UiTestVixen.Ui.Testing
  • AddComponentMenuVixen.Editor.App
  • BlockoutModeVixen.Editor.Blockout
  • BlockoutModeTestsVixen.Editor.Blockout.Tests
  • CommandDispatcherVixen.Editor.Ui
  • CommandPaletteVixen.Editor.Ui
  • CommandTestsVixen.Editor.Ui.Tests
  • EditorShellTestsVixen.Editor.Ui.Tests
  • FakeVixen.Editor.Ui.Tests
  • FoliageModeVixen.Editor.Terrain
  • IEditorModeVixen.Editor.Ui
  • IViewportInputVixen.Editor.SceneView