src/eric7/Documentation/Source/eric7.WebBrowser.JavaScript.ExternalJsObject.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.JavaScript.ExternalJsObject.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,240 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.WebBrowser.JavaScript.ExternalJsObject</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.WebBrowser.JavaScript.ExternalJsObject</h1>
+
+<p>
+Module implementing the JavaScript external object being the endpoint of
+a web channel.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#ExternalJsObject">ExternalJsObject</a></td>
+<td>Class implementing the endpoint of our web channel.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="ExternalJsObject" ID="ExternalJsObject"></a>
+<h2>ExternalJsObject</h2>
+
+<p>
+    Class implementing the endpoint of our web channel.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>extraObjects</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#ExternalJsObject.registerExtraObject">registerExtraObject</a></td>
+<td>Class method to register extra JavaScript objects.</td>
+</tr>
+<tr>
+<td><a href="#ExternalJsObject.setupWebChannel">setupWebChannel</a></td>
+<td>Class method to setup the web channel.</td>
+</tr>
+<tr>
+<td><a href="#ExternalJsObject.unregisterExtraObject">unregisterExtraObject</a></td>
+<td>Class method to unregister extra JavaScript objects.</td>
+</tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#ExternalJsObject.__init__">ExternalJsObject</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#ExternalJsObject.page">page</a></td>
+<td>Public method returning a reference to the web page object.</td>
+</tr>
+<tr>
+<td><a href="#ExternalJsObject.passwordManager">passwordManager</a></td>
+<td>Public method to get a reference to the password manager JavaScript object.</td>
+</tr>
+<tr>
+<td><a href="#ExternalJsObject.speedDial">speedDial</a></td>
+<td>Public method returning a reference to a speed dial object.</td>
+</tr>
+<tr>
+<td><a href="#ExternalJsObject.startPage">startPage</a></td>
+<td>Public method to get a reference to the start page JavaScript object.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="ExternalJsObject.registerExtraObject" ID="ExternalJsObject.registerExtraObject"></a>
+<h4>ExternalJsObject.registerExtraObject (class method)</h4>
+<b>registerExtraObject</b>(<i>name, jsObject</i>)
+
+<p>
+        Class method to register extra JavaScript objects.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name for the object
+</dd>
+<dt><i>jsObject</i> (QObject)</dt>
+<dd>
+reference to the JavaScript object to be registered
+</dd>
+</dl>
+<a NAME="ExternalJsObject.setupWebChannel" ID="ExternalJsObject.setupWebChannel"></a>
+<h4>ExternalJsObject.setupWebChannel (class method)</h4>
+<b>setupWebChannel</b>(<i>channel, page</i>)
+
+<p>
+        Class method to setup the web channel.
+</p>
+<dl>
+
+<dt><i>channel</i> (QWebChannel)</dt>
+<dd>
+reference to the channel
+</dd>
+<dt><i>page</i> (QWebEnginePage)</dt>
+<dd>
+reference to the web page
+</dd>
+</dl>
+<a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a>
+<h4>ExternalJsObject.unregisterExtraObject (class method)</h4>
+<b>unregisterExtraObject</b>(<i>name</i>)
+
+<p>
+        Class method to unregister extra JavaScript objects.
+</p>
+<dl>
+
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the object
+</dd>
+</dl>
+<a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a>
+<h4>ExternalJsObject (Constructor)</h4>
+<b>ExternalJsObject</b>(<i>page</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>page</i> (WebBrowserPage)</dt>
+<dd>
+reference to the web page object
+</dd>
+</dl>
+<a NAME="ExternalJsObject.page" ID="ExternalJsObject.page"></a>
+<h4>ExternalJsObject.page</h4>
+<b>page</b>(<i></i>)
+
+<p>
+        Public method returning a reference to the web page object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the web page object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+WebBrowserPage
+</dd>
+</dl>
+<a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a>
+<h4>ExternalJsObject.passwordManager</h4>
+<b>passwordManager</b>(<i></i>)
+
+<p>
+        Public method to get a reference to the password manager JavaScript
+        object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the password manager JavaScript object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+StartPageJsObject
+</dd>
+</dl>
+<a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a>
+<h4>ExternalJsObject.speedDial</h4>
+<b>speedDial</b>(<i></i>)
+
+<p>
+        Public method returning a reference to a speed dial object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to a speed dial object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SpeedDial
+</dd>
+</dl>
+<a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a>
+<h4>ExternalJsObject.startPage</h4>
+<b>startPage</b>(<i></i>)
+
+<p>
+        Public method to get a reference to the start page JavaScript object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the start page JavaScript object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+StartPageJsObject
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial