EventResult

type EventResult = {
  stopPropagation: boolean;
  cursorShape: EmbindString;
  tooltip: EmbindString;
  contextMenu: Menu;
};

Simple record that is returned by the input event handling mechanism of Display to indicate how to proceed.

Its main property is the EventResult#stopPropagation flag whether to continue or stop the event propagation (other event systems often call this "accepted"). Furthermore, it stores additional optional members describing visual cues or elements that the GUI should show to the user as reaction to the event (e.g. mouse cursor shape, tooltip, context menu).

Properties

stopPropagation

stopPropagation: boolean;

Flag whether the event was accepted and event processing should stop.

cursorShape

cursorShape: EmbindString;

Optional string to request showing a particular mouse cursor. A non-empty string refers to one of the values for the CSS cursor property.

tooltip

tooltip: EmbindString;

Optional text to show hovering next to the mouse cursor. A non-empty string indicates that the GUI should display a tool tip.

contextMenu

contextMenu: Menu;

An optional menu to show to the user next to the mouse cursor as reaction to the event (usually populated as reaction to a ContextMenuEvent).