Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.SearchWidget.html
src/eric7/Documentation/Source/eric7.WebBrowser.SearchWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8752
- 3c1ea4dfb691
- child 10436
- f6881d10e995
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.SearchWidget</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>eric7.WebBrowser.SearchWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the search bar for the web browser. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#SearchWidget">SearchWidget</a></td> | |
| 25 <td>Class implementing the search bar for the web browser.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="SearchWidget" ID="SearchWidget"></a> | |
| 36 <h2>SearchWidget</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the search bar for the web browser. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QWidget, Ui_SearchWidget | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#SearchWidget.__init__">SearchWidget</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#SearchWidget.__findByReturnPressed">__findByReturnPressed</a></td> | |
| 63 <td>Private slot to handle the returnPressed signal of the findtext combobox.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#SearchWidget.__findNextPrev">__findNextPrev</a></td> | |
| 67 <td>Private slot to find the next occurrence of text.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#SearchWidget.__findNextPrevCallback">__findNextPrevCallback</a></td> | |
| 71 <td>Private method to process the result of the last search.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#SearchWidget.__resetSearch">__resetSearch</a></td> | |
| 75 <td>Private method to reset the last search.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#SearchWidget.__searchTextEdited">__searchTextEdited</a></td> | |
| 79 <td>Private slot to perform an incremental search.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#SearchWidget.__setFindtextComboBackground">__setFindtextComboBackground</a></td> | |
| 83 <td>Private slot to change the findtext combo background to indicate errors.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#SearchWidget.findNext">findNext</a></td> | |
| 87 <td>Public slot to find the next occurrence.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#SearchWidget.findPrevious">findPrevious</a></td> | |
| 91 <td>Public slot to find the previous occurrence.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#SearchWidget.keyPressEvent">keyPressEvent</a></td> | |
| 95 <td>Protected slot to handle key press events.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#SearchWidget.on_closeButton_clicked">on_closeButton_clicked</a></td> | |
| 99 <td>Private slot to close the widget.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#SearchWidget.on_findNextButton_clicked">on_findNextButton_clicked</a></td> | |
| 103 <td>Private slot to find the next occurrence.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#SearchWidget.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td> | |
| 107 <td>Private slot to find the previous occurrence.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#SearchWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> | |
| 111 <td>Private slot to enable/disable the find buttons.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#SearchWidget.showFind">showFind</a></td> | |
| 115 <td>Public method to display this dialog.</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="SearchWidget.__init__" ID="SearchWidget.__init__"></a> | |
| 125 <h4>SearchWidget (Constructor)</h4> | |
| 126 <b>SearchWidget</b>(<i>mainWindow, parent=None</i>) | |
| 127 | |
| 128 <p> | |
| 129 Constructor | |
| 130 </p> | |
| 131 <dl> | |
| 132 | |
| 133 <dt><i>mainWindow</i></dt> | |
| 134 <dd> | |
| 135 reference to the main window (QMainWindow) | |
| 136 </dd> | |
| 137 <dt><i>parent</i></dt> | |
| 138 <dd> | |
| 139 parent widget of this dialog (QWidget) | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <a NAME="SearchWidget.__findByReturnPressed" ID="SearchWidget.__findByReturnPressed"></a> | |
| 143 <h4>SearchWidget.__findByReturnPressed</h4> | |
| 144 <b>__findByReturnPressed</b>(<i></i>) | |
| 145 | |
| 146 <p> | |
| 147 Private slot to handle the returnPressed signal of the findtext | |
| 148 combobox. | |
| 149 </p> | |
| 150 <a NAME="SearchWidget.__findNextPrev" ID="SearchWidget.__findNextPrev"></a> | |
| 151 <h4>SearchWidget.__findNextPrev</h4> | |
| 152 <b>__findNextPrev</b>(<i></i>) | |
| 153 | |
| 154 <p> | |
| 155 Private slot to find the next occurrence of text. | |
| 156 </p> | |
| 157 <a NAME="SearchWidget.__findNextPrevCallback" ID="SearchWidget.__findNextPrevCallback"></a> | |
| 158 <h4>SearchWidget.__findNextPrevCallback</h4> | |
| 159 <b>__findNextPrevCallback</b>(<i>result</i>) | |
| 160 | |
| 161 <p> | |
| 162 Private method to process the result of the last search. | |
| 163 </p> | |
| 164 <dl> | |
| 165 | |
| 166 <dt><i>result</i> (QWebEngineFindTextResult)</dt> | |
| 167 <dd> | |
| 168 reference to the search result | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <a NAME="SearchWidget.__resetSearch" ID="SearchWidget.__resetSearch"></a> | |
| 172 <h4>SearchWidget.__resetSearch</h4> | |
| 173 <b>__resetSearch</b>(<i></i>) | |
| 174 | |
| 175 <p> | |
| 176 Private method to reset the last search. | |
| 177 </p> | |
| 178 <a NAME="SearchWidget.__searchTextEdited" ID="SearchWidget.__searchTextEdited"></a> | |
| 179 <h4>SearchWidget.__searchTextEdited</h4> | |
| 180 <b>__searchTextEdited</b>(<i>txt</i>) | |
| 181 | |
| 182 <p> | |
| 183 Private slot to perform an incremental search. | |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>txt</i></dt> | |
| 188 <dd> | |
| 189 current text of the search combos line edit (string) | |
| 190 (unused) | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="SearchWidget.__setFindtextComboBackground" ID="SearchWidget.__setFindtextComboBackground"></a> | |
| 194 <h4>SearchWidget.__setFindtextComboBackground</h4> | |
| 195 <b>__setFindtextComboBackground</b>(<i>error</i>) | |
| 196 | |
| 197 <p> | |
| 198 Private slot to change the findtext combo background to indicate | |
| 199 errors. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>error</i></dt> | |
| 204 <dd> | |
| 205 flag indicating an error condition (boolean) | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <a NAME="SearchWidget.findNext" ID="SearchWidget.findNext"></a> | |
| 209 <h4>SearchWidget.findNext</h4> | |
| 210 <b>findNext</b>(<i></i>) | |
| 211 | |
| 212 <p> | |
| 213 Public slot to find the next occurrence. | |
| 214 </p> | |
| 215 <a NAME="SearchWidget.findPrevious" ID="SearchWidget.findPrevious"></a> | |
| 216 <h4>SearchWidget.findPrevious</h4> | |
| 217 <b>findPrevious</b>(<i></i>) | |
| 218 | |
| 219 <p> | |
| 220 Public slot to find the previous occurrence. | |
| 221 </p> | |
| 222 <a NAME="SearchWidget.keyPressEvent" ID="SearchWidget.keyPressEvent"></a> | |
| 223 <h4>SearchWidget.keyPressEvent</h4> | |
| 224 <b>keyPressEvent</b>(<i>event</i>) | |
| 225 | |
| 226 <p> | |
| 227 Protected slot to handle key press events. | |
| 228 </p> | |
| 229 <dl> | |
| 230 | |
| 231 <dt><i>event</i></dt> | |
| 232 <dd> | |
| 233 reference to the key press event (QKeyEvent) | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <a NAME="SearchWidget.on_closeButton_clicked" ID="SearchWidget.on_closeButton_clicked"></a> | |
| 237 <h4>SearchWidget.on_closeButton_clicked</h4> | |
| 238 <b>on_closeButton_clicked</b>(<i></i>) | |
| 239 | |
| 240 <p> | |
| 241 Private slot to close the widget. | |
| 242 </p> | |
| 243 <a NAME="SearchWidget.on_findNextButton_clicked" ID="SearchWidget.on_findNextButton_clicked"></a> | |
| 244 <h4>SearchWidget.on_findNextButton_clicked</h4> | |
| 245 <b>on_findNextButton_clicked</b>(<i></i>) | |
| 246 | |
| 247 <p> | |
| 248 Private slot to find the next occurrence. | |
| 249 </p> | |
| 250 <a NAME="SearchWidget.on_findPrevButton_clicked" ID="SearchWidget.on_findPrevButton_clicked"></a> | |
| 251 <h4>SearchWidget.on_findPrevButton_clicked</h4> | |
| 252 <b>on_findPrevButton_clicked</b>(<i></i>) | |
| 253 | |
| 254 <p> | |
| 255 Private slot to find the previous occurrence. | |
| 256 </p> | |
| 257 <a NAME="SearchWidget.on_findtextCombo_editTextChanged" ID="SearchWidget.on_findtextCombo_editTextChanged"></a> | |
| 258 <h4>SearchWidget.on_findtextCombo_editTextChanged</h4> | |
| 259 <b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) | |
| 260 | |
| 261 <p> | |
| 262 Private slot to enable/disable the find buttons. | |
| 263 </p> | |
| 264 <dl> | |
| 265 | |
| 266 <dt><i>txt</i></dt> | |
| 267 <dd> | |
| 268 text of the combobox (string) | |
| 269 </dd> | |
| 270 </dl> | |
| 271 <a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a> | |
| 272 <h4>SearchWidget.showFind</h4> | |
| 273 <b>showFind</b>(<i></i>) | |
| 274 | |
| 275 <p> | |
| 276 Public method to display this dialog. | |
| 277 </p> | |
| 278 <div align="right"><a href="#top">Up</a></div> | |
| 279 <hr /> | |
| 280 </body></html> |
