Documentation/Source/eric5.E5XML.HighlightingStylesReader.html

Mon, 07 Jan 2013 18:05:29 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 07 Jan 2013 18:05:29 +0100
changeset 2320
fe9d876fc9dd
parent 1229
a8207dc73672
child 2367
78f6c8193d37
permissions
-rw-r--r--

Added a context menu entry to reload the templates and changed the logic such, that the templates are only written, if they contain some changes.

603
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <html><head>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <title>eric5.E5XML.HighlightingStylesReader</title>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 <style>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 body {
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 background: #EDECE6;
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 margin: 0em 1em 10em 1em;
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 color: black;
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 }
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h1 { color: white; background: #85774A; }
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h2 { color: white; background: #85774A; }
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h3 { color: white; background: #9D936E; }
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 h4 { color: white; background: #9D936E; }
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 a { color: #BA6D36; }
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </style>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 </head>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <body><a NAME="top" ID="top"></a>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric5.E5XML.HighlightingStylesReader</h1>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Module implementing a class for reading a highlighting styles XML file.
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Global Attributes</h3>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <h3>Classes</h3>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td><a href="#HighlightingStylesReader">HighlightingStylesReader</a></td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <td>Class for reading a highlighting styles XML file.</td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr><td>None</td></tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <hr /><hr />
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <a NAME="HighlightingStylesReader" ID="HighlightingStylesReader"></a>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h2>HighlightingStylesReader</h2>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 Class for reading a highlighting styles XML file.
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <h3>Derived from</h3>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 XMLStreamReaderBase
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h3>Class Attributes</h3>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <tr><td>supportedVersions</td></tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
54 <h3>Class Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
55 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
56 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
57 </table>
603
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <h3>Methods</h3>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <table>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <tr>
1229
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
61 <td><a href="#HighlightingStylesReader.__init__">HighlightingStylesReader</a></td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
62 <td>Constructor</td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
63 </tr><tr>
603
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td><a href="#HighlightingStylesReader.__readLexer">__readLexer</a></td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <td>Private method to read the lexer info.</td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </tr><tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td><a href="#HighlightingStylesReader.__readStyle">__readStyle</a></td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <td>Private method to read the style info.</td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 </tr><tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <td><a href="#HighlightingStylesReader.readXML">readXML</a></td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <td>Public method to read and parse the XML document.</td>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 </tr>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
74 <h3>Static Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
75 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
76 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 603
diff changeset
77 </table>
603
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <a NAME="HighlightingStylesReader.__init__" ID="HighlightingStylesReader.__init__"></a>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <h4>HighlightingStylesReader (Constructor)</h4>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <b>HighlightingStylesReader</b>(<i>device, lexers</i>)
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 Constructor
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </p><dl>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <dt><i>device</i></dt>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <dd>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 reference to the I/O device to read from (QIODevice)
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 </dd><dt><i>lexers</i></dt>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <dd>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 list of lexer objects for which to export the styles
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 </dd>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 </dl><a NAME="HighlightingStylesReader.__readLexer" ID="HighlightingStylesReader.__readLexer"></a>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <h4>HighlightingStylesReader.__readLexer</h4>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <b>__readLexer</b>(<i></i>)
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 Private method to read the lexer info.
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 </p><a NAME="HighlightingStylesReader.__readStyle" ID="HighlightingStylesReader.__readStyle"></a>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <h4>HighlightingStylesReader.__readStyle</h4>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <b>__readStyle</b>(<i>lexer</i>)
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 Private method to read the style info.
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </p><dl>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <dt><i>lexer</i></dt>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <dd>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 reference to the lexer object
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 </dd>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 </dl><a NAME="HighlightingStylesReader.readXML" ID="HighlightingStylesReader.readXML"></a>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <h4>HighlightingStylesReader.readXML</h4>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <b>readXML</b>(<i></i>)
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 Public method to read and parse the XML document.
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 </p>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <div align="right"><a href="#top">Up</a></div>
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <hr />
7f620c649182 Updated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </body></html>

eric ide

mercurial