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