Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.PluginPep8Checker.html
Documentation/Source/eric5.Plugins.PluginPep8Checker.html
- changeset 832
- eb5ff61f927b
- child 945
- 8cd4d08fa9f6
- child 1278
- fb0460fd00b9
equal
deleted
inserted
replaced
| 831:f046b97785db | 832:eb5ff61f927b |
|---|---|
| 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>eric5.Plugins.PluginPep8Checker</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Plugins.PluginPep8Checker</h1> | |
| 24 <p> | |
| 25 Module implementing the PEP 8 Checker plugin. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 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> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#Pep8CheckerPlugin">Pep8CheckerPlugin</a></td> | |
| 35 <td>Class implementing the PEP 8 Checker plugin.</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="Pep8CheckerPlugin" ID="Pep8CheckerPlugin"></a> | |
| 44 <h2>Pep8CheckerPlugin</h2> | |
| 45 <p> | |
| 46 Class implementing the PEP 8 Checker plugin. | |
| 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="#Pep8CheckerPlugin.__init__">Pep8CheckerPlugin</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#Pep8CheckerPlugin.__editorClosed">__editorClosed</a></td> | |
| 61 <td>Private slot called, when an editor was closed.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#Pep8CheckerPlugin.__editorOpened">__editorOpened</a></td> | |
| 64 <td>Private slot called, when a new editor was opened.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#Pep8CheckerPlugin.__editorPep8Check">__editorPep8Check</a></td> | |
| 67 <td>Private slot to handle the PEP 8 check context menu action of the editors.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#Pep8CheckerPlugin.__editorShowMenu">__editorShowMenu</a></td> | |
| 70 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#Pep8CheckerPlugin.__initialize">__initialize</a></td> | |
| 73 <td>Private slot to (re)initialize the plugin.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#Pep8CheckerPlugin.__projectBrowserPep8Check">__projectBrowserPep8Check</a></td> | |
| 76 <td>Private method to handle the PEP 8 check context menu action of the project sources browser.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#Pep8CheckerPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> | |
| 79 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#Pep8CheckerPlugin.__projectPep8Check">__projectPep8Check</a></td> | |
| 82 <td>Public slot used to check the project files for PEP 8 compliance.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#Pep8CheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> | |
| 85 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#Pep8CheckerPlugin.activate">activate</a></td> | |
| 88 <td>Public method to activate this plugin.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#Pep8CheckerPlugin.deactivate">deactivate</a></td> | |
| 91 <td>Public method to deactivate this plugin.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <a NAME="Pep8CheckerPlugin.__init__" ID="Pep8CheckerPlugin.__init__"></a> | |
| 95 <h4>Pep8CheckerPlugin (Constructor)</h4> | |
| 96 <b>Pep8CheckerPlugin</b>(<i>ui</i>) | |
| 97 <p> | |
| 98 Constructor | |
| 99 </p><dl> | |
| 100 <dt><i>ui</i></dt> | |
| 101 <dd> | |
| 102 reference to the user interface object (UI.UserInterface) | |
| 103 </dd> | |
| 104 </dl><a NAME="Pep8CheckerPlugin.__editorClosed" ID="Pep8CheckerPlugin.__editorClosed"></a> | |
| 105 <h4>Pep8CheckerPlugin.__editorClosed</h4> | |
| 106 <b>__editorClosed</b>(<i>editor</i>) | |
| 107 <p> | |
| 108 Private slot called, when an editor was closed. | |
| 109 </p><dl> | |
| 110 <dt><i>editor</i></dt> | |
| 111 <dd> | |
| 112 reference to the editor (QScintilla.Editor) | |
| 113 </dd> | |
| 114 </dl><a NAME="Pep8CheckerPlugin.__editorOpened" ID="Pep8CheckerPlugin.__editorOpened"></a> | |
| 115 <h4>Pep8CheckerPlugin.__editorOpened</h4> | |
| 116 <b>__editorOpened</b>(<i>editor</i>) | |
| 117 <p> | |
| 118 Private slot called, when a new editor was opened. | |
| 119 </p><dl> | |
| 120 <dt><i>editor</i></dt> | |
| 121 <dd> | |
| 122 reference to the new editor (QScintilla.Editor) | |
| 123 </dd> | |
| 124 </dl><a NAME="Pep8CheckerPlugin.__editorPep8Check" ID="Pep8CheckerPlugin.__editorPep8Check"></a> | |
| 125 <h4>Pep8CheckerPlugin.__editorPep8Check</h4> | |
| 126 <b>__editorPep8Check</b>(<i></i>) | |
| 127 <p> | |
| 128 Private slot to handle the PEP 8 check context menu action | |
| 129 of the editors. | |
| 130 </p><a NAME="Pep8CheckerPlugin.__editorShowMenu" ID="Pep8CheckerPlugin.__editorShowMenu"></a> | |
| 131 <h4>Pep8CheckerPlugin.__editorShowMenu</h4> | |
| 132 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) | |
| 133 <p> | |
| 134 Private slot called, when the the editor context menu or a submenu is | |
| 135 about to be shown. | |
| 136 </p><dl> | |
| 137 <dt><i>menuName</i></dt> | |
| 138 <dd> | |
| 139 name of the menu to be shown (string) | |
| 140 </dd><dt><i>menu</i></dt> | |
| 141 <dd> | |
| 142 reference to the menu (QMenu) | |
| 143 </dd><dt><i>editor</i></dt> | |
| 144 <dd> | |
| 145 reference to the editor | |
| 146 </dd> | |
| 147 </dl><a NAME="Pep8CheckerPlugin.__initialize" ID="Pep8CheckerPlugin.__initialize"></a> | |
| 148 <h4>Pep8CheckerPlugin.__initialize</h4> | |
| 149 <b>__initialize</b>(<i></i>) | |
| 150 <p> | |
| 151 Private slot to (re)initialize the plugin. | |
| 152 </p><a NAME="Pep8CheckerPlugin.__projectBrowserPep8Check" ID="Pep8CheckerPlugin.__projectBrowserPep8Check"></a> | |
| 153 <h4>Pep8CheckerPlugin.__projectBrowserPep8Check</h4> | |
| 154 <b>__projectBrowserPep8Check</b>(<i></i>) | |
| 155 <p> | |
| 156 Private method to handle the PEP 8 check context menu action of | |
| 157 the project sources browser. | |
| 158 </p><a NAME="Pep8CheckerPlugin.__projectBrowserShowMenu" ID="Pep8CheckerPlugin.__projectBrowserShowMenu"></a> | |
| 159 <h4>Pep8CheckerPlugin.__projectBrowserShowMenu</h4> | |
| 160 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) | |
| 161 <p> | |
| 162 Private slot called, when the the project browser menu or a submenu is | |
| 163 about to be shown. | |
| 164 </p><dl> | |
| 165 <dt><i>menuName</i></dt> | |
| 166 <dd> | |
| 167 name of the menu to be shown (string) | |
| 168 </dd><dt><i>menu</i></dt> | |
| 169 <dd> | |
| 170 reference to the menu (QMenu) | |
| 171 </dd> | |
| 172 </dl><a NAME="Pep8CheckerPlugin.__projectPep8Check" ID="Pep8CheckerPlugin.__projectPep8Check"></a> | |
| 173 <h4>Pep8CheckerPlugin.__projectPep8Check</h4> | |
| 174 <b>__projectPep8Check</b>(<i></i>) | |
| 175 <p> | |
| 176 Public slot used to check the project files for PEP 8 compliance. | |
| 177 </p><a NAME="Pep8CheckerPlugin.__projectShowMenu" ID="Pep8CheckerPlugin.__projectShowMenu"></a> | |
| 178 <h4>Pep8CheckerPlugin.__projectShowMenu</h4> | |
| 179 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | |
| 180 <p> | |
| 181 Private slot called, when the the project menu or a submenu is | |
| 182 about to be shown. | |
| 183 </p><dl> | |
| 184 <dt><i>menuName</i></dt> | |
| 185 <dd> | |
| 186 name of the menu to be shown (string) | |
| 187 </dd><dt><i>menu</i></dt> | |
| 188 <dd> | |
| 189 reference to the menu (QMenu) | |
| 190 </dd> | |
| 191 </dl><a NAME="Pep8CheckerPlugin.activate" ID="Pep8CheckerPlugin.activate"></a> | |
| 192 <h4>Pep8CheckerPlugin.activate</h4> | |
| 193 <b>activate</b>(<i></i>) | |
| 194 <p> | |
| 195 Public method to activate this plugin. | |
| 196 </p><dl> | |
| 197 <dt>Returns:</dt> | |
| 198 <dd> | |
| 199 tuple of None and activation status (boolean) | |
| 200 </dd> | |
| 201 </dl><a NAME="Pep8CheckerPlugin.deactivate" ID="Pep8CheckerPlugin.deactivate"></a> | |
| 202 <h4>Pep8CheckerPlugin.deactivate</h4> | |
| 203 <b>deactivate</b>(<i></i>) | |
| 204 <p> | |
| 205 Public method to deactivate this plugin. | |
| 206 </p> | |
| 207 <div align="right"><a href="#top">Up</a></div> | |
| 208 <hr /> | |
| 209 </body></html> |
