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