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

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.JavaScript.StartPageJsObject</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.JavaScript.StartPageJsObject</h1>
<p>
Module implementing the Python side of the eric home page.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#StartPageJsObject">StartPageJsObject</a></td>
<td>Class implementing the Python side of the eric home page.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="StartPageJsObject" ID="StartPageJsObject"></a>
<h2>StartPageJsObject</h2>
<p>
    Class implementing the Python side of the eric home page.
</p>

<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

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

<h3>Methods</h3>
<table>
<tr>
<td><a href="#StartPageJsObject.__init__">StartPageJsObject</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#StartPageJsObject.providerString">providerString</a></td>
<td>Public method to get a string for the search provider.</td>
</tr>
<tr>
<td><a href="#StartPageJsObject.searchUrl">searchUrl</a></td>
<td>Public method to get the search URL for the given search term.</td>
</tr>
</table>

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


<a NAME="StartPageJsObject.__init__" ID="StartPageJsObject.__init__"></a>
<h4>StartPageJsObject (Constructor)</h4>
<b>StartPageJsObject</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (ExternalJsObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<a NAME="StartPageJsObject.providerString" ID="StartPageJsObject.providerString"></a>
<h4>StartPageJsObject.providerString</h4>
<b>providerString</b>(<i></i>)
<p>
        Public method to get a string for the search provider.
</p>

<dl>
<dt>Return:</dt>
<dd>
string for the search provider
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="StartPageJsObject.searchUrl" ID="StartPageJsObject.searchUrl"></a>
<h4>StartPageJsObject.searchUrl</h4>
<b>searchUrl</b>(<i>searchStr</i>)
<p>
        Public method to get the search URL for the given search term.
</p>

<dl>

<dt><i>searchStr</i> (str)</dt>
<dd>
search term
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
search URL
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>