--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html Thu Nov 24 16:10:58 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html Thu Nov 24 16:11:55 2022 +0100
@@ -46,6 +46,105 @@
that doesn't fit these categories. Optionally it contains an additional
tab with the file system browser.
</p>
+<p>
+ Note: The following signals are defined here to proxy the individual browser
+ signals.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>appendStderr(str)</dt>
+<dd>
+emitted after something was received from
+ a QProcess on stderr
+</dd>
+<dt>appendStdout(str)</dt>
+<dd>
+emitted after something was received from
+ a QProcess on stdout
+</dd>
+<dt>binaryFile(filename)</dt>
+<dd>
+emitted to open a file as binary (str)
+</dd>
+<dt>closeSourceWindow(str)</dt>
+<dd>
+emitted to close a source file
+</dd>
+<dt>designerFile(filename)</dt>
+<dd>
+emitted to open a Qt-Designer file (str)
+</dd>
+<dt>linguistFile(filename)</dt>
+<dd>
+emitted to open a Qt-Linguist (*.ts)
+ file (str)
+</dd>
+<dt>pixmapEditFile(filename)</dt>
+<dd>
+emitted to edit a pixmap file (str)
+</dd>
+<dt>pixmapFile(filename)</dt>
+<dd>
+emitted to open a pixmap file (str)
+</dd>
+<dt>preferencesChanged()</dt>
+<dd>
+emitted when the preferences have been changed
+</dd>
+<dt>processChangedProjectFiles()</dt>
+<dd>
+emitted to indicate, that changed project files
+ should be processed
+</dd>
+<dt>sourceFile(filename)</dt>
+<dd>
+emitted to open a Python file at a line (str)
+</dd>
+<dt>sourceFile(filename, lineno)</dt>
+<dd>
+emitted to open a Python file at a
+ line (str, int)
+</dd>
+<dt>sourceFile(filename, lineno, type)</dt>
+<dd>
+emitted to open a Python file
+ at a line giving an explicit file type (str, int, str)
+</dd>
+<dt>sourceFile(filename, linenos)</dt>
+<dd>
+emitted to open a Python file giving
+ a list of lines(str, list)
+</dd>
+<dt>svgFile(filename)</dt>
+<dd>
+emitted to open a SVG file (str)
+</dd>
+<dt>testFile(filename)</dt>
+<dd>
+emitted to open a Python file for a
+ unit test (str)
+</dd>
+<dt>trpreview(filenames)</dt>
+<dd>
+emitted to preview Qt-Linguist (*.qm)
+ files (list of str)
+</dd>
+<dt>trpreview(filenames, ignore)</dt>
+<dd>
+emitted to preview Qt-Linguist (*.qm)
+ files indicating whether non-existent files shall be ignored
+ (list of str, bool)
+</dd>
+<dt>uipreview(str)</dt>
+<dd>
+emitted to preview a forms file
+</dd>
+<dt>umlFile(filename)</dt>
+<dd>
+emitted to open an eric UML file (str)
+</dd>
+</dl>
<h3>Derived from</h3>
EricTabWidget
<h3>Class Attributes</h3>
@@ -103,12 +202,32 @@
<td>Private slot to react upon clicks on the VCS indicator LED.</td>
</tr>
<tr>
+<td><a href="#ProjectBrowser.addTypedProjectBrowser">addTypedProjectBrowser</a></td>
+<td>Public method to add a project browser type to the browser repository.</td>
+</tr>
+<tr>
<td><a href="#ProjectBrowser.getProjectBrowser">getProjectBrowser</a></td>
-<td>Public method to get a reference to the named project browser.</td>
+<td>Public method to get a reference to the project browser of given type.</td>
+</tr>
+<tr>
+<td><a href="#ProjectBrowser.getProjectBrowserFilter">getProjectBrowserFilter</a></td>
+<td>Public method to get the project browser file filter for a file category.</td>
+</tr>
+<tr>
+<td><a href="#ProjectBrowser.getProjectBrowserIcon">getProjectBrowserIcon</a></td>
+<td>Public method to get the icon for a project browser.</td>
</tr>
<tr>
<td><a href="#ProjectBrowser.getProjectBrowserNames">getProjectBrowserNames</a></td>
-<td>Public method to get the names of the various project browsers.</td>
+<td>Public method to get the types of the various project browsers.</td>
+</tr>
+<tr>
+<td><a href="#ProjectBrowser.getProjectBrowserType">getProjectBrowserType</a></td>
+<td>Public method to get the project browser type for a file category.</td>
+</tr>
+<tr>
+<td><a href="#ProjectBrowser.getProjectBrowserUserStrings">getProjectBrowserUserStrings</a></td>
+<td>Public method to get a dictionary of defined project browser user strings.</td>
</tr>
<tr>
<td><a href="#ProjectBrowser.getProjectBrowsers">getProjectBrowsers</a></td>
@@ -126,6 +245,10 @@
<td><a href="#ProjectBrowser.handlePreferencesChanged">handlePreferencesChanged</a></td>
<td>Public slot used to handle the preferencesChanged signal.</td>
</tr>
+<tr>
+<td><a href="#ProjectBrowser.removeTypedProjectBrowser">removeTypedProjectBrowser</a></td>
+<td>Public method to remove a browser type from the browsers repository.</td>
+</tr>
</table>
<h3>Static Methods</h3>
@@ -195,16 +318,16 @@
</p>
<a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a>
<h4>ProjectBrowser.__setBrowsersAvailable</h4>
-<b>__setBrowsersAvailable</b>(<i>browserFlags</i>)
+<b>__setBrowsersAvailable</b>(<i>browsersList</i>)
<p>
Private method to add selected browsers to the project browser.
</p>
<dl>
-<dt><i>browserFlags</i></dt>
+<dt><i>browsersList</i> (list of str)</dt>
<dd>
-flags indicating the browsers to add (integer)
+list of project browsers to be shown
</dd>
</dl>
<a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a>
@@ -242,20 +365,43 @@
position of the click (QPoint)
</dd>
</dl>
-<a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a>
-<h4>ProjectBrowser.getProjectBrowser</h4>
-<b>getProjectBrowser</b>(<i>name</i>)
+<a NAME="ProjectBrowser.addTypedProjectBrowser" ID="ProjectBrowser.addTypedProjectBrowser"></a>
+<h4>ProjectBrowser.addTypedProjectBrowser</h4>
+<b>addTypedProjectBrowser</b>(<i>browserType, projectBrowserItem</i>)
<p>
- Public method to get a reference to the named project browser.
+ Public method to add a project browser type to the browser repository.
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>browserType</i> (str)</dt>
+<dd>
+type of the project browser
+</dd>
+<dt><i>projectBrowserItem</i> (ProjectBrowserRepositoryItem)</dt>
+<dd>
+data structure containing the type specific data
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>TypeError</b>:</dt>
<dd>
-name of the requested project browser (string).
- Valid names are "sources, forms, resources, translations,
- interfaces, protocols, others".
+raised to signal a wrong type for the project browser item
+</dd>
+</dl>
+<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>
+<dd>
+type of the requested project browser
</dd>
</dl>
<dl>
@@ -264,17 +410,126 @@
reference to the requested browser or None
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ProjectBaseBrowser or None
+</dd>
+</dl>
+<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>
+<dd>
+file category
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+project browser file filter
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<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>
+<dd>
+type of the project browser
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+icon for the project browser
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QIcon
+</dd>
+</dl>
<a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a>
<h4>ProjectBrowser.getProjectBrowserNames</h4>
<b>getProjectBrowserNames</b>(<i></i>)
<p>
- Public method to get the names of the various project browsers.
+ Public method to get the types of the various project browsers.
</p>
<dl>
<dt>Return:</dt>
<dd>
-list of project browser names (list of string)
+list of project browser types
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<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>
+<dd>
+file category
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+project browser type
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<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>
+dictionary of defined project browser user strings
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
</dd>
</dl>
<a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a>
@@ -290,6 +545,12 @@
list of references to project browsers
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of ProjectBaseBrowser
+</dd>
+</dl>
<a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a>
<h4>ProjectBrowser.handleEditorChanged</h4>
<b>handleEditorChanged</b>(<i>fn</i>)
@@ -299,9 +560,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of the changed file (string)
+filename of the changed file
</dd>
</dl>
<a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a>
@@ -329,6 +590,24 @@
<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>
+<p>
+ 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>
+<dd>
+project browser type
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>
\ No newline at end of file
