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

Fri, 27 Oct 2023 14:09:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 27 Oct 2023 14:09:40 +0200
branch
eric7
changeset 10259
b51dfacef37f
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Regenerated the source documentation with the corrected module parser.

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

<p>
Module implementing a QWebEngineView to load the web inspector in.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#WebInspector">WebInspector</a></td>
<td>Class implementing a QWebEngineView to load the web inspector in.</td>
</tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#pushView">pushView</a></td>
<td>Function to push a view to the front of the list.</td>
</tr>
<tr>
<td><a href="#registerView">registerView</a></td>
<td>Function to register a view.</td>
</tr>
<tr>
<td><a href="#unregisterView">unregisterView</a></td>
<td>Function to unregister a view.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="WebInspector" ID="WebInspector"></a>
<h2>WebInspector</h2>

<p>
    Class implementing a QWebEngineView to load the web inspector in.
</p>
<h3>Signals</h3>
<dl>

<dt>inspectorClosed</dt>
<dd>
emitted to indicate the closing of the inspector
        window
</dd>
</dl>
<h3>Derived from</h3>
QWebEngineView
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>

<tr>
<td><a href="#WebInspector.isEnabled">isEnabled</a></td>
<td>Class method to check, if the web inspector is enabled.</td>
</tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#WebInspector.__init__">WebInspector</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#WebInspector.__loadFinished">__loadFinished</a></td>
<td>Private slot handling the finished signal.</td>
</tr>
<tr>
<td><a href="#WebInspector.__reloadGeometry">__reloadGeometry</a></td>
<td>Private method to restore the geometry.</td>
</tr>
<tr>
<td><a href="#WebInspector.closeEvent">closeEvent</a></td>
<td>Protected method to save the geometry when closed.</td>
</tr>
<tr>
<td><a href="#WebInspector.inspectElement">inspectElement</a></td>
<td>Public method to inspect an element.</td>
</tr>
<tr>
<td><a href="#WebInspector.setView">setView</a></td>
<td>Public method to connect a view to this inspector.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="WebInspector.isEnabled" ID="WebInspector.isEnabled"></a>
<h4>WebInspector.isEnabled (class method)</h4>
<b>isEnabled</b>(<i></i>)

<p>
        Class method to check, if the web inspector is enabled.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating the enabled state
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="WebInspector.__init__" ID="WebInspector.__init__"></a>
<h4>WebInspector (Constructor)</h4>
<b>WebInspector</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="WebInspector.__loadFinished" ID="WebInspector.__loadFinished"></a>
<h4>WebInspector.__loadFinished</h4>
<b>__loadFinished</b>(<i></i>)

<p>
        Private slot handling the finished signal.
</p>
<a NAME="WebInspector.__reloadGeometry" ID="WebInspector.__reloadGeometry"></a>
<h4>WebInspector.__reloadGeometry</h4>
<b>__reloadGeometry</b>(<i></i>)

<p>
        Private method to restore the geometry.
</p>
<a NAME="WebInspector.closeEvent" ID="WebInspector.closeEvent"></a>
<h4>WebInspector.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)

<p>
        Protected method to save the geometry when closed.
</p>
<dl>

<dt><i>evt</i> (QCloseEvent)</dt>
<dd>
event object
</dd>
</dl>
<a NAME="WebInspector.inspectElement" ID="WebInspector.inspectElement"></a>
<h4>WebInspector.inspectElement</h4>
<b>inspectElement</b>(<i></i>)

<p>
        Public method to inspect an element.
</p>
<a NAME="WebInspector.setView" ID="WebInspector.setView"></a>
<h4>WebInspector.setView</h4>
<b>setView</b>(<i>view, inspectElement=False</i>)

<p>
        Public method to connect a view to this inspector.
</p>
<dl>

<dt><i>view</i> (WebBrowserView)</dt>
<dd>
reference to the view object
</dd>
<dt><i>inspectElement</i> (bool)</dt>
<dd>
flag indicating to start a web inspection
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="pushView" ID="pushView"></a>
<h2>pushView</h2>
<b>pushView</b>(<i>view</i>)

<p>
    Function to push a view to the front of the list.
</p>
<dl>

<dt><i>view</i> (WebBrowserView)</dt>
<dd>
reference to the view
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="registerView" ID="registerView"></a>
<h2>registerView</h2>
<b>registerView</b>(<i>view</i>)

<p>
    Function to register a view.
</p>
<dl>

<dt><i>view</i> (WebBrowserView)</dt>
<dd>
reference to the view
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="unregisterView" ID="unregisterView"></a>
<h2>unregisterView</h2>
<b>unregisterView</b>(<i>view</i>)

<p>
    Function to unregister a view.
</p>
<dl>

<dt><i>view</i> (WebBrowserView)</dt>
<dd>
reference to the view
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial