mc_gallery/doc/api/features_core_abstracts_bas.../BaseViewModel-class.html

491 lines
21 KiB
HTML

<!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 BaseViewModel class from the base_view_model library, for the Dart programming language.">
<title>BaseViewModel class - base_view_model 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/icon?family=Material+Icons" 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">
<div id="overlay-under-drawer"></div>
<header id="title">
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="../index.html">mc_gallery</a></li>
<li><a href="../features_core_abstracts_base_view_model/features_core_abstracts_base_view_model-library.html">base_view_model</a></li>
<li class="self-crumb">BaseViewModel<span class="signature">&lt;<wbr><span class="type-parameter">T extends <a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a>?</span>&gt;</span> abstract class</li>
</ol>
<div class="self-name">BaseViewModel</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>
</header>
<main>
<div id="dartdoc-main-content" class="main-content">
<div>
<h1><span class="kind-class">BaseViewModel&lt;<wbr><span class="type-parameter">T extends Object?</span>&gt;</span> class
<a href="https://dart.dev/null-safety" class="feature feature-null-safety" title="Supports the null safety language feature.">Null safety</a>
</h1></div>
<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/foundation/ChangeNotifier-class.html">ChangeNotifier</a></li>
<li>BaseViewModel</li>
</ul>
</dd>
<dt>Implementers</dt>
<dd><ul class="comma-separated clazz-relationships">
<li><a href="../features_home_views_gallery_gallery_view_model/GalleryViewModel-class.html">GalleryViewModel</a></li>
<li><a href="../features_home_views_image_carousel_image_carousel_view_model/ImageCarouselViewModel-class.html">ImageCarouselViewModel</a></li>
</ul></dd>
</dl>
</section>
<section class="summary offset-anchor" id="constructors">
<h2>Constructors</h2>
<dl class="constructor-summary-list">
<dt id="BaseViewModel" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/BaseViewModel.html">BaseViewModel</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="errorMessage" class="property">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/errorMessage.html">errorMessage</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="hasError" class="property">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/hasError.html">hasError</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/foundation/ValueListenable-class.html">ValueListenable</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
</dt>
<dd>
<div class="features">read-only</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">&#8594; <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">read-only, inherited</div>
</dd>
<dt id="hasListeners" class="property inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html">hasListeners</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
</dt>
<dd class="inherited">
Whether any listeners are currently registered.
<div class="features">@<a href="https://pub.dev/documentation/meta/1.8.0/meta/protected-constant.html">protected</a>, read-only, inherited</div>
</dd>
<dt id="isBusy" class="property">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/isBusy.html">isBusy</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/foundation/ValueListenable-class.html">ValueListenable</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="isInitialised" class="property">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/isInitialised.html">isInitialised</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/foundation/ValueListenable-class.html">ValueListenable</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
</dt>
<dd>
<div class="features">read-only</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">&#8594; <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">read-only, inherited</div>
</dd>
<dt id="state" class="property">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/state.html">state</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/foundation/ValueListenable-class.html">ValueListenable</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../features_core_data_enums_view_model_state/ViewModelState.html">ViewModelState</a></span>&gt;</span></span>
</dt>
<dd>
<div class="features">read-only</div>
</dd>
<dt id="strings" class="property">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/strings.html">strings</a></span>
<span class="signature">&#8594; <a href="../l10n_generated_l10n/Strings-class.html">Strings</a></span>
</dt>
<dd>
<div class="features">final</div>
</dd>
</dl>
</section>
<section
class="summary offset-anchor"
id="instance-methods">
<h2>Methods</h2>
<dl class="callables">
<dt id="addListener" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html">addListener</a></span><span class="signature">(<wbr><span class="parameter" id="addListener-param-listener"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">listener</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
Register a closure to be called when the object changes.
<div class="features">inherited</div>
</dd>
<dt id="dispose" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/dispose.html">dispose</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
<a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html">addListener</a> will throw after the object is disposed).
<div class="features">override</div>
</dd>
<dt id="height" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/height.html">height</a></span><span class="signature">(<wbr><span class="parameter" id="height-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">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/double-class.html">double</a></span>
</span>
</dt>
<dd>
</dd>
<dt id="ifMounted" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/ifMounted.html">ifMounted</a></span><span class="signature">(<wbr><span class="parameter" id="ifMounted-param-voidCallback"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">voidCallback</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
</dd>
<dt id="initialise" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/initialise.html">initialise</a></span><span class="signature">(<wbr><span class="parameter" id="initialise-param-mounted"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">mounted</span>(), </span><span class="parameter" id="initialise-param-arguments">[<span class="type-annotation">T?</span> <span class="parameter-name">arguments</span>]</span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
<div class="features">@<a href="https://pub.dev/documentation/meta/1.8.0/meta/mustCallSuper-constant.html">mustCallSuper</a></div>
</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">&#8594; dynamic</span>
</span>
</dt>
<dd class="inherited">
Invoked when a non-existent method or property is accessed.
<div class="features">inherited</div>
</dd>
<dt id="notifyListeners" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html">notifyListeners</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
Call all the registered listeners.
<div class="features">@<a href="https://pub.dev/documentation/meta/1.8.0/meta/protected-constant.html">protected</a>, @<a href="https://pub.dev/documentation/meta/1.8.0/meta/visibleForTesting-constant.html">visibleForTesting</a>, inherited</div>
</dd>
<dt id="removeListener" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html">removeListener</a></span><span class="signature">(<wbr><span class="parameter" id="removeListener-param-listener"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-ui/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">listener</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd class="inherited">
Remove a previously registered closure from the list of closures that are
notified when the object changes.
<div class="features">inherited</div>
</dd>
<dt id="setBusy" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/setBusy.html">setBusy</a></span><span class="signature">(<wbr><span class="parameter" id="setBusy-param-isBusy"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">isBusy</span></span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
</dd>
<dt id="setError" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/setError.html">setError</a></span><span class="signature">(<wbr><span class="parameter" id="setError-param-hasError"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">hasError</span>, </span><span class="parameter" id="setError-param-message">{<span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">message</span>}</span>)
<span class="returntype parameter">&#8594; void</span>
</span>
</dt>
<dd>
</dd>
<dt id="toString" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; <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">inherited</div>
</dd>
<dt id="width" class="callable">
<span class="name"><a href="../features_core_abstracts_base_view_model/BaseViewModel/width.html">width</a></span><span class="signature">(<wbr><span class="parameter" id="width-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">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/double-class.html">double</a></span>
</span>
</dt>
<dd>
</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">&#8594; <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">inherited</div>
</dd>
</dl>
</section>
</div> <!-- /.main-content -->
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
<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">mc_gallery</a></li>
<li><a href="../features_core_abstracts_base_view_model/features_core_abstracts_base_view_model-library.html">base_view_model</a></li>
<li class="self-crumb">BaseViewModel<span class="signature">&lt;<wbr><span class="type-parameter">T extends <a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a>?</span>&gt;</span> abstract class</li>
</ol>
<h5>base_view_model library</h5>
<ol>
<li class="section-title"><a href="../features_core_abstracts_base_view_model/features_core_abstracts_base_view_model-library.html#classes">Classes</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel-class.html">BaseViewModel</a></li>
</ol>
</div>
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
<ol>
<li class="section-title"><a href="../features_core_abstracts_base_view_model/BaseViewModel-class.html#constructors">Constructors</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/BaseViewModel.html">BaseViewModel</a></li>
<li class="section-title">
<a href="../features_core_abstracts_base_view_model/BaseViewModel-class.html#instance-properties">Properties</a>
</li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/errorMessage.html">errorMessage</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/hasError.html">hasError</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/hasListeners.html">hasListeners</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/isBusy.html">isBusy</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/isInitialised.html">isInitialised</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/state.html">state</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/strings.html">strings</a></li>
<li class="section-title"><a href="../features_core_abstracts_base_view_model/BaseViewModel-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/addListener.html">addListener</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/dispose.html">dispose</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/height.html">height</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/ifMounted.html">ifMounted</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/initialise.html">initialise</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/notifyListeners.html">notifyListeners</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/foundation/ChangeNotifier/removeListener.html">removeListener</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/setBusy.html">setBusy</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/setError.html">setError</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
<li><a href="../features_core_abstracts_base_view_model/BaseViewModel/width.html">width</a></li>
<li class="section-title inherited"><a href="../features_core_abstracts_base_view_model/BaseViewModel-class.html#operators">Operators</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
</ol>
</div><!--/.sidebar-offcanvas-->
</main>
<footer>
<span class="no-break">
mc_gallery
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>