Documentation/Source/eric5.Plugins.PluginSyntaxChecker.html

Fri, 11 Mar 2011 16:51:57 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 11 Mar 2011 16:51:57 +0100
changeset 945
8cd4d08fa9f6
parent 832
eb5ff61f927b
child 1228
7afaf2fca55b
permissions
-rw-r--r--

Made code mostly PEP 8 compliant (except all whitespace and line length).

17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <html><head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <title>eric5.Plugins.PluginSyntaxChecker</title>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 <style>
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
7 body {
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
8 background: #EDECE6;
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
9 margin: 0em 1em 10em 1em;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
10 color: black;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
11 }
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
12
409
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
13 h1 { color: white; background: #85774A; }
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
14 h2 { color: white; background: #85774A; }
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
15 h3 { color: white; background: #9D936E; }
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
16 h4 { color: white; background: #9D936E; }
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
17
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
18 a { color: #BA6D36; }
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
19
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </style>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 </head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <body><a NAME="top" ID="top"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric5.Plugins.PluginSyntaxChecker</h1>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
832
eb5ff61f927b Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
25 Module implementing the Syntax Checker plugin.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Global Attributes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <h3>Classes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td><a href="#SyntaxCheckerPlugin">SyntaxCheckerPlugin</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
35 <td>Class implementing the Syntax Checker plugin.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr><td>None</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <hr /><hr />
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <a NAME="SyntaxCheckerPlugin" ID="SyntaxCheckerPlugin"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h2>SyntaxCheckerPlugin</h2>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
46 Class implementing the Syntax Checker plugin.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <h3>Derived from</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 QObject
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h3>Class Attributes</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <tr><td>None</td></tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <h3>Methods</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="#SyntaxCheckerPlugin.__init__">SyntaxCheckerPlugin</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
58 <td>Constructor</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="#SyntaxCheckerPlugin.__editorClosed">__editorClosed</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
61 <td>Private slot called, when an editor was closed.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#SyntaxCheckerPlugin.__editorOpened">__editorOpened</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
64 <td>Private slot called, when a new editor was opened.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#SyntaxCheckerPlugin.__editorShowMenu">__editorShowMenu</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
67 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td><a href="#SyntaxCheckerPlugin.__editorSyntaxCheck">__editorSyntaxCheck</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
70 <td>Private slot to handle the syntax check context menu action of the editors.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="#SyntaxCheckerPlugin.__initialize">__initialize</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
73 <td>Private slot to (re)initialize the plugin.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="#SyntaxCheckerPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
76 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <td><a href="#SyntaxCheckerPlugin.__projectBrowserSyntaxCheck">__projectBrowserSyntaxCheck</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
79 <td>Private method to handle the syntax check context menu action of the project sources browser.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <td><a href="#SyntaxCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
82 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <td><a href="#SyntaxCheckerPlugin.__projectSyntaxCheck">__projectSyntaxCheck</a></td>
832
eb5ff61f927b Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
85 <td>Public slot used to check the project files for syntax errors.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <td><a href="#SyntaxCheckerPlugin.activate">activate</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
88 <td>Public method to activate this plugin.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <td><a href="#SyntaxCheckerPlugin.deactivate">deactivate</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
91 <td>Public method to deactivate this plugin.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <a NAME="SyntaxCheckerPlugin.__init__" ID="SyntaxCheckerPlugin.__init__"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <h4>SyntaxCheckerPlugin (Constructor)</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <b>SyntaxCheckerPlugin</b>(<i>ui</i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
98 Constructor
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dt><i>ui</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
102 reference to the user interface object (UI.UserInterface)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 </dl><a NAME="SyntaxCheckerPlugin.__editorClosed" ID="SyntaxCheckerPlugin.__editorClosed"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <h4>SyntaxCheckerPlugin.__editorClosed</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <b>__editorClosed</b>(<i>editor</i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
108 Private slot called, when an editor was closed.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <dt><i>editor</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
112 reference to the editor (QScintilla.Editor)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </dl><a NAME="SyntaxCheckerPlugin.__editorOpened" ID="SyntaxCheckerPlugin.__editorOpened"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <h4>SyntaxCheckerPlugin.__editorOpened</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <b>__editorOpened</b>(<i>editor</i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
118 Private slot called, when a new editor was opened.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <dt><i>editor</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
122 reference to the new editor (QScintilla.Editor)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </dl><a NAME="SyntaxCheckerPlugin.__editorShowMenu" ID="SyntaxCheckerPlugin.__editorShowMenu"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 <h4>SyntaxCheckerPlugin.__editorShowMenu</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <p>
945
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 832
diff changeset
128 Private slot called, when the the editor context menu or a submenu is
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
129 about to be shown.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 <dt><i>menuName</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
133 name of the menu to be shown (string)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 </dd><dt><i>menu</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
136 reference to the menu (QMenu)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 </dd><dt><i>editor</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
139 reference to the editor
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 </dl><a NAME="SyntaxCheckerPlugin.__editorSyntaxCheck" ID="SyntaxCheckerPlugin.__editorSyntaxCheck"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 <h4>SyntaxCheckerPlugin.__editorSyntaxCheck</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 <b>__editorSyntaxCheck</b>(<i></i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
145 Private slot to handle the syntax check context menu action of the editors.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 </p><a NAME="SyntaxCheckerPlugin.__initialize" ID="SyntaxCheckerPlugin.__initialize"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 <h4>SyntaxCheckerPlugin.__initialize</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 <b>__initialize</b>(<i></i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
150 Private slot to (re)initialize the plugin.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 </p><a NAME="SyntaxCheckerPlugin.__projectBrowserShowMenu" ID="SyntaxCheckerPlugin.__projectBrowserShowMenu"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 <h4>SyntaxCheckerPlugin.__projectBrowserShowMenu</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 <p>
945
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 832
diff changeset
155 Private slot called, when the the project browser menu or a submenu is
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
156 about to be shown.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
157 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 <dt><i>menuName</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
160 name of the menu to be shown (string)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
161 </dd><dt><i>menu</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
163 reference to the menu (QMenu)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 </dl><a NAME="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck" ID="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 <h4>SyntaxCheckerPlugin.__projectBrowserSyntaxCheck</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 <b>__projectBrowserSyntaxCheck</b>(<i></i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
169 Private method to handle the syntax check context menu action of the project
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
170 sources browser.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 </p><a NAME="SyntaxCheckerPlugin.__projectShowMenu" ID="SyntaxCheckerPlugin.__projectShowMenu"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 <h4>SyntaxCheckerPlugin.__projectShowMenu</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174 <p>
945
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 832
diff changeset
175 Private slot called, when the the project menu or a submenu is
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
176 about to be shown.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
177 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
178 <dt><i>menuName</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
180 name of the menu to be shown (string)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
181 </dd><dt><i>menu</i></dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
182 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
183 reference to the menu (QMenu)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
185 </dl><a NAME="SyntaxCheckerPlugin.__projectSyntaxCheck" ID="SyntaxCheckerPlugin.__projectSyntaxCheck"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
186 <h4>SyntaxCheckerPlugin.__projectSyntaxCheck</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
187 <b>__projectSyntaxCheck</b>(<i></i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
188 <p>
832
eb5ff61f927b Added a checker for PEP 8 compliance.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
189 Public slot used to check the project files for syntax errors.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
190 </p><a NAME="SyntaxCheckerPlugin.activate" ID="SyntaxCheckerPlugin.activate"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 <h4>SyntaxCheckerPlugin.activate</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192 <b>activate</b>(<i></i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
193 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
194 Public method to activate this plugin.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195 </p><dl>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 <dt>Returns:</dt>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
197 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
198 tuple of None and activation status (boolean)
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199 </dd>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
200 </dl><a NAME="SyntaxCheckerPlugin.deactivate" ID="SyntaxCheckerPlugin.deactivate"></a>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
201 <h4>SyntaxCheckerPlugin.deactivate</h4>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
202 <b>deactivate</b>(<i></i>)
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
203 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
204 Public method to deactivate this plugin.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
205 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
206 <div align="right"><a href="#top">Up</a></div>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 <hr />
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
208 </body></html>

eric ide

mercurial