Documentation/Source/eric6.WebBrowser.Tools.Scripts.html

<!DOCTYPE html>
<html><head>
<title>eric6.WebBrowser.Tools.Scripts</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.WebBrowser.Tools.Scripts</h1>
<p>
Module containing function to generate JavaScript code.
</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="#completeFormData">completeFormData</a></td>
<td>Function generating a script to fill in form data.</td>
</tr><tr>
<td><a href="#getAllImages">getAllImages</a></td>
<td>Function generating a script to extract all image tags of a web page.</td>
</tr><tr>
<td><a href="#getAllMetaAttributes">getAllMetaAttributes</a></td>
<td>Function generating a script to extract all meta attributes of a web page.</td>
</tr><tr>
<td><a href="#getFeedLinks">getFeedLinks</a></td>
<td>Function generating a script to extract all RSS and Atom feed links.</td>
</tr><tr>
<td><a href="#getFormData">getFormData</a></td>
<td>Function generating a script to extract data for a form element.</td>
</tr><tr>
<td><a href="#getOpenSearchLinks">getOpenSearchLinks</a></td>
<td>Function generating a script to extract all open search links.</td>
</tr><tr>
<td><a href="#scrollToAnchor">scrollToAnchor</a></td>
<td>Function generating script to scroll to a given anchor.</td>
</tr><tr>
<td><a href="#sendPostData">sendPostData</a></td>
<td>Function generating a script to send Post data.</td>
</tr><tr>
<td><a href="#setCss">setCss</a></td>
<td>Function generating a script to set a given CSS style sheet.</td>
</tr><tr>
<td><a href="#setStyleSheet">setStyleSheet</a></td>
<td>Function generating a script to set a user style sheet.</td>
</tr><tr>
<td><a href="#setupFormObserver">setupFormObserver</a></td>
<td>Function generating a script to monitor a web form for user entries.</td>
</tr><tr>
<td><a href="#setupWebChannel">setupWebChannel</a></td>
<td>Function generating  a script to setup the web channel.</td>
</tr><tr>
<td><a href="#setupWindowObject">setupWindowObject</a></td>
<td>Function generating a script to setup window.object add-ons.</td>
</tr>
</table>
<hr /><hr />
<a NAME="completeFormData" ID="completeFormData"></a>
<h2>completeFormData</h2>
<b>completeFormData</b>(<i>data</i>)
<p>
    Function generating a script to fill in form data.
</p><dl>
<dt><i>data</i> (QByteArray)</dt>
<dd>
data to be filled into the form
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to fill a form
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getAllImages" ID="getAllImages"></a>
<h2>getAllImages</h2>
<b>getAllImages</b>(<i></i>)
<p>
    Function generating a script to extract all image tags of a web page.
</p><dl>
<dt>Returns:</dt>
<dd>
script to extract image tags
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getAllMetaAttributes" ID="getAllMetaAttributes"></a>
<h2>getAllMetaAttributes</h2>
<b>getAllMetaAttributes</b>(<i></i>)
<p>
    Function generating a script to extract all meta attributes of a web page.
</p><dl>
<dt>Returns:</dt>
<dd>
script to extract meta attributes
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getFeedLinks" ID="getFeedLinks"></a>
<h2>getFeedLinks</h2>
<b>getFeedLinks</b>(<i></i>)
<p>
    Function generating a script to extract all RSS and Atom feed links.
</p><dl>
<dt>Returns:</dt>
<dd>
script to extract all RSS and Atom feed links
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getFormData" ID="getFormData"></a>
<h2>getFormData</h2>
<b>getFormData</b>(<i>pos</i>)
<p>
    Function generating a script to extract data for a form element.
</p><dl>
<dt><i>pos</i> (QPoint)</dt>
<dd>
position to extract data at
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to extract form data
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getOpenSearchLinks" ID="getOpenSearchLinks"></a>
<h2>getOpenSearchLinks</h2>
<b>getOpenSearchLinks</b>(<i></i>)
<p>
    Function generating a script to extract all open search links.
</p><dl>
<dt>Returns:</dt>
<dd>
script to extract all open serach links
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="scrollToAnchor" ID="scrollToAnchor"></a>
<h2>scrollToAnchor</h2>
<b>scrollToAnchor</b>(<i>anchor</i>)
<p>
    Function generating script to scroll to a given anchor.
</p><dl>
<dt><i>anchor</i> (str)</dt>
<dd>
name of the anchor to scroll to
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to set the style sheet
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="sendPostData" ID="sendPostData"></a>
<h2>sendPostData</h2>
<b>sendPostData</b>(<i>url, data</i>)
<p>
    Function generating a script to send Post data.
</p><dl>
<dt><i>url</i> (QUrl)</dt>
<dd>
URL to send the data to
</dd><dt><i>data</i> (QByteArray)</dt>
<dd>
data to be sent
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to send Post data
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="setCss" ID="setCss"></a>
<h2>setCss</h2>
<b>setCss</b>(<i>css</i>)
<p>
    Function generating a script to set a given CSS style sheet.
</p><dl>
<dt><i>css</i> (str)</dt>
<dd>
style sheet
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to set the style sheet
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="setStyleSheet" ID="setStyleSheet"></a>
<h2>setStyleSheet</h2>
<b>setStyleSheet</b>(<i>css</i>)
<p>
    Function generating a script to set a user style sheet.
</p><dl>
<dt><i>css</i> (str)</dt>
<dd>
style sheet to be applied
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to set a user style sheet
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="setupFormObserver" ID="setupFormObserver"></a>
<h2>setupFormObserver</h2>
<b>setupFormObserver</b>(<i></i>)
<p>
    Function generating a script to monitor a web form for user entries.
</p><dl>
<dt>Returns:</dt>
<dd>
script to monitor a web 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="setupWebChannel" ID="setupWebChannel"></a>
<h2>setupWebChannel</h2>
<b>setupWebChannel</b>(<i>worldId</i>)
<p>
    Function generating  a script to setup the web channel.
</p><dl>
<dt><i>worldId</i> (int)</dt>
<dd>
world ID for which to setup the channel
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
script to setup the web channel
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="setupWindowObject" ID="setupWindowObject"></a>
<h2>setupWindowObject</h2>
<b>setupWindowObject</b>(<i></i>)
<p>
    Function generating a script to setup window.object add-ons.
</p><dl>
<dt>Returns:</dt>
<dd>
generated script
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>