270 lines
16 KiB
HTML
270 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>utils.settings.SettingManager.SettingManager — Analyse Morphologique 1.2.0 documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/sphinx_highlight.js"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="prev" title="utils.settings.SettingManager" href="utils.settings.SettingManager.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
Analyse Morphologique
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="utils.html">utils</a><ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.create_xyz.html">utils.create_xyz</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.data_processing.html">utils.data_processing</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.files.html">utils.files</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.graph2D.html">utils.graph2D</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.graph3D.html">utils.graph3D</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.gui.html">utils.gui</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="utils.math.html">utils.math</a></li>
|
||
<li class="toctree-l3 current"><a class="reference internal" href="utils.settings.html">utils.settings</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="utils.settings.SettingManager.html">utils.settings.SettingManager</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">Analyse Morphologique</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="../api.html">API</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.html">utils</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.settings.html">utils.settings</a></li>
|
||
<li class="breadcrumb-item"><a href="utils.settings.SettingManager.html">utils.settings.SettingManager</a></li>
|
||
<li class="breadcrumb-item active">utils.settings.SettingManager.SettingManager</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="../_sources/_autosummary/utils.settings.SettingManager.SettingManager.rst.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="utils-settings-settingmanager-settingmanager">
|
||
<h1>utils.settings.SettingManager.SettingManager<a class="headerlink" href="#utils-settings-settingmanager-settingmanager" title="Permalink to this heading"></a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">utils.settings.SettingManager.</span></span><span class="sig-name descname"><span class="pre">SettingManager</span></span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>A class to manage the settings</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Variables<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>settings</strong> – The settings</p></li>
|
||
<li><p><strong>instance</strong> – The instance of the class</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Methods</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">createInitialSettings</span></code></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.get_instance" title="utils.settings.SettingManager.SettingManager.get_instance"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_instance</span></code></a></p></td>
|
||
<td><p>Get the instance of the class</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.get_last_graph" title="utils.settings.SettingManager.SettingManager.get_last_graph"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_last_graph</span></code></a></p></td>
|
||
<td><p>Get the last graph name for the specified slot</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.get_setting" title="utils.settings.SettingManager.SettingManager.get_setting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_setting</span></code></a></p></td>
|
||
<td><p>Get the value of the specified setting</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.get_settings" title="utils.settings.SettingManager.SettingManager.get_settings"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_settings</span></code></a></p></td>
|
||
<td><p>Get the settings</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.remove_changed" title="utils.settings.SettingManager.SettingManager.remove_changed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_changed</span></code></a></p></td>
|
||
<td><p>Remove the changed flag</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.save" title="utils.settings.SettingManager.SettingManager.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code></a></p></td>
|
||
<td><p>Save the settings to the config file</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.set_last_graph" title="utils.settings.SettingManager.SettingManager.set_last_graph"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_last_graph</span></code></a></p></td>
|
||
<td><p>Set the last graph name for the specified slot</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="#utils.settings.SettingManager.SettingManager.set_setting" title="utils.settings.SettingManager.SettingManager.set_setting"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_setting</span></code></a></p></td>
|
||
<td><p>Set the value of the specified setting</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p class="rubric">Attributes</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">default_settings</span></code></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">instance</span></code></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">version</span></code></p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.get_instance">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_instance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#utils.settings.SettingManager.SettingManager" title="utils.settings.SettingManager.SettingManager"><span class="pre">SettingManager</span></a></span></span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.get_instance" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the instance of the class</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The instance of the class</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.get_last_graph">
|
||
<span class="sig-name descname"><span class="pre">get_last_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph_number</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.get_last_graph" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the last graph name for the specified slot</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.get_setting">
|
||
<span class="sig-name descname"><span class="pre">get_setting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">setting_name</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.get_setting" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the value of the specified setting</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>setting_name</strong> – The name of the setting</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The value of the setting</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.get_settings">
|
||
<span class="sig-name descname"><span class="pre">get_settings</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.get_settings" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Get the settings</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The settings</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.remove_changed">
|
||
<span class="sig-name descname"><span class="pre">remove_changed</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.remove_changed" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Remove the changed flag</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.save">
|
||
<span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.save" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Save the settings to the config file</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.set_last_graph">
|
||
<span class="sig-name descname"><span class="pre">set_last_graph</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">graph_number</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">graph_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.set_last_graph" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Set the last graph name for the specified slot</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>graph_number</strong> – The slot number</p></li>
|
||
<li><p><strong>graph_name</strong> – The graph name</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="utils.settings.SettingManager.SettingManager.set_setting">
|
||
<span class="sig-name descname"><span class="pre">set_setting</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">setting_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">setting_value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#utils.settings.SettingManager.SettingManager.set_setting" title="Permalink to this definition"></a></dt>
|
||
<dd><p>Set the value of the specified setting</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>setting_name</strong> – The name of the setting</p></li>
|
||
<li><p><strong>setting_value</strong> – The value of the setting</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="utils.settings.SettingManager.html" class="btn btn-neutral float-left" title="utils.settings.SettingManager" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023, Djalim SIMAILA, Alexis DOGHMANE.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |