Documentation/Source/eric5.Helpviewer.SpeedDial.SpeedDialWriter.html

<!DOCTYPE html>
<html><head>
<title>eric5.Helpviewer.SpeedDial.SpeedDialWriter</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>eric5.Helpviewer.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></dt>
<dd>
list of speed dial pages (list of Page)
</dd><dt><i>pagesPerRow</i></dt>
<dd>
number of pages per row (integer)
</dd><dt><i>speedDialSize</i></dt>
<dd>
size of the speed dial pages (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</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></dt>
<dd>
name of the file to write (string)
            or device to write to (QIODevice)
</dd><dt><i>pages</i></dt>
<dd>
list of speed dial pages (list of Page)
</dd><dt><i>pagesPerRow</i></dt>
<dd>
number of pages per row (integer)
</dd><dt><i>speedDialSize</i></dt>
<dd>
size of the speed dial pages (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>