Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.SpeedDial.SpeedDialWriter.html
Documentation/Source/eric5.Helpviewer.SpeedDial.SpeedDialWriter.html
- changeset 1699
- 10706f6ad9d2
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 1698:dba994e19891 | 1699:10706f6ad9d2 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.SpeedDial.SpeedDialWriter</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Helpviewer.SpeedDial.SpeedDialWriter</h1> | |
| 24 <p> | |
| 25 Module implementing a class to write speed dial data files. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#SpeedDialWriter">SpeedDialWriter</a></td> | |
| 35 <td>Class implementing a writer object to generate speed dial data files.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="SpeedDialWriter" ID="SpeedDialWriter"></a> | |
| 44 <h2>SpeedDialWriter</h2> | |
| 45 <p> | |
| 46 Class implementing a writer object to generate speed dial data files. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QXmlStreamWriter | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Class Methods</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 <table> | |
| 60 <tr> | |
| 61 <td><a href="#SpeedDialWriter.__init__">SpeedDialWriter</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#SpeedDialWriter.__write">__write</a></td> | |
| 65 <td>Private method to write a speed dial file.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#SpeedDialWriter.write">write</a></td> | |
| 68 <td>Public method to write a speed dial data file.</td> | |
| 69 </tr> | |
| 70 </table> | |
| 71 <h3>Static Methods</h3> | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <a NAME="SpeedDialWriter.__init__" ID="SpeedDialWriter.__init__"></a> | |
| 76 <h4>SpeedDialWriter (Constructor)</h4> | |
| 77 <b>SpeedDialWriter</b>(<i></i>) | |
| 78 <p> | |
| 79 Constructor | |
| 80 </p><a NAME="SpeedDialWriter.__write" ID="SpeedDialWriter.__write"></a> | |
| 81 <h4>SpeedDialWriter.__write</h4> | |
| 82 <b>__write</b>(<i>pages, pagesPerRow, speedDialSize</i>) | |
| 83 <p> | |
| 84 Private method to write a speed dial file. | |
| 85 </p><dl> | |
| 86 <dt><i>pages</i></dt> | |
| 87 <dd> | |
| 88 list of speed dial pages (list of Page) | |
| 89 </dd><dt><i>pagesPerRow</i></dt> | |
| 90 <dd> | |
| 91 number of pages per row (integer) | |
| 92 </dd><dt><i>speedDialSize</i></dt> | |
| 93 <dd> | |
| 94 size of the speed dial pages (integer) | |
| 95 </dd> | |
| 96 </dl><dl> | |
| 97 <dt>Returns:</dt> | |
| 98 <dd> | |
| 99 flag indicating success (boolean) | |
| 100 </dd> | |
| 101 </dl><a NAME="SpeedDialWriter.write" ID="SpeedDialWriter.write"></a> | |
| 102 <h4>SpeedDialWriter.write</h4> | |
| 103 <b>write</b>(<i>fileNameOrDevice, pages, pagesPerRow, speedDialSize</i>) | |
| 104 <p> | |
| 105 Public method to write a speed dial data file. | |
| 106 </p><dl> | |
| 107 <dt><i>fileNameOrDevice</i></dt> | |
| 108 <dd> | |
| 109 name of the file to write (string) | |
| 110 or device to write to (QIODevice) | |
| 111 </dd><dt><i>pages</i></dt> | |
| 112 <dd> | |
| 113 list of speed dial pages (list of Page) | |
| 114 </dd><dt><i>pagesPerRow</i></dt> | |
| 115 <dd> | |
| 116 number of pages per row (integer) | |
| 117 </dd><dt><i>speedDialSize</i></dt> | |
| 118 <dd> | |
| 119 size of the speed dial pages (integer) | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <div align="right"><a href="#top">Up</a></div> | |
| 123 <hr /> | |
| 124 </body></html> |
