Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.SymbolsWidget.html
src/eric7/Documentation/Source/eric7.UI.SymbolsWidget.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10433
- 328f3ec4b77a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.SymbolsWidget</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.UI.SymbolsWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a widget to select a symbol in various formats. | |
| 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="#SymbolsModel">SymbolsModel</a></td> | |
| 25 <td>Class implementing the model for the symbols widget.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#SymbolsWidget">SymbolsWidget</a></td> | |
| 29 <td>Class implementing a widget to select a symbol in various formats.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="SymbolsModel" ID="SymbolsModel"></a> | |
| 40 <h2>SymbolsModel</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing the model for the symbols widget. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QAbstractTableModel | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#SymbolsModel.__init__">SymbolsModel</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#SymbolsModel.__isDigit">__isDigit</a></td> | |
| 67 <td>Private method to check, if a character is a digit.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#SymbolsModel.__isLetter">__isLetter</a></td> | |
| 71 <td>Private method to check, if a character is a letter.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#SymbolsModel.__isMark">__isMark</a></td> | |
| 75 <td>Private method to check, if a character is a mark character.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#SymbolsModel.__isPunct">__isPunct</a></td> | |
| 79 <td>Private method to check, if a character is a punctuation character.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#SymbolsModel.__isSymbol">__isSymbol</a></td> | |
| 83 <td>Private method to check, if a character is a symbol.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#SymbolsModel.columnCount">columnCount</a></td> | |
| 87 <td>Public method to get the number of columns of the model.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#SymbolsModel.data">data</a></td> | |
| 91 <td>Public method to get data from the model.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#SymbolsModel.getLocale">getLocale</a></td> | |
| 95 <td>Public method to get the used locale.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#SymbolsModel.getTableBoundaries">getTableBoundaries</a></td> | |
| 99 <td>Public method to get the first and last character position of the given table.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#SymbolsModel.getTableIndex">getTableIndex</a></td> | |
| 103 <td>Public method to get the current table index.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#SymbolsModel.getTableNames">getTableNames</a></td> | |
| 107 <td>Public method to get a list of table names.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#SymbolsModel.headerData">headerData</a></td> | |
| 111 <td>Public method to get header data from the model.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#SymbolsModel.rowCount">rowCount</a></td> | |
| 115 <td>Public method to get the number of rows of the model.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#SymbolsModel.selectTable">selectTable</a></td> | |
| 119 <td>Public method to select the shown character table.</td> | |
| 120 </tr> | |
| 121 </table> | |
| 122 <h3>Static Methods</h3> | |
| 123 | |
| 124 <table> | |
| 125 <tr><td>None</td></tr> | |
| 126 </table> | |
| 127 | |
| 128 <a NAME="SymbolsModel.__init__" ID="SymbolsModel.__init__"></a> | |
| 129 <h4>SymbolsModel (Constructor)</h4> | |
| 130 <b>SymbolsModel</b>(<i>parent=None</i>) | |
| 131 | |
| 132 <p> | |
| 133 Constructor | |
| 134 </p> | |
| 135 <dl> | |
| 136 | |
| 137 <dt><i>parent</i></dt> | |
| 138 <dd> | |
| 139 reference to the parent object (QObject) | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <a NAME="SymbolsModel.__isDigit" ID="SymbolsModel.__isDigit"></a> | |
| 143 <h4>SymbolsModel.__isDigit</h4> | |
| 144 <b>__isDigit</b>(<i>char</i>) | |
| 145 | |
| 146 <p> | |
| 147 Private method to check, if a character is a digit. | |
| 148 </p> | |
| 149 <dl> | |
| 150 | |
| 151 <dt><i>char</i></dt> | |
| 152 <dd> | |
| 153 character to test (one character string) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <dl> | |
| 157 <dt>Return:</dt> | |
| 158 <dd> | |
| 159 flag indicating a digit (boolean) | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="SymbolsModel.__isLetter" ID="SymbolsModel.__isLetter"></a> | |
| 163 <h4>SymbolsModel.__isLetter</h4> | |
| 164 <b>__isLetter</b>(<i>char</i>) | |
| 165 | |
| 166 <p> | |
| 167 Private method to check, if a character is a letter. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>char</i></dt> | |
| 172 <dd> | |
| 173 character to test (one character string) | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <dl> | |
| 177 <dt>Return:</dt> | |
| 178 <dd> | |
| 179 flag indicating a letter (boolean) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="SymbolsModel.__isMark" ID="SymbolsModel.__isMark"></a> | |
| 183 <h4>SymbolsModel.__isMark</h4> | |
| 184 <b>__isMark</b>(<i>char</i>) | |
| 185 | |
| 186 <p> | |
| 187 Private method to check, if a character is a mark character. | |
| 188 </p> | |
| 189 <dl> | |
| 190 | |
| 191 <dt><i>char</i></dt> | |
| 192 <dd> | |
| 193 character to test (one character string) | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <dl> | |
| 197 <dt>Return:</dt> | |
| 198 <dd> | |
| 199 flag indicating a mark character (boolean) | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <a NAME="SymbolsModel.__isPunct" ID="SymbolsModel.__isPunct"></a> | |
| 203 <h4>SymbolsModel.__isPunct</h4> | |
| 204 <b>__isPunct</b>(<i>char</i>) | |
| 205 | |
| 206 <p> | |
| 207 Private method to check, if a character is a punctuation character. | |
| 208 </p> | |
| 209 <dl> | |
| 210 | |
| 211 <dt><i>char</i></dt> | |
| 212 <dd> | |
| 213 character to test (one character string) | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <dl> | |
| 217 <dt>Return:</dt> | |
| 218 <dd> | |
| 219 flag indicating a punctuation character (boolean) | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <a NAME="SymbolsModel.__isSymbol" ID="SymbolsModel.__isSymbol"></a> | |
| 223 <h4>SymbolsModel.__isSymbol</h4> | |
| 224 <b>__isSymbol</b>(<i>char</i>) | |
| 225 | |
| 226 <p> | |
| 227 Private method to check, if a character is a symbol. | |
| 228 </p> | |
| 229 <dl> | |
| 230 | |
| 231 <dt><i>char</i></dt> | |
| 232 <dd> | |
| 233 character to test (one character string) | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <dl> | |
| 237 <dt>Return:</dt> | |
| 238 <dd> | |
| 239 flag indicating a symbol (boolean) | |
| 240 </dd> | |
| 241 </dl> | |
| 242 <a NAME="SymbolsModel.columnCount" ID="SymbolsModel.columnCount"></a> | |
| 243 <h4>SymbolsModel.columnCount</h4> | |
| 244 <b>columnCount</b>(<i>parent</i>) | |
| 245 | |
| 246 <p> | |
| 247 Public method to get the number of columns of the model. | |
| 248 </p> | |
| 249 <dl> | |
| 250 | |
| 251 <dt><i>parent</i></dt> | |
| 252 <dd> | |
| 253 parent index (QModelIndex) | |
| 254 </dd> | |
| 255 </dl> | |
| 256 <dl> | |
| 257 <dt>Return:</dt> | |
| 258 <dd> | |
| 259 number of columns (integer) | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <a NAME="SymbolsModel.data" ID="SymbolsModel.data"></a> | |
| 263 <h4>SymbolsModel.data</h4> | |
| 264 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>) | |
| 265 | |
| 266 <p> | |
| 267 Public method to get data from the model. | |
| 268 </p> | |
| 269 <dl> | |
| 270 | |
| 271 <dt><i>index</i></dt> | |
| 272 <dd> | |
| 273 index to get data for (QModelIndex) | |
| 274 </dd> | |
| 275 <dt><i>role</i></dt> | |
| 276 <dd> | |
| 277 role of the data to retrieve (integer) | |
| 278 </dd> | |
| 279 </dl> | |
| 280 <dl> | |
| 281 <dt>Return:</dt> | |
| 282 <dd> | |
| 283 requested data | |
| 284 </dd> | |
| 285 </dl> | |
| 286 <a NAME="SymbolsModel.getLocale" ID="SymbolsModel.getLocale"></a> | |
| 287 <h4>SymbolsModel.getLocale</h4> | |
| 288 <b>getLocale</b>(<i></i>) | |
| 289 | |
| 290 <p> | |
| 291 Public method to get the used locale. | |
| 292 </p> | |
| 293 <dl> | |
| 294 <dt>Return:</dt> | |
| 295 <dd> | |
| 296 used locale | |
| 297 </dd> | |
| 298 </dl> | |
| 299 <dl> | |
| 300 <dt>Return Type:</dt> | |
| 301 <dd> | |
| 302 QLocale | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <a NAME="SymbolsModel.getTableBoundaries" ID="SymbolsModel.getTableBoundaries"></a> | |
| 306 <h4>SymbolsModel.getTableBoundaries</h4> | |
| 307 <b>getTableBoundaries</b>(<i>index</i>) | |
| 308 | |
| 309 <p> | |
| 310 Public method to get the first and last character position | |
| 311 of the given table. | |
| 312 </p> | |
| 313 <dl> | |
| 314 | |
| 315 <dt><i>index</i></dt> | |
| 316 <dd> | |
| 317 index of the character table (integer) | |
| 318 </dd> | |
| 319 </dl> | |
| 320 <dl> | |
| 321 <dt>Return:</dt> | |
| 322 <dd> | |
| 323 first and last character position (integer, integer) | |
| 324 </dd> | |
| 325 </dl> | |
| 326 <a NAME="SymbolsModel.getTableIndex" ID="SymbolsModel.getTableIndex"></a> | |
| 327 <h4>SymbolsModel.getTableIndex</h4> | |
| 328 <b>getTableIndex</b>(<i></i>) | |
| 329 | |
| 330 <p> | |
| 331 Public method to get the current table index. | |
| 332 </p> | |
| 333 <dl> | |
| 334 <dt>Return:</dt> | |
| 335 <dd> | |
| 336 current table index (integer) | |
| 337 </dd> | |
| 338 </dl> | |
| 339 <a NAME="SymbolsModel.getTableNames" ID="SymbolsModel.getTableNames"></a> | |
| 340 <h4>SymbolsModel.getTableNames</h4> | |
| 341 <b>getTableNames</b>(<i></i>) | |
| 342 | |
| 343 <p> | |
| 344 Public method to get a list of table names. | |
| 345 </p> | |
| 346 <dl> | |
| 347 <dt>Return:</dt> | |
| 348 <dd> | |
| 349 list of table names (list of strings) | |
| 350 </dd> | |
| 351 </dl> | |
| 352 <a NAME="SymbolsModel.headerData" ID="SymbolsModel.headerData"></a> | |
| 353 <h4>SymbolsModel.headerData</h4> | |
| 354 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>) | |
| 355 | |
| 356 <p> | |
| 357 Public method to get header data from the model. | |
| 358 </p> | |
| 359 <dl> | |
| 360 | |
| 361 <dt><i>section</i></dt> | |
| 362 <dd> | |
| 363 section number (integer) | |
| 364 </dd> | |
| 365 <dt><i>orientation</i></dt> | |
| 366 <dd> | |
| 367 orientation (Qt.Orientation) | |
| 368 </dd> | |
| 369 <dt><i>role</i></dt> | |
| 370 <dd> | |
| 371 role of the data to retrieve (Qt.ItemDataRole) | |
| 372 </dd> | |
| 373 </dl> | |
| 374 <dl> | |
| 375 <dt>Return:</dt> | |
| 376 <dd> | |
| 377 requested data | |
| 378 </dd> | |
| 379 </dl> | |
| 380 <a NAME="SymbolsModel.rowCount" ID="SymbolsModel.rowCount"></a> | |
| 381 <h4>SymbolsModel.rowCount</h4> | |
| 382 <b>rowCount</b>(<i>parent</i>) | |
| 383 | |
| 384 <p> | |
| 385 Public method to get the number of rows of the model. | |
| 386 </p> | |
| 387 <dl> | |
| 388 | |
| 389 <dt><i>parent</i></dt> | |
| 390 <dd> | |
| 391 parent index (QModelIndex) | |
| 392 </dd> | |
| 393 </dl> | |
| 394 <dl> | |
| 395 <dt>Return:</dt> | |
| 396 <dd> | |
| 397 number of columns (integer) | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <a NAME="SymbolsModel.selectTable" ID="SymbolsModel.selectTable"></a> | |
| 401 <h4>SymbolsModel.selectTable</h4> | |
| 402 <b>selectTable</b>(<i>index</i>) | |
| 403 | |
| 404 <p> | |
| 405 Public method to select the shown character table. | |
| 406 </p> | |
| 407 <dl> | |
| 408 | |
| 409 <dt><i>index</i></dt> | |
| 410 <dd> | |
| 411 index of the character table (integer) | |
| 412 </dd> | |
| 413 </dl> | |
| 414 <div align="right"><a href="#top">Up</a></div> | |
| 415 <hr /> | |
| 416 <hr /> | |
| 417 <a NAME="SymbolsWidget" ID="SymbolsWidget"></a> | |
| 418 <h2>SymbolsWidget</h2> | |
| 419 | |
| 420 <p> | |
| 421 Class implementing a widget to select a symbol in various formats. | |
| 422 </p> | |
| 423 <h3>Signals</h3> | |
| 424 <dl> | |
| 425 | |
| 426 <dt>insertSymbol(str)</dt> | |
| 427 <dd> | |
| 428 emitted after the user has selected a symbol | |
| 429 </dd> | |
| 430 </dl> | |
| 431 <h3>Derived from</h3> | |
| 432 QWidget, Ui_SymbolsWidget | |
| 433 <h3>Class Attributes</h3> | |
| 434 | |
| 435 <table> | |
| 436 <tr><td>None</td></tr> | |
| 437 </table> | |
| 438 <h3>Class Methods</h3> | |
| 439 | |
| 440 <table> | |
| 441 <tr><td>None</td></tr> | |
| 442 </table> | |
| 443 <h3>Methods</h3> | |
| 444 | |
| 445 <table> | |
| 446 | |
| 447 <tr> | |
| 448 <td><a href="#SymbolsWidget.__init__">SymbolsWidget</a></td> | |
| 449 <td>Constructor</td> | |
| 450 </tr> | |
| 451 <tr> | |
| 452 <td><a href="#SymbolsWidget.__currentRowChanged">__currentRowChanged</a></td> | |
| 453 <td>Private slot recording the currently selected row.</td> | |
| 454 </tr> | |
| 455 <tr> | |
| 456 <td><a href="#SymbolsWidget.on_symbolSpinBox_editingFinished">on_symbolSpinBox_editingFinished</a></td> | |
| 457 <td>Private slot to move the table to the entered symbol id.</td> | |
| 458 </tr> | |
| 459 <tr> | |
| 460 <td><a href="#SymbolsWidget.on_symbolsTable_activated">on_symbolsTable_activated</a></td> | |
| 461 <td>Private slot to signal the selection of a symbol.</td> | |
| 462 </tr> | |
| 463 <tr> | |
| 464 <td><a href="#SymbolsWidget.on_tableCombo_currentIndexChanged">on_tableCombo_currentIndexChanged</a></td> | |
| 465 <td>Private slot to select the current character table.</td> | |
| 466 </tr> | |
| 467 </table> | |
| 468 <h3>Static Methods</h3> | |
| 469 | |
| 470 <table> | |
| 471 <tr><td>None</td></tr> | |
| 472 </table> | |
| 473 | |
| 474 <a NAME="SymbolsWidget.__init__" ID="SymbolsWidget.__init__"></a> | |
| 475 <h4>SymbolsWidget (Constructor)</h4> | |
| 476 <b>SymbolsWidget</b>(<i>parent=None</i>) | |
| 477 | |
| 478 <p> | |
| 479 Constructor | |
| 480 </p> | |
| 481 <dl> | |
| 482 | |
| 483 <dt><i>parent</i></dt> | |
| 484 <dd> | |
| 485 reference to the parent widget (QWidget) | |
| 486 </dd> | |
| 487 </dl> | |
| 488 <a NAME="SymbolsWidget.__currentRowChanged" ID="SymbolsWidget.__currentRowChanged"></a> | |
| 489 <h4>SymbolsWidget.__currentRowChanged</h4> | |
| 490 <b>__currentRowChanged</b>(<i>current, previous</i>) | |
| 491 | |
| 492 <p> | |
| 493 Private slot recording the currently selected row. | |
| 494 </p> | |
| 495 <dl> | |
| 496 | |
| 497 <dt><i>current</i></dt> | |
| 498 <dd> | |
| 499 current index (QModelIndex) | |
| 500 </dd> | |
| 501 <dt><i>previous</i></dt> | |
| 502 <dd> | |
| 503 previous current index (QModelIndex) | |
| 504 </dd> | |
| 505 </dl> | |
| 506 <a NAME="SymbolsWidget.on_symbolSpinBox_editingFinished" ID="SymbolsWidget.on_symbolSpinBox_editingFinished"></a> | |
| 507 <h4>SymbolsWidget.on_symbolSpinBox_editingFinished</h4> | |
| 508 <b>on_symbolSpinBox_editingFinished</b>(<i></i>) | |
| 509 | |
| 510 <p> | |
| 511 Private slot to move the table to the entered symbol id. | |
| 512 </p> | |
| 513 <a NAME="SymbolsWidget.on_symbolsTable_activated" ID="SymbolsWidget.on_symbolsTable_activated"></a> | |
| 514 <h4>SymbolsWidget.on_symbolsTable_activated</h4> | |
| 515 <b>on_symbolsTable_activated</b>(<i>index</i>) | |
| 516 | |
| 517 <p> | |
| 518 Private slot to signal the selection of a symbol. | |
| 519 </p> | |
| 520 <dl> | |
| 521 | |
| 522 <dt><i>index</i></dt> | |
| 523 <dd> | |
| 524 index of the selected symbol (QModelIndex) | |
| 525 </dd> | |
| 526 </dl> | |
| 527 <a NAME="SymbolsWidget.on_tableCombo_currentIndexChanged" ID="SymbolsWidget.on_tableCombo_currentIndexChanged"></a> | |
| 528 <h4>SymbolsWidget.on_tableCombo_currentIndexChanged</h4> | |
| 529 <b>on_tableCombo_currentIndexChanged</b>(<i>index</i>) | |
| 530 | |
| 531 <p> | |
| 532 Private slot to select the current character table. | |
| 533 </p> | |
| 534 <dl> | |
| 535 | |
| 536 <dt><i>index</i></dt> | |
| 537 <dd> | |
| 538 index of the character table (integer) | |
| 539 </dd> | |
| 540 </dl> | |
| 541 <div align="right"><a href="#top">Up</a></div> | |
| 542 <hr /> | |
| 543 </body></html> |
