Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterBase.html
src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterBase.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.Exporters.ExporterBase</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QScintilla.Exporters.ExporterBase</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the exporter base class. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ExporterBase">ExporterBase</a></td> | |
| 25 <td>Class implementing the exporter base class.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="ExporterBase" ID="ExporterBase"></a> | |
| 36 <h2>ExporterBase</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the exporter base class. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QObject | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#ExporterBase.__init__">ExporterBase</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#ExporterBase._getFileName">_getFileName</a></td> | |
| 63 <td>Protected method to get the file name of the export file from the user.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ExporterBase.exportSource">exportSource</a></td> | |
| 67 <td>Public method performing the export.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <h3>Static Methods</h3> | |
| 71 | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 | |
| 76 <a NAME="ExporterBase.__init__" ID="ExporterBase.__init__"></a> | |
| 77 <h4>ExporterBase (Constructor)</h4> | |
| 78 <b>ExporterBase</b>(<i>editor, parent=None</i>) | |
| 79 | |
| 80 <p> | |
| 81 Constructor | |
| 82 </p> | |
| 83 <dl> | |
| 84 | |
| 85 <dt><i>editor</i></dt> | |
| 86 <dd> | |
| 87 reference to the editor object (QScintilla.Editor.Editor) | |
| 88 </dd> | |
| 89 <dt><i>parent</i></dt> | |
| 90 <dd> | |
| 91 parent object of the exporter (QObject) | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <a NAME="ExporterBase._getFileName" ID="ExporterBase._getFileName"></a> | |
| 95 <h4>ExporterBase._getFileName</h4> | |
| 96 <b>_getFileName</b>(<i>fileFilter</i>) | |
| 97 | |
| 98 <p> | |
| 99 Protected method to get the file name of the export file from the user. | |
| 100 </p> | |
| 101 <dl> | |
| 102 | |
| 103 <dt><i>fileFilter</i></dt> | |
| 104 <dd> | |
| 105 the filter string to be used (string). The filter for | |
| 106 "All Files (*)" is appended by this method. | |
| 107 </dd> | |
| 108 </dl> | |
| 109 <dl> | |
| 110 <dt>Return:</dt> | |
| 111 <dd> | |
| 112 file name entered by the user (string) | |
| 113 </dd> | |
| 114 </dl> | |
| 115 <a NAME="ExporterBase.exportSource" ID="ExporterBase.exportSource"></a> | |
| 116 <h4>ExporterBase.exportSource</h4> | |
| 117 <b>exportSource</b>(<i></i>) | |
| 118 | |
| 119 <p> | |
| 120 Public method performing the export. | |
| 121 </p> | |
| 122 <p> | |
| 123 This method must be overridden by the real exporters. | |
| 124 </p> | |
| 125 <dl> | |
| 126 | |
| 127 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 128 <dd> | |
| 129 raised to indicate that this method | |
| 130 must be implemented by a subclass | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <div align="right"><a href="#top">Up</a></div> | |
| 134 <hr /> | |
| 135 </body></html> |
