mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-10-03 09:04:32 -04:00
213 lines
16 KiB
HTML
213 lines
16 KiB
HTML
<!doctype html>
|
|
<html class="no-js" lang="en">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>ConfigState</title>
|
|
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../../";</script>
|
|
<script>document.documentElement.classList.replace("no-js", "js");</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if (savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async></script>
|
|
<link href="../../../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
|
|
<link href="../../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../../../scripts/safe-local-storage_blocking.js"></script>
|
|
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async></script>
|
|
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async></script>
|
|
<script type="text/javascript" src="../../../../scripts/main.js" defer></script>
|
|
<script type="text/javascript" src="../../../../scripts/prism.js" async></script>
|
|
<script type="text/javascript" src="../../../../ui-kit/ui-kit.min.js" defer></script></head>
|
|
<body>
|
|
<div class="root">
|
|
<header class="navigation theme-dark" id="navigation-wrapper" role="banner">
|
|
<a class="library-name--link" href="../../../../index.html" tabindex="1">
|
|
Meshtastic App
|
|
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
|
|
</button>
|
|
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
|
<div class="library-version" id="library-version">
|
|
</div>
|
|
<div class="navigation-controls">
|
|
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">
|
|
<button class="platform-tag platform-selector common-like" data-active="" aria-pressed="true" data-filter=":feature:settings/commonMain">common</button>
|
|
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
|
|
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox" data-role="dropdown-toggle" aria-controls="platform-tags-listbox" aria-haspopup="listbox" aria-expanded="false" aria-label="Toggle source sets"></button>
|
|
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox" aria-label="Target filter">
|
|
<div class="dropdown--header"><span>Target filter</span>
|
|
<button class="button" data-role="dropdown-toggle" aria-label="Close target filter">
|
|
<i class="ui-kit-icon ui-kit-icon_cross"></i>
|
|
</button>
|
|
</div>
|
|
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
|
|
<label class="checkbox">
|
|
<input type="checkbox" class="checkbox--input" id=":feature:settings/commonMain" data-filter=":feature:settings/commonMain">
|
|
<span class="checkbox--icon"></span>
|
|
common
|
|
</label>
|
|
</li>
|
|
</ul>
|
|
<div class="dropdown--overlay"></div>
|
|
</div>
|
|
</ul>
|
|
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button" type="button">Switch theme
|
|
</button>
|
|
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
|
|
API
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div id="container">
|
|
<nav id="leftColumn" class="sidebar" data-item-type="SECTION" data-item-config="{"defaultSize": 280, "minSize": 200, "maxSize": 400}">
|
|
<a class="toc--skip-link" href="#main">Skip to content</a>
|
|
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
|
|
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list" data-role="dropdown-listbox" aria-label="Table of contents">
|
|
<div class="dropdown--header">
|
|
<span>
|
|
Meshtastic App
|
|
</span>
|
|
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
|
|
<i class="ui-kit-icon ui-kit-icon_cross"></i>
|
|
</button>
|
|
</div>
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</ul>
|
|
<div class="dropdown--overlay"></div>
|
|
</div>
|
|
</nav>
|
|
<div id="resizer" class="resizer" data-item-type="BAR"></div>
|
|
<div id="main" data-item-type="SECTION" role="main">
|
|
<div class="main-content" data-page-type="classlike" id="content" pageids="feature-settings::org.meshtastic.feature.settings.radio.component/ConfigState///PointingToDeclaration//1086999794">
|
|
<div class="breadcrumbs"><a href="../../index.html">feature-settings</a><span class="delimiter">/</span><a href="../index.html">org.meshtastic.feature.settings.radio.component</a><span class="delimiter">/</span><span class="current">ConfigState</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Config</span><wbr><span><span>State</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:settings/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">ConfigState</a><span class="token operator"><</span><a href="index.html">T</a><span class="token operator"> : </span><span data-unresolved-link="com.squareup.wire/Message///PointingToDeclaration/">Message</span><span class="token operator"><</span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">initialValue<span class="token operator">: </span><a href="index.html">T</a></span></span><span class="token punctuation">)</span><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/meshtastic/Meshtastic-Android/blob/main/feature/settings/src/commonMain/kotlin/org/meshtastic/feature/settings/radio/component/ConfigState.kt#L37">source</a>)</span></span></div><p class="paragraph">A state holder for managing config data within a Composable.</p><p class="paragraph">This class encapsulates the common logic for handling editable state that is derived from an initial value. It tracks whether the current value has been modified ("dirty"), and provides simple methods to save the changes or reset to the initial state.</p><h4 class="tableheader">Type Parameters</h4><div class="table"><div class="table-row table-row_content" data-filterable-current=":feature:settings/commonMain" data-filterable-set=":feature:settings/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>T</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The type of the data being managed, typically a Wire message.</p></div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="CONSTRUCTOR">
|
|
<h2 class="tableheader">Constructors</h2>
|
|
<div class="table"><a data-name="-1782338258%2FConstructors%2F1086999794" anchor-label="ConfigState" id="-1782338258%2FConstructors%2F1086999794" data-filterable-set=":feature:settings/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="CONSTRUCTOR" data-filterable-current=":feature:settings/commonMain" data-filterable-set=":feature:settings/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-config-state.html"><span>Config</span><wbr><span><span>State</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1782338258%2FConstructors%2F1086999794"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:settings/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">initialValue<span class="token operator">: </span><a href="index.html">T</a></span></span><span class="token punctuation">)</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="TYPE">
|
|
<h2 class="tableheader">Types</h2>
|
|
<div class="table"><a data-name="1154028429%2FClasslikes%2F1086999794" anchor-label="Companion" id="1154028429%2FClasslikes%2F1086999794" data-filterable-set=":feature:settings/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":feature:settings/commonMain" data-filterable-set=":feature:settings/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1154028429%2FClasslikes%2F1086999794"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:settings/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="PROPERTY">
|
|
<h2 class="tableheader">Properties</h2>
|
|
<div class="table"><a data-name="978055358%2FProperties%2F1086999794" anchor-label="isDirty" id="978055358%2FProperties%2F1086999794" data-filterable-set=":feature:settings/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":feature:settings/commonMain" data-filterable-set=":feature:settings/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="is-dirty.html"><span>is</span><wbr><span><span>Dirty</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="978055358%2FProperties%2F1086999794"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:settings/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="is-dirty.html">isDirty</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1740558731%2FProperties%2F1086999794" anchor-label="value" id="-1740558731%2FProperties%2F1086999794" data-filterable-set=":feature:settings/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":feature:settings/commonMain" data-filterable-set=":feature:settings/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="value.html"><span><span>value</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1740558731%2FProperties%2F1086999794"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:settings/commonMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="value.html">value</a><span class="token operator">: </span><a href="index.html">T</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="tableheader">Functions</h2>
|
|
<div class="table"><a data-name="1462769751%2FFunctions%2F1086999794" anchor-label="reset" id="1462769751%2FFunctions%2F1086999794" data-filterable-set=":feature:settings/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":feature:settings/commonMain" data-filterable-set=":feature:settings/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="reset.html"><span><span>reset</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1462769751%2FFunctions%2F1086999794"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:settings/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="reset.html"><span class="token function">reset</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<div class="footer--container">
|
|
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
|
|
<div class="footer--content">
|
|
<div>
|
|
<span>Generated by </span>
|
|
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
|
|
Dokka
|
|
</a>
|
|
<div>© 2026 Copyright</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |