src/eric7/Documentation/Source/eric7.WebBrowser.OpenSearch.OpenSearchWriter.html

Fri, 22 Dec 2023 17:24:07 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Dec 2023 17:24:07 +0100
branch
eric7
changeset 10436
f6881d10e995
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Converted some source code documentation to the new style.

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

<p>
Module implementing a writer for open search engine descriptions.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#OpenSearchWriter">OpenSearchWriter</a></td>
<td>Class implementing a writer for open search engine descriptions.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="OpenSearchWriter" ID="OpenSearchWriter"></a>
<h2>OpenSearchWriter</h2>

<p>
    Class implementing a writer for open search engine descriptions.
</p>
<h3>Derived from</h3>
QXmlStreamWriter
<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="#OpenSearchWriter.__init__">OpenSearchWriter</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#OpenSearchWriter.__write">__write</a></td>
<td>Private method to write the description of an engine.</td>
</tr>
<tr>
<td><a href="#OpenSearchWriter.write">write</a></td>
<td>Public method to write the description of an engine.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="OpenSearchWriter.__init__" ID="OpenSearchWriter.__init__"></a>
<h4>OpenSearchWriter (Constructor)</h4>
<b>OpenSearchWriter</b>(<i></i>)

<p>
        Constructor
</p>
<a NAME="OpenSearchWriter.__write" ID="OpenSearchWriter.__write"></a>
<h4>OpenSearchWriter.__write</h4>
<b>__write</b>(<i>engine</i>)

<p>
        Private method to write the description of an engine.
</p>
<dl>

<dt><i>engine</i> (OpenSearchEngine)</dt>
<dd>
reference to the engine
</dd>
</dl>
<a NAME="OpenSearchWriter.write" ID="OpenSearchWriter.write"></a>
<h4>OpenSearchWriter.write</h4>
<b>write</b>(<i>device, engine</i>)

<p>
        Public method to write the description of an engine.
</p>
<dl>

<dt><i>device</i> (QIODevice)</dt>
<dd>
reference to the device to write to
</dd>
<dt><i>engine</i> (OpenSearchEngine)</dt>
<dd>
reference to the engine
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial