|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Helpviewer.SpeedDial.SpeedDialReader</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Helpviewer.SpeedDial.SpeedDialReader</h1> |
|
23 <p> |
|
24 Module implementing a class to read speed dial data files. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#SpeedDialReader">SpeedDialReader</a></td> |
|
34 <td>Class implementing a reader object for speed dial data files.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="SpeedDialReader" ID="SpeedDialReader"></a> |
|
43 <h2>SpeedDialReader</h2> |
|
44 <p> |
|
45 Class implementing a reader object for speed dial data files. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QXmlStreamReader |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#SpeedDialReader.__init__">SpeedDialReader</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SpeedDialReader.__readSpeedDial">__readSpeedDial</a></td> |
|
64 <td>Private method to read the speed dial data.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SpeedDialReader.__skipUnknownElement">__skipUnknownElement</a></td> |
|
67 <td>Private method to skip over all unknown elements.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SpeedDialReader.read">read</a></td> |
|
70 <td>Public method to read a user agent file.</td> |
|
71 </tr> |
|
72 </table> |
|
73 <h3>Static Methods</h3> |
|
74 <table> |
|
75 <tr><td>None</td></tr> |
|
76 </table> |
|
77 <a NAME="SpeedDialReader.__init__" ID="SpeedDialReader.__init__"></a> |
|
78 <h4>SpeedDialReader (Constructor)</h4> |
|
79 <b>SpeedDialReader</b>(<i></i>) |
|
80 <p> |
|
81 Constructor |
|
82 </p><a NAME="SpeedDialReader.__readSpeedDial" ID="SpeedDialReader.__readSpeedDial"></a> |
|
83 <h4>SpeedDialReader.__readSpeedDial</h4> |
|
84 <b>__readSpeedDial</b>(<i></i>) |
|
85 <p> |
|
86 Private method to read the speed dial data. |
|
87 </p><a NAME="SpeedDialReader.__skipUnknownElement" ID="SpeedDialReader.__skipUnknownElement"></a> |
|
88 <h4>SpeedDialReader.__skipUnknownElement</h4> |
|
89 <b>__skipUnknownElement</b>(<i></i>) |
|
90 <p> |
|
91 Private method to skip over all unknown elements. |
|
92 </p><a NAME="SpeedDialReader.read" ID="SpeedDialReader.read"></a> |
|
93 <h4>SpeedDialReader.read</h4> |
|
94 <b>read</b>(<i>fileNameOrDevice</i>) |
|
95 <p> |
|
96 Public method to read a user agent file. |
|
97 </p><dl> |
|
98 <dt><i>fileNameOrDevice</i></dt> |
|
99 <dd> |
|
100 name of the file to read (string) |
|
101 or reference to the device to read (QIODevice) |
|
102 </dd> |
|
103 </dl><dl> |
|
104 <dt>Returns:</dt> |
|
105 <dd> |
|
106 list of speed dial pages (list of Page), number of pages per |
|
107 row (integer) and size of the speed dial pages (integer) |
|
108 </dd> |
|
109 </dl> |
|
110 <div align="right"><a href="#top">Up</a></div> |
|
111 <hr /> |
|
112 </body></html> |