docs: added project code documentation
This commit is contained in:
parent
07584a48a1
commit
0465851ec5
2866 changed files with 64165 additions and 0 deletions
|
|
@ -0,0 +1,487 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
|
||||
<meta name="description" content="API docs for the ReceiveScreenState class from the receive_screen library, for the Dart programming language.">
|
||||
<title>ReceiveScreenState class - receive_screen library - Dart API</title>
|
||||
|
||||
|
||||
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
|
||||
|
||||
<link rel="stylesheet" href="../static-assets/github.css?v1">
|
||||
<link rel="stylesheet" href="../static-assets/styles.css?v1">
|
||||
<link rel="icon" href="../static-assets/favicon.png?v1">
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body data-base-href="../" data-using-base-href="false" class="light-theme">
|
||||
|
||||
<div id="overlay-under-drawer"></div>
|
||||
|
||||
<header id="title">
|
||||
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
|
||||
<ol class="breadcrumbs gt-separated dark hidden-xs">
|
||||
<li><a href="../index.html">flutter_test_gui</a></li>
|
||||
<li><a href="../pages_receive_screen/pages_receive_screen-library.html">pages/receive_screen.dart</a></li>
|
||||
<li class="self-crumb">ReceiveScreenState class</li>
|
||||
</ol>
|
||||
<div class="self-name">ReceiveScreenState</div>
|
||||
<form class="search navbar-right" role="search">
|
||||
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
||||
</form>
|
||||
<div class="toggle" id="theme-button" title="Toggle brightness">
|
||||
<label for="theme">
|
||||
<input type="checkbox" id="theme" value="light-theme">
|
||||
<span id="dark-theme-button" class="material-symbols-outlined">
|
||||
dark_mode
|
||||
</span>
|
||||
<span id="light-theme-button" class="material-symbols-outlined">
|
||||
light_mode
|
||||
</span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<main>
|
||||
|
||||
<div
|
||||
id="dartdoc-main-content"
|
||||
class="main-content"
|
||||
data-above-sidebar="pages_receive_screen/pages_receive_screen-library-sidebar.html"
|
||||
data-below-sidebar="pages_receive_screen/ReceiveScreenState-class-sidebar.html">
|
||||
<div>
|
||||
<h1><span class="kind-class">ReceiveScreenState</span> class
|
||||
|
||||
</h1></div>
|
||||
|
||||
|
||||
<section class="desc markdown">
|
||||
<p>State for the receive screen.</p>
|
||||
</section>
|
||||
|
||||
|
||||
<section>
|
||||
<dl class="dl-horizontal">
|
||||
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<ul class="gt-separated dark clazz-relationships">
|
||||
<li><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></li>
|
||||
<li><a href="https://api.flutter.dev/flutter/widgets/State-class.html">State</a><span class="signature"><<wbr><span class="type-parameter"><a href="../pages_receive_screen/ReceiveScreen-class.html">ReceiveScreen</a></span>></span></li>
|
||||
<li>ReceiveScreenState</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
<section class="summary offset-anchor" id="constructors">
|
||||
<h2>Constructors</h2>
|
||||
|
||||
<dl class="constructor-summary-list">
|
||||
<dt id="ReceiveScreenState" class="callable">
|
||||
<span class="name"><a href="../pages_receive_screen/ReceiveScreenState/ReceiveScreenState.html">ReceiveScreenState</a></span><span class="signature">()</span>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
<section
|
||||
class="summary offset-anchor"
|
||||
id="instance-properties">
|
||||
<h2>Properties</h2>
|
||||
<dl class="properties">
|
||||
<dt id="appOrigin" class="property">
|
||||
<span class="name"><a href="../pages_receive_screen/ReceiveScreenState/appOrigin.html">appOrigin</a></span>
|
||||
<span class="signature">↔ <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
The URL of the app that initiated the transfer.
|
||||
<div class="features"><span class="feature">getter/setter pair</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="context" class="property inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/context.html">context</a></span>
|
||||
<span class="signature">→ <a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
The location in the tree where this widget builds.
|
||||
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="hashCode" class="property inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
|
||||
<span class="signature">→ <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
The hash code for this object.
|
||||
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="inputValue" class="property">
|
||||
<span class="name"><a href="../pages_receive_screen/ReceiveScreenState/inputValue.html">inputValue</a></span>
|
||||
<span class="signature">↔ <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
The current input value of the connection link input.
|
||||
<div class="features"><span class="feature">getter/setter pair</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="mounted" class="property inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/mounted.html">mounted</a></span>
|
||||
<span class="signature">→ <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Whether this <a href="https://api.flutter.dev/flutter/widgets/State-class.html">State</a> object is currently in a tree.
|
||||
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="myController" class="property">
|
||||
<span class="name"><a href="../pages_receive_screen/ReceiveScreenState/myController.html">myController</a></span>
|
||||
<span class="signature">→ <a href="https://api.flutter.dev/flutter/widgets/TextEditingController-class.html">TextEditingController</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
Text editing controller for the connection link input.
|
||||
<div class="features"><span class="feature">final</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="runtimeType" class="property inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
|
||||
<span class="signature">→ <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
A representation of the runtime type of the object.
|
||||
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="widget" class="property inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/widget.html">widget</a></span>
|
||||
<span class="signature">→ <a href="../pages_receive_screen/ReceiveScreen-class.html">ReceiveScreen</a></span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
The current configuration.
|
||||
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
<section
|
||||
class="summary offset-anchor"
|
||||
id="instance-methods">
|
||||
<h2>Methods</h2>
|
||||
<dl class="callables">
|
||||
<dt id="activate" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/activate.html">activate</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called when this object is reinserted into the tree after having been
|
||||
removed via <a href="https://api.flutter.dev/flutter/widgets/State/deactivate.html">deactivate</a>.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="build" class="callable">
|
||||
<span class="name"><a href="../pages_receive_screen/ReceiveScreenState/build.html">build</a></span><span class="signature">(<wbr><span class="parameter" id="build-param-context"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/widgets/BuildContext-class.html">BuildContext</a></span> <span class="parameter-name">context</span></span>)
|
||||
<span class="returntype parameter">→ <a href="https://api.flutter.dev/flutter/widgets/Widget-class.html">Widget</a></span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
Builds the scaffold for the receive screen.
|
||||
<div class="features"><span class="feature">override</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="deactivate" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/deactivate.html">deactivate</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called when this object is removed from the tree.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="debugFillProperties" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/debugFillProperties.html">debugFillProperties</a></span><span class="signature">(<wbr><span class="parameter" id="debugFillProperties-param-properties"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/DiagnosticPropertiesBuilder-class.html">DiagnosticPropertiesBuilder</a></span> <span class="parameter-name">properties</span></span>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Add additional properties associated with the node.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="didChangeDependencies" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/didChangeDependencies.html">didChangeDependencies</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called when a dependency of this <a href="https://api.flutter.dev/flutter/widgets/State-class.html">State</a> object changes.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="didUpdateWidget" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/didUpdateWidget.html">didUpdateWidget</a></span><span class="signature">(<wbr><span class="parameter" id="didUpdateWidget-param-oldWidget"><span>covariant</span> <span class="type-annotation"><a href="../pages_receive_screen/ReceiveScreen-class.html">ReceiveScreen</a></span> <span class="parameter-name">oldWidget</span></span>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called whenever the widget configuration changes.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="dispose" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/dispose.html">dispose</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called when this object is removed from the tree permanently.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="initState" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/initState.html">initState</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called when this object is inserted into the tree.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="loadSettings" class="callable">
|
||||
<span class="name"><a href="../pages_receive_screen/ReceiveScreenState/loadSettings.html">loadSettings</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ <a href="https://api.flutter.dev/flutter/dart-async/Future-class.html">Future</a><span class="signature"><<wbr><span class="type-parameter">void</span>></span></span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd>
|
||||
Loads the app origin from the shared preferences.
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="noSuchMethod" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
|
||||
<span class="returntype parameter">→ dynamic</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Invoked when a nonexistent method or property is accessed.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="reassemble" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/reassemble.html">reassemble</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Called whenever the application is reassembled during debugging, for
|
||||
example during hot reload.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="setState" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/widgets/State/setState.html">setState</a></span><span class="signature">(<wbr><span class="parameter" id="setState-param-fn"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">fn</span></span>)
|
||||
<span class="returntype parameter">→ void</span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Notify the framework that the internal state of this object has changed.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="toDiagnosticsNode" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/Diagnosticable/toDiagnosticsNode.html">toDiagnosticsNode</a></span><span class="signature">(<wbr><span class="parameter" id="toDiagnosticsNode-param-name">{<span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">name</span>, </span><span class="parameter" id="toDiagnosticsNode-param-style"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/DiagnosticsTreeStyle.html">DiagnosticsTreeStyle</a>?</span> <span class="parameter-name">style</span>}</span>)
|
||||
<span class="returntype parameter">→ <a href="https://api.flutter.dev/flutter/foundation/DiagnosticsNode-class.html">DiagnosticsNode</a></span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
Returns a debug representation of the object that is used by debugging
|
||||
tools and by <a href="https://api.flutter.dev/flutter/foundation/DiagnosticsNode/toStringDeep.html">DiagnosticsNode.toStringDeep</a>.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="toString" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/Diagnosticable/toString.html">toString</a></span><span class="signature">(<wbr><span class="parameter" id="toString-param-minLevel">{<span class="type-annotation"><a href="https://api.flutter.dev/flutter/foundation/DiagnosticLevel.html">DiagnosticLevel</a></span> <span class="parameter-name">minLevel</span> = <span class="default-value">DiagnosticLevel.info</span>}</span>)
|
||||
<span class="returntype parameter">→ <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
A string representation of this object.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
<dt id="toStringShort" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/Diagnosticable/toStringShort.html">toStringShort</a></span><span class="signature">(<wbr>)
|
||||
<span class="returntype parameter">→ <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
A brief description of this object, usually just the <a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a> and the
|
||||
<a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a>.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
<section
|
||||
class="summary offset-anchor inherited"
|
||||
id="operators">
|
||||
<h2>Operators</h2>
|
||||
<dl class="callables">
|
||||
<dt id="operator ==" class="callable inherited">
|
||||
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
|
||||
<span class="returntype parameter">→ <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
|
||||
</span>
|
||||
|
||||
|
||||
</dt>
|
||||
<dd class="inherited">
|
||||
The equality operator.
|
||||
<div class="features"><span class="feature">inherited</span></div>
|
||||
|
||||
</dd>
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- /.main-content -->
|
||||
|
||||
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
|
||||
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
|
||||
<header id="header-search-sidebar" class="hidden-l">
|
||||
<form class="search-sidebar" role="search">
|
||||
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
||||
</form>
|
||||
</header>
|
||||
|
||||
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
|
||||
<li><a href="../index.html">flutter_test_gui</a></li>
|
||||
<li><a href="../pages_receive_screen/pages_receive_screen-library.html">receive_screen</a></li>
|
||||
<li class="self-crumb">ReceiveScreenState class</li>
|
||||
</ol>
|
||||
|
||||
|
||||
<h5>receive_screen library</h5>
|
||||
<div id="dartdoc-sidebar-left-content"></div>
|
||||
</div>
|
||||
|
||||
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
|
||||
</div><!--/.sidebar-offcanvas-->
|
||||
|
||||
</main>
|
||||
|
||||
<footer>
|
||||
<span class="no-break">
|
||||
flutter_test_gui
|
||||
1.0.0+1
|
||||
</span>
|
||||
|
||||
|
||||
</footer>
|
||||
|
||||
|
||||
|
||||
<script src="../static-assets/highlight.pack.js?v1"></script>
|
||||
<script src="../static-assets/docs.dart.js"></script>
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue