@@ -125,7 +125,7 @@ abstract class FlutterView {
125
125
/// system UI. The [padding] and [viewInsets] properties provide information
126
126
/// about how much of each side of the view may be obscured by system UI.
127
127
///
128
- /// This value is the same as [physicalGeometry.size ] .
128
+ /// This value is the same as the `size` member of [physicalGeometry] .
129
129
///
130
130
/// See also:
131
131
///
@@ -309,10 +309,10 @@ class SingletonFlutterWindow extends FlutterWindow {
309
309
: super ._(windowId, platformDispatcher);
310
310
311
311
/// A callback that is invoked whenever the [devicePixelRatio] ,
312
- /// [physicalSize] , [padding] , [viewInsets] , [PlatformDispatcher.views] ,
313
- /// [PlatformDispatcher.screens] , or [ systemGestureInsets] values change.
312
+ /// [physicalSize] , [padding] , [viewInsets] , [PlatformDispatcher.views] , or
313
+ /// [systemGestureInsets] values change.
314
314
///
315
- /// {@template flutter.lib.ui.window.forwardWarning }
315
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
316
316
///
317
317
/// See [PlatformDispatcher.onMetricsChanged] for more information.
318
318
VoidCallback ? get onMetricsChanged => platformDispatcher.onMetricsChanged;
@@ -374,7 +374,7 @@ class SingletonFlutterWindow extends FlutterWindow {
374
374
375
375
/// A callback that is invoked whenever [locale] changes value.
376
376
///
377
- /// {@macro flutter.lib.ui.window.forwardWarning }
377
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
378
378
///
379
379
/// The framework invokes this callback in the same zone in which the
380
380
/// callback was set.
@@ -424,7 +424,7 @@ class SingletonFlutterWindow extends FlutterWindow {
424
424
425
425
/// A callback that is invoked whenever [textScaleFactor] changes value.
426
426
///
427
- /// {@macro flutter.lib.ui.window.forwardWarning }
427
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
428
428
///
429
429
/// The framework invokes this callback in the same zone in which the
430
430
/// callback was set.
@@ -448,7 +448,7 @@ class SingletonFlutterWindow extends FlutterWindow {
448
448
449
449
/// A callback that is invoked whenever [platformBrightness] changes value.
450
450
///
451
- /// {@macro flutter.lib.ui.window.forwardWarning }
451
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
452
452
///
453
453
/// The framework invokes this callback in the same zone in which the
454
454
/// callback was set.
@@ -466,7 +466,7 @@ class SingletonFlutterWindow extends FlutterWindow {
466
466
/// time to provide a scene using the [SceneBuilder] API and the [render]
467
467
/// method.
468
468
///
469
- /// {@macro flutter.lib.ui.window.forwardWarning }
469
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
470
470
///
471
471
/// When possible, this is driven by the hardware VSync signal. This is only
472
472
/// called if [scheduleFrame] has been called since the last time this
@@ -493,7 +493,7 @@ class SingletonFlutterWindow extends FlutterWindow {
493
493
/// A callback that is invoked for each frame after [onBeginFrame] has
494
494
/// completed and after the microtask queue has been drained.
495
495
///
496
- /// {@macro flutter.lib.ui.window.forwardWarning }
496
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
497
497
///
498
498
/// This can be used to implement a second phase of frame rendering that
499
499
/// happens after any deferred work queued by the [onBeginFrame] phase.
@@ -515,10 +515,10 @@ class SingletonFlutterWindow extends FlutterWindow {
515
515
/// A callback that is invoked to report the [FrameTiming] of recently
516
516
/// rasterized frames.
517
517
///
518
- /// {@macro flutter.lib.ui.window.forwardWarning }
518
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
519
519
///
520
520
/// It's prefered to use [SchedulerBinding.addTimingsCallback] than to use
521
- /// [FlutterWindow .onReportTimings] directly because
521
+ /// [SingletonFlutterWindow .onReportTimings] directly because
522
522
/// [SchedulerBinding.addTimingsCallback] allows multiple callbacks.
523
523
///
524
524
/// This can be used to see if the window has missed frames (through
@@ -542,7 +542,7 @@ class SingletonFlutterWindow extends FlutterWindow {
542
542
543
543
/// A callback that is invoked when pointer data is available.
544
544
///
545
- /// {@macro flutter.lib.ui.window.forwardWarning }
545
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
546
546
///
547
547
/// The framework invokes this callback in the same zone in which the
548
548
/// callback was set.
@@ -615,7 +615,7 @@ class SingletonFlutterWindow extends FlutterWindow {
615
615
616
616
/// A callback that is invoked when the value of [semanticsEnabled] changes.
617
617
///
618
- /// {@macro flutter.lib.ui.window.forwardWarning }
618
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
619
619
///
620
620
/// The framework invokes this callback in the same zone in which the
621
621
/// callback was set.
@@ -627,7 +627,7 @@ class SingletonFlutterWindow extends FlutterWindow {
627
627
/// A callback that is invoked whenever the user requests an action to be
628
628
/// performed.
629
629
///
630
- /// {@macro flutter.lib.ui.window.forwardWarning }
630
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
631
631
///
632
632
/// This callback is used when the user expresses the action they wish to
633
633
/// perform based on the semantics supplied by [updateSemantics] .
@@ -644,7 +644,7 @@ class SingletonFlutterWindow extends FlutterWindow {
644
644
645
645
/// A callback that is invoked when the value of [accessibilityFeatures] changes.
646
646
///
647
- /// {@macro flutter.lib.ui.window.forwardWarning }
647
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
648
648
///
649
649
/// The framework invokes this callback in the same zone in which the
650
650
/// callback was set.
@@ -684,7 +684,7 @@ class SingletonFlutterWindow extends FlutterWindow {
684
684
/// Called whenever this window receives a message from a platform-specific
685
685
/// plugin.
686
686
///
687
- /// {@macro flutter.lib.ui.window.forwardWarning }
687
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
688
688
///
689
689
/// The `name` parameter determines which plugin sent the message. The `data`
690
690
/// parameter is the payload and is typically UTF-8 encoded JSON but can be
@@ -704,7 +704,7 @@ class SingletonFlutterWindow extends FlutterWindow {
704
704
/// Set the debug name associated with this platform dispatcher's root
705
705
/// isolate.
706
706
///
707
- /// {@macro flutter.lib.ui.window.forwardWarning }
707
+ /// {@macro flutter.lib.ui.window.accessorForwardWarning }
708
708
///
709
709
/// Normally debug names are automatically generated from the Dart port, entry
710
710
/// point, and source file. For example: `main.dart$main-1234` .
@@ -798,9 +798,214 @@ class AccessibilityFeatures {
798
798
/// [SingletonFlutterWindow] .
799
799
///
800
800
/// This class will be removed once the framework no longer refers to it.
801
+ // In order for the documentation build to succeed, this interface duplicates
802
+ // all of the methods with documentation, overrides them, and calls the super
803
+ // implementation. Once this merges into the framework and the framework
804
+ // references to it can be updated, this class will be removed entirely.
801
805
class Window extends SingletonFlutterWindow {
802
806
Window ._(Object windowId, PlatformDispatcher platformDispatcher)
803
807
: super ._(windowId, platformDispatcher);
808
+
809
+ @override
810
+ // ignore: unnecessary_overrides
811
+ double get devicePixelRatio => super .devicePixelRatio;
812
+
813
+ @override
814
+ // ignore: unnecessary_overrides
815
+ Rect get physicalGeometry => super .physicalGeometry;
816
+
817
+ @override
818
+ // ignore: unnecessary_overrides
819
+ Size get physicalSize => super .physicalSize;
820
+
821
+ @override
822
+ // ignore: unnecessary_overrides
823
+ WindowPadding get viewInsets => super .viewInsets;
824
+
825
+ @override
826
+ // ignore: unnecessary_overrides
827
+ WindowPadding get viewPadding => super .viewPadding;
828
+
829
+ @override
830
+ // ignore: unnecessary_overrides
831
+ WindowPadding get systemGestureInsets => super .systemGestureInsets;
832
+
833
+ @override
834
+ // ignore: unnecessary_overrides
835
+ WindowPadding get padding => super .padding;
836
+
837
+ @override
838
+ // ignore: unnecessary_overrides
839
+ void render (Scene scene) => super .render (scene);
840
+
841
+ @override
842
+ // ignore: unnecessary_overrides
843
+ VoidCallback ? get onMetricsChanged => super .onMetricsChanged;
844
+ @override
845
+ // ignore: unnecessary_overrides
846
+ set onMetricsChanged (VoidCallback ? callback) {
847
+ super .onMetricsChanged = callback;
848
+ }
849
+
850
+ @override
851
+ // ignore: unnecessary_overrides
852
+ Locale ? get locale => super .locale;
853
+
854
+ @override
855
+ // ignore: unnecessary_overrides
856
+ List <Locale >? get locales => super .locales;
857
+
858
+ @override
859
+ // ignore: unnecessary_overrides
860
+ Locale ? computePlatformResolvedLocale (List <Locale > supportedLocales) {
861
+ return super .computePlatformResolvedLocale (supportedLocales);
862
+ }
863
+
864
+ @override
865
+ // ignore: unnecessary_overrides
866
+ VoidCallback ? get onLocaleChanged => super .onLocaleChanged;
867
+ @override
868
+ // ignore: unnecessary_overrides
869
+ set onLocaleChanged (VoidCallback ? callback) {
870
+ super .onLocaleChanged = callback;
871
+ }
872
+
873
+ @override
874
+ // ignore: unnecessary_overrides
875
+ String get initialLifecycleState => super .initialLifecycleState;
876
+
877
+ @override
878
+ // ignore: unnecessary_overrides
879
+ double get textScaleFactor => super .textScaleFactor;
880
+
881
+ @override
882
+ // ignore: unnecessary_overrides
883
+ bool get alwaysUse24HourFormat => super .alwaysUse24HourFormat;
884
+
885
+ @override
886
+ // ignore: unnecessary_overrides
887
+ VoidCallback ? get onTextScaleFactorChanged => super .onTextScaleFactorChanged;
888
+ @override
889
+ // ignore: unnecessary_overrides
890
+ set onTextScaleFactorChanged (VoidCallback ? callback) {
891
+ super .onTextScaleFactorChanged = callback;
892
+ }
893
+
894
+ @override
895
+ // ignore: unnecessary_overrides
896
+ Brightness get platformBrightness => super .platformBrightness;
897
+
898
+ @override
899
+ // ignore: unnecessary_overrides
900
+ VoidCallback ? get onPlatformBrightnessChanged => super .onPlatformBrightnessChanged;
901
+ @override
902
+ // ignore: unnecessary_overrides
903
+ set onPlatformBrightnessChanged (VoidCallback ? callback) {
904
+ super .onPlatformBrightnessChanged = callback;
905
+ }
906
+
907
+ @override
908
+ // ignore: unnecessary_overrides
909
+ FrameCallback ? get onBeginFrame => super .onBeginFrame;
910
+ @override
911
+ // ignore: unnecessary_overrides
912
+ set onBeginFrame (FrameCallback ? callback) {
913
+ super .onBeginFrame = callback;
914
+ }
915
+
916
+ @override
917
+ // ignore: unnecessary_overrides
918
+ VoidCallback ? get onDrawFrame => super .onDrawFrame;
919
+ @override
920
+ // ignore: unnecessary_overrides
921
+ set onDrawFrame (VoidCallback ? callback) {
922
+ super .onDrawFrame = callback;
923
+ }
924
+
925
+ @override
926
+ // ignore: unnecessary_overrides
927
+ TimingsCallback ? get onReportTimings => super .onReportTimings;
928
+ @override
929
+ // ignore: unnecessary_overrides
930
+ set onReportTimings (TimingsCallback ? callback) {
931
+ super .onReportTimings = callback;
932
+ }
933
+
934
+ @override
935
+ // ignore: unnecessary_overrides
936
+ PointerDataPacketCallback ? get onPointerDataPacket => super .onPointerDataPacket;
937
+ @override
938
+ // ignore: unnecessary_overrides
939
+ set onPointerDataPacket (PointerDataPacketCallback ? callback) {
940
+ super .onPointerDataPacket = callback;
941
+ }
942
+
943
+ @override
944
+ // ignore: unnecessary_overrides
945
+ String get defaultRouteName => super .defaultRouteName;
946
+
947
+ @override
948
+ // ignore: unnecessary_overrides
949
+ void scheduleFrame () => super .scheduleFrame ();
950
+
951
+ @override
952
+ // ignore: unnecessary_overrides
953
+ bool get semanticsEnabled => super .semanticsEnabled;
954
+
955
+ @override
956
+ // ignore: unnecessary_overrides
957
+ VoidCallback ? get onSemanticsEnabledChanged => super .onSemanticsEnabledChanged;
958
+ @override
959
+ // ignore: unnecessary_overrides
960
+ set onSemanticsEnabledChanged (VoidCallback ? callback) {
961
+ super .onSemanticsEnabledChanged = callback;
962
+ }
963
+
964
+ @override
965
+ // ignore: unnecessary_overrides
966
+ SemanticsActionCallback ? get onSemanticsAction => super .onSemanticsAction;
967
+ @override
968
+ // ignore: unnecessary_overrides
969
+ set onSemanticsAction (SemanticsActionCallback ? callback) {
970
+ super .onSemanticsAction = callback;
971
+ }
972
+
973
+ @override
974
+ // ignore: unnecessary_overrides
975
+ AccessibilityFeatures get accessibilityFeatures => super .accessibilityFeatures;
976
+
977
+ @override
978
+ // ignore: unnecessary_overrides
979
+ VoidCallback ? get onAccessibilityFeaturesChanged =>
980
+ super .onAccessibilityFeaturesChanged;
981
+ @override
982
+ // ignore: unnecessary_overrides
983
+ set onAccessibilityFeaturesChanged (VoidCallback ? callback) {
984
+ super .onAccessibilityFeaturesChanged = callback;
985
+ }
986
+
987
+ @override
988
+ // ignore: unnecessary_overrides
989
+ void updateSemantics (SemanticsUpdate update) => super .updateSemantics (update);
990
+
991
+ @override
992
+ // ignore: unnecessary_overrides
993
+ void sendPlatformMessage (String name, ByteData ? data, PlatformMessageResponseCallback ? callback) {
994
+ super .sendPlatformMessage (name, data, callback);
995
+ }
996
+
997
+ @override
998
+ // ignore: unnecessary_overrides
999
+ PlatformMessageCallback ? get onPlatformMessage => super .onPlatformMessage;
1000
+ @override
1001
+ // ignore: unnecessary_overrides
1002
+ set onPlatformMessage (PlatformMessageCallback ? callback) {
1003
+ super .onPlatformMessage = callback;
1004
+ }
1005
+
1006
+ @override
1007
+ // ignore: unnecessary_overrides
1008
+ void setIsolateDebugName (String name) => super .setIsolateDebugName (name);
804
1009
}
805
1010
806
1011
/// Describes the contrast of a theme or color palette.
0 commit comments