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