Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginSyntaxChecker.html
src/eric7/Documentation/Source/eric7.Plugins.PluginSyntaxChecker.html
- branch
- eric7
- changeset 10341
- 3fdffd9cc21d
- parent 10259
- b51dfacef37f
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10340:548b4c7f410e | 10341:3fdffd9cc21d |
|---|---|
| 124 <p> | 124 <p> |
| 125 Constructor | 125 Constructor |
| 126 </p> | 126 </p> |
| 127 <dl> | 127 <dl> |
| 128 | 128 |
| 129 <dt><i>ui</i></dt> | 129 <dt><i>ui</i> (UI.UserInterface)</dt> |
| 130 <dd> | 130 <dd> |
| 131 reference to the user interface object (UI.UserInterface) | 131 reference to the user interface object |
| 132 </dd> | 132 </dd> |
| 133 </dl> | 133 </dl> |
| 134 <a NAME="SyntaxCheckerPlugin.__editorClosed" ID="SyntaxCheckerPlugin.__editorClosed"></a> | 134 <a NAME="SyntaxCheckerPlugin.__editorClosed" ID="SyntaxCheckerPlugin.__editorClosed"></a> |
| 135 <h4>SyntaxCheckerPlugin.__editorClosed</h4> | 135 <h4>SyntaxCheckerPlugin.__editorClosed</h4> |
| 136 <b>__editorClosed</b>(<i>editor</i>) | 136 <b>__editorClosed</b>(<i>editor</i>) |
| 138 <p> | 138 <p> |
| 139 Private slot called, when an editor was closed. | 139 Private slot called, when an editor was closed. |
| 140 </p> | 140 </p> |
| 141 <dl> | 141 <dl> |
| 142 | 142 |
| 143 <dt><i>editor</i></dt> | 143 <dt><i>editor</i> (QScintilla.Editor)</dt> |
| 144 <dd> | 144 <dd> |
| 145 reference to the editor (QScintilla.Editor) | 145 reference to the editor |
| 146 </dd> | 146 </dd> |
| 147 </dl> | 147 </dl> |
| 148 <a NAME="SyntaxCheckerPlugin.__editorOpened" ID="SyntaxCheckerPlugin.__editorOpened"></a> | 148 <a NAME="SyntaxCheckerPlugin.__editorOpened" ID="SyntaxCheckerPlugin.__editorOpened"></a> |
| 149 <h4>SyntaxCheckerPlugin.__editorOpened</h4> | 149 <h4>SyntaxCheckerPlugin.__editorOpened</h4> |
| 150 <b>__editorOpened</b>(<i>editor</i>) | 150 <b>__editorOpened</b>(<i>editor</i>) |
| 152 <p> | 152 <p> |
| 153 Private slot called, when a new editor was opened. | 153 Private slot called, when a new editor was opened. |
| 154 </p> | 154 </p> |
| 155 <dl> | 155 <dl> |
| 156 | 156 |
| 157 <dt><i>editor</i></dt> | 157 <dt><i>editor</i> (QScintilla.Editor)</dt> |
| 158 <dd> | 158 <dd> |
| 159 reference to the new editor (QScintilla.Editor) | 159 reference to the new editor |
| 160 </dd> | 160 </dd> |
| 161 </dl> | 161 </dl> |
| 162 <a NAME="SyntaxCheckerPlugin.__editorShowMenu" ID="SyntaxCheckerPlugin.__editorShowMenu"></a> | 162 <a NAME="SyntaxCheckerPlugin.__editorShowMenu" ID="SyntaxCheckerPlugin.__editorShowMenu"></a> |
| 163 <h4>SyntaxCheckerPlugin.__editorShowMenu</h4> | 163 <h4>SyntaxCheckerPlugin.__editorShowMenu</h4> |
| 164 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) | 164 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) |
| 167 Private slot called, when the the editor context menu or a submenu is | 167 Private slot called, when the the editor context menu or a submenu is |
| 168 about to be shown. | 168 about to be shown. |
| 169 </p> | 169 </p> |
| 170 <dl> | 170 <dl> |
| 171 | 171 |
| 172 <dt><i>menuName</i></dt> | 172 <dt><i>menuName</i> (str)</dt> |
| 173 <dd> | 173 <dd> |
| 174 name of the menu to be shown (string) | 174 name of the menu to be shown |
| 175 </dd> | 175 </dd> |
| 176 <dt><i>menu</i></dt> | 176 <dt><i>menu</i> (QMenu)</dt> |
| 177 <dd> | 177 <dd> |
| 178 reference to the menu (QMenu) | 178 reference to the menu |
| 179 </dd> | 179 </dd> |
| 180 <dt><i>editor</i></dt> | 180 <dt><i>editor</i> (QScintilla.Editor)</dt> |
| 181 <dd> | 181 <dd> |
| 182 reference to the editor | 182 reference to the editor |
| 183 </dd> | 183 </dd> |
| 184 </dl> | 184 </dl> |
| 185 <a NAME="SyntaxCheckerPlugin.__editorSyntaxCheck" ID="SyntaxCheckerPlugin.__editorSyntaxCheck"></a> | 185 <a NAME="SyntaxCheckerPlugin.__editorSyntaxCheck" ID="SyntaxCheckerPlugin.__editorSyntaxCheck"></a> |
| 225 Private slot called, when the the project browser menu or a submenu is | 225 Private slot called, when the the project browser menu or a submenu is |
| 226 about to be shown. | 226 about to be shown. |
| 227 </p> | 227 </p> |
| 228 <dl> | 228 <dl> |
| 229 | 229 |
| 230 <dt><i>menuName</i></dt> | 230 <dt><i>menuName</i> (str)</dt> |
| 231 <dd> | 231 <dd> |
| 232 name of the menu to be shown (string) | 232 name of the menu to be shown |
| 233 </dd> | 233 </dd> |
| 234 <dt><i>menu</i></dt> | 234 <dt><i>menu</i> (QMenu)</dt> |
| 235 <dd> | 235 <dd> |
| 236 reference to the menu (QMenu) | 236 reference to the menu |
| 237 </dd> | 237 </dd> |
| 238 </dl> | 238 </dl> |
| 239 <a NAME="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck" ID="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck"></a> | 239 <a NAME="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck" ID="SyntaxCheckerPlugin.__projectBrowserSyntaxCheck"></a> |
| 240 <h4>SyntaxCheckerPlugin.__projectBrowserSyntaxCheck</h4> | 240 <h4>SyntaxCheckerPlugin.__projectBrowserSyntaxCheck</h4> |
| 241 <b>__projectBrowserSyntaxCheck</b>(<i></i>) | 241 <b>__projectBrowserSyntaxCheck</b>(<i></i>) |
| 252 Private slot called, when the the project menu or a submenu is | 252 Private slot called, when the the project menu or a submenu is |
| 253 about to be shown. | 253 about to be shown. |
| 254 </p> | 254 </p> |
| 255 <dl> | 255 <dl> |
| 256 | 256 |
| 257 <dt><i>menuName</i></dt> | 257 <dt><i>menuName</i> (str)</dt> |
| 258 <dd> | 258 <dd> |
| 259 name of the menu to be shown (string) | 259 name of the menu to be shown |
| 260 </dd> | 260 </dd> |
| 261 <dt><i>menu</i></dt> | 261 <dt><i>menu</i> (QMenu)</dt> |
| 262 <dd> | 262 <dd> |
| 263 reference to the menu (QMenu) | 263 reference to the menu |
| 264 </dd> | 264 </dd> |
| 265 </dl> | 265 </dl> |
| 266 <a NAME="SyntaxCheckerPlugin.__projectSyntaxCheck" ID="SyntaxCheckerPlugin.__projectSyntaxCheck"></a> | 266 <a NAME="SyntaxCheckerPlugin.__projectSyntaxCheck" ID="SyntaxCheckerPlugin.__projectSyntaxCheck"></a> |
| 267 <h4>SyntaxCheckerPlugin.__projectSyntaxCheck</h4> | 267 <h4>SyntaxCheckerPlugin.__projectSyntaxCheck</h4> |
| 268 <b>__projectSyntaxCheck</b>(<i></i>) | 268 <b>__projectSyntaxCheck</b>(<i></i>) |
| 282 the warnings (marker, file name, line number, message) | 282 the warnings (marker, file name, line number, message) |
| 283 The values are only valid, if nok is False. | 283 The values are only valid, if nok is False. |
| 284 </p> | 284 </p> |
| 285 <dl> | 285 <dl> |
| 286 | 286 |
| 287 <dt><i>fn</i></dt> | 287 <dt><i>fn</i> (str)</dt> |
| 288 <dd> | 288 <dd> |
| 289 filename of the checked file (str) | 289 filename of the checked file |
| 290 </dd> | 290 </dd> |
| 291 <dt><i>problems</i></dt> | 291 <dt><i>problems</i> (list of dict)</dt> |
| 292 <dd> | 292 <dd> |
| 293 dictionary with the keys 'error' and 'warnings' which | 293 list of dictionaries with the keys 'error', 'py_warnings' and |
| 294 hold a list containing details about the error/ warnings | 294 'warnings' which contain a tuple with details about the syntax error or a |
| 295 (file name, line number, column, codestring (only at syntax | 295 list of tuples with details about Python warnings and PyFlakes warnings. |
| 296 errors), the message, a list with arguments for the message) | 296 Each tuple contains the file name, line number, column, code string (only |
| 297 for syntax errors), the message and an optional list with arguments for | |
| 298 the message. | |
| 297 </dd> | 299 </dd> |
| 298 </dl> | 300 </dl> |
| 299 <a NAME="SyntaxCheckerPlugin.activate" ID="SyntaxCheckerPlugin.activate"></a> | 301 <a NAME="SyntaxCheckerPlugin.activate" ID="SyntaxCheckerPlugin.activate"></a> |
| 300 <h4>SyntaxCheckerPlugin.activate</h4> | 302 <h4>SyntaxCheckerPlugin.activate</h4> |
| 301 <b>activate</b>(<i></i>) | 303 <b>activate</b>(<i></i>) |
| 304 Public method to activate this plugin. | 306 Public method to activate this plugin. |
| 305 </p> | 307 </p> |
| 306 <dl> | 308 <dl> |
| 307 <dt>Return:</dt> | 309 <dt>Return:</dt> |
| 308 <dd> | 310 <dd> |
| 309 tuple of None and activation status (boolean) | 311 tuple of None and activation status |
| 312 </dd> | |
| 313 </dl> | |
| 314 <dl> | |
| 315 <dt>Return Type:</dt> | |
| 316 <dd> | |
| 317 bool | |
| 310 </dd> | 318 </dd> |
| 311 </dl> | 319 </dl> |
| 312 <a NAME="SyntaxCheckerPlugin.deactivate" ID="SyntaxCheckerPlugin.deactivate"></a> | 320 <a NAME="SyntaxCheckerPlugin.deactivate" ID="SyntaxCheckerPlugin.deactivate"></a> |
| 313 <h4>SyntaxCheckerPlugin.deactivate</h4> | 321 <h4>SyntaxCheckerPlugin.deactivate</h4> |
| 314 <b>deactivate</b>(<i></i>) | 322 <b>deactivate</b>(<i></i>) |
