Added two methods needed by project type plugins to the Preferences. eric7

Sat, 26 Nov 2022 17:15:15 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 26 Nov 2022 17:15:15 +0100
branch
eric7
changeset 9537
66a2e32ecba9
parent 9536
c1c84299bef3
child 9538
1fce92e31dad

Added two methods needed by project type plugins to the Preferences.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Preferences.__init__.html file | annotate | diff | comparison | revisions
src/eric7/Preferences/__init__.py file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Sat Nov 26 15:54:32 2022 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Sat Nov 26 17:15:15 2022 +0100
@@ -7457,6 +7457,7 @@
 eric7.Preferences.initRecentSettings?4()
 eric7.Preferences.isConfigured?4()
 eric7.Preferences.readToolGroups?4()
+eric7.Preferences.removeProjectBrowsers?4(key)
 eric7.Preferences.resetLayout?4()
 eric7.Preferences.saveResetLayout?4()
 eric7.Preferences.saveToolGroups?4(toolGroups, currentGroup)
@@ -7492,6 +7493,7 @@
 eric7.Preferences.setProject?4(key, value)
 eric7.Preferences.setProjectBrowserColour?4(key, value)
 eric7.Preferences.setProjectBrowsers?4(key, value)
+eric7.Preferences.setProjectBrowsersDefault?4(projectType, browsersList)
 eric7.Preferences.setProtobuf?4(key, value)
 eric7.Preferences.setPython?4(key, value)
 eric7.Preferences.setQt?4(key, value)
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Sat Nov 26 15:54:32 2022 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Sat Nov 26 17:15:15 2022 +0100
@@ -19418,6 +19418,7 @@
       <keyword name="rehashPassword" id="rehashPassword" ref="eric7.Utilities.crypto.py3PBKDF2.html#rehashPassword" />
       <keyword name="relativeUniversalPath" id="relativeUniversalPath" ref="eric7.Utilities.__init__.html#relativeUniversalPath" />
       <keyword name="removeMarkers" id="removeMarkers" ref="eric7.UI.CompareDialog.html#removeMarkers" />
+      <keyword name="removeProjectBrowsers" id="removeProjectBrowsers" ref="eric7.Preferences.__init__.html#removeProjectBrowsers" />
       <keyword name="removeQuotesFromArgs" id="removeQuotesFromArgs" ref="eric7.DebugClients.Python.DebugUtilities.html#removeQuotesFromArgs" />
       <keyword name="removeSearchPath" id="removeSearchPath" ref="eric7.EricGui.EricPixmapCache.html#removeSearchPath" />
       <keyword name="renderTabPreview" id="renderTabPreview" ref="eric7.WebBrowser.WebBrowserSnap.html#renderTabPreview" />
@@ -19493,6 +19494,7 @@
       <keyword name="setProject" id="setProject" ref="eric7.Preferences.__init__.html#setProject" />
       <keyword name="setProjectBrowserColour" id="setProjectBrowserColour" ref="eric7.Preferences.__init__.html#setProjectBrowserColour" />
       <keyword name="setProjectBrowsers" id="setProjectBrowsers" ref="eric7.Preferences.__init__.html#setProjectBrowsers" />
+      <keyword name="setProjectBrowsersDefault" id="setProjectBrowsersDefault" ref="eric7.Preferences.__init__.html#setProjectBrowsersDefault" />
       <keyword name="setProtobuf" id="setProtobuf" ref="eric7.Preferences.__init__.html#setProtobuf" />
       <keyword name="setPython" id="setPython" ref="eric7.Preferences.__init__.html#setPython" />
       <keyword name="setQt" id="setQt" ref="eric7.Preferences.__init__.html#setQt" />
--- a/src/eric7/Documentation/Source/eric7.Preferences.__init__.html	Sat Nov 26 15:54:32 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.__init__.html	Sat Nov 26 17:15:15 2022 +0100
@@ -280,6 +280,10 @@
 <td>Module function to read the tool groups configuration.</td>
 </tr>
 <tr>
+<td><a href="#removeProjectBrowsers">removeProjectBrowsers</a></td>
+<td>Function to remove the browsers list of the given project type.</td>
+</tr>
+<tr>
 <td><a href="#resetLayout">resetLayout</a></td>
 <td>Module function to set a flag not storing the current layout.</td>
 </tr>
@@ -420,6 +424,10 @@
 <td>Function to store the enabled project browsers per project type.</td>
 </tr>
 <tr>
+<td><a href="#setProjectBrowsersDefault">setProjectBrowsersDefault</a></td>
+<td>Function to store the given project browser list to the list of defaults.</td>
+</tr>
+<tr>
 <td><a href="#setProtobuf">setProtobuf</a></td>
 <td>Module function to store the various protobuf settings.</td>
 </tr>
@@ -1859,6 +1867,23 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="removeProjectBrowsers" ID="removeProjectBrowsers"></a>
+<h2>removeProjectBrowsers</h2>
+<b>removeProjectBrowsers</b>(<i>key</i>)
+
+<p>
+    Function to remove the browsers list of the given project type.
+</p>
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+project type
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="resetLayout" ID="resetLayout"></a>
 <h2>resetLayout</h2>
 <b>resetLayout</b>(<i></i>)
@@ -2561,6 +2586,27 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="setProjectBrowsersDefault" ID="setProjectBrowsersDefault"></a>
+<h2>setProjectBrowsersDefault</h2>
+<b>setProjectBrowsersDefault</b>(<i>projectType, browsersList</i>)
+
+<p>
+    Function to store the given project browser list to the list of defaults.
+</p>
+<dl>
+
+<dt><i>projectType</i> (str)</dt>
+<dd>
+project type
+</dd>
+<dt><i>browsersList</i> (list of str or tuple of str)</dt>
+<dd>
+default list of browsers for the project type
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="setProtobuf" ID="setProtobuf"></a>
 <h2>setProtobuf</h2>
 <b>setProtobuf</b>(<i>key, value</i>)
--- a/src/eric7/Preferences/__init__.py	Sat Nov 26 15:54:32 2022 +0100
+++ b/src/eric7/Preferences/__init__.py	Sat Nov 26 17:15:15 2022 +0100
@@ -2693,6 +2693,28 @@
     Prefs.settings.setValue("Project/BrowsersEnabled/" + key, value)
 
 
+def removeProjectBrowsers(key):
+    """
+    Function to remove the browsers list of the given project type.
+
+    @param key project type
+    @type str
+    """
+    Prefs.settings.remove("Project/BrowsersEnabled/" + key)
+
+
+def setProjectBrowsersDefault(projectType, browsersList):
+    """
+    Function to store the given project browser list to the list of defaults.
+
+    @param projectType project type
+    @type str
+    @param browsersList default list of browsers for the project type
+    @type list of str or tuple of str
+    """
+    Prefs.projectBrowsersDefaults[projectType] = browsersList
+
+
 def getProjectBrowserColour(key):
     """
     Module function to retrieve the various project browser colours.

eric ide

mercurial