diff -r 2a386a2100d7 -r 331ecfa0e716 eric6/Documentation/Source/eric6.WebBrowser.Tools.WebBrowserTools.html --- a/eric6/Documentation/Source/eric6.WebBrowser.Tools.WebBrowserTools.html Tue Sep 29 18:59:05 2020 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Tools.WebBrowserTools.html Tue Sep 29 19:00:15 2020 +0200 @@ -28,7 +28,7 @@ <h3>Global Attributes</h3> <table> -<tr><td>None</td></tr> +<tr><td>WebBrowserDataDirectory</td></tr> </table> <h3>Classes</h3> @@ -56,10 +56,22 @@ <td>Module function to generate a file name based on the given URL.</td> </tr> <tr> +<td><a href="#getHtmlPage">getHtmlPage</a></td> +<td>Module function to load a HTML page.</td> +</tr> +<tr> +<td><a href="#getJavascript">getJavascript</a></td> +<td>Module function to load a JavaScript source file.</td> +</tr> +<tr> <td><a href="#getWebEngineVersions">getWebEngineVersions</a></td> <td>Module function to extract the web engine version from the default user agent string.</td> </tr> <tr> +<td><a href="#pixmapFileToDataUrl">pixmapFileToDataUrl</a></td> +<td>Module function to load a pixmap file and convert the pixmap to a data: URL.</td> +</tr> +<tr> <td><a href="#pixmapFromByteArray">pixmapFromByteArray</a></td> <td>Module function to convert a byte array to a pixmap.</td> </tr> @@ -185,6 +197,73 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="getHtmlPage" ID="getHtmlPage"></a> +<h2>getHtmlPage</h2> +<b>getHtmlPage</b>(<i>pageFileName</i>) + +<p> + Module function to load a HTML page. +</p> +<p> + 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> +<dd> +file name of the HTML file +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +HTML page +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<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> +<p> + Note: If the given JavaScript source file path is not absolute, it is + assumed to denote a JavaScript source file in the javascript data + directory. +</p> +<dl> + +<dt><i>jsFileName</i> (str)</dt> +<dd> +file name of the JavaScript source file +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +JavaScript source +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="getWebEngineVersions" ID="getWebEngineVersions"></a> <h2>getWebEngineVersions</h2> <b>getWebEngineVersions</b>(<i></i>) @@ -208,6 +287,44 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<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. +</p> +<p> + 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> +<dd> +file name of the pixmap file +</dd> +<dt><i>asString</i> (bool)</dt> +<dd> +flag indicating a string representation is requested +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +data: URL +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QUrl or str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="pixmapFromByteArray" ID="pixmapFromByteArray"></a> <h2>pixmapFromByteArray</h2> <b>pixmapFromByteArray</b>(<i>data</i>) @@ -269,7 +386,7 @@ <hr /> <a NAME="pixmapToDataUrl" ID="pixmapToDataUrl"></a> <h2>pixmapToDataUrl</h2> -<b>pixmapToDataUrl</b>(<i>pixmap</i>) +<b>pixmapToDataUrl</b>(<i>pixmap, mimetype="image/png"</i>) <p> Module function to convert a pixmap to a data: URL.