VirtualWindow class

Deprecated. Will be removed in a future version of Flutter.

Implemented types

• SingletonFlutterWindow

Available extensions

• SingletonFlutterWindowExtension

Annotations

• @Deprecated('Deprecated to prepare for the upcoming multi-window support. ' 'This feature was deprecated after v3.9.0-0.1.pre.')

Constructors

VirtualWindow.fromPlatformDispatcher({required VirtualPlatformDispatcher platformDispatcher})

Properties

accessibilityFeatures → AccessibilityFeatures

Additional accessibility features that may be enabled by the platform.

no setter, override

alwaysUse24HourFormat → bool

The setting indicating whether time should always be shown in the 24-hour format.

no setter, override

brieflyShowPassword → bool

Whether briefly displaying the characters as you type in obscured text fields is enabled in system settings.

no setter, override

debugPhysicalSizeOverride ← Size?

Available on SingletonFlutterWindow, provided by the SingletonFlutterWindowExtension extension

Overrides the value of physicalSize in tests.

no getter

defaultRouteName → String

The route or path that the embedder requested when the application was launched.

no setter, override

devicePixelRatio → double

The number of device pixels for each logical pixel for the screen this view is displayed on.

no setter, override

display → Display

The Display this view is drawn in.

no setter, override

displayFeatures → List<DisplayFeature>

Areas of the display that are obstructed by hardware features.

no setter, override

frameData → FrameData

The FrameData object for the current frame.

no setter, override

gestureSettings → GestureSettings

Additional configuration for touch gestures performed on this view.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

initialLifecycleState → String

The lifecycle state immediately after dart isolate initialization.

no setter, override

locale → Locale

The system-reported default locale of the device.

no setter, override

locales → List<Locale>

The full system-reported supported locales of the device.

no setter, override

nativeSpellCheckServiceDefined → bool

Whether the spell check service is supported on the current platform.

no setter, override

onAccessibilityFeaturesChanged ↔ VoidCallback?

A callback that is invoked when the value of accessibilityFeatures changes.

getter/setter pair, override

onBeginFrame ↔ FrameCallback?

A callback that is invoked to notify the window that it is an appropriate time to provide a scene using the SceneBuilder API and the render method.

getter/setter pair, override

onDrawFrame ↔ VoidCallback?

A callback that is invoked for each frame after onBeginFrame has completed and after the microtask queue has been drained.

getter/setter pair, override

onFrameDataChanged ↔ VoidCallback?

A callback that is invoked when the window updates the FrameData.

getter/setter pair, override

onKeyData ↔ KeyDataCallback?

A callback that is invoked when key data is available.

getter/setter pair, override

onLocaleChanged ↔ VoidCallback?

A callback that is invoked whenever locale changes value.

getter/setter pair, override

onMetricsChanged ↔ VoidCallback?

A callback that is invoked whenever the devicePixelRatio, physicalSize, padding, viewInsets, PlatformDispatcher.views, or systemGestureInsets values change.

getter/setter pair, override

onPlatformBrightnessChanged ↔ VoidCallback?

A callback that is invoked whenever platformBrightness changes value.

getter/setter pair, override

onPlatformMessage ↔ PlatformMessageCallback?

Deprecated. Migrate to ChannelBuffers.setListener instead.

getter/setter pair, override

onPointerDataPacket ↔ PointerDataPacketCallback?

A callback that is invoked when pointer data is available.

getter/setter pair, override

onReportTimings ↔ TimingsCallback?

A callback that is invoked to report the FrameTiming of recently rasterized frames.

getter/setter pair, override

onSemanticsEnabledChanged ↔ VoidCallback?

A callback that is invoked when the value of semanticsEnabled changes.

getter/setter pair, override

onSystemFontFamilyChanged ↔ VoidCallback?

A callback that is invoked whenever systemFontFamily changes value.

getter/setter pair, override

onTextScaleFactorChanged ↔ VoidCallback?

A callback that is invoked whenever textScaleFactor changes value.

getter/setter pair, override

padding → ViewPadding

The number of physical pixels on each side of the display rectangle into which the view can render, but which may be partially obscured by system UI (such as the system notification area), or physical intrusions in the display (e.g. overscan regions on television screens or phone sensor housings).

no setter, override

physicalConstraints → ViewConstraints

The sizing constraints in physical pixels for this view.

no setter, override

physicalSize → Size

The current dimensions of the rectangle as last reported by the platform into which scenes rendered in this view are drawn.

no setter, override

platformBrightness → Brightness

The setting indicating the current brightness mode of the host platform.

no setter, override

platformDispatcher → VirtualPlatformDispatcher

The platform dispatcher that this view is registered with, and gets its information from.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

semanticsEnabled → bool

Whether the user has requested that updateSemantics be called when the semantic contents of window changes.

no setter, override

supportsShowingSystemContextMenu → bool

Whether the spell check service is supported on the current platform.

no setter, override

systemFontFamily → String?

The setting indicating the system font of the host platform.

no setter, override

systemGestureInsets → ViewPadding

The number of physical pixels on each side of the display rectangle into which the view can render, but where the operating system will consume input gestures for the sake of system navigation.

no setter, override

textScaleFactor → double

The system-reported text scale.

no setter, override

viewId → int

The opaque ID for this view.

no setter, override

viewInsets → ViewPadding

The number of physical pixels on each side of the display rectangle into which the view can render, but over which the operating system will likely place system UI, such as the keyboard, that fully obscures any content.

no setter, override

viewPadding → ViewPadding

The number of physical pixels on each side of the display rectangle into which the view can render, but which may be partially obscured by system UI (such as the system notification area), or physical intrusions in the display (e.g. overscan regions on television screens or phone sensor housings).

no setter, override

Methods

computePlatformResolvedLocale(List<Locale> supportedLocales) → Locale?

Performs the platform-native locale resolution.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

render(Scene scene, {Size? size}) → void

Updates the view's rendering on the GPU with the newly provided Scene.

override

scheduleFrame() → void

Requests that, at the next appropriate opportunity, the onBeginFrame and onDrawFrame callbacks be invoked.

override

sendPlatformMessage(String name, ByteData? data, PlatformMessageResponseCallback? callback) → void

Sends a message to a platform-specific plugin.

override

setIsolateDebugName(String name) → void

Set the debug name associated with this platform dispatcher's root isolate.

override

toString() → String

A string representation of this object.

inherited

updateSemantics(SemanticsUpdate update) → void

Change the retained semantics data about this FlutterView.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited