Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.QScintilla.Exporters.ExporterBase.html
Documentation/Source/eric4.QScintilla.Exporters.ExporterBase.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 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>eric4.QScintilla.Exporters.ExporterBase</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.QScintilla.Exporters.ExporterBase</h1> | |
| 24 <p> | |
| 25 Module implementing the exporter base class. | |
| 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="#ExporterBase">ExporterBase</a></td> | |
| 35 <td>Class implementing the exporter base class.</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="ExporterBase" ID="ExporterBase"></a> | |
| 44 <h2>ExporterBase</h2> | |
| 45 <p> | |
| 46 Class implementing the exporter base class. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QObject | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#ExporterBase.__init__">ExporterBase</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ExporterBase._getFileName">_getFileName</a></td> | |
| 61 <td>Protected method to get the file name of the export file from the user.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ExporterBase.exportSource">exportSource</a></td> | |
| 64 <td>Public method performing the export.</td> | |
| 65 </tr> | |
| 66 </table> | |
| 67 <a NAME="ExporterBase.__init__" ID="ExporterBase.__init__"></a> | |
| 68 <h4>ExporterBase (Constructor)</h4> | |
| 69 <b>ExporterBase</b>(<i>editor, parent = None</i>) | |
| 70 <p> | |
| 71 Constructor | |
| 72 </p><dl> | |
| 73 <dt><i>editor</i></dt> | |
| 74 <dd> | |
| 75 reference to the editor object (QScintilla.Editor.Editor) | |
| 76 </dd><dt><i>parent</i></dt> | |
| 77 <dd> | |
| 78 parent object of the exporter (QObject) | |
| 79 </dd> | |
| 80 </dl><a NAME="ExporterBase._getFileName" ID="ExporterBase._getFileName"></a> | |
| 81 <h4>ExporterBase._getFileName</h4> | |
| 82 <b>_getFileName</b>(<i>filter</i>) | |
| 83 <p> | |
| 84 Protected method to get the file name of the export file from the user. | |
| 85 </p><dl> | |
| 86 <dt><i>filter</i></dt> | |
| 87 <dd> | |
| 88 the filter string to be used (string). The filter for | |
| 89 "All Files (*)" is appended by this method. | |
| 90 </dd> | |
| 91 </dl><a NAME="ExporterBase.exportSource" ID="ExporterBase.exportSource"></a> | |
| 92 <h4>ExporterBase.exportSource</h4> | |
| 93 <b>exportSource</b>(<i></i>) | |
| 94 <p> | |
| 95 Public method performing the export. | |
| 96 </p><p> | |
| 97 This method must be overridden by the real exporters. | |
| 98 </p> | |
| 99 <div align="right"><a href="#top">Up</a></div> | |
| 100 <hr /> | |
| 101 </body></html> |
