Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit 2d2b51d

Browse files
authored
Remove obsolete references in ViewConfiguration documentation (#39708)
Co-authored-by: Bruno Leroux <bruno.leroux@gmail.com>
1 parent 57cbf08 commit 2d2b51d

File tree

1 file changed

+28
-40
lines changed

1 file changed

+28
-40
lines changed

lib/ui/platform_dispatcher.dart

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1405,57 +1405,45 @@ class ViewConfiguration {
14051405
/// Whether or not the view is currently visible on the screen.
14061406
final bool visible;
14071407

1408-
/// The view insets, as it intersects with [Screen.viewInsets] for the screen
1409-
/// it is on.
1408+
/// The number of physical pixels on each side of the display rectangle into
1409+
/// which the view can render, but over which the operating system will likely
1410+
/// place system UI, such as the keyboard, that fully obscures any content.
14101411
///
1411-
/// For instance, if the view doesn't overlap the
1412-
/// [ScreenConfiguration.viewInsets] area, [viewInsets] will be
1413-
/// [ViewPadding.zero].
1414-
///
1415-
/// The number of physical pixels on each side of this view rectangle into
1416-
/// which the application can draw, but over which the operating system will
1417-
/// likely place system UI, such as the keyboard or system menus, that fully
1418-
/// obscures any content.
1412+
/// The relationship between this [viewInsets], [viewPadding], and [padding]
1413+
/// are described in more detail in the documentation for [FlutterView].
14191414
final ViewPadding viewInsets;
14201415

1421-
/// The view insets, as it intersects with [ScreenConfiguration.viewPadding]
1422-
/// for the screen it is on.
1416+
/// The number of physical pixels on each side of the display rectangle into
1417+
/// which the view can render, but which may be partially obscured by system
1418+
/// UI (such as the system notification area), or physical intrusions in
1419+
/// the display (e.g. overscan regions on television screens or phone sensor
1420+
/// housings).
14231421
///
1424-
/// For instance, if the view doesn't overlap the
1425-
/// [ScreenConfiguration.viewPadding] area, [viewPadding] will be
1426-
/// [ViewPadding.zero].
1422+
/// Unlike [padding], this value does not change relative to [viewInsets].
1423+
/// For example, on an iPhone X, it will not change in response to the soft
1424+
/// keyboard being visible or hidden, whereas [padding] will.
14271425
///
1428-
/// The number of physical pixels on each side of this screen rectangle into
1429-
/// which the application can place a view, but which may be partially
1430-
/// obscured by system UI (such as the system notification area), or physical
1431-
/// intrusions in the display (e.g. overscan regions on television screens or
1432-
/// phone sensor housings).
1426+
/// The relationship between this [viewInsets], [viewPadding], and [padding]
1427+
/// are described in more detail in the documentation for [FlutterView].
14331428
final ViewPadding viewPadding;
14341429

1435-
/// The view insets, as it intersects with
1436-
/// [ScreenConfiguration.systemGestureInsets] for the screen it is on.
1437-
///
1438-
/// For instance, if the view doesn't overlap the
1439-
/// [ScreenConfiguration.systemGestureInsets] area, [systemGestureInsets] will
1440-
/// be [ViewPadding.zero].
1430+
/// The number of physical pixels on each side of the display rectangle into
1431+
/// which the view can render, but where the operating system will consume
1432+
/// input gestures for the sake of system navigation.
14411433
///
1442-
/// The number of physical pixels on each side of this screen rectangle into
1443-
/// which the application can place a view, but where the operating system
1444-
/// will consume input gestures for the sake of system navigation.
1434+
/// For example, an operating system might use the vertical edges of the
1435+
/// screen, where swiping inwards from the edges takes users backward
1436+
/// through the history of screens they previously visited.
14451437
final ViewPadding systemGestureInsets;
14461438

1447-
/// The view insets, as it intersects with [ScreenConfiguration.padding] for
1448-
/// the screen it is on.
1449-
///
1450-
/// For instance, if the view doesn't overlap the
1451-
/// [ScreenConfiguration.padding] area, [padding] will be
1452-
/// [ViewPadding.zero].
1439+
/// The number of physical pixels on each side of the display rectangle into
1440+
/// which the view can render, but which may be partially obscured by system
1441+
/// UI (such as the system notification area), or physical intrusions in
1442+
/// the display (e.g. overscan regions on television screens or phone sensor
1443+
/// housings).
14531444
///
1454-
/// The number of physical pixels on each side of this screen rectangle into
1455-
/// which the application can place a view, but which may be partially
1456-
/// obscured by system UI (such as the system notification area), or physical
1457-
/// intrusions in the display (e.g. overscan regions on television screens or
1458-
/// phone sensor housings).
1445+
/// The relationship between this [viewInsets], [viewPadding], and [padding]
1446+
/// are described in more detail in the documentation for [FlutterView].
14591447
final ViewPadding padding;
14601448

14611449
/// Additional configuration for touch gestures performed on this view.

0 commit comments

Comments
 (0)