IInputRoot Interface

Summary

Defines the interface for top-level input elements.
Namespace
Avalonia.Input
Interfaces
Implementing Types
graph BT Type-.->Interface0["IInputElement"] click Interface0 "/api/Avalonia.Input/IInputElement" Type-.->Interface1["IInteractive"] click Interface1 "/api/Avalonia.Interactivity/IInteractive" Type-.->Interface2["IVisual"] click Interface2 "/api/Avalonia.VisualTree/IVisual" Type["IInputRoot"] class Type type-node Implementing0["AboutAvaloniaDialog"]-.->Type click Implementing0 "/api/Avalonia.Dialogs/AboutAvaloniaDialog" Implementing1["TopLevel"]-.->Type click Implementing1 "/api/Avalonia.Controls/TopLevel" Implementing2["ReactiveWindow<TViewModel>"]-.->Type click Implementing2 "/api/Avalonia.ReactiveUI/ReactiveWindow_1" Implementing3["EmbeddableControlRoot"]-.->Type click Implementing3 "/api/Avalonia.Controls.Embedding/EmbeddableControlRoot" Implementing4["PopupRoot"]-.->Type click Implementing4 "/api/Avalonia.Controls.Primitives/PopupRoot" Implementing5["ITextInputMethodRoot"]-.->Type click Implementing5 "/api/Avalonia.Input.TextInput/ITextInputMethodRoot" Implementing6["Window"]-.->Type click Implementing6 "/api/Avalonia.Controls/Window" Implementing7["WindowBase"]-.->Type click Implementing7 "/api/Avalonia.Controls/WindowBase"

Syntax

public interface IInputRoot : IInputElement, IInteractive, IVisual

Properties

Name Value Summary
AccessKeyHandler IAccessKeyHandler
Gets or sets the access key handler.
KeyboardNavigationHandler IKeyboardNavigationHandler
Gets or sets the keyboard navigation handler.
MouseDevice IMouseDevice?
Gets associated mouse device
PointerOverElement IInputElement?
Gets or sets the input element that the pointer is currently over.
ShowAccessKeys bool
Gets or sets a value indicating whether access keys are shown in the window.

Extension Methods

Name Value Summary
AddDisposableHandler<TEventArgs>(RoutedEvent<TEventArgs>, EventHandler<TEventArgs>, RoutingStrategies, bool) IDisposable
Adds a handler for the specified routed event and returns a disposable that can terminate the event subscription.
CalculateDistanceFromAncestor(IVisual) int
Calculates the distance from a visual's ancestor.
FindAncestorOfType<T>(bool) T
Finds first ancestor of given type.
FindCommonVisualAncestor(IVisual) IVisual
Tries to get the first common ancestor of two visuals.
FindDescendantOfType<T>(bool) T
Finds first descendant of given type.
GetInputElementsAt(Point) IEnumerable<IInputElement>
Returns the active input elements at a point on an IInputElement.
GetObservable<TEventArgs>(RoutedEvent<TEventArgs>, RoutingStrategies, bool) IObservable<TEventArgs>
Gets an observable for a RoutedEvent<TEventArgs>.
GetSelfAndVisualAncestors() IEnumerable<IVisual>
Enumerates an IVisual and its ancestors in the visual tree.
GetSelfAndVisualDescendants() IEnumerable<IVisual>
Enumerates an IVisual and its descendants in the visual tree.
GetVisualAncestors() IEnumerable<IVisual>
Enumerates the ancestors of an IVisual in the visual tree.
GetVisualAt(Point) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualAt(Point, Func<IVisual, bool>) IVisual
Gets the first visual in the visual tree whose bounds contain a point.
GetVisualChildren() IEnumerable<IVisual>
Enumerates the children of an IVisual in the visual tree.
GetVisualDescendants() IEnumerable<IVisual>
Enumerates the descendants of an IVisual in the visual tree.
GetVisualParent() IVisual
Gets the visual parent of an IVisual.
GetVisualParent<T>() T
Gets the visual parent of an IVisual.
GetVisualRoot() IRenderRoot
Gets the root visual for an IVisual.
GetVisualsAt(Point) IEnumerable<IVisual>
Enumerates the visible visuals in the visual tree whose bounds contain a point.
GetVisualsAt(Point, Func<IVisual, bool>) IEnumerable<IVisual>
Enumerates the visuals in the visual tree whose bounds contain a point.
HitTestCustom(Point) bool
InputHitTest(Point) IInputElement?
Returns the topmost active input element at a point on an IInputElement.
InputHitTest(Point, Func<IVisual, bool>) IInputElement?
Returns the topmost active input element at a point on an IInputElement.
IsVisualAncestorOf(IVisual) bool
Tests whether an IVisual is an ancestor of another visual.
PointToClient(PixelPoint) Point
Converts a point from screen to client coordinates.
PointToScreen(Point) PixelPoint
Converts a point from client to screen coordinates.
TransformToVisual(IVisual) Matrix?
Returns a transform that transforms the visual's coordinates into the coordinates of the specified to.
TranslatePoint(Point, IVisual) Point?
Translates a point relative to this visual to coordinates that are relative to the specified visual.