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

Commit 2ac2eed

Browse files
committed
Remove obsolete references in ViewConfiguration documentation
1 parent 2217725 commit 2ac2eed

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
@@ -1374,57 +1374,45 @@ class ViewConfiguration {
13741374
/// Whether or not the view is currently visible on the screen.
13751375
final bool visible;
13761376

1377-
/// The view insets, as it intersects with [Screen.viewInsets] for the screen
1378-
/// it is on.
1377+
/// The number of physical pixels on each side of the display rectangle into
1378+
/// which the view can render, but over which the operating system will likely
1379+
/// place system UI, such as the keyboard, that fully obscures any content.
13791380
///
1380-
/// For instance, if the view doesn't overlap the
1381-
/// [ScreenConfiguration.viewInsets] area, [viewInsets] will be
1382-
/// [WindowPadding.zero].
1383-
///
1384-
/// The number of physical pixels on each side of this view rectangle into
1385-
/// which the application can draw, but over which the operating system will
1386-
/// likely place system UI, such as the keyboard or system menus, that fully
1387-
/// obscures any content.
1381+
/// The relationship between this [viewInsets], [viewPadding], and [padding]
1382+
/// are described in more detail in the documentation for [FlutterView].
13881383
final WindowPadding viewInsets;
13891384

1390-
/// The view insets, as it intersects with [ScreenConfiguration.viewPadding]
1391-
/// for the screen it is on.
1385+
/// The number of physical pixels on each side of the display rectangle into
1386+
/// which the view can render, but which may be partially obscured by system
1387+
/// UI (such as the system notification area), or physical intrusions in
1388+
/// the display (e.g. overscan regions on television screens or phone sensor
1389+
/// housings).
13921390
///
1393-
/// For instance, if the view doesn't overlap the
1394-
/// [ScreenConfiguration.viewPadding] area, [viewPadding] will be
1395-
/// [WindowPadding.zero].
1391+
/// Unlike [padding], this value does not change relative to [viewInsets].
1392+
/// For example, on an iPhone X, it will not change in response to the soft
1393+
/// keyboard being visible or hidden, whereas [padding] will.
13961394
///
1397-
/// The number of physical pixels on each side of this screen rectangle into
1398-
/// which the application can place a view, but which may be partially
1399-
/// obscured by system UI (such as the system notification area), or physical
1400-
/// intrusions in the display (e.g. overscan regions on television screens or
1401-
/// phone sensor housings).
1395+
/// The relationship between this [viewInsets], [viewPadding], and [padding]
1396+
/// are described in more detail in the documentation for [FlutterView].
14021397
final WindowPadding viewPadding;
14031398

1404-
/// The view insets, as it intersects with
1405-
/// [ScreenConfiguration.systemGestureInsets] for the screen it is on.
1406-
///
1407-
/// For instance, if the view doesn't overlap the
1408-
/// [ScreenConfiguration.systemGestureInsets] area, [systemGestureInsets] will
1409-
/// be [WindowPadding.zero].
1399+
/// The number of physical pixels on each side of the display rectangle into
1400+
/// which the view can render, but where the operating system will consume
1401+
/// input gestures for the sake of system navigation.
14101402
///
1411-
/// The number of physical pixels on each side of this screen rectangle into
1412-
/// which the application can place a view, but where the operating system
1413-
/// will consume input gestures for the sake of system navigation.
1403+
/// For example, an operating system might use the vertical edges of the
1404+
/// screen, where swiping inwards from the edges takes users backward
1405+
/// through the history of screens they previously visited.
14141406
final WindowPadding systemGestureInsets;
14151407

1416-
/// The view insets, as it intersects with [ScreenConfiguration.padding] for
1417-
/// the screen it is on.
1418-
///
1419-
/// For instance, if the view doesn't overlap the
1420-
/// [ScreenConfiguration.padding] area, [padding] will be
1421-
/// [WindowPadding.zero].
1408+
/// The number of physical pixels on each side of the display rectangle into
1409+
/// which the view can render, but which may be partially obscured by system
1410+
/// UI (such as the system notification area), or physical intrusions in
1411+
/// the display (e.g. overscan regions on television screens or phone sensor
1412+
/// housings).
14221413
///
1423-
/// The number of physical pixels on each side of this screen rectangle into
1424-
/// which the application can place a view, but which may be partially
1425-
/// obscured by system UI (such as the system notification area), or physical
1426-
/// intrusions in the display (e.g. overscan regions on television screens or
1427-
/// phone sensor housings).
1414+
/// The relationship between this [viewInsets], [viewPadding], and [padding]
1415+
/// are described in more detail in the documentation for [FlutterView].
14281416
final WindowPadding padding;
14291417

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

0 commit comments

Comments
 (0)