|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Helpviewer.SpeedDial.SpeedDialWriter</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.SpeedDialWriter</h1> |
|
23 <p> |
|
24 Module implementing a class to write 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="#SpeedDialWriter">SpeedDialWriter</a></td> |
|
34 <td>Class implementing a writer object to generate 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="SpeedDialWriter" ID="SpeedDialWriter"></a> |
|
43 <h2>SpeedDialWriter</h2> |
|
44 <p> |
|
45 Class implementing a writer object to generate speed dial data files. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QXmlStreamWriter |
|
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="#SpeedDialWriter.__init__">SpeedDialWriter</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SpeedDialWriter.__write">__write</a></td> |
|
64 <td>Private method to write a speed dial file.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SpeedDialWriter.write">write</a></td> |
|
67 <td>Public method to write a speed dial data file.</td> |
|
68 </tr> |
|
69 </table> |
|
70 <h3>Static Methods</h3> |
|
71 <table> |
|
72 <tr><td>None</td></tr> |
|
73 </table> |
|
74 <a NAME="SpeedDialWriter.__init__" ID="SpeedDialWriter.__init__"></a> |
|
75 <h4>SpeedDialWriter (Constructor)</h4> |
|
76 <b>SpeedDialWriter</b>(<i></i>) |
|
77 <p> |
|
78 Constructor |
|
79 </p><a NAME="SpeedDialWriter.__write" ID="SpeedDialWriter.__write"></a> |
|
80 <h4>SpeedDialWriter.__write</h4> |
|
81 <b>__write</b>(<i>pages, pagesPerRow, speedDialSize</i>) |
|
82 <p> |
|
83 Private method to write a speed dial file. |
|
84 </p><dl> |
|
85 <dt><i>pages</i></dt> |
|
86 <dd> |
|
87 list of speed dial pages (list of Page) |
|
88 </dd><dt><i>pagesPerRow</i></dt> |
|
89 <dd> |
|
90 number of pages per row (integer) |
|
91 </dd><dt><i>speedDialSize</i></dt> |
|
92 <dd> |
|
93 size of the speed dial pages (integer) |
|
94 </dd> |
|
95 </dl><dl> |
|
96 <dt>Returns:</dt> |
|
97 <dd> |
|
98 flag indicating success (boolean) |
|
99 </dd> |
|
100 </dl><a NAME="SpeedDialWriter.write" ID="SpeedDialWriter.write"></a> |
|
101 <h4>SpeedDialWriter.write</h4> |
|
102 <b>write</b>(<i>fileNameOrDevice, pages, pagesPerRow, speedDialSize</i>) |
|
103 <p> |
|
104 Public method to write a speed dial data file. |
|
105 </p><dl> |
|
106 <dt><i>fileNameOrDevice</i></dt> |
|
107 <dd> |
|
108 name of the file to write (string) |
|
109 or device to write to (QIODevice) |
|
110 </dd><dt><i>pages</i></dt> |
|
111 <dd> |
|
112 list of speed dial pages (list of Page) |
|
113 </dd><dt><i>pagesPerRow</i></dt> |
|
114 <dd> |
|
115 number of pages per row (integer) |
|
116 </dd><dt><i>speedDialSize</i></dt> |
|
117 <dd> |
|
118 size of the speed dial pages (integer) |
|
119 </dd> |
|
120 </dl><dl> |
|
121 <dt>Returns:</dt> |
|
122 <dd> |
|
123 flag indicating success (boolean) |
|
124 </dd> |
|
125 </dl> |
|
126 <div align="right"><a href="#top">Up</a></div> |
|
127 <hr /> |
|
128 </body></html> |