--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Project.ProjectBrowser</h1>
-
<p>
Module implementing the project browser part of the eric UI.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ProjectBrowser">ProjectBrowser</a></td>
<td>Class implementing the project browser part of the eric UI.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ProjectBrowser" ID="ProjectBrowser"></a>
<h2>ProjectBrowser</h2>
-
<p>
Class implementing the project browser part of the eric UI.
</p>
@@ -50,6 +48,7 @@
Note: The following signals are defined here to proxy the individual browser
signals.
</p>
+
<h3>Signals</h3>
<dl>
@@ -152,19 +151,17 @@
<h3>Derived from</h3>
EricTabWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#ProjectBrowser.__init__">ProjectBrowser</a></td>
<td>Constructor</td>
@@ -254,19 +251,20 @@
<td>Public method to remove a browser type from the browsers repository.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBrowser.__init__" ID="ProjectBrowser.__init__"></a>
<h4>ProjectBrowser (Constructor)</h4>
<b>ProjectBrowser</b>(<i>project, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>project</i> (Project)</dt>
@@ -281,10 +279,10 @@
<a NAME="ProjectBrowser.__currentChanged" ID="ProjectBrowser.__currentChanged"></a>
<h4>ProjectBrowser.__currentChanged</h4>
<b>__currentChanged</b>(<i>index</i>)
-
<p>
Private slot to handle the currentChanged(int) signal.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -295,38 +293,38 @@
<a NAME="ProjectBrowser.__newProject" ID="ProjectBrowser.__newProject"></a>
<h4>ProjectBrowser.__newProject</h4>
<b>__newProject</b>(<i></i>)
-
<p>
Private slot to handle the newProject signal.
</p>
+
<a NAME="ProjectBrowser.__projectClosed" ID="ProjectBrowser.__projectClosed"></a>
<h4>ProjectBrowser.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
-
<p>
Private slot to handle the projectClosed signal.
</p>
+
<a NAME="ProjectBrowser.__projectOpened" ID="ProjectBrowser.__projectOpened"></a>
<h4>ProjectBrowser.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)
-
<p>
Private slot to handle the projectOpened signal.
</p>
+
<a NAME="ProjectBrowser.__projectPropertiesChanged" ID="ProjectBrowser.__projectPropertiesChanged"></a>
<h4>ProjectBrowser.__projectPropertiesChanged</h4>
<b>__projectPropertiesChanged</b>(<i></i>)
-
<p>
Private slot to handle the projectPropertiesChanged signal.
</p>
+
<a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a>
<h4>ProjectBrowser.__setBrowsersAvailable</h4>
<b>__setBrowsersAvailable</b>(<i>browsersList</i>)
-
<p>
Private method to add selected browsers to the project browser.
</p>
+
<dl>
<dt><i>browsersList</i> (list of str)</dt>
@@ -337,17 +335,17 @@
<a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a>
<h4>ProjectBrowser.__setSourcesIcon</h4>
<b>__setSourcesIcon</b>(<i></i>)
-
<p>
Private method to set the right icon for the sources browser tab.
</p>
+
<a NAME="ProjectBrowser.__vcsStateChanged" ID="ProjectBrowser.__vcsStateChanged"></a>
<h4>ProjectBrowser.__vcsStateChanged</h4>
<b>__vcsStateChanged</b>(<i>state</i>)
-
<p>
Private slot to handle a change in the vcs state.
</p>
+
<dl>
<dt><i>state</i> (str)</dt>
@@ -358,10 +356,10 @@
<a NAME="ProjectBrowser.__vcsStatusIndicatorClicked" ID="ProjectBrowser.__vcsStatusIndicatorClicked"></a>
<h4>ProjectBrowser.__vcsStatusIndicatorClicked</h4>
<b>__vcsStatusIndicatorClicked</b>(<i>pos</i>)
-
<p>
Private slot to react upon clicks on the VCS indicator LED.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -372,10 +370,10 @@
<a NAME="ProjectBrowser.addTypedProjectBrowser" ID="ProjectBrowser.addTypedProjectBrowser"></a>
<h4>ProjectBrowser.addTypedProjectBrowser</h4>
<b>addTypedProjectBrowser</b>(<i>browserType, projectBrowserItem</i>)
-
<p>
Public method to add a project browser type to the browser repository.
</p>
+
<dl>
<dt><i>browserType</i> (str)</dt>
@@ -397,10 +395,10 @@
<a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a>
<h4>ProjectBrowser.getProjectBrowser</h4>
<b>getProjectBrowser</b>(<i>browserType</i>)
-
<p>
Public method to get a reference to the project browser of given type.
</p>
+
<dl>
<dt><i>browserType</i> (str)</dt>
@@ -423,10 +421,10 @@
<a NAME="ProjectBrowser.getProjectBrowserFilter" ID="ProjectBrowser.getProjectBrowserFilter"></a>
<h4>ProjectBrowser.getProjectBrowserFilter</h4>
<b>getProjectBrowserFilter</b>(<i>fileCategory</i>)
-
<p>
Public method to get the project browser file filter for a file category.
</p>
+
<dl>
<dt><i>fileCategory</i> (str)</dt>
@@ -449,10 +447,10 @@
<a NAME="ProjectBrowser.getProjectBrowserIcon" ID="ProjectBrowser.getProjectBrowserIcon"></a>
<h4>ProjectBrowser.getProjectBrowserIcon</h4>
<b>getProjectBrowserIcon</b>(<i>browserType</i>)
-
<p>
Public method to get the icon for a project browser.
</p>
+
<dl>
<dt><i>browserType</i> (str)</dt>
@@ -475,10 +473,10 @@
<a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a>
<h4>ProjectBrowser.getProjectBrowserNames</h4>
<b>getProjectBrowserNames</b>(<i></i>)
-
<p>
Public method to get the types of the various project browsers.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -494,10 +492,10 @@
<a NAME="ProjectBrowser.getProjectBrowserType" ID="ProjectBrowser.getProjectBrowserType"></a>
<h4>ProjectBrowser.getProjectBrowserType</h4>
<b>getProjectBrowserType</b>(<i>fileCategory</i>)
-
<p>
Public method to get the project browser type for a file category.
</p>
+
<dl>
<dt><i>fileCategory</i> (str)</dt>
@@ -520,10 +518,10 @@
<a NAME="ProjectBrowser.getProjectBrowserUserStrings" ID="ProjectBrowser.getProjectBrowserUserStrings"></a>
<h4>ProjectBrowser.getProjectBrowserUserStrings</h4>
<b>getProjectBrowserUserStrings</b>(<i></i>)
-
<p>
Public method to get a dictionary of defined project browser user strings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -539,10 +537,10 @@
<a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a>
<h4>ProjectBrowser.getProjectBrowsers</h4>
<b>getProjectBrowsers</b>(<i></i>)
-
<p>
Public method to get references to the individual project browsers.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -558,10 +556,10 @@
<a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a>
<h4>ProjectBrowser.handleEditorChanged</h4>
<b>handleEditorChanged</b>(<i>fn</i>)
-
<p>
Public slot to handle the editorChanged signal.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -572,10 +570,10 @@
<a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a>
<h4>ProjectBrowser.handleEditorLineChanged</h4>
<b>handleEditorLineChanged</b>(<i>fn, lineno</i>)
-
<p>
Public slot to handle the editorLineChanged signal.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -590,14 +588,13 @@
<a NAME="ProjectBrowser.handlePreferencesChanged" ID="ProjectBrowser.handlePreferencesChanged"></a>
<h4>ProjectBrowser.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot used to handle the preferencesChanged signal.
</p>
+
<a NAME="ProjectBrowser.removeTypedProjectBrowser" ID="ProjectBrowser.removeTypedProjectBrowser"></a>
<h4>ProjectBrowser.removeTypedProjectBrowser</h4>
<b>removeTypedProjectBrowser</b>(<i>browserType</i>)
-
<p>
Public method to remove a browser type from the browsers repository.
</p>
@@ -605,6 +602,7 @@
Note: If the browser type is not contained in the repository, the request to
remove it will be ignored silently.
</p>
+
<dl>
<dt><i>browserType</i> (str)</dt>
@@ -614,4 +612,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
