diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html --- a/eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.JavaScript.ExternalJsObject.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,178 +18,232 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<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> +</tr> +<tr> <td><a href="#ExternalJsObject.setupWebChannel">setupWebChannel</a></td> <td>Class method to setup the web channel.</td> -</tr><tr> +</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> +</tr> +<tr> <td><a href="#ExternalJsObject.page">page</a></td> <td>Public method returning a reference to the web page object.</td> -</tr><tr> +</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> +</tr> +<tr> <td><a href="#ExternalJsObject.speedDial">speedDial</a></td> <td>Public method returning a reference to a speed dial object.</td> -</tr><tr> +</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> +</p> +<dl> + <dt><i>name</i> (str)</dt> <dd> name for the object -</dd><dt><i>jsObject</i> (QObject)</dt> +</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> +</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> +</p> +<dl> + <dt><i>channel</i> (QWebChannel)</dt> <dd> reference to the channel -</dd><dt><i>page</i> (QWebEnginePage)</dt> +</dd> +<dt><i>page</i> (QWebEnginePage)</dt> <dd> reference to the web page </dd> -</dl><a NAME="ExternalJsObject.unregisterExtraObject" ID="ExternalJsObject.unregisterExtraObject"></a> +</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> +</p> +<dl> + <dt><i>name</i> (str)</dt> <dd> name of the object </dd> -</dl><a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a> +</dl> +<a NAME="ExternalJsObject.__init__" ID="ExternalJsObject.__init__"></a> <h4>ExternalJsObject (Constructor)</h4> <b>ExternalJsObject</b>(<i>page</i>) + <p> Constructor -</p><dl> +</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> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> reference to the web page object </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> WebBrowserPage </dd> -</dl><a NAME="ExternalJsObject.passwordManager" ID="ExternalJsObject.passwordManager"></a> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> reference to the password manager JavaScript object </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> StartPageJsObject </dd> -</dl><a NAME="ExternalJsObject.speedDial" ID="ExternalJsObject.speedDial"></a> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> reference to a speed dial object </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> SpeedDial </dd> -</dl><a NAME="ExternalJsObject.startPage" ID="ExternalJsObject.startPage"></a> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> reference to the start page JavaScript object </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> StartPageJsObject