diff -r af03537d56b2 -r 93b496cc3c88 src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.__init__.html
--- a/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.__init__.html Sun Dec 11 18:24:41 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.__init__.html Mon Dec 12 16:35:21 2022 +0100
@@ -27,7 +27,7 @@
<h3>Global Attributes</h3>
<table>
-<tr><td>IDL_SOURCE</td></tr><tr><td>JS_SOURCE</td></tr><tr><td>PROTO_SOURCE</td></tr><tr><td>PTL_SOURCE</td></tr><tr><td>PY_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>UNKNOWN_SOURCE</td></tr><tr><td>__extensions</td></tr>
+<tr><td>ClassBrowserRegistry</td></tr><tr><td>JS_SOURCE</td></tr><tr><td>PTL_SOURCE</td></tr><tr><td>PY_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>UNKNOWN_SOURCE</td></tr><tr><td>__extensions</td></tr>
</table>
<h3>Classes</h3>
@@ -47,9 +47,29 @@
<td>Function to import a class browser module.</td>
</tr>
<tr>
+<td><a href="#getIcon">getIcon</a></td>
+<td>Function to get an icon name for the given file (only for class browsers provided via plugins).</td>
+</tr>
+<tr>
+<td><a href="#isSupportedType">isSupportedType</a></td>
+<td>Function to check, if the given file extension indicates a supported file type.</td>
+</tr>
+<tr>
<td><a href="#readmodule">readmodule</a></td>
<td>Function to read a source file and return a dictionary of classes, functions, modules, etc.</td>
</tr>
+<tr>
+<td><a href="#registerClassBrowser">registerClassBrowser</a></td>
+<td>Function to register a class browser type.</td>
+</tr>
+<tr>
+<td><a href="#scan">scan</a></td>
+<td>Function to scan the given source text.</td>
+</tr>
+<tr>
+<td><a href="#unregisterClassBrowser">unregisterClassBrowser</a></td>
+<td>Function to unregister a class browser type.</td>
+</tr>
</table>
<hr />
<hr />
@@ -133,6 +153,65 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
+<a NAME="getIcon" ID="getIcon"></a>
+<h2>getIcon</h2>
+<b>getIcon</b>(<i>filename</i>)
+
+<p>
+ Function to get an icon name for the given file (only for class browsers provided
+ via plugins).
+</p>
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the file
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+icon name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="isSupportedType" ID="isSupportedType"></a>
+<h2>isSupportedType</h2>
+<b>isSupportedType</b>(<i>fileext</i>)
+
+<p>
+ Function to check, if the given file extension indicates a supported file type.
+</p>
+<dl>
+
+<dt><i>fileext</i> (str)</dt>
+<dd>
+file extension
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a supported file type
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
<a NAME="readmodule" ID="readmodule"></a>
<h2>readmodule</h2>
<b>readmodule</b>(<i>module, path=None, isPyFile=False</i>)
@@ -174,4 +253,104 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
+<hr />
+<a NAME="registerClassBrowser" ID="registerClassBrowser"></a>
+<h2>registerClassBrowser</h2>
+<b>registerClassBrowser</b>(<i>name, readModuleFunc, scanFunc, iconFunc, extensions</i>)
+
+<p>
+ Function to register a class browser type.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the class browser
+</dd>
+<dt><i>readModuleFunc</i> (function)</dt>
+<dd>
+function to read and parse a file returning a dictionary
+ with the parsing result
+</dd>
+<dt><i>scanFunc</i> (function)</dt>
+<dd>
+function to scan a given source text returning a dictionary with
+ the parsing result
+</dd>
+<dt><i>iconFunc</i> (function)</dt>
+<dd>
+function returning an icon name for the supported files
+</dd>
+<dt><i>extensions</i> (list of str)</dt>
+<dd>
+list of associated file extensions
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>KeyError</b>:</dt>
+<dd>
+raised if the class browser to be registered is already
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="scan" ID="scan"></a>
+<h2>scan</h2>
+<b>scan</b>(<i>src, filename, module, isPyFile=False</i>)
+
+<p>
+ Function to scan the given source text.
+</p>
+<dl>
+
+<dt><i>src</i> (str)</dt>
+<dd>
+source text to be scanned
+</dd>
+<dt><i>filename</i> (str)</dt>
+<dd>
+file name associated with the source text
+</dd>
+<dt><i>module</i> (str)</dt>
+<dd>
+module name associated with the source text
+</dd>
+<dt><i>isPyFile</i> (bool)</dt>
+<dd>
+flag indicating a Python file
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the extracted data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="unregisterClassBrowser" ID="unregisterClassBrowser"></a>
+<h2>unregisterClassBrowser</h2>
+<b>unregisterClassBrowser</b>(<i>name</i>)
+
+<p>
+ Function to unregister a class browser type.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the class browser
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
</body></html>
\ No newline at end of file
