Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.QsciScintillaCompat.html
src/eric7/Documentation/Source/eric7.QScintilla.QsciScintillaCompat.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8752
- 3c1ea4dfb691
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.QsciScintillaCompat</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.QScintilla.QsciScintillaCompat</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a compatability interface class to QsciScintilla. | |
| 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="#QsciScintillaCompat">QsciScintillaCompat</a></td> | |
| 25 <td>Class implementing a compatability interface to QsciScintilla.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#QSCINTILLA_VERSION">QSCINTILLA_VERSION</a></td> | |
| 34 <td>Module function to return the QScintilla version.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="QsciScintillaCompat" ID="QsciScintillaCompat"></a> | |
| 40 <h2>QsciScintillaCompat</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a compatability interface to QsciScintilla. | |
| 44 </p> | |
| 45 <p> | |
| 46 This class implements all the functions, that were added to | |
| 47 QsciScintilla incrementally. This class ensures compatibility | |
| 48 to older versions of QsciScintilla. | |
| 49 </p> | |
| 50 <h3>Signals</h3> | |
| 51 <dl> | |
| 52 | |
| 53 <dt>zoomValueChanged(int)</dt> | |
| 54 <dd> | |
| 55 emitted to signal a change of the zoom value | |
| 56 </dd> | |
| 57 </dl> | |
| 58 <h3>Derived from</h3> | |
| 59 QsciScintilla | |
| 60 <h3>Class Attributes</h3> | |
| 61 | |
| 62 <table> | |
| 63 <tr><td>ArrowFoldStyle</td></tr><tr><td>ArrowTreeFoldStyle</td></tr><tr><td>IndicatorStyleMax</td></tr><tr><td>QFontWeightMapping</td></tr><tr><td>UserSeparator</td></tr> | |
| 64 </table> | |
| 65 <h3>Class Methods</h3> | |
| 66 | |
| 67 <table> | |
| 68 <tr><td>None</td></tr> | |
| 69 </table> | |
| 70 <h3>Methods</h3> | |
| 71 | |
| 72 <table> | |
| 73 | |
| 74 <tr> | |
| 75 <td><a href="#QsciScintillaCompat.__init__">QsciScintillaCompat</a></td> | |
| 76 <td>Constructor</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#QsciScintillaCompat.__completionListSelected">__completionListSelected</a></td> | |
| 80 <td>Private slot to handle the selection from the completion list.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#QsciScintillaCompat.__doSearchTarget">__doSearchTarget</a></td> | |
| 84 <td>Private method to perform the search in target.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#QsciScintillaCompat.__modificationChanged">__modificationChanged</a></td> | |
| 88 <td>Private slot to handle the modificationChanged signal.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#QsciScintillaCompat.__setFoldMarker">__setFoldMarker</a></td> | |
| 92 <td>Private method to define a fold marker.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#QsciScintillaCompat._encodeString">_encodeString</a></td> | |
| 96 <td>Protected method to encode a string depending on the current mode.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#QsciScintillaCompat.addCursor">addCursor</a></td> | |
| 100 <td>Public method to add an additional cursor.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#QsciScintillaCompat.autoCompleteFromAPIs">autoCompleteFromAPIs</a></td> | |
| 104 <td>Public method to resize list box after creation.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#QsciScintillaCompat.autoCompleteFromAll">autoCompleteFromAll</a></td> | |
| 108 <td>Public method to resize list box after creation.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#QsciScintillaCompat.autoCompleteFromDocument">autoCompleteFromDocument</a></td> | |
| 112 <td>Public method to resize list box after creation.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#QsciScintillaCompat.byteAt">byteAt</a></td> | |
| 116 <td>Public method to get the raw character (bytes) at a position in the text.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#QsciScintillaCompat.canPaste">canPaste</a></td> | |
| 120 <td>Public method to test, if the paste action is available (i.e.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#QsciScintillaCompat.cancelCallTips">cancelCallTips</a></td> | |
| 124 <td>Public method to cancel displayed call tips.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#QsciScintillaCompat.charAt">charAt</a></td> | |
| 128 <td>Public method to get the character at a position in the text observing multibyte characters.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#QsciScintillaCompat.clearAllIndicators">clearAllIndicators</a></td> | |
| 132 <td>Public method to clear all occurrences of an indicator.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#QsciScintillaCompat.clearAlternateKeys">clearAlternateKeys</a></td> | |
| 136 <td>Public method to clear the alternate key commands.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#QsciScintillaCompat.clearIndicator">clearIndicator</a></td> | |
| 140 <td>Public method to clear an indicator for the given range.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#QsciScintillaCompat.clearIndicatorRange">clearIndicatorRange</a></td> | |
| 144 <td>Public method to clear an indicator for the given range.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#QsciScintillaCompat.clearKeys">clearKeys</a></td> | |
| 148 <td>Public method to clear the key commands.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#QsciScintillaCompat.clearStyles">clearStyles</a></td> | |
| 152 <td>Public method to set the styles according the selected Qt style.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#QsciScintillaCompat.currentPosition">currentPosition</a></td> | |
| 156 <td>Public method to get the current position.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#QsciScintillaCompat.currentStyle">currentStyle</a></td> | |
| 160 <td>Public method to get the style at the current position.</td> | |
| 161 </tr> | |
| 162 <tr> | |
| 163 <td><a href="#QsciScintillaCompat.delete">delete</a></td> | |
| 164 <td>Public method to delete the character to the right of the cursor.</td> | |
| 165 </tr> | |
| 166 <tr> | |
| 167 <td><a href="#QsciScintillaCompat.deleteBack">deleteBack</a></td> | |
| 168 <td>Public method to delete the character to the left of the cursor.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#QsciScintillaCompat.deleteLineLeft">deleteLineLeft</a></td> | |
| 172 <td>Public method to delete the line to the left of the cursor.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#QsciScintillaCompat.deleteLineRight">deleteLineRight</a></td> | |
| 176 <td>Public method to delete the line to the right of the cursor.</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#QsciScintillaCompat.deleteWordLeft">deleteWordLeft</a></td> | |
| 180 <td>Public method to delete the word to the left of the cursor.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#QsciScintillaCompat.deleteWordRight">deleteWordRight</a></td> | |
| 184 <td>Public method to delete the word to the right of the cursor.</td> | |
| 185 </tr> | |
| 186 <tr> | |
| 187 <td><a href="#QsciScintillaCompat.detectEolString">detectEolString</a></td> | |
| 188 <td>Public method to determine the eol string used.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#QsciScintillaCompat.editorCommand">editorCommand</a></td> | |
| 192 <td>Public method to perform a simple editor command.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#QsciScintillaCompat.enableMultiCursorSupport">enableMultiCursorSupport</a></td> | |
| 196 <td>Public method to enable support for multi cursor editing.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#QsciScintillaCompat.event">event</a></td> | |
| 200 <td>Public method to handle events.</td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#QsciScintillaCompat.extendSelectionLeft">extendSelectionLeft</a></td> | |
| 204 <td>Public method to extend the selection one character to the left.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#QsciScintillaCompat.extendSelectionRight">extendSelectionRight</a></td> | |
| 208 <td>Public method to extend the selection one character to the right.</td> | |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#QsciScintillaCompat.extendSelectionToBOL">extendSelectionToBOL</a></td> | |
| 212 <td>Public method to extend the selection to the beginning of the line.</td> | |
| 213 </tr> | |
| 214 <tr> | |
| 215 <td><a href="#QsciScintillaCompat.extendSelectionToEOL">extendSelectionToEOL</a></td> | |
| 216 <td>Public method to extend the selection to the end of the line.</td> | |
| 217 </tr> | |
| 218 <tr> | |
| 219 <td><a href="#QsciScintillaCompat.extendSelectionWordLeft">extendSelectionWordLeft</a></td> | |
| 220 <td>Public method to extend the selection one word to the left.</td> | |
| 221 </tr> | |
| 222 <tr> | |
| 223 <td><a href="#QsciScintillaCompat.extendSelectionWordRight">extendSelectionWordRight</a></td> | |
| 224 <td>Public method to extend the selection one word to the right.</td> | |
| 225 </tr> | |
| 226 <tr> | |
| 227 <td><a href="#QsciScintillaCompat.findFirstTarget">findFirstTarget</a></td> | |
| 228 <td>Public method to search in a specified range of text without setting the selection.</td> | |
| 229 </tr> | |
| 230 <tr> | |
| 231 <td><a href="#QsciScintillaCompat.findNextTarget">findNextTarget</a></td> | |
| 232 <td>Public method to find the next occurrence in the target range.</td> | |
| 233 </tr> | |
| 234 <tr> | |
| 235 <td><a href="#QsciScintillaCompat.flashFindIndicator">flashFindIndicator</a></td> | |
| 236 <td>Public method to flash the find indicator for the given range.</td> | |
| 237 </tr> | |
| 238 <tr> | |
| 239 <td><a href="#QsciScintillaCompat.focusOutEvent">focusOutEvent</a></td> | |
| 240 <td>Protected method called when the editor loses focus.</td> | |
| 241 </tr> | |
| 242 <tr> | |
| 243 <td><a href="#QsciScintillaCompat.foldExpandedAt">foldExpandedAt</a></td> | |
| 244 <td>Public method to determine, if a fold is expanded.</td> | |
| 245 </tr> | |
| 246 <tr> | |
| 247 <td><a href="#QsciScintillaCompat.foldFlagsAt">foldFlagsAt</a></td> | |
| 248 <td>Public method to get the fold flags of a line of the document.</td> | |
| 249 </tr> | |
| 250 <tr> | |
| 251 <td><a href="#QsciScintillaCompat.foldHeaderAt">foldHeaderAt</a></td> | |
| 252 <td>Public method to determine, if a line of the document is a fold header line.</td> | |
| 253 </tr> | |
| 254 <tr> | |
| 255 <td><a href="#QsciScintillaCompat.foldLevelAt">foldLevelAt</a></td> | |
| 256 <td>Public method to get the fold level of a line of the document.</td> | |
| 257 </tr> | |
| 258 <tr> | |
| 259 <td><a href="#QsciScintillaCompat.getCaretLineAlwaysVisible">getCaretLineAlwaysVisible</a></td> | |
| 260 <td>Public method to determine, if the caret line is visible even if the editor doesn't have the focus.</td> | |
| 261 </tr> | |
| 262 <tr> | |
| 263 <td><a href="#QsciScintillaCompat.getCursorFlashTime">getCursorFlashTime</a></td> | |
| 264 <td>Public method to get the flash (blink) time of the cursor in milliseconds.</td> | |
| 265 </tr> | |
| 266 <tr> | |
| 267 <td><a href="#QsciScintillaCompat.getDocLineFromVisibleLine">getDocLineFromVisibleLine</a></td> | |
| 268 <td>Public method to convert a visible line number to a document line number (i.e.</td> | |
| 269 </tr> | |
| 270 <tr> | |
| 271 <td><a href="#QsciScintillaCompat.getEndStyled">getEndStyled</a></td> | |
| 272 <td>Public method to get the last styled position.</td> | |
| 273 </tr> | |
| 274 <tr> | |
| 275 <td><a href="#QsciScintillaCompat.getEolIndicator">getEolIndicator</a></td> | |
| 276 <td>Public method to get the eol indicator for the current eol mode.</td> | |
| 277 </tr> | |
| 278 <tr> | |
| 279 <td><a href="#QsciScintillaCompat.getFileName">getFileName</a></td> | |
| 280 <td>Public method to return the name of the file being displayed.</td> | |
| 281 </tr> | |
| 282 <tr> | |
| 283 <td><a href="#QsciScintillaCompat.getFoundTarget">getFoundTarget</a></td> | |
| 284 <td>Public method to get the recently found target.</td> | |
| 285 </tr> | |
| 286 <tr> | |
| 287 <td><a href="#QsciScintillaCompat.getGlobalCursorPosition">getGlobalCursorPosition</a></td> | |
| 288 <td>Public method to determine the point of the cursor.</td> | |
| 289 </tr> | |
| 290 <tr> | |
| 291 <td><a href="#QsciScintillaCompat.getIndicatorEndPos">getIndicatorEndPos</a></td> | |
| 292 <td>Public method to get the end position of an indicator at a position.</td> | |
| 293 </tr> | |
| 294 <tr> | |
| 295 <td><a href="#QsciScintillaCompat.getIndicatorStartPos">getIndicatorStartPos</a></td> | |
| 296 <td>Public method to get the start position of an indicator at a position.</td> | |
| 297 </tr> | |
| 298 <tr> | |
| 299 <td><a href="#QsciScintillaCompat.getLineSeparator">getLineSeparator</a></td> | |
| 300 <td>Public method to get the line separator for the current eol mode.</td> | |
| 301 </tr> | |
| 302 <tr> | |
| 303 <td><a href="#QsciScintillaCompat.getRectangularSelection">getRectangularSelection</a></td> | |
| 304 <td>Public method to retrieve the start and end of a rectangular selection.</td> | |
| 305 </tr> | |
| 306 <tr> | |
| 307 <td><a href="#QsciScintillaCompat.getSelectionCount">getSelectionCount</a></td> | |
| 308 <td>Public method to get the number of active selections.</td> | |
| 309 </tr> | |
| 310 <tr> | |
| 311 <td><a href="#QsciScintillaCompat.getSelectionN">getSelectionN</a></td> | |
| 312 <td>Public method to get the start and end of a selection given by its index.</td> | |
| 313 </tr> | |
| 314 <tr> | |
| 315 <td><a href="#QsciScintillaCompat.getSelections">getSelections</a></td> | |
| 316 <td>Public method to get the start and end coordinates of all active selections.</td> | |
| 317 </tr> | |
| 318 <tr> | |
| 319 <td><a href="#QsciScintillaCompat.getSubStyleRange">getSubStyleRange</a></td> | |
| 320 <td>Public method to get the sub style range for given style number.</td> | |
| 321 </tr> | |
| 322 <tr> | |
| 323 <td><a href="#QsciScintillaCompat.getVisibleLineFromDocLine">getVisibleLineFromDocLine</a></td> | |
| 324 <td>Public method to convert a document line number to a visible line number (i.e.</td> | |
| 325 </tr> | |
| 326 <tr> | |
| 327 <td><a href="#QsciScintillaCompat.getZoom">getZoom</a></td> | |
| 328 <td>Public method used to retrieve the current zoom factor.</td> | |
| 329 </tr> | |
| 330 <tr> | |
| 331 <td><a href="#QsciScintillaCompat.gotoNextIndicator">gotoNextIndicator</a></td> | |
| 332 <td>Public method to move the cursor to the next position of an indicator.</td> | |
| 333 </tr> | |
| 334 <tr> | |
| 335 <td><a href="#QsciScintillaCompat.gotoPreviousIndicator">gotoPreviousIndicator</a></td> | |
| 336 <td>Public method to move the cursor to the previous position of an indicator.</td> | |
| 337 </tr> | |
| 338 <tr> | |
| 339 <td><a href="#QsciScintillaCompat.hasIndicator">hasIndicator</a></td> | |
| 340 <td>Public method to test for the existence of an indicator.</td> | |
| 341 </tr> | |
| 342 <tr> | |
| 343 <td><a href="#QsciScintillaCompat.hasSelectedText">hasSelectedText</a></td> | |
| 344 <td>Public method to indicate the presence of selected text.</td> | |
| 345 </tr> | |
| 346 <tr> | |
| 347 <td><a href="#QsciScintillaCompat.hasSelection">hasSelection</a></td> | |
| 348 <td>Public method to check for a selection.</td> | |
| 349 </tr> | |
| 350 <tr> | |
| 351 <td><a href="#QsciScintillaCompat.hideFindIndicator">hideFindIndicator</a></td> | |
| 352 <td>Public method to hide the find indicator.</td> | |
| 353 </tr> | |
| 354 <tr> | |
| 355 <td><a href="#QsciScintillaCompat.indentationGuideView">indentationGuideView</a></td> | |
| 356 <td>Public method to get the indentation guide view.</td> | |
| 357 </tr> | |
| 358 <tr> | |
| 359 <td><a href="#QsciScintillaCompat.indicatorDefine">indicatorDefine</a></td> | |
| 360 <td>Public method to define the appearance of an indicator.</td> | |
| 361 </tr> | |
| 362 <tr> | |
| 363 <td><a href="#QsciScintillaCompat.isModified">isModified</a></td> | |
| 364 <td>Public method to return the modification status.</td> | |
| 365 </tr> | |
| 366 <tr> | |
| 367 <td><a href="#QsciScintillaCompat.lineAt">lineAt</a></td> | |
| 368 <td>Public method to calculate the line at a position.</td> | |
| 369 </tr> | |
| 370 <tr> | |
| 371 <td><a href="#QsciScintillaCompat.lineEndPosition">lineEndPosition</a></td> | |
| 372 <td>Public method to determine the line end position of the given line.</td> | |
| 373 </tr> | |
| 374 <tr> | |
| 375 <td><a href="#QsciScintillaCompat.lineIndexFromPoint">lineIndexFromPoint</a></td> | |
| 376 <td>Public method to convert a point to line and index.</td> | |
| 377 </tr> | |
| 378 <tr> | |
| 379 <td><a href="#QsciScintillaCompat.linesOnScreen">linesOnScreen</a></td> | |
| 380 <td>Public method to get the amount of visible lines.</td> | |
| 381 </tr> | |
| 382 <tr> | |
| 383 <td><a href="#QsciScintillaCompat.monospacedStyles">monospacedStyles</a></td> | |
| 384 <td>Public method to set the current style to be monospaced.</td> | |
| 385 </tr> | |
| 386 <tr> | |
| 387 <td><a href="#QsciScintillaCompat.moveCursorLeft">moveCursorLeft</a></td> | |
| 388 <td>Public method to move the cursor left.</td> | |
| 389 </tr> | |
| 390 <tr> | |
| 391 <td><a href="#QsciScintillaCompat.moveCursorRight">moveCursorRight</a></td> | |
| 392 <td>Public method to move the cursor right.</td> | |
| 393 </tr> | |
| 394 <tr> | |
| 395 <td><a href="#QsciScintillaCompat.moveCursorToEOL">moveCursorToEOL</a></td> | |
| 396 <td>Public method to move the cursor to the end of line.</td> | |
| 397 </tr> | |
| 398 <tr> | |
| 399 <td><a href="#QsciScintillaCompat.moveCursorWordLeft">moveCursorWordLeft</a></td> | |
| 400 <td>Public method to move the cursor left one word.</td> | |
| 401 </tr> | |
| 402 <tr> | |
| 403 <td><a href="#QsciScintillaCompat.moveCursorWordRight">moveCursorWordRight</a></td> | |
| 404 <td>Public method to move the cursor right one word.</td> | |
| 405 </tr> | |
| 406 <tr> | |
| 407 <td><a href="#QsciScintillaCompat.newLineBelow">newLineBelow</a></td> | |
| 408 <td>Public method to insert a new line below the current one.</td> | |
| 409 </tr> | |
| 410 <tr> | |
| 411 <td><a href="#QsciScintillaCompat.positionAfter">positionAfter</a></td> | |
| 412 <td>Public method to get the position after the given position taking into account multibyte characters.</td> | |
| 413 </tr> | |
| 414 <tr> | |
| 415 <td><a href="#QsciScintillaCompat.positionBefore">positionBefore</a></td> | |
| 416 <td>Public method to get the position before the given position taking into account multibyte characters.</td> | |
| 417 </tr> | |
| 418 <tr> | |
| 419 <td><a href="#QsciScintillaCompat.positionFromPoint">positionFromPoint</a></td> | |
| 420 <td>Public method to calculate the scintilla position from a point in the window.</td> | |
| 421 </tr> | |
| 422 <tr> | |
| 423 <td><a href="#QsciScintillaCompat.replaceTarget">replaceTarget</a></td> | |
| 424 <td>Public method to replace the string found by the last search in target.</td> | |
| 425 </tr> | |
| 426 <tr> | |
| 427 <td><a href="#QsciScintillaCompat.scrollVertical">scrollVertical</a></td> | |
| 428 <td>Public method to scroll the text area.</td> | |
| 429 </tr> | |
| 430 <tr> | |
| 431 <td><a href="#QsciScintillaCompat.selectionIsRectangle">selectionIsRectangle</a></td> | |
| 432 <td>Public method to check, if the current selection is rectangular.</td> | |
| 433 </tr> | |
| 434 <tr> | |
| 435 <td><a href="#QsciScintillaCompat.setAutoCompletionWidgetSize">setAutoCompletionWidgetSize</a></td> | |
| 436 <td>Public method to set the size of completion and user lists.</td> | |
| 437 </tr> | |
| 438 <tr> | |
| 439 <td><a href="#QsciScintillaCompat.setCaretLineAlwaysVisible">setCaretLineAlwaysVisible</a></td> | |
| 440 <td>Public method to set the caret line visible even if the editor doesn't have the focus.</td> | |
| 441 </tr> | |
| 442 <tr> | |
| 443 <td><a href="#QsciScintillaCompat.setCurrentIndicator">setCurrentIndicator</a></td> | |
| 444 <td>Public method to set the current indicator.</td> | |
| 445 </tr> | |
| 446 <tr> | |
| 447 <td><a href="#QsciScintillaCompat.setCursorFlashTime">setCursorFlashTime</a></td> | |
| 448 <td>Public method to set the flash (blink) time of the cursor in milliseconds.</td> | |
| 449 </tr> | |
| 450 <tr> | |
| 451 <td><a href="#QsciScintillaCompat.setEolModeByEolString">setEolModeByEolString</a></td> | |
| 452 <td>Public method to set the eol mode given the eol string.</td> | |
| 453 </tr> | |
| 454 <tr> | |
| 455 <td><a href="#QsciScintillaCompat.setFoldMarkersColors">setFoldMarkersColors</a></td> | |
| 456 <td>Public method to set the foreground and background colors of the fold markers.</td> | |
| 457 </tr> | |
| 458 <tr> | |
| 459 <td><a href="#QsciScintillaCompat.setFolding">setFolding</a></td> | |
| 460 <td>Public method to set the folding style and margin.</td> | |
| 461 </tr> | |
| 462 <tr> | |
| 463 <td><a href="#QsciScintillaCompat.setIndentationGuideView">setIndentationGuideView</a></td> | |
| 464 <td>Public method to set the view of the indentation guides.</td> | |
| 465 </tr> | |
| 466 <tr> | |
| 467 <td><a href="#QsciScintillaCompat.setIndicator">setIndicator</a></td> | |
| 468 <td>Public method to set an indicator for the given range.</td> | |
| 469 </tr> | |
| 470 <tr> | |
| 471 <td><a href="#QsciScintillaCompat.setIndicatorRange">setIndicatorRange</a></td> | |
| 472 <td>Public method to set an indicator for the given range.</td> | |
| 473 </tr> | |
| 474 <tr> | |
| 475 <td><a href="#QsciScintillaCompat.setLexer">setLexer</a></td> | |
| 476 <td>Public method to set the lexer.</td> | |
| 477 </tr> | |
| 478 <tr> | |
| 479 <td><a href="#QsciScintillaCompat.setModified">setModified</a></td> | |
| 480 <td>Public slot to set the modification status.</td> | |
| 481 </tr> | |
| 482 <tr> | |
| 483 <td><a href="#QsciScintillaCompat.setRectangularSelection">setRectangularSelection</a></td> | |
| 484 <td>Public method to set a rectangular selection.</td> | |
| 485 </tr> | |
| 486 <tr> | |
| 487 <td><a href="#QsciScintillaCompat.setStyling">setStyling</a></td> | |
| 488 <td>Public method to style some text.</td> | |
| 489 </tr> | |
| 490 <tr> | |
| 491 <td><a href="#QsciScintillaCompat.setVirtualSpaceOptions">setVirtualSpaceOptions</a></td> | |
| 492 <td>Public method to set the virtual space usage options.</td> | |
| 493 </tr> | |
| 494 <tr> | |
| 495 <td><a href="#QsciScintillaCompat.setWrapStartIndent">setWrapStartIndent</a></td> | |
| 496 <td>Public method to set a the amount of characters wrapped sublines shall be indented.</td> | |
| 497 </tr> | |
| 498 <tr> | |
| 499 <td><a href="#QsciScintillaCompat.showFindIndicator">showFindIndicator</a></td> | |
| 500 <td>Public method to show the find indicator for the given range.</td> | |
| 501 </tr> | |
| 502 <tr> | |
| 503 <td><a href="#QsciScintillaCompat.showUserList">showUserList</a></td> | |
| 504 <td>Public method to show a user supplied list.</td> | |
| 505 </tr> | |
| 506 <tr> | |
| 507 <td><a href="#QsciScintillaCompat.startStyling">startStyling</a></td> | |
| 508 <td>Public method to prepare styling.</td> | |
| 509 </tr> | |
| 510 <tr> | |
| 511 <td><a href="#QsciScintillaCompat.styleAt">styleAt</a></td> | |
| 512 <td>Public method to get the style at a position in the text.</td> | |
| 513 </tr> | |
| 514 <tr> | |
| 515 <td><a href="#QsciScintillaCompat.updateUserListSize">updateUserListSize</a></td> | |
| 516 <td>Public method to resize the completion list to fit with contents.</td> | |
| 517 </tr> | |
| 518 <tr> | |
| 519 <td><a href="#QsciScintillaCompat.updateVerticalScrollBar">updateVerticalScrollBar</a></td> | |
| 520 <td>Public method to update the vertical scroll bar to reflect the additional lines added by annotations.</td> | |
| 521 </tr> | |
| 522 <tr> | |
| 523 <td><a href="#QsciScintillaCompat.zoomIn">zoomIn</a></td> | |
| 524 <td>Public method used to increase the zoom factor.</td> | |
| 525 </tr> | |
| 526 <tr> | |
| 527 <td><a href="#QsciScintillaCompat.zoomOut">zoomOut</a></td> | |
| 528 <td>Public method used to decrease the zoom factor.</td> | |
| 529 </tr> | |
| 530 <tr> | |
| 531 <td><a href="#QsciScintillaCompat.zoomTo">zoomTo</a></td> | |
| 532 <td>Public method used to zoom to a specific zoom factor.</td> | |
| 533 </tr> | |
| 534 </table> | |
| 535 <h3>Static Methods</h3> | |
| 536 | |
| 537 <table> | |
| 538 <tr><td>None</td></tr> | |
| 539 </table> | |
| 540 | |
| 541 <a NAME="QsciScintillaCompat.__init__" ID="QsciScintillaCompat.__init__"></a> | |
| 542 <h4>QsciScintillaCompat (Constructor)</h4> | |
| 543 <b>QsciScintillaCompat</b>(<i>parent=None</i>) | |
| 544 | |
| 545 <p> | |
| 546 Constructor | |
| 547 </p> | |
| 548 <dl> | |
| 549 | |
| 550 <dt><i>parent</i></dt> | |
| 551 <dd> | |
| 552 parent widget (QWidget) | |
| 553 </dd> | |
| 554 </dl> | |
| 555 <a NAME="QsciScintillaCompat.__completionListSelected" ID="QsciScintillaCompat.__completionListSelected"></a> | |
| 556 <h4>QsciScintillaCompat.__completionListSelected</h4> | |
| 557 <b>__completionListSelected</b>(<i>listId, txt</i>) | |
| 558 | |
| 559 <p> | |
| 560 Private slot to handle the selection from the completion list. | |
| 561 </p> | |
| 562 <p> | |
| 563 Note: This works around an issue of some window managers taking | |
| 564 focus away from the application when clicked inside a completion | |
| 565 list but not giving it back when an item is selected via a | |
| 566 double-click. | |
| 567 </p> | |
| 568 <dl> | |
| 569 | |
| 570 <dt><i>listId</i></dt> | |
| 571 <dd> | |
| 572 the ID of the user list (integer) | |
| 573 </dd> | |
| 574 <dt><i>txt</i></dt> | |
| 575 <dd> | |
| 576 the selected text (string) | |
| 577 </dd> | |
| 578 </dl> | |
| 579 <a NAME="QsciScintillaCompat.__doSearchTarget" ID="QsciScintillaCompat.__doSearchTarget"></a> | |
| 580 <h4>QsciScintillaCompat.__doSearchTarget</h4> | |
| 581 <b>__doSearchTarget</b>(<i></i>) | |
| 582 | |
| 583 <p> | |
| 584 Private method to perform the search in target. | |
| 585 </p> | |
| 586 <dl> | |
| 587 <dt>Return:</dt> | |
| 588 <dd> | |
| 589 flag indicating a successful search (boolean) | |
| 590 </dd> | |
| 591 </dl> | |
| 592 <a NAME="QsciScintillaCompat.__modificationChanged" ID="QsciScintillaCompat.__modificationChanged"></a> | |
| 593 <h4>QsciScintillaCompat.__modificationChanged</h4> | |
| 594 <b>__modificationChanged</b>(<i>m</i>) | |
| 595 | |
| 596 <p> | |
| 597 Private slot to handle the modificationChanged signal. | |
| 598 </p> | |
| 599 <dl> | |
| 600 | |
| 601 <dt><i>m</i></dt> | |
| 602 <dd> | |
| 603 modification status (boolean) | |
| 604 </dd> | |
| 605 </dl> | |
| 606 <a NAME="QsciScintillaCompat.__setFoldMarker" ID="QsciScintillaCompat.__setFoldMarker"></a> | |
| 607 <h4>QsciScintillaCompat.__setFoldMarker</h4> | |
| 608 <b>__setFoldMarker</b>(<i>marknr, mark=QsciScintilla.SC_MARK_EMPTY</i>) | |
| 609 | |
| 610 <p> | |
| 611 Private method to define a fold marker. | |
| 612 </p> | |
| 613 <dl> | |
| 614 | |
| 615 <dt><i>marknr</i></dt> | |
| 616 <dd> | |
| 617 marker number to define (integer) | |
| 618 </dd> | |
| 619 <dt><i>mark</i></dt> | |
| 620 <dd> | |
| 621 fold mark symbol to be used (integer) | |
| 622 </dd> | |
| 623 </dl> | |
| 624 <a NAME="QsciScintillaCompat._encodeString" ID="QsciScintillaCompat._encodeString"></a> | |
| 625 <h4>QsciScintillaCompat._encodeString</h4> | |
| 626 <b>_encodeString</b>(<i>string</i>) | |
| 627 | |
| 628 <p> | |
| 629 Protected method to encode a string depending on the current mode. | |
| 630 </p> | |
| 631 <dl> | |
| 632 | |
| 633 <dt><i>string</i></dt> | |
| 634 <dd> | |
| 635 string to be encoded (str) | |
| 636 </dd> | |
| 637 </dl> | |
| 638 <dl> | |
| 639 <dt>Return:</dt> | |
| 640 <dd> | |
| 641 encoded string (bytes) | |
| 642 </dd> | |
| 643 </dl> | |
| 644 <a NAME="QsciScintillaCompat.addCursor" ID="QsciScintillaCompat.addCursor"></a> | |
| 645 <h4>QsciScintillaCompat.addCursor</h4> | |
| 646 <b>addCursor</b>(<i>line, index</i>) | |
| 647 | |
| 648 <p> | |
| 649 Public method to add an additional cursor. | |
| 650 </p> | |
| 651 <dl> | |
| 652 | |
| 653 <dt><i>line</i> (int)</dt> | |
| 654 <dd> | |
| 655 line number for the cursor | |
| 656 </dd> | |
| 657 <dt><i>index</i> (int)</dt> | |
| 658 <dd> | |
| 659 index number for the cursor | |
| 660 </dd> | |
| 661 </dl> | |
| 662 <a NAME="QsciScintillaCompat.autoCompleteFromAPIs" ID="QsciScintillaCompat.autoCompleteFromAPIs"></a> | |
| 663 <h4>QsciScintillaCompat.autoCompleteFromAPIs</h4> | |
| 664 <b>autoCompleteFromAPIs</b>(<i></i>) | |
| 665 | |
| 666 <p> | |
| 667 Public method to resize list box after creation. | |
| 668 </p> | |
| 669 <a NAME="QsciScintillaCompat.autoCompleteFromAll" ID="QsciScintillaCompat.autoCompleteFromAll"></a> | |
| 670 <h4>QsciScintillaCompat.autoCompleteFromAll</h4> | |
| 671 <b>autoCompleteFromAll</b>(<i></i>) | |
| 672 | |
| 673 <p> | |
| 674 Public method to resize list box after creation. | |
| 675 </p> | |
| 676 <a NAME="QsciScintillaCompat.autoCompleteFromDocument" ID="QsciScintillaCompat.autoCompleteFromDocument"></a> | |
| 677 <h4>QsciScintillaCompat.autoCompleteFromDocument</h4> | |
| 678 <b>autoCompleteFromDocument</b>(<i></i>) | |
| 679 | |
| 680 <p> | |
| 681 Public method to resize list box after creation. | |
| 682 </p> | |
| 683 <a NAME="QsciScintillaCompat.byteAt" ID="QsciScintillaCompat.byteAt"></a> | |
| 684 <h4>QsciScintillaCompat.byteAt</h4> | |
| 685 <b>byteAt</b>(<i>pos</i>) | |
| 686 | |
| 687 <p> | |
| 688 Public method to get the raw character (bytes) at a position in the | |
| 689 text. | |
| 690 </p> | |
| 691 <dl> | |
| 692 | |
| 693 <dt><i>pos</i></dt> | |
| 694 <dd> | |
| 695 position in the text (integer) | |
| 696 </dd> | |
| 697 </dl> | |
| 698 <dl> | |
| 699 <dt>Return:</dt> | |
| 700 <dd> | |
| 701 raw character at the requested position or empty bytes, if the | |
| 702 position is negative or past the end of the document (bytes) | |
| 703 </dd> | |
| 704 </dl> | |
| 705 <a NAME="QsciScintillaCompat.canPaste" ID="QsciScintillaCompat.canPaste"></a> | |
| 706 <h4>QsciScintillaCompat.canPaste</h4> | |
| 707 <b>canPaste</b>(<i></i>) | |
| 708 | |
| 709 <p> | |
| 710 Public method to test, if the paste action is available (i.e. if the | |
| 711 clipboard contains some text). | |
| 712 </p> | |
| 713 <dl> | |
| 714 <dt>Return:</dt> | |
| 715 <dd> | |
| 716 flag indicating the availability of 'paste' | |
| 717 </dd> | |
| 718 </dl> | |
| 719 <dl> | |
| 720 <dt>Return Type:</dt> | |
| 721 <dd> | |
| 722 bool | |
| 723 </dd> | |
| 724 </dl> | |
| 725 <a NAME="QsciScintillaCompat.cancelCallTips" ID="QsciScintillaCompat.cancelCallTips"></a> | |
| 726 <h4>QsciScintillaCompat.cancelCallTips</h4> | |
| 727 <b>cancelCallTips</b>(<i></i>) | |
| 728 | |
| 729 <p> | |
| 730 Public method to cancel displayed call tips. | |
| 731 </p> | |
| 732 <a NAME="QsciScintillaCompat.charAt" ID="QsciScintillaCompat.charAt"></a> | |
| 733 <h4>QsciScintillaCompat.charAt</h4> | |
| 734 <b>charAt</b>(<i>pos</i>) | |
| 735 | |
| 736 <p> | |
| 737 Public method to get the character at a position in the text observing | |
| 738 multibyte characters. | |
| 739 </p> | |
| 740 <dl> | |
| 741 | |
| 742 <dt><i>pos</i></dt> | |
| 743 <dd> | |
| 744 position in the text (integer) | |
| 745 </dd> | |
| 746 </dl> | |
| 747 <dl> | |
| 748 <dt>Return:</dt> | |
| 749 <dd> | |
| 750 character at the requested position or empty string, if the | |
| 751 position is negative or past the end of the document (string) | |
| 752 </dd> | |
| 753 </dl> | |
| 754 <a NAME="QsciScintillaCompat.clearAllIndicators" ID="QsciScintillaCompat.clearAllIndicators"></a> | |
| 755 <h4>QsciScintillaCompat.clearAllIndicators</h4> | |
| 756 <b>clearAllIndicators</b>(<i>indicator</i>) | |
| 757 | |
| 758 <p> | |
| 759 Public method to clear all occurrences of an indicator. | |
| 760 </p> | |
| 761 <dl> | |
| 762 | |
| 763 <dt><i>indicator</i></dt> | |
| 764 <dd> | |
| 765 number of the indicator (integer, | |
| 766 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 767 </dd> | |
| 768 </dl> | |
| 769 <a NAME="QsciScintillaCompat.clearAlternateKeys" ID="QsciScintillaCompat.clearAlternateKeys"></a> | |
| 770 <h4>QsciScintillaCompat.clearAlternateKeys</h4> | |
| 771 <b>clearAlternateKeys</b>(<i></i>) | |
| 772 | |
| 773 <p> | |
| 774 Public method to clear the alternate key commands. | |
| 775 </p> | |
| 776 <a NAME="QsciScintillaCompat.clearIndicator" ID="QsciScintillaCompat.clearIndicator"></a> | |
| 777 <h4>QsciScintillaCompat.clearIndicator</h4> | |
| 778 <b>clearIndicator</b>(<i>indicator, sline, sindex, eline, eindex</i>) | |
| 779 | |
| 780 <p> | |
| 781 Public method to clear an indicator for the given range. | |
| 782 </p> | |
| 783 <dl> | |
| 784 | |
| 785 <dt><i>indicator</i></dt> | |
| 786 <dd> | |
| 787 number of the indicator (integer, | |
| 788 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 789 </dd> | |
| 790 <dt><i>sline</i></dt> | |
| 791 <dd> | |
| 792 line number of the indicator start (integer) | |
| 793 </dd> | |
| 794 <dt><i>sindex</i></dt> | |
| 795 <dd> | |
| 796 index of the indicator start (integer) | |
| 797 </dd> | |
| 798 <dt><i>eline</i></dt> | |
| 799 <dd> | |
| 800 line number of the indicator end (integer) | |
| 801 </dd> | |
| 802 <dt><i>eindex</i></dt> | |
| 803 <dd> | |
| 804 index of the indicator end (integer) | |
| 805 </dd> | |
| 806 </dl> | |
| 807 <a NAME="QsciScintillaCompat.clearIndicatorRange" ID="QsciScintillaCompat.clearIndicatorRange"></a> | |
| 808 <h4>QsciScintillaCompat.clearIndicatorRange</h4> | |
| 809 <b>clearIndicatorRange</b>(<i>indicator, spos, length</i>) | |
| 810 | |
| 811 <p> | |
| 812 Public method to clear an indicator for the given range. | |
| 813 </p> | |
| 814 <dl> | |
| 815 | |
| 816 <dt><i>indicator</i></dt> | |
| 817 <dd> | |
| 818 number of the indicator (integer, | |
| 819 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 820 </dd> | |
| 821 <dt><i>spos</i></dt> | |
| 822 <dd> | |
| 823 position of the indicator start (integer) | |
| 824 </dd> | |
| 825 <dt><i>length</i></dt> | |
| 826 <dd> | |
| 827 length of the indicator (integer) | |
| 828 </dd> | |
| 829 </dl> | |
| 830 <a NAME="QsciScintillaCompat.clearKeys" ID="QsciScintillaCompat.clearKeys"></a> | |
| 831 <h4>QsciScintillaCompat.clearKeys</h4> | |
| 832 <b>clearKeys</b>(<i></i>) | |
| 833 | |
| 834 <p> | |
| 835 Public method to clear the key commands. | |
| 836 </p> | |
| 837 <a NAME="QsciScintillaCompat.clearStyles" ID="QsciScintillaCompat.clearStyles"></a> | |
| 838 <h4>QsciScintillaCompat.clearStyles</h4> | |
| 839 <b>clearStyles</b>(<i></i>) | |
| 840 | |
| 841 <p> | |
| 842 Public method to set the styles according the selected Qt style. | |
| 843 </p> | |
| 844 <a NAME="QsciScintillaCompat.currentPosition" ID="QsciScintillaCompat.currentPosition"></a> | |
| 845 <h4>QsciScintillaCompat.currentPosition</h4> | |
| 846 <b>currentPosition</b>(<i></i>) | |
| 847 | |
| 848 <p> | |
| 849 Public method to get the current position. | |
| 850 </p> | |
| 851 <dl> | |
| 852 <dt>Return:</dt> | |
| 853 <dd> | |
| 854 absolute position of the cursor (integer) | |
| 855 </dd> | |
| 856 </dl> | |
| 857 <a NAME="QsciScintillaCompat.currentStyle" ID="QsciScintillaCompat.currentStyle"></a> | |
| 858 <h4>QsciScintillaCompat.currentStyle</h4> | |
| 859 <b>currentStyle</b>(<i></i>) | |
| 860 | |
| 861 <p> | |
| 862 Public method to get the style at the current position. | |
| 863 </p> | |
| 864 <dl> | |
| 865 <dt>Return:</dt> | |
| 866 <dd> | |
| 867 style at the current position (integer) | |
| 868 </dd> | |
| 869 </dl> | |
| 870 <a NAME="QsciScintillaCompat.delete" ID="QsciScintillaCompat.delete"></a> | |
| 871 <h4>QsciScintillaCompat.delete</h4> | |
| 872 <b>delete</b>(<i></i>) | |
| 873 | |
| 874 <p> | |
| 875 Public method to delete the character to the right of the cursor. | |
| 876 </p> | |
| 877 <a NAME="QsciScintillaCompat.deleteBack" ID="QsciScintillaCompat.deleteBack"></a> | |
| 878 <h4>QsciScintillaCompat.deleteBack</h4> | |
| 879 <b>deleteBack</b>(<i></i>) | |
| 880 | |
| 881 <p> | |
| 882 Public method to delete the character to the left of the cursor. | |
| 883 </p> | |
| 884 <a NAME="QsciScintillaCompat.deleteLineLeft" ID="QsciScintillaCompat.deleteLineLeft"></a> | |
| 885 <h4>QsciScintillaCompat.deleteLineLeft</h4> | |
| 886 <b>deleteLineLeft</b>(<i></i>) | |
| 887 | |
| 888 <p> | |
| 889 Public method to delete the line to the left of the cursor. | |
| 890 </p> | |
| 891 <a NAME="QsciScintillaCompat.deleteLineRight" ID="QsciScintillaCompat.deleteLineRight"></a> | |
| 892 <h4>QsciScintillaCompat.deleteLineRight</h4> | |
| 893 <b>deleteLineRight</b>(<i></i>) | |
| 894 | |
| 895 <p> | |
| 896 Public method to delete the line to the right of the cursor. | |
| 897 </p> | |
| 898 <a NAME="QsciScintillaCompat.deleteWordLeft" ID="QsciScintillaCompat.deleteWordLeft"></a> | |
| 899 <h4>QsciScintillaCompat.deleteWordLeft</h4> | |
| 900 <b>deleteWordLeft</b>(<i></i>) | |
| 901 | |
| 902 <p> | |
| 903 Public method to delete the word to the left of the cursor. | |
| 904 </p> | |
| 905 <a NAME="QsciScintillaCompat.deleteWordRight" ID="QsciScintillaCompat.deleteWordRight"></a> | |
| 906 <h4>QsciScintillaCompat.deleteWordRight</h4> | |
| 907 <b>deleteWordRight</b>(<i></i>) | |
| 908 | |
| 909 <p> | |
| 910 Public method to delete the word to the right of the cursor. | |
| 911 </p> | |
| 912 <a NAME="QsciScintillaCompat.detectEolString" ID="QsciScintillaCompat.detectEolString"></a> | |
| 913 <h4>QsciScintillaCompat.detectEolString</h4> | |
| 914 <b>detectEolString</b>(<i>txt</i>) | |
| 915 | |
| 916 <p> | |
| 917 Public method to determine the eol string used. | |
| 918 </p> | |
| 919 <dl> | |
| 920 | |
| 921 <dt><i>txt</i></dt> | |
| 922 <dd> | |
| 923 text from which to determine the eol string (string) | |
| 924 </dd> | |
| 925 </dl> | |
| 926 <dl> | |
| 927 <dt>Return:</dt> | |
| 928 <dd> | |
| 929 eol string (string) | |
| 930 </dd> | |
| 931 </dl> | |
| 932 <a NAME="QsciScintillaCompat.editorCommand" ID="QsciScintillaCompat.editorCommand"></a> | |
| 933 <h4>QsciScintillaCompat.editorCommand</h4> | |
| 934 <b>editorCommand</b>(<i>cmd</i>) | |
| 935 | |
| 936 <p> | |
| 937 Public method to perform a simple editor command. | |
| 938 </p> | |
| 939 <dl> | |
| 940 | |
| 941 <dt><i>cmd</i></dt> | |
| 942 <dd> | |
| 943 the scintilla command to be performed (integer) | |
| 944 </dd> | |
| 945 </dl> | |
| 946 <a NAME="QsciScintillaCompat.enableMultiCursorSupport" ID="QsciScintillaCompat.enableMultiCursorSupport"></a> | |
| 947 <h4>QsciScintillaCompat.enableMultiCursorSupport</h4> | |
| 948 <b>enableMultiCursorSupport</b>(<i></i>) | |
| 949 | |
| 950 <p> | |
| 951 Public method to enable support for multi cursor editing. | |
| 952 </p> | |
| 953 <a NAME="QsciScintillaCompat.event" ID="QsciScintillaCompat.event"></a> | |
| 954 <h4>QsciScintillaCompat.event</h4> | |
| 955 <b>event</b>(<i>evt</i>) | |
| 956 | |
| 957 <p> | |
| 958 Public method to handle events. | |
| 959 </p> | |
| 960 <p> | |
| 961 Note: We are not interested in the standard QsciScintilla event | |
| 962 handling because we do it ourselves. | |
| 963 </p> | |
| 964 <dl> | |
| 965 | |
| 966 <dt><i>evt</i></dt> | |
| 967 <dd> | |
| 968 event object to handle (QEvent) | |
| 969 </dd> | |
| 970 </dl> | |
| 971 <dl> | |
| 972 <dt>Return:</dt> | |
| 973 <dd> | |
| 974 result of the event handling (boolean) | |
| 975 </dd> | |
| 976 </dl> | |
| 977 <a NAME="QsciScintillaCompat.extendSelectionLeft" ID="QsciScintillaCompat.extendSelectionLeft"></a> | |
| 978 <h4>QsciScintillaCompat.extendSelectionLeft</h4> | |
| 979 <b>extendSelectionLeft</b>(<i></i>) | |
| 980 | |
| 981 <p> | |
| 982 Public method to extend the selection one character to the left. | |
| 983 </p> | |
| 984 <a NAME="QsciScintillaCompat.extendSelectionRight" ID="QsciScintillaCompat.extendSelectionRight"></a> | |
| 985 <h4>QsciScintillaCompat.extendSelectionRight</h4> | |
| 986 <b>extendSelectionRight</b>(<i></i>) | |
| 987 | |
| 988 <p> | |
| 989 Public method to extend the selection one character to the right. | |
| 990 </p> | |
| 991 <a NAME="QsciScintillaCompat.extendSelectionToBOL" ID="QsciScintillaCompat.extendSelectionToBOL"></a> | |
| 992 <h4>QsciScintillaCompat.extendSelectionToBOL</h4> | |
| 993 <b>extendSelectionToBOL</b>(<i></i>) | |
| 994 | |
| 995 <p> | |
| 996 Public method to extend the selection to the beginning of the line. | |
| 997 </p> | |
| 998 <a NAME="QsciScintillaCompat.extendSelectionToEOL" ID="QsciScintillaCompat.extendSelectionToEOL"></a> | |
| 999 <h4>QsciScintillaCompat.extendSelectionToEOL</h4> | |
| 1000 <b>extendSelectionToEOL</b>(<i></i>) | |
| 1001 | |
| 1002 <p> | |
| 1003 Public method to extend the selection to the end of the line. | |
| 1004 </p> | |
| 1005 <a NAME="QsciScintillaCompat.extendSelectionWordLeft" ID="QsciScintillaCompat.extendSelectionWordLeft"></a> | |
| 1006 <h4>QsciScintillaCompat.extendSelectionWordLeft</h4> | |
| 1007 <b>extendSelectionWordLeft</b>(<i></i>) | |
| 1008 | |
| 1009 <p> | |
| 1010 Public method to extend the selection one word to the left. | |
| 1011 </p> | |
| 1012 <a NAME="QsciScintillaCompat.extendSelectionWordRight" ID="QsciScintillaCompat.extendSelectionWordRight"></a> | |
| 1013 <h4>QsciScintillaCompat.extendSelectionWordRight</h4> | |
| 1014 <b>extendSelectionWordRight</b>(<i></i>) | |
| 1015 | |
| 1016 <p> | |
| 1017 Public method to extend the selection one word to the right. | |
| 1018 </p> | |
| 1019 <a NAME="QsciScintillaCompat.findFirstTarget" ID="QsciScintillaCompat.findFirstTarget"></a> | |
| 1020 <h4>QsciScintillaCompat.findFirstTarget</h4> | |
| 1021 <b>findFirstTarget</b>(<i>expr_, re_, cs_, wo_, begline=-1, begindex=-1, endline=-1, endindex=-1, ws_=False, posix=False, cxx11=False</i>) | |
| 1022 | |
| 1023 <p> | |
| 1024 Public method to search in a specified range of text without | |
| 1025 setting the selection. | |
| 1026 </p> | |
| 1027 <dl> | |
| 1028 | |
| 1029 <dt><i>expr_</i> (str)</dt> | |
| 1030 <dd> | |
| 1031 search expression | |
| 1032 </dd> | |
| 1033 <dt><i>re_</i> (bool)</dt> | |
| 1034 <dd> | |
| 1035 flag indicating a regular expression | |
| 1036 </dd> | |
| 1037 <dt><i>cs_</i> (bool)</dt> | |
| 1038 <dd> | |
| 1039 flag indicating a case sensitive search | |
| 1040 </dd> | |
| 1041 <dt><i>wo_</i> (bool)</dt> | |
| 1042 <dd> | |
| 1043 flag indicating a word only search | |
| 1044 </dd> | |
| 1045 <dt><i>begline</i> (int)</dt> | |
| 1046 <dd> | |
| 1047 line number to start from (-1 to indicate current | |
| 1048 position) | |
| 1049 </dd> | |
| 1050 <dt><i>begindex</i> (int)</dt> | |
| 1051 <dd> | |
| 1052 index to start from (-1 to indicate current position) | |
| 1053 </dd> | |
| 1054 <dt><i>endline</i> (int)</dt> | |
| 1055 <dd> | |
| 1056 line number to stop at (-1 to indicate end of document) | |
| 1057 </dd> | |
| 1058 <dt><i>endindex</i> (int)</dt> | |
| 1059 <dd> | |
| 1060 index number to stop at (-1 to indicate end of | |
| 1061 document) | |
| 1062 </dd> | |
| 1063 <dt><i>ws_</i> (bool)</dt> | |
| 1064 <dd> | |
| 1065 flag indicating a word start search (boolean) | |
| 1066 </dd> | |
| 1067 <dt><i>posix</i> (bool)</dt> | |
| 1068 <dd> | |
| 1069 | |
| 1070 </dd> | |
| 1071 <dt><i>cxx11</i> (bool)</dt> | |
| 1072 <dd> | |
| 1073 | |
| 1074 </dd> | |
| 1075 </dl> | |
| 1076 <dl> | |
| 1077 <dt>Return:</dt> | |
| 1078 <dd> | |
| 1079 flag indicating a successful search | |
| 1080 </dd> | |
| 1081 </dl> | |
| 1082 <dl> | |
| 1083 <dt>Return Type:</dt> | |
| 1084 <dd> | |
| 1085 bool | |
| 1086 </dd> | |
| 1087 </dl> | |
| 1088 <a NAME="QsciScintillaCompat.findNextTarget" ID="QsciScintillaCompat.findNextTarget"></a> | |
| 1089 <h4>QsciScintillaCompat.findNextTarget</h4> | |
| 1090 <b>findNextTarget</b>(<i></i>) | |
| 1091 | |
| 1092 <p> | |
| 1093 Public method to find the next occurrence in the target range. | |
| 1094 </p> | |
| 1095 <dl> | |
| 1096 <dt>Return:</dt> | |
| 1097 <dd> | |
| 1098 flag indicating a successful search (boolean) | |
| 1099 </dd> | |
| 1100 </dl> | |
| 1101 <a NAME="QsciScintillaCompat.flashFindIndicator" ID="QsciScintillaCompat.flashFindIndicator"></a> | |
| 1102 <h4>QsciScintillaCompat.flashFindIndicator</h4> | |
| 1103 <b>flashFindIndicator</b>(<i>sline, sindex, eline, eindex</i>) | |
| 1104 | |
| 1105 <p> | |
| 1106 Public method to flash the find indicator for the given range. | |
| 1107 </p> | |
| 1108 <dl> | |
| 1109 | |
| 1110 <dt><i>sline</i></dt> | |
| 1111 <dd> | |
| 1112 line number of the indicator start (integer) | |
| 1113 </dd> | |
| 1114 <dt><i>sindex</i></dt> | |
| 1115 <dd> | |
| 1116 index of the indicator start (integer) | |
| 1117 </dd> | |
| 1118 <dt><i>eline</i></dt> | |
| 1119 <dd> | |
| 1120 line number of the indicator end (integer) | |
| 1121 </dd> | |
| 1122 <dt><i>eindex</i></dt> | |
| 1123 <dd> | |
| 1124 index of the indicator end (integer) | |
| 1125 </dd> | |
| 1126 </dl> | |
| 1127 <a NAME="QsciScintillaCompat.focusOutEvent" ID="QsciScintillaCompat.focusOutEvent"></a> | |
| 1128 <h4>QsciScintillaCompat.focusOutEvent</h4> | |
| 1129 <b>focusOutEvent</b>(<i>event</i>) | |
| 1130 | |
| 1131 <p> | |
| 1132 Protected method called when the editor loses focus. | |
| 1133 </p> | |
| 1134 <dl> | |
| 1135 | |
| 1136 <dt><i>event</i></dt> | |
| 1137 <dd> | |
| 1138 event object (QFocusEvent) | |
| 1139 </dd> | |
| 1140 </dl> | |
| 1141 <a NAME="QsciScintillaCompat.foldExpandedAt" ID="QsciScintillaCompat.foldExpandedAt"></a> | |
| 1142 <h4>QsciScintillaCompat.foldExpandedAt</h4> | |
| 1143 <b>foldExpandedAt</b>(<i>line</i>) | |
| 1144 | |
| 1145 <p> | |
| 1146 Public method to determine, if a fold is expanded. | |
| 1147 </p> | |
| 1148 <dl> | |
| 1149 | |
| 1150 <dt><i>line</i></dt> | |
| 1151 <dd> | |
| 1152 line number (integer) | |
| 1153 </dd> | |
| 1154 </dl> | |
| 1155 <dl> | |
| 1156 <dt>Return:</dt> | |
| 1157 <dd> | |
| 1158 flag indicating the fold expansion state of the line (boolean) | |
| 1159 </dd> | |
| 1160 </dl> | |
| 1161 <a NAME="QsciScintillaCompat.foldFlagsAt" ID="QsciScintillaCompat.foldFlagsAt"></a> | |
| 1162 <h4>QsciScintillaCompat.foldFlagsAt</h4> | |
| 1163 <b>foldFlagsAt</b>(<i>line</i>) | |
| 1164 | |
| 1165 <p> | |
| 1166 Public method to get the fold flags of a line of the document. | |
| 1167 </p> | |
| 1168 <dl> | |
| 1169 | |
| 1170 <dt><i>line</i></dt> | |
| 1171 <dd> | |
| 1172 line number (integer) | |
| 1173 </dd> | |
| 1174 </dl> | |
| 1175 <dl> | |
| 1176 <dt>Return:</dt> | |
| 1177 <dd> | |
| 1178 fold flags of the given line (integer) | |
| 1179 </dd> | |
| 1180 </dl> | |
| 1181 <a NAME="QsciScintillaCompat.foldHeaderAt" ID="QsciScintillaCompat.foldHeaderAt"></a> | |
| 1182 <h4>QsciScintillaCompat.foldHeaderAt</h4> | |
| 1183 <b>foldHeaderAt</b>(<i>line</i>) | |
| 1184 | |
| 1185 <p> | |
| 1186 Public method to determine, if a line of the document is a fold header | |
| 1187 line. | |
| 1188 </p> | |
| 1189 <dl> | |
| 1190 | |
| 1191 <dt><i>line</i></dt> | |
| 1192 <dd> | |
| 1193 line number (integer) | |
| 1194 </dd> | |
| 1195 </dl> | |
| 1196 <dl> | |
| 1197 <dt>Return:</dt> | |
| 1198 <dd> | |
| 1199 flag indicating a fold header line (boolean) | |
| 1200 </dd> | |
| 1201 </dl> | |
| 1202 <a NAME="QsciScintillaCompat.foldLevelAt" ID="QsciScintillaCompat.foldLevelAt"></a> | |
| 1203 <h4>QsciScintillaCompat.foldLevelAt</h4> | |
| 1204 <b>foldLevelAt</b>(<i>line</i>) | |
| 1205 | |
| 1206 <p> | |
| 1207 Public method to get the fold level of a line of the document. | |
| 1208 </p> | |
| 1209 <dl> | |
| 1210 | |
| 1211 <dt><i>line</i></dt> | |
| 1212 <dd> | |
| 1213 line number (integer) | |
| 1214 </dd> | |
| 1215 </dl> | |
| 1216 <dl> | |
| 1217 <dt>Return:</dt> | |
| 1218 <dd> | |
| 1219 fold level of the given line (integer) | |
| 1220 </dd> | |
| 1221 </dl> | |
| 1222 <a NAME="QsciScintillaCompat.getCaretLineAlwaysVisible" ID="QsciScintillaCompat.getCaretLineAlwaysVisible"></a> | |
| 1223 <h4>QsciScintillaCompat.getCaretLineAlwaysVisible</h4> | |
| 1224 <b>getCaretLineAlwaysVisible</b>(<i></i>) | |
| 1225 | |
| 1226 <p> | |
| 1227 Public method to determine, if the caret line is visible even if | |
| 1228 the editor doesn't have the focus. | |
| 1229 </p> | |
| 1230 <dl> | |
| 1231 <dt>Return:</dt> | |
| 1232 <dd> | |
| 1233 flag indicating an always visible caret line (boolean) | |
| 1234 </dd> | |
| 1235 </dl> | |
| 1236 <a NAME="QsciScintillaCompat.getCursorFlashTime" ID="QsciScintillaCompat.getCursorFlashTime"></a> | |
| 1237 <h4>QsciScintillaCompat.getCursorFlashTime</h4> | |
| 1238 <b>getCursorFlashTime</b>(<i></i>) | |
| 1239 | |
| 1240 <p> | |
| 1241 Public method to get the flash (blink) time of the cursor in | |
| 1242 milliseconds. | |
| 1243 </p> | |
| 1244 <p> | |
| 1245 The flash time is the time required to display, invert and restore the | |
| 1246 caret display. Usually the text cursor is displayed for half the cursor | |
| 1247 flash time, then hidden for the same amount of time. | |
| 1248 </p> | |
| 1249 <dl> | |
| 1250 <dt>Return:</dt> | |
| 1251 <dd> | |
| 1252 flash time of the cursor in milliseconds (integer) | |
| 1253 </dd> | |
| 1254 </dl> | |
| 1255 <a NAME="QsciScintillaCompat.getDocLineFromVisibleLine" ID="QsciScintillaCompat.getDocLineFromVisibleLine"></a> | |
| 1256 <h4>QsciScintillaCompat.getDocLineFromVisibleLine</h4> | |
| 1257 <b>getDocLineFromVisibleLine</b>(<i>displayLine</i>) | |
| 1258 | |
| 1259 <p> | |
| 1260 Public method to convert a visible line number to a document line | |
| 1261 number (i.e. respect folded lines and annotations). | |
| 1262 </p> | |
| 1263 <dl> | |
| 1264 | |
| 1265 <dt><i>displayLine</i> (int)</dt> | |
| 1266 <dd> | |
| 1267 display line number to be converted | |
| 1268 </dd> | |
| 1269 </dl> | |
| 1270 <dl> | |
| 1271 <dt>Return:</dt> | |
| 1272 <dd> | |
| 1273 document line number | |
| 1274 </dd> | |
| 1275 </dl> | |
| 1276 <dl> | |
| 1277 <dt>Return Type:</dt> | |
| 1278 <dd> | |
| 1279 int | |
| 1280 </dd> | |
| 1281 </dl> | |
| 1282 <a NAME="QsciScintillaCompat.getEndStyled" ID="QsciScintillaCompat.getEndStyled"></a> | |
| 1283 <h4>QsciScintillaCompat.getEndStyled</h4> | |
| 1284 <b>getEndStyled</b>(<i></i>) | |
| 1285 | |
| 1286 <p> | |
| 1287 Public method to get the last styled position. | |
| 1288 </p> | |
| 1289 <dl> | |
| 1290 <dt>Return:</dt> | |
| 1291 <dd> | |
| 1292 end position of the last styling run (integer) | |
| 1293 </dd> | |
| 1294 </dl> | |
| 1295 <a NAME="QsciScintillaCompat.getEolIndicator" ID="QsciScintillaCompat.getEolIndicator"></a> | |
| 1296 <h4>QsciScintillaCompat.getEolIndicator</h4> | |
| 1297 <b>getEolIndicator</b>(<i></i>) | |
| 1298 | |
| 1299 <p> | |
| 1300 Public method to get the eol indicator for the current eol mode. | |
| 1301 </p> | |
| 1302 <dl> | |
| 1303 <dt>Return:</dt> | |
| 1304 <dd> | |
| 1305 eol indicator (string) | |
| 1306 </dd> | |
| 1307 </dl> | |
| 1308 <a NAME="QsciScintillaCompat.getFileName" ID="QsciScintillaCompat.getFileName"></a> | |
| 1309 <h4>QsciScintillaCompat.getFileName</h4> | |
| 1310 <b>getFileName</b>(<i></i>) | |
| 1311 | |
| 1312 <p> | |
| 1313 Public method to return the name of the file being displayed. | |
| 1314 </p> | |
| 1315 <dl> | |
| 1316 <dt>Return:</dt> | |
| 1317 <dd> | |
| 1318 filename of the displayed file (string) | |
| 1319 </dd> | |
| 1320 </dl> | |
| 1321 <a NAME="QsciScintillaCompat.getFoundTarget" ID="QsciScintillaCompat.getFoundTarget"></a> | |
| 1322 <h4>QsciScintillaCompat.getFoundTarget</h4> | |
| 1323 <b>getFoundTarget</b>(<i></i>) | |
| 1324 | |
| 1325 <p> | |
| 1326 Public method to get the recently found target. | |
| 1327 </p> | |
| 1328 <dl> | |
| 1329 <dt>Return:</dt> | |
| 1330 <dd> | |
| 1331 found target as a tuple of starting position and target length | |
| 1332 (integer, integer) | |
| 1333 </dd> | |
| 1334 </dl> | |
| 1335 <a NAME="QsciScintillaCompat.getGlobalCursorPosition" ID="QsciScintillaCompat.getGlobalCursorPosition"></a> | |
| 1336 <h4>QsciScintillaCompat.getGlobalCursorPosition</h4> | |
| 1337 <b>getGlobalCursorPosition</b>(<i></i>) | |
| 1338 | |
| 1339 <p> | |
| 1340 Public method to determine the point of the cursor. | |
| 1341 </p> | |
| 1342 <dl> | |
| 1343 <dt>Return:</dt> | |
| 1344 <dd> | |
| 1345 point of the cursor | |
| 1346 </dd> | |
| 1347 </dl> | |
| 1348 <dl> | |
| 1349 <dt>Return Type:</dt> | |
| 1350 <dd> | |
| 1351 QPoint | |
| 1352 </dd> | |
| 1353 </dl> | |
| 1354 <a NAME="QsciScintillaCompat.getIndicatorEndPos" ID="QsciScintillaCompat.getIndicatorEndPos"></a> | |
| 1355 <h4>QsciScintillaCompat.getIndicatorEndPos</h4> | |
| 1356 <b>getIndicatorEndPos</b>(<i>indicator, pos</i>) | |
| 1357 | |
| 1358 <p> | |
| 1359 Public method to get the end position of an indicator at a position. | |
| 1360 </p> | |
| 1361 <dl> | |
| 1362 | |
| 1363 <dt><i>indicator</i></dt> | |
| 1364 <dd> | |
| 1365 ID of the indicator (integer) | |
| 1366 </dd> | |
| 1367 <dt><i>pos</i></dt> | |
| 1368 <dd> | |
| 1369 position within the indicator (integer) | |
| 1370 </dd> | |
| 1371 </dl> | |
| 1372 <dl> | |
| 1373 <dt>Return:</dt> | |
| 1374 <dd> | |
| 1375 end position of the indicator (integer) | |
| 1376 </dd> | |
| 1377 </dl> | |
| 1378 <a NAME="QsciScintillaCompat.getIndicatorStartPos" ID="QsciScintillaCompat.getIndicatorStartPos"></a> | |
| 1379 <h4>QsciScintillaCompat.getIndicatorStartPos</h4> | |
| 1380 <b>getIndicatorStartPos</b>(<i>indicator, pos</i>) | |
| 1381 | |
| 1382 <p> | |
| 1383 Public method to get the start position of an indicator at a position. | |
| 1384 </p> | |
| 1385 <dl> | |
| 1386 | |
| 1387 <dt><i>indicator</i></dt> | |
| 1388 <dd> | |
| 1389 ID of the indicator (integer) | |
| 1390 </dd> | |
| 1391 <dt><i>pos</i></dt> | |
| 1392 <dd> | |
| 1393 position within the indicator (integer) | |
| 1394 </dd> | |
| 1395 </dl> | |
| 1396 <dl> | |
| 1397 <dt>Return:</dt> | |
| 1398 <dd> | |
| 1399 start position of the indicator (integer) | |
| 1400 </dd> | |
| 1401 </dl> | |
| 1402 <a NAME="QsciScintillaCompat.getLineSeparator" ID="QsciScintillaCompat.getLineSeparator"></a> | |
| 1403 <h4>QsciScintillaCompat.getLineSeparator</h4> | |
| 1404 <b>getLineSeparator</b>(<i></i>) | |
| 1405 | |
| 1406 <p> | |
| 1407 Public method to get the line separator for the current eol mode. | |
| 1408 </p> | |
| 1409 <dl> | |
| 1410 <dt>Return:</dt> | |
| 1411 <dd> | |
| 1412 eol string (string) | |
| 1413 </dd> | |
| 1414 </dl> | |
| 1415 <a NAME="QsciScintillaCompat.getRectangularSelection" ID="QsciScintillaCompat.getRectangularSelection"></a> | |
| 1416 <h4>QsciScintillaCompat.getRectangularSelection</h4> | |
| 1417 <b>getRectangularSelection</b>(<i></i>) | |
| 1418 | |
| 1419 <p> | |
| 1420 Public method to retrieve the start and end of a rectangular selection. | |
| 1421 </p> | |
| 1422 <dl> | |
| 1423 <dt>Return:</dt> | |
| 1424 <dd> | |
| 1425 tuple with start line and index and end line and index | |
| 1426 (tuple of four int) | |
| 1427 </dd> | |
| 1428 </dl> | |
| 1429 <a NAME="QsciScintillaCompat.getSelectionCount" ID="QsciScintillaCompat.getSelectionCount"></a> | |
| 1430 <h4>QsciScintillaCompat.getSelectionCount</h4> | |
| 1431 <b>getSelectionCount</b>(<i></i>) | |
| 1432 | |
| 1433 <p> | |
| 1434 Public method to get the number of active selections. | |
| 1435 </p> | |
| 1436 <dl> | |
| 1437 <dt>Return:</dt> | |
| 1438 <dd> | |
| 1439 number of active selection (integer) | |
| 1440 </dd> | |
| 1441 </dl> | |
| 1442 <a NAME="QsciScintillaCompat.getSelectionN" ID="QsciScintillaCompat.getSelectionN"></a> | |
| 1443 <h4>QsciScintillaCompat.getSelectionN</h4> | |
| 1444 <b>getSelectionN</b>(<i>index</i>) | |
| 1445 | |
| 1446 <p> | |
| 1447 Public method to get the start and end of a selection given by its | |
| 1448 index. | |
| 1449 </p> | |
| 1450 <dl> | |
| 1451 | |
| 1452 <dt><i>index</i></dt> | |
| 1453 <dd> | |
| 1454 index of the selection (integer) | |
| 1455 </dd> | |
| 1456 </dl> | |
| 1457 <dl> | |
| 1458 <dt>Return:</dt> | |
| 1459 <dd> | |
| 1460 tuple with start line and index and end line and index | |
| 1461 (tuple of four int) for the given selection | |
| 1462 </dd> | |
| 1463 </dl> | |
| 1464 <a NAME="QsciScintillaCompat.getSelections" ID="QsciScintillaCompat.getSelections"></a> | |
| 1465 <h4>QsciScintillaCompat.getSelections</h4> | |
| 1466 <b>getSelections</b>(<i></i>) | |
| 1467 | |
| 1468 <p> | |
| 1469 Public method to get the start and end coordinates of all active | |
| 1470 selections. | |
| 1471 </p> | |
| 1472 <dl> | |
| 1473 <dt>Return:</dt> | |
| 1474 <dd> | |
| 1475 list of tuples with start line and index and end line and index | |
| 1476 of each active selection (list of tuples of four int) | |
| 1477 </dd> | |
| 1478 </dl> | |
| 1479 <a NAME="QsciScintillaCompat.getSubStyleRange" ID="QsciScintillaCompat.getSubStyleRange"></a> | |
| 1480 <h4>QsciScintillaCompat.getSubStyleRange</h4> | |
| 1481 <b>getSubStyleRange</b>(<i>styleNr</i>) | |
| 1482 | |
| 1483 <p> | |
| 1484 Public method to get the sub style range for given style number. | |
| 1485 </p> | |
| 1486 <dl> | |
| 1487 | |
| 1488 <dt><i>styleNr</i> (int)</dt> | |
| 1489 <dd> | |
| 1490 Number of the base style | |
| 1491 </dd> | |
| 1492 </dl> | |
| 1493 <dl> | |
| 1494 <dt>Return:</dt> | |
| 1495 <dd> | |
| 1496 start index of the sub style and their count | |
| 1497 </dd> | |
| 1498 </dl> | |
| 1499 <dl> | |
| 1500 <dt>Return Type:</dt> | |
| 1501 <dd> | |
| 1502 int, int | |
| 1503 </dd> | |
| 1504 </dl> | |
| 1505 <a NAME="QsciScintillaCompat.getVisibleLineFromDocLine" ID="QsciScintillaCompat.getVisibleLineFromDocLine"></a> | |
| 1506 <h4>QsciScintillaCompat.getVisibleLineFromDocLine</h4> | |
| 1507 <b>getVisibleLineFromDocLine</b>(<i>docLine</i>) | |
| 1508 | |
| 1509 <p> | |
| 1510 Public method to convert a document line number to a visible line | |
| 1511 number (i.e. respect folded lines and annotations). | |
| 1512 </p> | |
| 1513 <dl> | |
| 1514 | |
| 1515 <dt><i>docLine</i> (int)</dt> | |
| 1516 <dd> | |
| 1517 document line number to be converted | |
| 1518 </dd> | |
| 1519 </dl> | |
| 1520 <dl> | |
| 1521 <dt>Return:</dt> | |
| 1522 <dd> | |
| 1523 visible line number | |
| 1524 </dd> | |
| 1525 </dl> | |
| 1526 <dl> | |
| 1527 <dt>Return Type:</dt> | |
| 1528 <dd> | |
| 1529 int | |
| 1530 </dd> | |
| 1531 </dl> | |
| 1532 <a NAME="QsciScintillaCompat.getZoom" ID="QsciScintillaCompat.getZoom"></a> | |
| 1533 <h4>QsciScintillaCompat.getZoom</h4> | |
| 1534 <b>getZoom</b>(<i></i>) | |
| 1535 | |
| 1536 <p> | |
| 1537 Public method used to retrieve the current zoom factor. | |
| 1538 </p> | |
| 1539 <dl> | |
| 1540 <dt>Return:</dt> | |
| 1541 <dd> | |
| 1542 zoom factor (integer) | |
| 1543 </dd> | |
| 1544 </dl> | |
| 1545 <a NAME="QsciScintillaCompat.gotoNextIndicator" ID="QsciScintillaCompat.gotoNextIndicator"></a> | |
| 1546 <h4>QsciScintillaCompat.gotoNextIndicator</h4> | |
| 1547 <b>gotoNextIndicator</b>(<i>indicator, wrap</i>) | |
| 1548 | |
| 1549 <p> | |
| 1550 Public method to move the cursor to the next position of an indicator. | |
| 1551 </p> | |
| 1552 <p> | |
| 1553 This method ensures, that the position found is visible (i.e. unfolded | |
| 1554 and inside the visible range). The text containing the indicator is | |
| 1555 selected. | |
| 1556 </p> | |
| 1557 <dl> | |
| 1558 | |
| 1559 <dt><i>indicator</i></dt> | |
| 1560 <dd> | |
| 1561 ID of the indicator to search (integer) | |
| 1562 </dd> | |
| 1563 <dt><i>wrap</i></dt> | |
| 1564 <dd> | |
| 1565 flag indicating to wrap around at the beginning of the | |
| 1566 text (boolean) | |
| 1567 </dd> | |
| 1568 </dl> | |
| 1569 <dl> | |
| 1570 <dt>Return:</dt> | |
| 1571 <dd> | |
| 1572 flag indicating if the indicator was found (boolean) | |
| 1573 </dd> | |
| 1574 </dl> | |
| 1575 <a NAME="QsciScintillaCompat.gotoPreviousIndicator" ID="QsciScintillaCompat.gotoPreviousIndicator"></a> | |
| 1576 <h4>QsciScintillaCompat.gotoPreviousIndicator</h4> | |
| 1577 <b>gotoPreviousIndicator</b>(<i>indicator, wrap</i>) | |
| 1578 | |
| 1579 <p> | |
| 1580 Public method to move the cursor to the previous position of an | |
| 1581 indicator. | |
| 1582 </p> | |
| 1583 <p> | |
| 1584 This method ensures, that the position found is visible (i.e. unfolded | |
| 1585 and inside the visible range). The text containing the indicator is | |
| 1586 selected. | |
| 1587 </p> | |
| 1588 <dl> | |
| 1589 | |
| 1590 <dt><i>indicator</i></dt> | |
| 1591 <dd> | |
| 1592 ID of the indicator to search (integer) | |
| 1593 </dd> | |
| 1594 <dt><i>wrap</i></dt> | |
| 1595 <dd> | |
| 1596 flag indicating to wrap around at the beginning of the | |
| 1597 text (boolean) | |
| 1598 </dd> | |
| 1599 </dl> | |
| 1600 <dl> | |
| 1601 <dt>Return:</dt> | |
| 1602 <dd> | |
| 1603 flag indicating if the indicator was found (boolean) | |
| 1604 </dd> | |
| 1605 </dl> | |
| 1606 <a NAME="QsciScintillaCompat.hasIndicator" ID="QsciScintillaCompat.hasIndicator"></a> | |
| 1607 <h4>QsciScintillaCompat.hasIndicator</h4> | |
| 1608 <b>hasIndicator</b>(<i>indicator, pos</i>) | |
| 1609 | |
| 1610 <p> | |
| 1611 Public method to test for the existence of an indicator. | |
| 1612 </p> | |
| 1613 <dl> | |
| 1614 | |
| 1615 <dt><i>indicator</i></dt> | |
| 1616 <dd> | |
| 1617 number of the indicator (integer, | |
| 1618 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1619 </dd> | |
| 1620 <dt><i>pos</i></dt> | |
| 1621 <dd> | |
| 1622 position to test (integer) | |
| 1623 </dd> | |
| 1624 </dl> | |
| 1625 <dl> | |
| 1626 <dt>Return:</dt> | |
| 1627 <dd> | |
| 1628 flag indicating the existence of the indicator (boolean) | |
| 1629 </dd> | |
| 1630 </dl> | |
| 1631 <a NAME="QsciScintillaCompat.hasSelectedText" ID="QsciScintillaCompat.hasSelectedText"></a> | |
| 1632 <h4>QsciScintillaCompat.hasSelectedText</h4> | |
| 1633 <b>hasSelectedText</b>(<i></i>) | |
| 1634 | |
| 1635 <p> | |
| 1636 Public method to indicate the presence of selected text. | |
| 1637 </p> | |
| 1638 <p> | |
| 1639 This is an overriding method to cope with a bug in QsciScintilla. | |
| 1640 </p> | |
| 1641 <dl> | |
| 1642 <dt>Return:</dt> | |
| 1643 <dd> | |
| 1644 flag indicating the presence of selected text (boolean) | |
| 1645 </dd> | |
| 1646 </dl> | |
| 1647 <a NAME="QsciScintillaCompat.hasSelection" ID="QsciScintillaCompat.hasSelection"></a> | |
| 1648 <h4>QsciScintillaCompat.hasSelection</h4> | |
| 1649 <b>hasSelection</b>(<i></i>) | |
| 1650 | |
| 1651 <p> | |
| 1652 Public method to check for a selection. | |
| 1653 </p> | |
| 1654 <dl> | |
| 1655 <dt>Return:</dt> | |
| 1656 <dd> | |
| 1657 flag indicating the presence of a selection (boolean) | |
| 1658 </dd> | |
| 1659 </dl> | |
| 1660 <a NAME="QsciScintillaCompat.hideFindIndicator" ID="QsciScintillaCompat.hideFindIndicator"></a> | |
| 1661 <h4>QsciScintillaCompat.hideFindIndicator</h4> | |
| 1662 <b>hideFindIndicator</b>(<i></i>) | |
| 1663 | |
| 1664 <p> | |
| 1665 Public method to hide the find indicator. | |
| 1666 </p> | |
| 1667 <a NAME="QsciScintillaCompat.indentationGuideView" ID="QsciScintillaCompat.indentationGuideView"></a> | |
| 1668 <h4>QsciScintillaCompat.indentationGuideView</h4> | |
| 1669 <b>indentationGuideView</b>(<i></i>) | |
| 1670 | |
| 1671 <p> | |
| 1672 Public method to get the indentation guide view. | |
| 1673 </p> | |
| 1674 <dl> | |
| 1675 <dt>Return:</dt> | |
| 1676 <dd> | |
| 1677 indentation guide view (SC_IV_NONE, SC_IV_REAL, | |
| 1678 SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH) | |
| 1679 </dd> | |
| 1680 </dl> | |
| 1681 <a NAME="QsciScintillaCompat.indicatorDefine" ID="QsciScintillaCompat.indicatorDefine"></a> | |
| 1682 <h4>QsciScintillaCompat.indicatorDefine</h4> | |
| 1683 <b>indicatorDefine</b>(<i>indicator, style, color</i>) | |
| 1684 | |
| 1685 <p> | |
| 1686 Public method to define the appearance of an indicator. | |
| 1687 </p> | |
| 1688 <dl> | |
| 1689 | |
| 1690 <dt><i>indicator</i></dt> | |
| 1691 <dd> | |
| 1692 number of the indicator (integer, | |
| 1693 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1694 </dd> | |
| 1695 <dt><i>style</i></dt> | |
| 1696 <dd> | |
| 1697 style to be used for the indicator | |
| 1698 (QsciScintilla.INDIC_PLAIN, QsciScintilla.INDIC_SQUIGGLE, | |
| 1699 QsciScintilla.INDIC_TT, QsciScintilla.INDIC_DIAGONAL, | |
| 1700 QsciScintilla.INDIC_STRIKE, QsciScintilla.INDIC_HIDDEN, | |
| 1701 QsciScintilla.INDIC_BOX, QsciScintilla.INDIC_ROUNDBOX, | |
| 1702 QsciScintilla.INDIC_STRAIGHTBOX, QsciScintilla.INDIC_FULLBOX, | |
| 1703 QsciScintilla.INDIC_DASH, QsciScintilla.INDIC_DOTS, | |
| 1704 QsciScintilla.INDIC_SQUIGGLELOW, QsciScintilla.INDIC_DOTBOX, | |
| 1705 QsciScintilla.INDIC_GRADIENT, QsciScintilla.INDIC_GRADIENTCENTRE, | |
| 1706 QsciScintilla.INDIC_SQUIGGLEPIXMAP, | |
| 1707 QsciScintilla.INDIC_COMPOSITIONTHICK, | |
| 1708 QsciScintilla.INDIC_COMPOSITIONTHIN, QsciScintilla.INDIC_TEXTFORE, | |
| 1709 QsciScintilla.INDIC_POINT, QsciScintilla.INDIC_POINTCHARACTER | |
| 1710 depending upon QScintilla version) | |
| 1711 </dd> | |
| 1712 <dt><i>color</i></dt> | |
| 1713 <dd> | |
| 1714 color to be used by the indicator (QColor) | |
| 1715 </dd> | |
| 1716 </dl> | |
| 1717 <dl> | |
| 1718 | |
| 1719 <dt>Raises <b>ValueError</b>:</dt> | |
| 1720 <dd> | |
| 1721 the indicator or style are not valid | |
| 1722 </dd> | |
| 1723 </dl> | |
| 1724 <a NAME="QsciScintillaCompat.isModified" ID="QsciScintillaCompat.isModified"></a> | |
| 1725 <h4>QsciScintillaCompat.isModified</h4> | |
| 1726 <b>isModified</b>(<i></i>) | |
| 1727 | |
| 1728 <p> | |
| 1729 Public method to return the modification status. | |
| 1730 </p> | |
| 1731 <dl> | |
| 1732 <dt>Return:</dt> | |
| 1733 <dd> | |
| 1734 flag indicating the modification status (boolean) | |
| 1735 </dd> | |
| 1736 </dl> | |
| 1737 <a NAME="QsciScintillaCompat.lineAt" ID="QsciScintillaCompat.lineAt"></a> | |
| 1738 <h4>QsciScintillaCompat.lineAt</h4> | |
| 1739 <b>lineAt</b>(<i>pos</i>) | |
| 1740 | |
| 1741 <p> | |
| 1742 Public method to calculate the line at a position. | |
| 1743 </p> | |
| 1744 <p> | |
| 1745 This variant is able to calculate the line for positions in the | |
| 1746 margins and for empty lines. | |
| 1747 </p> | |
| 1748 <dl> | |
| 1749 | |
| 1750 <dt><i>pos</i></dt> | |
| 1751 <dd> | |
| 1752 position to calculate the line for (integer or QPoint) | |
| 1753 </dd> | |
| 1754 </dl> | |
| 1755 <dl> | |
| 1756 <dt>Return:</dt> | |
| 1757 <dd> | |
| 1758 linenumber at position or -1, if there is no line at pos | |
| 1759 (integer, zero based) | |
| 1760 </dd> | |
| 1761 </dl> | |
| 1762 <a NAME="QsciScintillaCompat.lineEndPosition" ID="QsciScintillaCompat.lineEndPosition"></a> | |
| 1763 <h4>QsciScintillaCompat.lineEndPosition</h4> | |
| 1764 <b>lineEndPosition</b>(<i>line</i>) | |
| 1765 | |
| 1766 <p> | |
| 1767 Public method to determine the line end position of the given line. | |
| 1768 </p> | |
| 1769 <dl> | |
| 1770 | |
| 1771 <dt><i>line</i></dt> | |
| 1772 <dd> | |
| 1773 line number (integer) | |
| 1774 </dd> | |
| 1775 </dl> | |
| 1776 <dl> | |
| 1777 <dt>Return:</dt> | |
| 1778 <dd> | |
| 1779 position of the line end disregarding line end characters | |
| 1780 (integer) | |
| 1781 </dd> | |
| 1782 </dl> | |
| 1783 <a NAME="QsciScintillaCompat.lineIndexFromPoint" ID="QsciScintillaCompat.lineIndexFromPoint"></a> | |
| 1784 <h4>QsciScintillaCompat.lineIndexFromPoint</h4> | |
| 1785 <b>lineIndexFromPoint</b>(<i>point</i>) | |
| 1786 | |
| 1787 <p> | |
| 1788 Public method to convert a point to line and index. | |
| 1789 </p> | |
| 1790 <dl> | |
| 1791 | |
| 1792 <dt><i>point</i> (QPoin)</dt> | |
| 1793 <dd> | |
| 1794 point to be converted | |
| 1795 </dd> | |
| 1796 </dl> | |
| 1797 <dl> | |
| 1798 <dt>Return:</dt> | |
| 1799 <dd> | |
| 1800 tuple containing the line number and index number | |
| 1801 </dd> | |
| 1802 </dl> | |
| 1803 <dl> | |
| 1804 <dt>Return Type:</dt> | |
| 1805 <dd> | |
| 1806 tuple of (int, int) | |
| 1807 </dd> | |
| 1808 </dl> | |
| 1809 <a NAME="QsciScintillaCompat.linesOnScreen" ID="QsciScintillaCompat.linesOnScreen"></a> | |
| 1810 <h4>QsciScintillaCompat.linesOnScreen</h4> | |
| 1811 <b>linesOnScreen</b>(<i></i>) | |
| 1812 | |
| 1813 <p> | |
| 1814 Public method to get the amount of visible lines. | |
| 1815 </p> | |
| 1816 <dl> | |
| 1817 <dt>Return:</dt> | |
| 1818 <dd> | |
| 1819 amount of visible lines (integer) | |
| 1820 </dd> | |
| 1821 </dl> | |
| 1822 <a NAME="QsciScintillaCompat.monospacedStyles" ID="QsciScintillaCompat.monospacedStyles"></a> | |
| 1823 <h4>QsciScintillaCompat.monospacedStyles</h4> | |
| 1824 <b>monospacedStyles</b>(<i>font</i>) | |
| 1825 | |
| 1826 <p> | |
| 1827 Public method to set the current style to be monospaced. | |
| 1828 </p> | |
| 1829 <dl> | |
| 1830 | |
| 1831 <dt><i>font</i></dt> | |
| 1832 <dd> | |
| 1833 font to be used (QFont) | |
| 1834 </dd> | |
| 1835 </dl> | |
| 1836 <a NAME="QsciScintillaCompat.moveCursorLeft" ID="QsciScintillaCompat.moveCursorLeft"></a> | |
| 1837 <h4>QsciScintillaCompat.moveCursorLeft</h4> | |
| 1838 <b>moveCursorLeft</b>(<i></i>) | |
| 1839 | |
| 1840 <p> | |
| 1841 Public method to move the cursor left. | |
| 1842 </p> | |
| 1843 <a NAME="QsciScintillaCompat.moveCursorRight" ID="QsciScintillaCompat.moveCursorRight"></a> | |
| 1844 <h4>QsciScintillaCompat.moveCursorRight</h4> | |
| 1845 <b>moveCursorRight</b>(<i></i>) | |
| 1846 | |
| 1847 <p> | |
| 1848 Public method to move the cursor right. | |
| 1849 </p> | |
| 1850 <a NAME="QsciScintillaCompat.moveCursorToEOL" ID="QsciScintillaCompat.moveCursorToEOL"></a> | |
| 1851 <h4>QsciScintillaCompat.moveCursorToEOL</h4> | |
| 1852 <b>moveCursorToEOL</b>(<i></i>) | |
| 1853 | |
| 1854 <p> | |
| 1855 Public method to move the cursor to the end of line. | |
| 1856 </p> | |
| 1857 <a NAME="QsciScintillaCompat.moveCursorWordLeft" ID="QsciScintillaCompat.moveCursorWordLeft"></a> | |
| 1858 <h4>QsciScintillaCompat.moveCursorWordLeft</h4> | |
| 1859 <b>moveCursorWordLeft</b>(<i></i>) | |
| 1860 | |
| 1861 <p> | |
| 1862 Public method to move the cursor left one word. | |
| 1863 </p> | |
| 1864 <a NAME="QsciScintillaCompat.moveCursorWordRight" ID="QsciScintillaCompat.moveCursorWordRight"></a> | |
| 1865 <h4>QsciScintillaCompat.moveCursorWordRight</h4> | |
| 1866 <b>moveCursorWordRight</b>(<i></i>) | |
| 1867 | |
| 1868 <p> | |
| 1869 Public method to move the cursor right one word. | |
| 1870 </p> | |
| 1871 <a NAME="QsciScintillaCompat.newLineBelow" ID="QsciScintillaCompat.newLineBelow"></a> | |
| 1872 <h4>QsciScintillaCompat.newLineBelow</h4> | |
| 1873 <b>newLineBelow</b>(<i></i>) | |
| 1874 | |
| 1875 <p> | |
| 1876 Public method to insert a new line below the current one. | |
| 1877 </p> | |
| 1878 <a NAME="QsciScintillaCompat.positionAfter" ID="QsciScintillaCompat.positionAfter"></a> | |
| 1879 <h4>QsciScintillaCompat.positionAfter</h4> | |
| 1880 <b>positionAfter</b>(<i>pos</i>) | |
| 1881 | |
| 1882 <p> | |
| 1883 Public method to get the position after the given position taking into | |
| 1884 account multibyte characters. | |
| 1885 </p> | |
| 1886 <dl> | |
| 1887 | |
| 1888 <dt><i>pos</i></dt> | |
| 1889 <dd> | |
| 1890 position (integer) | |
| 1891 </dd> | |
| 1892 </dl> | |
| 1893 <dl> | |
| 1894 <dt>Return:</dt> | |
| 1895 <dd> | |
| 1896 position after the given one (integer) | |
| 1897 </dd> | |
| 1898 </dl> | |
| 1899 <a NAME="QsciScintillaCompat.positionBefore" ID="QsciScintillaCompat.positionBefore"></a> | |
| 1900 <h4>QsciScintillaCompat.positionBefore</h4> | |
| 1901 <b>positionBefore</b>(<i>pos</i>) | |
| 1902 | |
| 1903 <p> | |
| 1904 Public method to get the position before the given position taking into | |
| 1905 account multibyte characters. | |
| 1906 </p> | |
| 1907 <dl> | |
| 1908 | |
| 1909 <dt><i>pos</i></dt> | |
| 1910 <dd> | |
| 1911 position (integer) | |
| 1912 </dd> | |
| 1913 </dl> | |
| 1914 <dl> | |
| 1915 <dt>Return:</dt> | |
| 1916 <dd> | |
| 1917 position before the given one (integer) | |
| 1918 </dd> | |
| 1919 </dl> | |
| 1920 <a NAME="QsciScintillaCompat.positionFromPoint" ID="QsciScintillaCompat.positionFromPoint"></a> | |
| 1921 <h4>QsciScintillaCompat.positionFromPoint</h4> | |
| 1922 <b>positionFromPoint</b>(<i>point</i>) | |
| 1923 | |
| 1924 <p> | |
| 1925 Public method to calculate the scintilla position from a point in the | |
| 1926 window. | |
| 1927 </p> | |
| 1928 <dl> | |
| 1929 | |
| 1930 <dt><i>point</i></dt> | |
| 1931 <dd> | |
| 1932 point in the window (QPoint) | |
| 1933 </dd> | |
| 1934 </dl> | |
| 1935 <dl> | |
| 1936 <dt>Return:</dt> | |
| 1937 <dd> | |
| 1938 scintilla position (integer) or -1 to indicate, that the point | |
| 1939 is not near any character | |
| 1940 </dd> | |
| 1941 </dl> | |
| 1942 <a NAME="QsciScintillaCompat.replaceTarget" ID="QsciScintillaCompat.replaceTarget"></a> | |
| 1943 <h4>QsciScintillaCompat.replaceTarget</h4> | |
| 1944 <b>replaceTarget</b>(<i>replaceStr</i>) | |
| 1945 | |
| 1946 <p> | |
| 1947 Public method to replace the string found by the last search in target. | |
| 1948 </p> | |
| 1949 <dl> | |
| 1950 | |
| 1951 <dt><i>replaceStr</i></dt> | |
| 1952 <dd> | |
| 1953 replacement string or regexp (string) | |
| 1954 </dd> | |
| 1955 </dl> | |
| 1956 <a NAME="QsciScintillaCompat.scrollVertical" ID="QsciScintillaCompat.scrollVertical"></a> | |
| 1957 <h4>QsciScintillaCompat.scrollVertical</h4> | |
| 1958 <b>scrollVertical</b>(<i>lines</i>) | |
| 1959 | |
| 1960 <p> | |
| 1961 Public method to scroll the text area. | |
| 1962 </p> | |
| 1963 <dl> | |
| 1964 | |
| 1965 <dt><i>lines</i></dt> | |
| 1966 <dd> | |
| 1967 number of lines to scroll (negative scrolls up, | |
| 1968 positive scrolls down) (integer) | |
| 1969 </dd> | |
| 1970 </dl> | |
| 1971 <a NAME="QsciScintillaCompat.selectionIsRectangle" ID="QsciScintillaCompat.selectionIsRectangle"></a> | |
| 1972 <h4>QsciScintillaCompat.selectionIsRectangle</h4> | |
| 1973 <b>selectionIsRectangle</b>(<i></i>) | |
| 1974 | |
| 1975 <p> | |
| 1976 Public method to check, if the current selection is rectangular. | |
| 1977 </p> | |
| 1978 <dl> | |
| 1979 <dt>Return:</dt> | |
| 1980 <dd> | |
| 1981 flag indicating a rectangular selection (boolean) | |
| 1982 </dd> | |
| 1983 </dl> | |
| 1984 <a NAME="QsciScintillaCompat.setAutoCompletionWidgetSize" ID="QsciScintillaCompat.setAutoCompletionWidgetSize"></a> | |
| 1985 <h4>QsciScintillaCompat.setAutoCompletionWidgetSize</h4> | |
| 1986 <b>setAutoCompletionWidgetSize</b>(<i>chars, lines</i>) | |
| 1987 | |
| 1988 <p> | |
| 1989 Public method to set the size of completion and user lists. | |
| 1990 </p> | |
| 1991 <dl> | |
| 1992 | |
| 1993 <dt><i>chars</i> (int)</dt> | |
| 1994 <dd> | |
| 1995 max. number of chars to show | |
| 1996 </dd> | |
| 1997 <dt><i>lines</i> (int)</dt> | |
| 1998 <dd> | |
| 1999 max. number of lines to show | |
| 2000 </dd> | |
| 2001 </dl> | |
| 2002 <a NAME="QsciScintillaCompat.setCaretLineAlwaysVisible" ID="QsciScintillaCompat.setCaretLineAlwaysVisible"></a> | |
| 2003 <h4>QsciScintillaCompat.setCaretLineAlwaysVisible</h4> | |
| 2004 <b>setCaretLineAlwaysVisible</b>(<i>alwaysVisible</i>) | |
| 2005 | |
| 2006 <p> | |
| 2007 Public method to set the caret line visible even if the editor doesn't | |
| 2008 have the focus. | |
| 2009 </p> | |
| 2010 <dl> | |
| 2011 | |
| 2012 <dt><i>alwaysVisible</i></dt> | |
| 2013 <dd> | |
| 2014 flag indicating that the caret line shall be | |
| 2015 visible even if the editor doesn't have the focus (boolean) | |
| 2016 </dd> | |
| 2017 </dl> | |
| 2018 <a NAME="QsciScintillaCompat.setCurrentIndicator" ID="QsciScintillaCompat.setCurrentIndicator"></a> | |
| 2019 <h4>QsciScintillaCompat.setCurrentIndicator</h4> | |
| 2020 <b>setCurrentIndicator</b>(<i>indicator</i>) | |
| 2021 | |
| 2022 <p> | |
| 2023 Public method to set the current indicator. | |
| 2024 </p> | |
| 2025 <dl> | |
| 2026 | |
| 2027 <dt><i>indicator</i></dt> | |
| 2028 <dd> | |
| 2029 number of the indicator (integer, | |
| 2030 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 2031 </dd> | |
| 2032 </dl> | |
| 2033 <dl> | |
| 2034 | |
| 2035 <dt>Raises <b>ValueError</b>:</dt> | |
| 2036 <dd> | |
| 2037 the indicator or style are not valid | |
| 2038 </dd> | |
| 2039 </dl> | |
| 2040 <a NAME="QsciScintillaCompat.setCursorFlashTime" ID="QsciScintillaCompat.setCursorFlashTime"></a> | |
| 2041 <h4>QsciScintillaCompat.setCursorFlashTime</h4> | |
| 2042 <b>setCursorFlashTime</b>(<i>time</i>) | |
| 2043 | |
| 2044 <p> | |
| 2045 Public method to set the flash (blink) time of the cursor in | |
| 2046 milliseconds. | |
| 2047 </p> | |
| 2048 <p> | |
| 2049 The flash time is the time required to display, invert and restore the | |
| 2050 caret display. Usually the text cursor is displayed for half the cursor | |
| 2051 flash time, then hidden for the same amount of time. | |
| 2052 </p> | |
| 2053 <dl> | |
| 2054 | |
| 2055 <dt><i>time</i></dt> | |
| 2056 <dd> | |
| 2057 flash time of the cursor in milliseconds (integer) | |
| 2058 </dd> | |
| 2059 </dl> | |
| 2060 <a NAME="QsciScintillaCompat.setEolModeByEolString" ID="QsciScintillaCompat.setEolModeByEolString"></a> | |
| 2061 <h4>QsciScintillaCompat.setEolModeByEolString</h4> | |
| 2062 <b>setEolModeByEolString</b>(<i>eolStr</i>) | |
| 2063 | |
| 2064 <p> | |
| 2065 Public method to set the eol mode given the eol string. | |
| 2066 </p> | |
| 2067 <dl> | |
| 2068 | |
| 2069 <dt><i>eolStr</i></dt> | |
| 2070 <dd> | |
| 2071 eol string (string) | |
| 2072 </dd> | |
| 2073 </dl> | |
| 2074 <a NAME="QsciScintillaCompat.setFoldMarkersColors" ID="QsciScintillaCompat.setFoldMarkersColors"></a> | |
| 2075 <h4>QsciScintillaCompat.setFoldMarkersColors</h4> | |
| 2076 <b>setFoldMarkersColors</b>(<i>foreColor, backColor</i>) | |
| 2077 | |
| 2078 <p> | |
| 2079 Public method to set the foreground and background colors of the | |
| 2080 fold markers. | |
| 2081 </p> | |
| 2082 <dl> | |
| 2083 | |
| 2084 <dt><i>foreColor</i></dt> | |
| 2085 <dd> | |
| 2086 foreground color (QColor) | |
| 2087 </dd> | |
| 2088 <dt><i>backColor</i></dt> | |
| 2089 <dd> | |
| 2090 background color (QColor) | |
| 2091 </dd> | |
| 2092 </dl> | |
| 2093 <a NAME="QsciScintillaCompat.setFolding" ID="QsciScintillaCompat.setFolding"></a> | |
| 2094 <h4>QsciScintillaCompat.setFolding</h4> | |
| 2095 <b>setFolding</b>(<i>style, margin=2</i>) | |
| 2096 | |
| 2097 <p> | |
| 2098 Public method to set the folding style and margin. | |
| 2099 </p> | |
| 2100 <dl> | |
| 2101 | |
| 2102 <dt><i>style</i></dt> | |
| 2103 <dd> | |
| 2104 folding style to set (integer) | |
| 2105 </dd> | |
| 2106 <dt><i>margin</i></dt> | |
| 2107 <dd> | |
| 2108 margin number (integer) | |
| 2109 </dd> | |
| 2110 </dl> | |
| 2111 <a NAME="QsciScintillaCompat.setIndentationGuideView" ID="QsciScintillaCompat.setIndentationGuideView"></a> | |
| 2112 <h4>QsciScintillaCompat.setIndentationGuideView</h4> | |
| 2113 <b>setIndentationGuideView</b>(<i>view</i>) | |
| 2114 | |
| 2115 <p> | |
| 2116 Public method to set the view of the indentation guides. | |
| 2117 </p> | |
| 2118 <dl> | |
| 2119 | |
| 2120 <dt><i>view</i></dt> | |
| 2121 <dd> | |
| 2122 view of the indentation guides (SC_IV_NONE, SC_IV_REAL, | |
| 2123 SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH) | |
| 2124 </dd> | |
| 2125 </dl> | |
| 2126 <a NAME="QsciScintillaCompat.setIndicator" ID="QsciScintillaCompat.setIndicator"></a> | |
| 2127 <h4>QsciScintillaCompat.setIndicator</h4> | |
| 2128 <b>setIndicator</b>(<i>indicator, sline, sindex, eline, eindex</i>) | |
| 2129 | |
| 2130 <p> | |
| 2131 Public method to set an indicator for the given range. | |
| 2132 </p> | |
| 2133 <dl> | |
| 2134 | |
| 2135 <dt><i>indicator</i></dt> | |
| 2136 <dd> | |
| 2137 number of the indicator (integer, | |
| 2138 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 2139 </dd> | |
| 2140 <dt><i>sline</i></dt> | |
| 2141 <dd> | |
| 2142 line number of the indicator start (integer) | |
| 2143 </dd> | |
| 2144 <dt><i>sindex</i></dt> | |
| 2145 <dd> | |
| 2146 index of the indicator start (integer) | |
| 2147 </dd> | |
| 2148 <dt><i>eline</i></dt> | |
| 2149 <dd> | |
| 2150 line number of the indicator end (integer) | |
| 2151 </dd> | |
| 2152 <dt><i>eindex</i></dt> | |
| 2153 <dd> | |
| 2154 index of the indicator end (integer) | |
| 2155 </dd> | |
| 2156 </dl> | |
| 2157 <a NAME="QsciScintillaCompat.setIndicatorRange" ID="QsciScintillaCompat.setIndicatorRange"></a> | |
| 2158 <h4>QsciScintillaCompat.setIndicatorRange</h4> | |
| 2159 <b>setIndicatorRange</b>(<i>indicator, spos, length</i>) | |
| 2160 | |
| 2161 <p> | |
| 2162 Public method to set an indicator for the given range. | |
| 2163 </p> | |
| 2164 <dl> | |
| 2165 | |
| 2166 <dt><i>indicator</i></dt> | |
| 2167 <dd> | |
| 2168 number of the indicator (integer, | |
| 2169 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 2170 </dd> | |
| 2171 <dt><i>spos</i></dt> | |
| 2172 <dd> | |
| 2173 position of the indicator start (integer) | |
| 2174 </dd> | |
| 2175 <dt><i>length</i></dt> | |
| 2176 <dd> | |
| 2177 length of the indicator (integer) | |
| 2178 </dd> | |
| 2179 </dl> | |
| 2180 <a NAME="QsciScintillaCompat.setLexer" ID="QsciScintillaCompat.setLexer"></a> | |
| 2181 <h4>QsciScintillaCompat.setLexer</h4> | |
| 2182 <b>setLexer</b>(<i>lex=None</i>) | |
| 2183 | |
| 2184 <p> | |
| 2185 Public method to set the lexer. | |
| 2186 </p> | |
| 2187 <dl> | |
| 2188 | |
| 2189 <dt><i>lex</i></dt> | |
| 2190 <dd> | |
| 2191 the lexer to be set or None to reset it. | |
| 2192 </dd> | |
| 2193 </dl> | |
| 2194 <a NAME="QsciScintillaCompat.setModified" ID="QsciScintillaCompat.setModified"></a> | |
| 2195 <h4>QsciScintillaCompat.setModified</h4> | |
| 2196 <b>setModified</b>(<i>m</i>) | |
| 2197 | |
| 2198 <p> | |
| 2199 Public slot to set the modification status. | |
| 2200 </p> | |
| 2201 <dl> | |
| 2202 | |
| 2203 <dt><i>m</i></dt> | |
| 2204 <dd> | |
| 2205 new modification status (boolean) | |
| 2206 </dd> | |
| 2207 </dl> | |
| 2208 <a NAME="QsciScintillaCompat.setRectangularSelection" ID="QsciScintillaCompat.setRectangularSelection"></a> | |
| 2209 <h4>QsciScintillaCompat.setRectangularSelection</h4> | |
| 2210 <b>setRectangularSelection</b>(<i>startLine, startIndex, endLine, endIndex</i>) | |
| 2211 | |
| 2212 <p> | |
| 2213 Public method to set a rectangular selection. | |
| 2214 </p> | |
| 2215 <dl> | |
| 2216 | |
| 2217 <dt><i>startLine</i></dt> | |
| 2218 <dd> | |
| 2219 line number of the start of the selection (int) | |
| 2220 </dd> | |
| 2221 <dt><i>startIndex</i></dt> | |
| 2222 <dd> | |
| 2223 index number of the start of the selection (int) | |
| 2224 </dd> | |
| 2225 <dt><i>endLine</i></dt> | |
| 2226 <dd> | |
| 2227 line number of the end of the selection (int) | |
| 2228 </dd> | |
| 2229 <dt><i>endIndex</i></dt> | |
| 2230 <dd> | |
| 2231 index number of the end of the selection (int) | |
| 2232 </dd> | |
| 2233 </dl> | |
| 2234 <a NAME="QsciScintillaCompat.setStyling" ID="QsciScintillaCompat.setStyling"></a> | |
| 2235 <h4>QsciScintillaCompat.setStyling</h4> | |
| 2236 <b>setStyling</b>(<i>length, style</i>) | |
| 2237 | |
| 2238 <p> | |
| 2239 Public method to style some text. | |
| 2240 </p> | |
| 2241 <dl> | |
| 2242 | |
| 2243 <dt><i>length</i></dt> | |
| 2244 <dd> | |
| 2245 length of text to style (integer) | |
| 2246 </dd> | |
| 2247 <dt><i>style</i></dt> | |
| 2248 <dd> | |
| 2249 style to set for text (integer) | |
| 2250 </dd> | |
| 2251 </dl> | |
| 2252 <a NAME="QsciScintillaCompat.setVirtualSpaceOptions" ID="QsciScintillaCompat.setVirtualSpaceOptions"></a> | |
| 2253 <h4>QsciScintillaCompat.setVirtualSpaceOptions</h4> | |
| 2254 <b>setVirtualSpaceOptions</b>(<i>options</i>) | |
| 2255 | |
| 2256 <p> | |
| 2257 Public method to set the virtual space usage options. | |
| 2258 </p> | |
| 2259 <dl> | |
| 2260 | |
| 2261 <dt><i>options</i></dt> | |
| 2262 <dd> | |
| 2263 usage options to set (integer, 0 to 3) | |
| 2264 </dd> | |
| 2265 </dl> | |
| 2266 <a NAME="QsciScintillaCompat.setWrapStartIndent" ID="QsciScintillaCompat.setWrapStartIndent"></a> | |
| 2267 <h4>QsciScintillaCompat.setWrapStartIndent</h4> | |
| 2268 <b>setWrapStartIndent</b>(<i>indent</i>) | |
| 2269 | |
| 2270 <p> | |
| 2271 Public method to set a the amount of characters wrapped sublines | |
| 2272 shall be indented. | |
| 2273 </p> | |
| 2274 <dl> | |
| 2275 | |
| 2276 <dt><i>indent</i> (int)</dt> | |
| 2277 <dd> | |
| 2278 amount of characters to indent | |
| 2279 </dd> | |
| 2280 </dl> | |
| 2281 <a NAME="QsciScintillaCompat.showFindIndicator" ID="QsciScintillaCompat.showFindIndicator"></a> | |
| 2282 <h4>QsciScintillaCompat.showFindIndicator</h4> | |
| 2283 <b>showFindIndicator</b>(<i>sline, sindex, eline, eindex</i>) | |
| 2284 | |
| 2285 <p> | |
| 2286 Public method to show the find indicator for the given range. | |
| 2287 </p> | |
| 2288 <dl> | |
| 2289 | |
| 2290 <dt><i>sline</i></dt> | |
| 2291 <dd> | |
| 2292 line number of the indicator start (integer) | |
| 2293 </dd> | |
| 2294 <dt><i>sindex</i></dt> | |
| 2295 <dd> | |
| 2296 index of the indicator start (integer) | |
| 2297 </dd> | |
| 2298 <dt><i>eline</i></dt> | |
| 2299 <dd> | |
| 2300 line number of the indicator end (integer) | |
| 2301 </dd> | |
| 2302 <dt><i>eindex</i></dt> | |
| 2303 <dd> | |
| 2304 index of the indicator end (integer) | |
| 2305 </dd> | |
| 2306 </dl> | |
| 2307 <a NAME="QsciScintillaCompat.showUserList" ID="QsciScintillaCompat.showUserList"></a> | |
| 2308 <h4>QsciScintillaCompat.showUserList</h4> | |
| 2309 <b>showUserList</b>(<i>listId, lst</i>) | |
| 2310 | |
| 2311 <p> | |
| 2312 Public method to show a user supplied list. | |
| 2313 </p> | |
| 2314 <dl> | |
| 2315 | |
| 2316 <dt><i>listId</i></dt> | |
| 2317 <dd> | |
| 2318 id of the list (integer) | |
| 2319 </dd> | |
| 2320 <dt><i>lst</i></dt> | |
| 2321 <dd> | |
| 2322 list to be show (list of strings) | |
| 2323 </dd> | |
| 2324 </dl> | |
| 2325 <a NAME="QsciScintillaCompat.startStyling" ID="QsciScintillaCompat.startStyling"></a> | |
| 2326 <h4>QsciScintillaCompat.startStyling</h4> | |
| 2327 <b>startStyling</b>(<i>pos, mask</i>) | |
| 2328 | |
| 2329 <p> | |
| 2330 Public method to prepare styling. | |
| 2331 </p> | |
| 2332 <dl> | |
| 2333 | |
| 2334 <dt><i>pos</i></dt> | |
| 2335 <dd> | |
| 2336 styling positition to start at (integer) | |
| 2337 </dd> | |
| 2338 <dt><i>mask</i></dt> | |
| 2339 <dd> | |
| 2340 mask of bits to use for styling (integer) | |
| 2341 </dd> | |
| 2342 </dl> | |
| 2343 <a NAME="QsciScintillaCompat.styleAt" ID="QsciScintillaCompat.styleAt"></a> | |
| 2344 <h4>QsciScintillaCompat.styleAt</h4> | |
| 2345 <b>styleAt</b>(<i>pos</i>) | |
| 2346 | |
| 2347 <p> | |
| 2348 Public method to get the style at a position in the text. | |
| 2349 </p> | |
| 2350 <dl> | |
| 2351 | |
| 2352 <dt><i>pos</i></dt> | |
| 2353 <dd> | |
| 2354 position in the text (integer) | |
| 2355 </dd> | |
| 2356 </dl> | |
| 2357 <dl> | |
| 2358 <dt>Return:</dt> | |
| 2359 <dd> | |
| 2360 style at the requested position or 0, if the position | |
| 2361 is negative or past the end of the document (integer) | |
| 2362 </dd> | |
| 2363 </dl> | |
| 2364 <a NAME="QsciScintillaCompat.updateUserListSize" ID="QsciScintillaCompat.updateUserListSize"></a> | |
| 2365 <h4>QsciScintillaCompat.updateUserListSize</h4> | |
| 2366 <b>updateUserListSize</b>(<i></i>) | |
| 2367 | |
| 2368 <p> | |
| 2369 Public method to resize the completion list to fit with contents. | |
| 2370 </p> | |
| 2371 <a NAME="QsciScintillaCompat.updateVerticalScrollBar" ID="QsciScintillaCompat.updateVerticalScrollBar"></a> | |
| 2372 <h4>QsciScintillaCompat.updateVerticalScrollBar</h4> | |
| 2373 <b>updateVerticalScrollBar</b>(<i></i>) | |
| 2374 | |
| 2375 <p> | |
| 2376 Public method to update the vertical scroll bar to reflect the | |
| 2377 additional lines added by annotations. | |
| 2378 </p> | |
| 2379 <a NAME="QsciScintillaCompat.zoomIn" ID="QsciScintillaCompat.zoomIn"></a> | |
| 2380 <h4>QsciScintillaCompat.zoomIn</h4> | |
| 2381 <b>zoomIn</b>(<i>zoom=1</i>) | |
| 2382 | |
| 2383 <p> | |
| 2384 Public method used to increase the zoom factor. | |
| 2385 </p> | |
| 2386 <dl> | |
| 2387 | |
| 2388 <dt><i>zoom</i></dt> | |
| 2389 <dd> | |
| 2390 zoom factor increment (integer) | |
| 2391 </dd> | |
| 2392 </dl> | |
| 2393 <a NAME="QsciScintillaCompat.zoomOut" ID="QsciScintillaCompat.zoomOut"></a> | |
| 2394 <h4>QsciScintillaCompat.zoomOut</h4> | |
| 2395 <b>zoomOut</b>(<i>zoom=1</i>) | |
| 2396 | |
| 2397 <p> | |
| 2398 Public method used to decrease the zoom factor. | |
| 2399 </p> | |
| 2400 <dl> | |
| 2401 | |
| 2402 <dt><i>zoom</i></dt> | |
| 2403 <dd> | |
| 2404 zoom factor decrement (integer) | |
| 2405 </dd> | |
| 2406 </dl> | |
| 2407 <a NAME="QsciScintillaCompat.zoomTo" ID="QsciScintillaCompat.zoomTo"></a> | |
| 2408 <h4>QsciScintillaCompat.zoomTo</h4> | |
| 2409 <b>zoomTo</b>(<i>zoom</i>) | |
| 2410 | |
| 2411 <p> | |
| 2412 Public method used to zoom to a specific zoom factor. | |
| 2413 </p> | |
| 2414 <dl> | |
| 2415 | |
| 2416 <dt><i>zoom</i></dt> | |
| 2417 <dd> | |
| 2418 zoom factor (integer) | |
| 2419 </dd> | |
| 2420 </dl> | |
| 2421 <div align="right"><a href="#top">Up</a></div> | |
| 2422 <hr /> | |
| 2423 <hr /> | |
| 2424 <a NAME="QSCINTILLA_VERSION" ID="QSCINTILLA_VERSION"></a> | |
| 2425 <h2>QSCINTILLA_VERSION</h2> | |
| 2426 <b>QSCINTILLA_VERSION</b>(<i></i>) | |
| 2427 | |
| 2428 <p> | |
| 2429 Module function to return the QScintilla version. | |
| 2430 </p> | |
| 2431 <dl> | |
| 2432 <dt>Return:</dt> | |
| 2433 <dd> | |
| 2434 QScintilla version (integer) | |
| 2435 </dd> | |
| 2436 </dl> | |
| 2437 <div align="right"><a href="#top">Up</a></div> | |
| 2438 <hr /> | |
| 2439 </body></html> |
