MediaQuery class
Establishes a subtree in which media queries resolve to the given data.
For example, to learn the size of the current media (e.g., the window
containing your app), you can read the MediaQueryData.size property from
the MediaQueryData returned by MediaQuery.of:
MediaQuery.of(context).size
.
Querying the current media using MediaQuery.of will cause your widget to rebuild automatically whenever the MediaQueryData changes (e.g., if the user rotates their device).
If no MediaQuery is in scope then the MediaQuery.of method will throw an
exception, unless the nullOk
argument is set to true, in which case it
returns null.
See also:
- WidgetsApp and MaterialApp, which introduce a MediaQuery and keep it up to date with the current screen metrics as they change.
- MediaQueryData, the data structure that represents the metrics.
- Inheritance
Constructors
- MediaQuery({Key key, @required MediaQueryData data, @required Widget child })
-
Creates a widget that provides MediaQueryData to its descendants. [...]
const
- MediaQuery.removePadding({Key key, @required BuildContext context, bool removeLeft: false, bool removeTop: false, bool removeRight: false, bool removeBottom: false, @required Widget child })
-
Creates a new MediaQuery that inherits from the ambient MediaQuery from
the given context, but removes the specified paddings. [...]
factory
- MediaQuery.removeViewInsets({Key key, @required BuildContext context, bool removeLeft: false, bool removeTop: false, bool removeRight: false, bool removeBottom: false, @required Widget child })
-
Creates a new MediaQuery that inherits from the ambient MediaQuery from
the given context, but removes the specified view insets. [...]
factory
Properties
- data → MediaQueryData
-
Contains information about the current media. [...]
final
- child → Widget
-
The widget below this widget in the tree. [...]
final, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- key → Key
-
Controls how one widget replaces another widget in the tree. [...]
final, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node. [...]
override
-
updateShouldNotify(
covariant MediaQuery oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget. [...]
override
-
createElement(
) → InheritedElement -
Inflates this configuration to a concrete instance. [...]
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children. [...]
@protected, inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toDiagnosticsNode(
{String name, DiagnosticsTreeStyle style }) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by toStringDeep. [...]
inherited
-
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns a string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns a string representation of this node and its descendants. [...]
inherited
-
toStringShallow(
{String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns a one-line detailed description of the object. [...]
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
dynamic other) → bool -
The equality operator. [...]
inherited
Static Methods
-
boldTextOverride(
BuildContext context) → bool - Returns the boldText accessibility setting for the nearest MediaQuery ancestor, or false if no such ancestor exists.
-
of(
BuildContext context, { bool nullOk: false }) → MediaQueryData - The data from the closest instance of this class that encloses the given context. [...]
-
textScaleFactorOf(
BuildContext context) → double - Returns textScaleFactor for the nearest MediaQuery ancestor or 1.0, if no such ancestor exists.