Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterBase.html
eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterBase.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.QScintilla.Exporters.ExporterBase</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.QScintilla.Exporters.ExporterBase</h1> | |
| 23 <p> | |
| 24 Module implementing the exporter base class. | |
| 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="#ExporterBase">ExporterBase</a></td> | |
| 34 <td>Class implementing the exporter base class.</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="ExporterBase" ID="ExporterBase"></a> | |
| 43 <h2>ExporterBase</h2> | |
| 44 <p> | |
| 45 Class implementing the exporter base class. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 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="#ExporterBase.__init__">ExporterBase</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ExporterBase._getFileName">_getFileName</a></td> | |
| 64 <td>Protected method to get the file name of the export file from the user.</td> | |
| 65 </tr><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 <table> | |
| 72 <tr><td>None</td></tr> | |
| 73 </table> | |
| 74 <a NAME="ExporterBase.__init__" ID="ExporterBase.__init__"></a> | |
| 75 <h4>ExporterBase (Constructor)</h4> | |
| 76 <b>ExporterBase</b>(<i>editor, parent=None</i>) | |
| 77 <p> | |
| 78 Constructor | |
| 79 </p><dl> | |
| 80 <dt><i>editor</i></dt> | |
| 81 <dd> | |
| 82 reference to the editor object (QScintilla.Editor.Editor) | |
| 83 </dd><dt><i>parent</i></dt> | |
| 84 <dd> | |
| 85 parent object of the exporter (QObject) | |
| 86 </dd> | |
| 87 </dl><a NAME="ExporterBase._getFileName" ID="ExporterBase._getFileName"></a> | |
| 88 <h4>ExporterBase._getFileName</h4> | |
| 89 <b>_getFileName</b>(<i>fileFilter</i>) | |
| 90 <p> | |
| 91 Protected method to get the file name of the export file from the user. | |
| 92 </p><dl> | |
| 93 <dt><i>fileFilter</i></dt> | |
| 94 <dd> | |
| 95 the filter string to be used (string). The filter for | |
| 96 "All Files (*)" is appended by this method. | |
| 97 </dd> | |
| 98 </dl><dl> | |
| 99 <dt>Returns:</dt> | |
| 100 <dd> | |
| 101 file name entered by the user (string) | |
| 102 </dd> | |
| 103 </dl><a NAME="ExporterBase.exportSource" ID="ExporterBase.exportSource"></a> | |
| 104 <h4>ExporterBase.exportSource</h4> | |
| 105 <b>exportSource</b>(<i></i>) | |
| 106 <p> | |
| 107 Public method performing the export. | |
| 108 </p><p> | |
| 109 This method must be overridden by the real exporters. | |
| 110 </p><dl> | |
| 111 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 112 <dd> | |
| 113 raised to indicate that this method | |
| 114 must be implemented by a subclass | |
| 115 </dd> | |
| 116 </dl> | |
| 117 <div align="right"><a href="#top">Up</a></div> | |
| 118 <hr /> | |
| 119 </body></html> |
