src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserSnap.html

Fri, 22 Dec 2023 17:24:07 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Dec 2023 17:24:07 +0100
branch
eric7
changeset 10436
f6881d10e995
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Converted some source code documentation to the new style.

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.WebBrowserSnap</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.WebBrowserSnap</h1>

<p>
Module implementing functions to generate page previews.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#__render">__render</a></td>
<td>Private function to render a pixmap of given size for a web page.</td>
</tr>
<tr>
<td><a href="#renderTabPreview">renderTabPreview</a></td>
<td>Public function to render a pixmap of a page.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="__render" ID="__render"></a>
<h2>__render</h2>
<b>__render</b>(<i>view, w, h</i>)

<p>
    Private function to render a pixmap of given size for a web page.
</p>
<dl>

<dt><i>view</i> (QWebEngineView)</dt>
<dd>
reference to the view to be previewed
</dd>
<dt><i>w</i> (int)</dt>
<dd>
width of the pixmap
</dd>
<dt><i>h</i> (int)</dt>
<dd>
height of the pixmap
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
rendered pixmap
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QPixmap
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="renderTabPreview" ID="renderTabPreview"></a>
<h2>renderTabPreview</h2>
<b>renderTabPreview</b>(<i>view, w, h</i>)

<p>
    Public function to render a pixmap of a page.
</p>
<dl>

<dt><i>view</i> (QWebEngineView)</dt>
<dd>
reference to the view to be previewed
</dd>
<dt><i>w</i> (int)</dt>
<dd>
width of the preview pixmap
</dd>
<dt><i>h</i> (int)</dt>
<dd>
height of the preview pixmap
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
preview pixmap
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QPixmap
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial