--- a/src/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,24 +7,22 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.Tools.WebBrowserTools</h1>
-
<p>
Module implementing tool functions for the web browser.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>WebBrowserDataDirectory</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#containsSpace">containsSpace</a></td>
<td>Function to check, if a string contains whitespace characters.</td>
@@ -78,15 +76,16 @@
<td>Function to read the string contents of the given file.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="containsSpace" ID="containsSpace"></a>
<h2>containsSpace</h2>
<b>containsSpace</b>(<i>string</i>)
-
<p>
Function to check, if a string contains whitespace characters.
</p>
+
<dl>
<dt><i>string</i> (str)</dt>
@@ -112,10 +111,10 @@
<a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a>
<h2>ensureUniqueFilename</h2>
<b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>)
-
<p>
Module function to generate an unique file name based on a pattern.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -145,10 +144,10 @@
<a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a>
<h2>filterCharsFromFilename</h2>
<b>filterCharsFromFilename</b>(<i>name</i>)
-
<p>
Module function to filter illegal characters.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -174,10 +173,10 @@
<a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a>
<h2>getFileNameFromUrl</h2>
<b>getFileNameFromUrl</b>(<i>url</i>)
-
<p>
Module function to generate a file name based on the given URL.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -203,7 +202,6 @@
<a NAME="getHtmlPage" ID="getHtmlPage"></a>
<h2>getHtmlPage</h2>
<b>getHtmlPage</b>(<i>pageFileName</i>)
-
<p>
Module function to load a HTML page.
</p>
@@ -211,6 +209,7 @@
Note: If the given HTML file path is not absolute, it is assumed to
denote a HTML file in the html data directory.
</p>
+
<dl>
<dt><i>pageFileName</i> (str)</dt>
@@ -236,7 +235,6 @@
<a NAME="getJavascript" ID="getJavascript"></a>
<h2>getJavascript</h2>
<b>getJavascript</b>(<i>jsFileName</i>)
-
<p>
Module function to load a JavaScript source file.
</p>
@@ -245,6 +243,7 @@
assumed to denote a JavaScript source file in the javascript data
directory.
</p>
+
<dl>
<dt><i>jsFileName</i> (str)</dt>
@@ -270,7 +269,6 @@
<a NAME="getJquery" ID="getJquery"></a>
<h2>getJquery</h2>
<b>getJquery</b>(<i>jqName</i>)
-
<p>
Module function to load a JQuery source file.
</p>
@@ -279,6 +277,7 @@
the platform is Linux, it is assumed that it is installed system wide in the
'/usr/share/javascript' directory (e.g. as packaged by Debian).
</p>
+
<dl>
<dt><i>jqName</i> (str)</dt>
@@ -305,7 +304,6 @@
<a NAME="getWebEngineVersions" ID="getWebEngineVersions"></a>
<h2>getWebEngineVersions</h2>
<b>getWebEngineVersions</b>(<i></i>)
-
<p>
Module function to extract the web engine related versions from the default
user agent string.
@@ -313,6 +311,7 @@
<p>
Note: For PyQt 6.3.1 or newer the data is extracted via some Qt functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -332,7 +331,6 @@
<a NAME="pixmapFileToDataUrl" ID="pixmapFileToDataUrl"></a>
<h2>pixmapFileToDataUrl</h2>
<b>pixmapFileToDataUrl</b>(<i>pixmapFile, asString=False</i>)
-
<p>
Module function to load a pixmap file and convert the pixmap to a
data: URL.
@@ -341,6 +339,7 @@
Note: If the given pixmap file path is not absolute, it is assumed to
denote a pixmap file in the icons data directory.
</p>
+
<dl>
<dt><i>pixmapFile</i> (str)</dt>
@@ -370,10 +369,10 @@
<a NAME="pixmapFromByteArray" ID="pixmapFromByteArray"></a>
<h2>pixmapFromByteArray</h2>
<b>pixmapFromByteArray</b>(<i>data</i>)
-
<p>
Module function to convert a byte array to a pixmap.
</p>
+
<dl>
<dt><i>data</i> (bytes or QByteArray)</dt>
@@ -399,11 +398,11 @@
<a NAME="pixmapToByteArray" ID="pixmapToByteArray"></a>
<h2>pixmapToByteArray</h2>
<b>pixmapToByteArray</b>(<i>pixmap</i>)
-
<p>
Module function to convert a pixmap to a byte array containing the pixmap
as a PNG encoded as base64.
</p>
+
<dl>
<dt><i>pixmap</i> (QPixmap)</dt>
@@ -429,10 +428,10 @@
<a NAME="pixmapToDataUrl" ID="pixmapToDataUrl"></a>
<h2>pixmapToDataUrl</h2>
<b>pixmapToDataUrl</b>(<i>pixmap, mimetype="image/png"</i>)
-
<p>
Module function to convert a pixmap to a data: URL.
</p>
+
<dl>
<dt><i>pixmap</i> (QPixmap)</dt>
@@ -462,10 +461,10 @@
<a NAME="readAllFileContents" ID="readAllFileContents"></a>
<h2>readAllFileContents</h2>
<b>readAllFileContents</b>(<i>filename</i>)
-
<p>
Function to read the string contents of the given file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -487,4 +486,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
