Mercurial Repositories > Pyright Checker / file comparison
comparison: PyrightChecker/Documentation/Source/Plugin_Checker_Pyright.PluginPyright.html
PyrightChecker/Documentation/Source/Plugin_Checker_Pyright.PluginPyright.html
- changeset 1
- 191e9ec72893
- child 3
- 109b8e5513d8
equal
deleted
inserted
replaced
| 0:1b1bf094c013 | 1:191e9ec72893 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Checker_Pyright.PluginPyright</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Checker_Pyright.PluginPyright</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the pyright plug-in. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>__header__</td></tr><tr><td>error</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#PyrightPlugin">PyrightPlugin</a></td> | |
| 25 <td>Class documentation goes here.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#installDependencies">installDependencies</a></td> | |
| 34 <td>Function to install dependencies of this plug-in.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 38 <td>Module function to prepare for an uninstallation.</td> | |
| 39 </tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="PyrightPlugin" ID="PyrightPlugin"></a> | |
| 44 <h2>PyrightPlugin</h2> | |
| 45 | |
| 46 <p> | |
| 47 Class documentation goes here. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QObject | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>PreferencesKey</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#PyrightPlugin.__init__">PyrightPlugin</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PyrightPlugin.__editorClosed">__editorClosed</a></td> | |
| 71 <td>Private slot called, when an editor was closed.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PyrightPlugin.__editorOpened">__editorOpened</a></td> | |
| 75 <td>Private slot called, when a new editor was opened.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PyrightPlugin.__editorPyrightCheck">__editorPyrightCheck</a></td> | |
| 79 <td>Private slot to handle the code style check context menu action of the editors.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PyrightPlugin.__editorShowMenu">__editorShowMenu</a></td> | |
| 83 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PyrightPlugin.__initialize">__initialize</a></td> | |
| 87 <td>Private slot to (re)initialize the plug-in.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PyrightPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 91 <td>Private method to load the translation file.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PyrightPlugin.__projectBrowserPyrightCheck">__projectBrowserPyrightCheck</a></td> | |
| 95 <td>Private method to handle the static typing check context menu action of the project sources browser.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PyrightPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> | |
| 99 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PyrightPlugin.__projectPyrightCheck">__projectPyrightCheck</a></td> | |
| 103 <td>Private slot used to check the project for static typing issues.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PyrightPlugin.__projectShowMenu">__projectShowMenu</a></td> | |
| 107 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PyrightPlugin.activate">activate</a></td> | |
| 111 <td>Public method to activate this plug-in.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PyrightPlugin.deactivate">deactivate</a></td> | |
| 115 <td>Public method to deactivate this plug-in.</td> | |
| 116 </tr> | |
| 117 </table> | |
| 118 <h3>Static Methods</h3> | |
| 119 | |
| 120 <table> | |
| 121 <tr><td>None</td></tr> | |
| 122 </table> | |
| 123 | |
| 124 <a NAME="PyrightPlugin.__init__" ID="PyrightPlugin.__init__"></a> | |
| 125 <h4>PyrightPlugin (Constructor)</h4> | |
| 126 <b>PyrightPlugin</b>(<i>ui</i>) | |
| 127 | |
| 128 <p> | |
| 129 Constructor | |
| 130 </p> | |
| 131 <dl> | |
| 132 | |
| 133 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 134 <dd> | |
| 135 reference to the user interface object | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <a NAME="PyrightPlugin.__editorClosed" ID="PyrightPlugin.__editorClosed"></a> | |
| 139 <h4>PyrightPlugin.__editorClosed</h4> | |
| 140 <b>__editorClosed</b>(<i>editor</i>) | |
| 141 | |
| 142 <p> | |
| 143 Private slot called, when an editor was closed. | |
| 144 </p> | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 148 <dd> | |
| 149 reference to the editor | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="PyrightPlugin.__editorOpened" ID="PyrightPlugin.__editorOpened"></a> | |
| 153 <h4>PyrightPlugin.__editorOpened</h4> | |
| 154 <b>__editorOpened</b>(<i>editor</i>) | |
| 155 | |
| 156 <p> | |
| 157 Private slot called, when a new editor was opened. | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 162 <dd> | |
| 163 reference to the new editor | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="PyrightPlugin.__editorPyrightCheck" ID="PyrightPlugin.__editorPyrightCheck"></a> | |
| 167 <h4>PyrightPlugin.__editorPyrightCheck</h4> | |
| 168 <b>__editorPyrightCheck</b>(<i></i>) | |
| 169 | |
| 170 <p> | |
| 171 Private slot to handle the code style check context menu action | |
| 172 of the editors. | |
| 173 </p> | |
| 174 <a NAME="PyrightPlugin.__editorShowMenu" ID="PyrightPlugin.__editorShowMenu"></a> | |
| 175 <h4>PyrightPlugin.__editorShowMenu</h4> | |
| 176 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) | |
| 177 | |
| 178 <p> | |
| 179 Private slot called, when the the editor context menu or a submenu is | |
| 180 about to be shown. | |
| 181 </p> | |
| 182 <dl> | |
| 183 | |
| 184 <dt><i>menuName</i> (str)</dt> | |
| 185 <dd> | |
| 186 name of the menu to be shown | |
| 187 </dd> | |
| 188 <dt><i>menu</i> (QMenu)</dt> | |
| 189 <dd> | |
| 190 reference to the menu | |
| 191 </dd> | |
| 192 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 193 <dd> | |
| 194 reference to the editor | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <a NAME="PyrightPlugin.__initialize" ID="PyrightPlugin.__initialize"></a> | |
| 198 <h4>PyrightPlugin.__initialize</h4> | |
| 199 <b>__initialize</b>(<i></i>) | |
| 200 | |
| 201 <p> | |
| 202 Private slot to (re)initialize the plug-in. | |
| 203 </p> | |
| 204 <a NAME="PyrightPlugin.__loadTranslator" ID="PyrightPlugin.__loadTranslator"></a> | |
| 205 <h4>PyrightPlugin.__loadTranslator</h4> | |
| 206 <b>__loadTranslator</b>(<i></i>) | |
| 207 | |
| 208 <p> | |
| 209 Private method to load the translation file. | |
| 210 </p> | |
| 211 <a NAME="PyrightPlugin.__projectBrowserPyrightCheck" ID="PyrightPlugin.__projectBrowserPyrightCheck"></a> | |
| 212 <h4>PyrightPlugin.__projectBrowserPyrightCheck</h4> | |
| 213 <b>__projectBrowserPyrightCheck</b>(<i></i>) | |
| 214 | |
| 215 <p> | |
| 216 Private method to handle the static typing check context menu action of | |
| 217 the project sources browser. | |
| 218 </p> | |
| 219 <a NAME="PyrightPlugin.__projectBrowserShowMenu" ID="PyrightPlugin.__projectBrowserShowMenu"></a> | |
| 220 <h4>PyrightPlugin.__projectBrowserShowMenu</h4> | |
| 221 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) | |
| 222 | |
| 223 <p> | |
| 224 Private slot called, when the the project browser menu or a submenu is | |
| 225 about to be shown. | |
| 226 </p> | |
| 227 <dl> | |
| 228 | |
| 229 <dt><i>menuName</i> (str)</dt> | |
| 230 <dd> | |
| 231 name of the menu to be shown | |
| 232 </dd> | |
| 233 <dt><i>menu</i> (QMenu)</dt> | |
| 234 <dd> | |
| 235 reference to the menu | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <a NAME="PyrightPlugin.__projectPyrightCheck" ID="PyrightPlugin.__projectPyrightCheck"></a> | |
| 239 <h4>PyrightPlugin.__projectPyrightCheck</h4> | |
| 240 <b>__projectPyrightCheck</b>(<i></i>) | |
| 241 | |
| 242 <p> | |
| 243 Private slot used to check the project for static typing issues. | |
| 244 </p> | |
| 245 <a NAME="PyrightPlugin.__projectShowMenu" ID="PyrightPlugin.__projectShowMenu"></a> | |
| 246 <h4>PyrightPlugin.__projectShowMenu</h4> | |
| 247 <b>__projectShowMenu</b>(<i>menuName, menu, </i>) | |
| 248 | |
| 249 <p> | |
| 250 Private slot called, when the the project menu or a submenu is | |
| 251 about to be shown. | |
| 252 </p> | |
| 253 <dl> | |
| 254 | |
| 255 <dt><i>menuName</i> (str)</dt> | |
| 256 <dd> | |
| 257 name of the menu to be shown | |
| 258 </dd> | |
| 259 <dt><i>menu</i> (QMenu)</dt> | |
| 260 <dd> | |
| 261 reference to the menu | |
| 262 </dd> | |
| 263 </dl> | |
| 264 <a NAME="PyrightPlugin.activate" ID="PyrightPlugin.activate"></a> | |
| 265 <h4>PyrightPlugin.activate</h4> | |
| 266 <b>activate</b>(<i></i>) | |
| 267 | |
| 268 <p> | |
| 269 Public method to activate this plug-in. | |
| 270 </p> | |
| 271 <dl> | |
| 272 <dt>Return:</dt> | |
| 273 <dd> | |
| 274 tuple of None and activation status | |
| 275 </dd> | |
| 276 </dl> | |
| 277 <dl> | |
| 278 <dt>Return Type:</dt> | |
| 279 <dd> | |
| 280 bool | |
| 281 </dd> | |
| 282 </dl> | |
| 283 <a NAME="PyrightPlugin.deactivate" ID="PyrightPlugin.deactivate"></a> | |
| 284 <h4>PyrightPlugin.deactivate</h4> | |
| 285 <b>deactivate</b>(<i></i>) | |
| 286 | |
| 287 <p> | |
| 288 Public method to deactivate this plug-in. | |
| 289 </p> | |
| 290 <div align="right"><a href="#top">Up</a></div> | |
| 291 <hr /> | |
| 292 <hr /> | |
| 293 <a NAME="installDependencies" ID="installDependencies"></a> | |
| 294 <h2>installDependencies</h2> | |
| 295 <b>installDependencies</b>(<i>pipInstall</i>) | |
| 296 | |
| 297 <p> | |
| 298 Function to install dependencies of this plug-in. | |
| 299 </p> | |
| 300 <dl> | |
| 301 | |
| 302 <dt><i>pipInstall</i> (function)</dt> | |
| 303 <dd> | |
| 304 function to be called with a list of package names. | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <div align="right"><a href="#top">Up</a></div> | |
| 308 <hr /> | |
| 309 <hr /> | |
| 310 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 311 <h2>prepareUninstall</h2> | |
| 312 <b>prepareUninstall</b>(<i></i>) | |
| 313 | |
| 314 <p> | |
| 315 Module function to prepare for an uninstallation. | |
| 316 </p> | |
| 317 <div align="right"><a href="#top">Up</a></div> | |
| 318 <hr /> | |
| 319 </body></html> |
