src/eric7/Documentation/Source/eric7.WebBrowser.SpeedDial.SpeedDialWriter.html

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.SpeedDial.SpeedDialWriter</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.SpeedDial.SpeedDialWriter</h1>
<p>
Module implementing a class to write speed dial data files.
</p>

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

<h3>Classes</h3>
<table>
<tr>
<td><a href="#SpeedDialWriter">SpeedDialWriter</a></td>
<td>Class implementing a writer object to generate speed dial data files.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="SpeedDialWriter" ID="SpeedDialWriter"></a>
<h2>SpeedDialWriter</h2>
<p>
    Class implementing a writer object to generate speed dial data files.
</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="#SpeedDialWriter.__init__">SpeedDialWriter</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SpeedDialWriter.__write">__write</a></td>
<td>Private method to write a speed dial file.</td>
</tr>
<tr>
<td><a href="#SpeedDialWriter.write">write</a></td>
<td>Public method to write a speed dial data file.</td>
</tr>
</table>

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


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

<a NAME="SpeedDialWriter.__write" ID="SpeedDialWriter.__write"></a>
<h4>SpeedDialWriter.__write</h4>
<b>__write</b>(<i>pages, pagesPerRow, speedDialSize</i>)
<p>
        Private method to write a speed dial file.
</p>

<dl>

<dt><i>pages</i> (list of Page)</dt>
<dd>
list of speed dial pages
</dd>
<dt><i>pagesPerRow</i> (int)</dt>
<dd>
number of pages per row
</dd>
<dt><i>speedDialSize</i> (int)</dt>
<dd>
size of the speed dial pages
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="SpeedDialWriter.write" ID="SpeedDialWriter.write"></a>
<h4>SpeedDialWriter.write</h4>
<b>write</b>(<i>fileNameOrDevice, pages, pagesPerRow, speedDialSize</i>)
<p>
        Public method to write a speed dial data file.
</p>

<dl>

<dt><i>fileNameOrDevice</i> (str or QIODevice)</dt>
<dd>
name of the file to write or device to write to
</dd>
<dt><i>pages</i> (list of Page)</dt>
<dd>
list of speed dial pages
</dd>
<dt><i>pagesPerRow</i> (int)</dt>
<dd>
number of pages per row
</dd>
<dt><i>speedDialSize</i> (int)</dt>
<dd>
size of the speed dial pages
</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>