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

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Helpviewer.SpeedDial.SpeedDialReader</title>
<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.SpeedDialReader</h1>
<p>
Module implementing a class to read speed dial data files.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#SpeedDialReader">SpeedDialReader</a></td>
<td>Class implementing a reader object for speed dial data files.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="SpeedDialReader" ID="SpeedDialReader"></a>
<h2>SpeedDialReader</h2>
<p>
    Class implementing a reader object for speed dial data files.
</p>
<h3>Derived from</h3>
QXmlStreamReader
<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="#SpeedDialReader.__init__">SpeedDialReader</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#SpeedDialReader.__readSpeedDial">__readSpeedDial</a></td>
<td>Private method to read the speed dial data.</td>
</tr><tr>
<td><a href="#SpeedDialReader.__skipUnknownElement">__skipUnknownElement</a></td>
<td>Private method to skip over all unknown elements.</td>
</tr><tr>
<td><a href="#SpeedDialReader.read">read</a></td>
<td>Public method to read a user agent file.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="SpeedDialReader.__init__" ID="SpeedDialReader.__init__"></a>
<h4>SpeedDialReader (Constructor)</h4>
<b>SpeedDialReader</b>(<i></i>)
<p>
        Constructor
</p><a NAME="SpeedDialReader.__readSpeedDial" ID="SpeedDialReader.__readSpeedDial"></a>
<h4>SpeedDialReader.__readSpeedDial</h4>
<b>__readSpeedDial</b>(<i></i>)
<p>
        Private method to read the speed dial data.
</p><a NAME="SpeedDialReader.__skipUnknownElement" ID="SpeedDialReader.__skipUnknownElement"></a>
<h4>SpeedDialReader.__skipUnknownElement</h4>
<b>__skipUnknownElement</b>(<i></i>)
<p>
        Private method to skip over all unknown elements.
</p><a NAME="SpeedDialReader.read" ID="SpeedDialReader.read"></a>
<h4>SpeedDialReader.read</h4>
<b>read</b>(<i>fileNameOrDevice</i>)
<p>
        Public method to read a user agent file.
</p><dl>
<dt><i>fileNameOrDevice</i></dt>
<dd>
name of the file to read (string)
            or reference to the device to read (QIODevice)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of speed dial pages (list of Page), number of pages per row (integer)
            and size of the speed dial pages (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>