Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html
Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.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.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog</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.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a simple Python syntax checker. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#SyntaxCheckerDialog">SyntaxCheckerDialog</a></td> | |
| 23 <td>Class implementing a dialog to display the results of a syntax check run.</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="SyntaxCheckerDialog" ID="SyntaxCheckerDialog"></a> | |
| 32 <h2>SyntaxCheckerDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to display the results of a syntax check run. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QDialog, Ui_SyntaxCheckerDialog | |
| 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="#SyntaxCheckerDialog.__init__">SyntaxCheckerDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#SyntaxCheckerDialog.__clearErrors">__clearErrors</a></td> | |
| 49 <td>Private method to clear all error markers of open editors.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#SyntaxCheckerDialog.__createResultItem">__createResultItem</a></td> | |
| 52 <td>Private method to create an entry in the result list.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#SyntaxCheckerDialog.__finish">__finish</a></td> | |
| 55 <td>Private slot called when the syntax check finished or the user pressed the button.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#SyntaxCheckerDialog.__resort">__resort</a></td> | |
| 58 <td>Private method to resort the tree.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#SyntaxCheckerDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 61 <td>Private slot called by a button of the button box clicked.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#SyntaxCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> | |
| 64 <td>Private slot to handle the activation of an item.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#SyntaxCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td> | |
| 67 <td>Private slot to handle the "Show" button press.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#SyntaxCheckerDialog.start">start</a></td> | |
| 70 <td>Public slot to start the syntax check.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <a NAME="SyntaxCheckerDialog.__init__" ID="SyntaxCheckerDialog.__init__"></a> | |
| 74 <h4>SyntaxCheckerDialog (Constructor)</h4> | |
| 75 <b>SyntaxCheckerDialog</b>(<i>parent = None</i>) | |
| 76 <p> | |
| 77 Constructor | |
| 78 </p><dl> | |
| 79 <dt><i>parent</i></dt> | |
| 80 <dd> | |
| 81 The parent widget. (QWidget) | |
| 82 </dd> | |
| 83 </dl><a NAME="SyntaxCheckerDialog.__clearErrors" ID="SyntaxCheckerDialog.__clearErrors"></a> | |
| 84 <h4>SyntaxCheckerDialog.__clearErrors</h4> | |
| 85 <b>__clearErrors</b>(<i></i>) | |
| 86 <p> | |
| 87 Private method to clear all error markers of open editors. | |
| 88 </p><a NAME="SyntaxCheckerDialog.__createResultItem" ID="SyntaxCheckerDialog.__createResultItem"></a> | |
| 89 <h4>SyntaxCheckerDialog.__createResultItem</h4> | |
| 90 <b>__createResultItem</b>(<i>file, line, error, sourcecode</i>) | |
| 91 <p> | |
| 92 Private method to create an entry in the result list. | |
| 93 </p><dl> | |
| 94 <dt><i>file</i></dt> | |
| 95 <dd> | |
| 96 filename of file (string) | |
| 97 </dd><dt><i>line</i></dt> | |
| 98 <dd> | |
| 99 linenumber of faulty source (integer or string) | |
| 100 </dd><dt><i>error</i></dt> | |
| 101 <dd> | |
| 102 error text (string) | |
| 103 </dd><dt><i>sourcecode</i></dt> | |
| 104 <dd> | |
| 105 faulty line of code (string) | |
| 106 </dd> | |
| 107 </dl><a NAME="SyntaxCheckerDialog.__finish" ID="SyntaxCheckerDialog.__finish"></a> | |
| 108 <h4>SyntaxCheckerDialog.__finish</h4> | |
| 109 <b>__finish</b>(<i></i>) | |
| 110 <p> | |
| 111 Private slot called when the syntax check finished or the user pressed the button. | |
| 112 </p><a NAME="SyntaxCheckerDialog.__resort" ID="SyntaxCheckerDialog.__resort"></a> | |
| 113 <h4>SyntaxCheckerDialog.__resort</h4> | |
| 114 <b>__resort</b>(<i></i>) | |
| 115 <p> | |
| 116 Private method to resort the tree. | |
| 117 </p><a NAME="SyntaxCheckerDialog.on_buttonBox_clicked" ID="SyntaxCheckerDialog.on_buttonBox_clicked"></a> | |
| 118 <h4>SyntaxCheckerDialog.on_buttonBox_clicked</h4> | |
| 119 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 120 <p> | |
| 121 Private slot called by a button of the button box clicked. | |
| 122 </p><dl> | |
| 123 <dt><i>button</i></dt> | |
| 124 <dd> | |
| 125 button that was clicked (QAbstractButton) | |
| 126 </dd> | |
| 127 </dl><a NAME="SyntaxCheckerDialog.on_resultList_itemActivated" ID="SyntaxCheckerDialog.on_resultList_itemActivated"></a> | |
| 128 <h4>SyntaxCheckerDialog.on_resultList_itemActivated</h4> | |
| 129 <b>on_resultList_itemActivated</b>(<i>itm, col</i>) | |
| 130 <p> | |
| 131 Private slot to handle the activation of an item. | |
| 132 </p><dl> | |
| 133 <dt><i>itm</i></dt> | |
| 134 <dd> | |
| 135 reference to the activated item (QTreeWidgetItem) | |
| 136 </dd><dt><i>col</i></dt> | |
| 137 <dd> | |
| 138 column the item was activated in (integer) | |
| 139 </dd> | |
| 140 </dl><a NAME="SyntaxCheckerDialog.on_showButton_clicked" ID="SyntaxCheckerDialog.on_showButton_clicked"></a> | |
| 141 <h4>SyntaxCheckerDialog.on_showButton_clicked</h4> | |
| 142 <b>on_showButton_clicked</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot to handle the "Show" button press. | |
| 145 </p><a NAME="SyntaxCheckerDialog.start" ID="SyntaxCheckerDialog.start"></a> | |
| 146 <h4>SyntaxCheckerDialog.start</h4> | |
| 147 <b>start</b>(<i>fn, codestring = ""</i>) | |
| 148 <p> | |
| 149 Public slot to start the syntax check. | |
| 150 </p><dl> | |
| 151 <dt><i>fn</i></dt> | |
| 152 <dd> | |
| 153 file or list of files or directory to be checked | |
| 154 (string or list of strings) | |
| 155 </dd><dt><i>codestring</i></dt> | |
| 156 <dd> | |
| 157 string containing the code to be checked (string). | |
| 158 If this is given, file must be a single file name. | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <div align="right"><a href="#top">Up</a></div> | |
| 162 <hr /> | |
| 163 </body></html> |
