src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterODT.html

Fri, 27 Oct 2023 14:09:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 27 Oct 2023 14:09:40 +0200
branch
eric7
changeset 10259
b51dfacef37f
parent 9503
ae9232bf4854
child 10431
64157aeb0312
permissions
-rw-r--r--

Regenerated the source documentation with the corrected module parser.

8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.QScintilla.Exporters.ExporterODT</title>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
8596
d64760b2da50 Documentation Generator: streamlined the code to use an external style sheet file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8372
diff changeset
5 <link rel="stylesheet" href="styles.css">
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <a NAME="top" ID="top"></a>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <h1>eric7.QScintilla.Exporters.ExporterODT</h1>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 <p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 Module implementing an exporter for ODT.
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 </p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Global Attributes</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 <tr><td>None</td></tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <h3>Classes</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <td><a href="#ExporterODT">ExporterODT</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <td>Class implementing an exporter for ODT.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Functions</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
9503
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
31
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
32 <tr>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
33 <td><a href="#createExporter">createExporter</a></td>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
34 <td>Function to instantiate an exporter object.</td>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
35 </tr>
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <hr />
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <hr />
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <a NAME="ExporterODT" ID="ExporterODT"></a>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <h2>ExporterODT</h2>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 Class implementing an exporter for ODT.
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 </p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <h3>Derived from</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 ExporterBase
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Class Attributes</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <tr><td>None</td></tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <h3>Class Methods</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <tr><td>None</td></tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <td><a href="#ExporterODT.__init__">ExporterODT</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td>Constructor</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#ExporterODT.exportSource">exportSource</a></td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td>Public method performing the export.</td>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <h3>Static Methods</h3>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <tr><td>None</td></tr>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 </table>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <a NAME="ExporterODT.__init__" ID="ExporterODT.__init__"></a>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <h4>ExporterODT (Constructor)</h4>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <b>ExporterODT</b>(<i>editor, parent=None</i>)
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 Constructor
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 </p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dl>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <dt><i>editor</i></dt>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <dd>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 reference to the editor object (QScintilla.Editor.Editor)
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 </dd>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <dt><i>parent</i></dt>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <dd>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 parent object of the exporter (QObject)
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 </dd>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </dl>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <a NAME="ExporterODT.exportSource" ID="ExporterODT.exportSource"></a>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <h4>ExporterODT.exportSource</h4>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <b>exportSource</b>(<i></i>)
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 Public method performing the export.
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 </p>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <div align="right"><a href="#top">Up</a></div>
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <hr />
9503
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
103 <hr />
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
104 <a NAME="createExporter" ID="createExporter"></a>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
105 <h2>createExporter</h2>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
106 <b>createExporter</b>(<i>editor, parent=None</i>)
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
107
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
108 <p>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
109 Function to instantiate an exporter object.
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
110 </p>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
111 <dl>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
112
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
113 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
114 <dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
115 reference to the editor object
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
116 </dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
117 <dt><i>parent</i> (QObject (optional))</dt>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
118 <dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
119 parent object of the exporter (defaults to None)
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
120 </dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
121 </dl>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
122 <dl>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
123 <dt>Return:</dt>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
124 <dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
125 exporter object
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
126 </dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
127 </dl>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
128 <dl>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
129 <dt>Return Type:</dt>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
130 <dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
131 ExporterODT
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
132 </dd>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
133 </dl>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
134 <div align="right"><a href="#top">Up</a></div>
ae9232bf4854 Regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
135 <hr />
8372
e0227a7c850e Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 </body></html>

eric ide

mercurial