src/eric7/Documentation/Source/eric7.EricCore.EricPreferences.html

branch
eric7
changeset 10928
46651e194fbe
child 10933
95a15b70f7bb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricCore.EricPreferences.html	Thu Sep 26 15:49:36 2024 +0200
@@ -0,0 +1,180 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricCore.EricPreferences</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricCore.EricPreferences</h1>
+<p>
+Module implementing the preferences for the eric library.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>_settingsNameGlobal</td></tr>
+<tr><td>_settingsNameOrganization</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#EricPreferences">EricPreferences</a></td>
+<td>A class to hold all configuration items.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#convertPasswords">convertPasswords</a></td>
+<td>Module function to convert all passwords.</td>
+</tr>
+<tr>
+<td><a href="#getNetworkProxy">getNetworkProxy</a></td>
+<td>Function to retrieve the various Network Proxy related settings.</td>
+</tr>
+<tr>
+<td><a href="#initPreferences">initPreferences</a></td>
+<td>Function to initialize the central configuration store.</td>
+</tr>
+<tr>
+<td><a href="#setNetworkProxy">setNetworkProxy</a></td>
+<td>Function to store the various Network Proxy settings.</td>
+</tr>
+<tr>
+<td><a href="#syncPreferences">syncPreferences</a></td>
+<td>Module function to sync the preferences to disk.</td>
+</tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="EricPreferences" ID="EricPreferences"></a>
+<h2>EricPreferences</h2>
+<p>
+    A class to hold all configuration items.
+</p>
+
+<h3>Derived from</h3>
+None
+<h3>Class Attributes</h3>
+<table>
+<tr><td>proxyDefaults</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="convertPasswords" ID="convertPasswords"></a>
+<h2>convertPasswords</h2>
+<b>convertPasswords</b>(<i>oldPassword, newPassword</i>)
+<p>
+    Module function to convert all passwords.
+</p>
+
+<dl>
+
+<dt><i>oldPassword</i> (str)</dt>
+<dd>
+current password
+</dd>
+<dt><i>newPassword</i> (str)</dt>
+<dd>
+new password
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getNetworkProxy" ID="getNetworkProxy"></a>
+<h2>getNetworkProxy</h2>
+<b>getNetworkProxy</b>(<i>key</i>)
+<p>
+    Function to retrieve the various Network Proxy related settings.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the value to get
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the requested network proxy setting
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="initPreferences" ID="initPreferences"></a>
+<h2>initPreferences</h2>
+<b>initPreferences</b>(<i></i>)
+<p>
+    Function to initialize the central configuration store.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="setNetworkProxy" ID="setNetworkProxy"></a>
+<h2>setNetworkProxy</h2>
+<b>setNetworkProxy</b>(<i>key, value</i>)
+<p>
+    Function to store the various Network Proxy settings.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the setting to be set
+</dd>
+<dt><i>value</i> (Any)</dt>
+<dd>
+the value to be set
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="syncPreferences" ID="syncPreferences"></a>
+<h2>syncPreferences</h2>
+<b>syncPreferences</b>(<i></i>)
+<p>
+    Module function to sync the preferences to disk.
+</p>
+<p>
+    In addition to syncing, the central configuration store is reinitialized
+    as well.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial