Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html
eric6/Documentation/Source/eric6.QScintilla.QsciScintillaCompat.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7204
- cbf6d88004ce
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.QScintilla.QsciScintillaCompat</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.QScintilla.QsciScintillaCompat</h1> | |
| 23 <p> | |
| 24 Module implementing a compatability interface class to QsciScintilla. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#QsciScintillaCompat">QsciScintillaCompat</a></td> | |
| 34 <td>Class implementing a compatability interface to QsciScintilla.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#QSCINTILLA_VERSION">QSCINTILLA_VERSION</a></td> | |
| 41 <td>Module function to return the QScintilla version.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="QsciScintillaCompat" ID="QsciScintillaCompat"></a> | |
| 46 <h2>QsciScintillaCompat</h2> | |
| 47 <p> | |
| 48 Class implementing a compatability interface to QsciScintilla. | |
| 49 </p><p> | |
| 50 This class implements all the functions, that were added to | |
| 51 QsciScintilla incrementally. This class ensures compatibility | |
| 52 to older versions of QsciScintilla. | |
| 53 </p><h3>Signals</h3> | |
| 54 <dl> | |
| 55 <dt>zoomValueChanged(int)</dt> | |
| 56 <dd> | |
| 57 emitted to signal a change of the zoom value | |
| 58 </dd> | |
| 59 </dl> | |
| 60 <h3>Derived from</h3> | |
| 61 QsciScintilla | |
| 62 <h3>Class Attributes</h3> | |
| 63 <table> | |
| 64 <tr><td>ArrowFoldStyle</td></tr><tr><td>ArrowTreeFoldStyle</td></tr><tr><td>IndicatorStyleMax</td></tr><tr><td>UserSeparator</td></tr> | |
| 65 </table> | |
| 66 <h3>Class Methods</h3> | |
| 67 <table> | |
| 68 <tr><td>None</td></tr> | |
| 69 </table> | |
| 70 <h3>Methods</h3> | |
| 71 <table> | |
| 72 <tr> | |
| 73 <td><a href="#QsciScintillaCompat.__init__">QsciScintillaCompat</a></td> | |
| 74 <td>Constructor</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#QsciScintillaCompat.__completionListSelected">__completionListSelected</a></td> | |
| 77 <td>Private slot to handle the selection from the completion list.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#QsciScintillaCompat.__doSearchTarget">__doSearchTarget</a></td> | |
| 80 <td>Private method to perform the search in target.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#QsciScintillaCompat.__modificationChanged">__modificationChanged</a></td> | |
| 83 <td>Private slot to handle the modificationChanged signal.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#QsciScintillaCompat.__setFoldMarker">__setFoldMarker</a></td> | |
| 86 <td>Private method to define a fold marker.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#QsciScintillaCompat._encodeString">_encodeString</a></td> | |
| 89 <td>Protected method to encode a string depending on the current mode.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#QsciScintillaCompat.autoCompleteFromAPIs">autoCompleteFromAPIs</a></td> | |
| 92 <td>Public method to resize list box after creation.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#QsciScintillaCompat.autoCompleteFromAll">autoCompleteFromAll</a></td> | |
| 95 <td>Public method to resize list box after creation.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#QsciScintillaCompat.autoCompleteFromDocument">autoCompleteFromDocument</a></td> | |
| 98 <td>Public method to resize list box after creation.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#QsciScintillaCompat.byteAt">byteAt</a></td> | |
| 101 <td>Public method to get the raw character (bytes) at a position in the text.</td> | |
| 102 </tr><tr> | |
| 103 <td><a href="#QsciScintillaCompat.canPaste">canPaste</a></td> | |
| 104 <td>Public method to test, if the paste action is available (i.e.</td> | |
| 105 </tr><tr> | |
| 106 <td><a href="#QsciScintillaCompat.charAt">charAt</a></td> | |
| 107 <td>Public method to get the character at a position in the text observing multibyte characters.</td> | |
| 108 </tr><tr> | |
| 109 <td><a href="#QsciScintillaCompat.clearAllIndicators">clearAllIndicators</a></td> | |
| 110 <td>Public method to clear all occurrences of an indicator.</td> | |
| 111 </tr><tr> | |
| 112 <td><a href="#QsciScintillaCompat.clearAlternateKeys">clearAlternateKeys</a></td> | |
| 113 <td>Public method to clear the alternate key commands.</td> | |
| 114 </tr><tr> | |
| 115 <td><a href="#QsciScintillaCompat.clearIndicator">clearIndicator</a></td> | |
| 116 <td>Public method to clear an indicator for the given range.</td> | |
| 117 </tr><tr> | |
| 118 <td><a href="#QsciScintillaCompat.clearIndicatorRange">clearIndicatorRange</a></td> | |
| 119 <td>Public method to clear an indicator for the given range.</td> | |
| 120 </tr><tr> | |
| 121 <td><a href="#QsciScintillaCompat.clearKeys">clearKeys</a></td> | |
| 122 <td>Public method to clear the key commands.</td> | |
| 123 </tr><tr> | |
| 124 <td><a href="#QsciScintillaCompat.clearStyles">clearStyles</a></td> | |
| 125 <td>Public method to set the styles according the selected Qt style.</td> | |
| 126 </tr><tr> | |
| 127 <td><a href="#QsciScintillaCompat.contractedFolds">contractedFolds</a></td> | |
| 128 <td>Public method to get a list of line numbers of collapsed folds.</td> | |
| 129 </tr><tr> | |
| 130 <td><a href="#QsciScintillaCompat.currentPosition">currentPosition</a></td> | |
| 131 <td>Public method to get the current position.</td> | |
| 132 </tr><tr> | |
| 133 <td><a href="#QsciScintillaCompat.currentStyle">currentStyle</a></td> | |
| 134 <td>Public method to get the style at the current position.</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#QsciScintillaCompat.delete">delete</a></td> | |
| 137 <td>Public method to delete the character to the right of the cursor.</td> | |
| 138 </tr><tr> | |
| 139 <td><a href="#QsciScintillaCompat.deleteBack">deleteBack</a></td> | |
| 140 <td>Public method to delete the character to the left of the cursor.</td> | |
| 141 </tr><tr> | |
| 142 <td><a href="#QsciScintillaCompat.deleteLineLeft">deleteLineLeft</a></td> | |
| 143 <td>Public method to delete the line to the left of the cursor.</td> | |
| 144 </tr><tr> | |
| 145 <td><a href="#QsciScintillaCompat.deleteLineRight">deleteLineRight</a></td> | |
| 146 <td>Public method to delete the line to the right of the cursor.</td> | |
| 147 </tr><tr> | |
| 148 <td><a href="#QsciScintillaCompat.deleteWordLeft">deleteWordLeft</a></td> | |
| 149 <td>Public method to delete the word to the left of the cursor.</td> | |
| 150 </tr><tr> | |
| 151 <td><a href="#QsciScintillaCompat.deleteWordRight">deleteWordRight</a></td> | |
| 152 <td>Public method to delete the word to the right of the cursor.</td> | |
| 153 </tr><tr> | |
| 154 <td><a href="#QsciScintillaCompat.detectEolString">detectEolString</a></td> | |
| 155 <td>Public method to determine the eol string used.</td> | |
| 156 </tr><tr> | |
| 157 <td><a href="#QsciScintillaCompat.editorCommand">editorCommand</a></td> | |
| 158 <td>Public method to perform a simple editor command.</td> | |
| 159 </tr><tr> | |
| 160 <td><a href="#QsciScintillaCompat.event">event</a></td> | |
| 161 <td>Public method to handle events.</td> | |
| 162 </tr><tr> | |
| 163 <td><a href="#QsciScintillaCompat.extendSelectionLeft">extendSelectionLeft</a></td> | |
| 164 <td>Public method to extend the selection one character to the left.</td> | |
| 165 </tr><tr> | |
| 166 <td><a href="#QsciScintillaCompat.extendSelectionRight">extendSelectionRight</a></td> | |
| 167 <td>Public method to extend the selection one character to the right.</td> | |
| 168 </tr><tr> | |
| 169 <td><a href="#QsciScintillaCompat.extendSelectionToBOL">extendSelectionToBOL</a></td> | |
| 170 <td>Public method to extend the selection to the beginning of the line.</td> | |
| 171 </tr><tr> | |
| 172 <td><a href="#QsciScintillaCompat.extendSelectionToEOL">extendSelectionToEOL</a></td> | |
| 173 <td>Public method to extend the selection to the end of the line.</td> | |
| 174 </tr><tr> | |
| 175 <td><a href="#QsciScintillaCompat.extendSelectionWordLeft">extendSelectionWordLeft</a></td> | |
| 176 <td>Public method to extend the selection one word to the left.</td> | |
| 177 </tr><tr> | |
| 178 <td><a href="#QsciScintillaCompat.extendSelectionWordRight">extendSelectionWordRight</a></td> | |
| 179 <td>Public method to extend the selection one word to the right.</td> | |
| 180 </tr><tr> | |
| 181 <td><a href="#QsciScintillaCompat.findFirst">findFirst</a></td> | |
| 182 <td>Public method to search in the current editor text.</td> | |
| 183 </tr><tr> | |
| 184 <td><a href="#QsciScintillaCompat.findFirstTarget">findFirstTarget</a></td> | |
| 185 <td>Public method to search in a specified range of text without setting the selection.</td> | |
| 186 </tr><tr> | |
| 187 <td><a href="#QsciScintillaCompat.findNextTarget">findNextTarget</a></td> | |
| 188 <td>Public method to find the next occurrence in the target range.</td> | |
| 189 </tr><tr> | |
| 190 <td><a href="#QsciScintillaCompat.flashFindIndicator">flashFindIndicator</a></td> | |
| 191 <td>Public method to flash the find indicator for the given range.</td> | |
| 192 </tr><tr> | |
| 193 <td><a href="#QsciScintillaCompat.focusOutEvent">focusOutEvent</a></td> | |
| 194 <td>Protected method called when the editor loses focus.</td> | |
| 195 </tr><tr> | |
| 196 <td><a href="#QsciScintillaCompat.foldExpandedAt">foldExpandedAt</a></td> | |
| 197 <td>Public method to determine, if a fold is expanded.</td> | |
| 198 </tr><tr> | |
| 199 <td><a href="#QsciScintillaCompat.foldFlagsAt">foldFlagsAt</a></td> | |
| 200 <td>Public method to get the fold flags of a line of the document.</td> | |
| 201 </tr><tr> | |
| 202 <td><a href="#QsciScintillaCompat.foldHeaderAt">foldHeaderAt</a></td> | |
| 203 <td>Public method to determine, if a line of the document is a fold header line.</td> | |
| 204 </tr><tr> | |
| 205 <td><a href="#QsciScintillaCompat.foldLevelAt">foldLevelAt</a></td> | |
| 206 <td>Public method to get the fold level of a line of the document.</td> | |
| 207 </tr><tr> | |
| 208 <td><a href="#QsciScintillaCompat.getCaretLineAlwaysVisible">getCaretLineAlwaysVisible</a></td> | |
| 209 <td>Public method to determine, if the caret line is visible even if the editor doesn't have the focus.</td> | |
| 210 </tr><tr> | |
| 211 <td><a href="#QsciScintillaCompat.getCursorFlashTime">getCursorFlashTime</a></td> | |
| 212 <td>Public method to get the flash (blink) time of the cursor in milliseconds.</td> | |
| 213 </tr><tr> | |
| 214 <td><a href="#QsciScintillaCompat.getDocLineFromVisibleLine">getDocLineFromVisibleLine</a></td> | |
| 215 <td>Public method to convert a visible line number to a document line number (i.e.</td> | |
| 216 </tr><tr> | |
| 217 <td><a href="#QsciScintillaCompat.getEndStyled">getEndStyled</a></td> | |
| 218 <td>Public method to get the last styled position.</td> | |
| 219 </tr><tr> | |
| 220 <td><a href="#QsciScintillaCompat.getEolIndicator">getEolIndicator</a></td> | |
| 221 <td>Public method to get the eol indicator for the current eol mode.</td> | |
| 222 </tr><tr> | |
| 223 <td><a href="#QsciScintillaCompat.getFileName">getFileName</a></td> | |
| 224 <td>Public method to return the name of the file being displayed.</td> | |
| 225 </tr><tr> | |
| 226 <td><a href="#QsciScintillaCompat.getFoundTarget">getFoundTarget</a></td> | |
| 227 <td>Public method to get the recently found target.</td> | |
| 228 </tr><tr> | |
| 229 <td><a href="#QsciScintillaCompat.getIndicatorEndPos">getIndicatorEndPos</a></td> | |
| 230 <td>Public method to get the end position of an indicator at a position.</td> | |
| 231 </tr><tr> | |
| 232 <td><a href="#QsciScintillaCompat.getIndicatorStartPos">getIndicatorStartPos</a></td> | |
| 233 <td>Public method to get the start position of an indicator at a position.</td> | |
| 234 </tr><tr> | |
| 235 <td><a href="#QsciScintillaCompat.getLineSeparator">getLineSeparator</a></td> | |
| 236 <td>Public method to get the line separator for the current eol mode.</td> | |
| 237 </tr><tr> | |
| 238 <td><a href="#QsciScintillaCompat.getRectangularSelection">getRectangularSelection</a></td> | |
| 239 <td>Public method to retrieve the start and end of a rectangular selection.</td> | |
| 240 </tr><tr> | |
| 241 <td><a href="#QsciScintillaCompat.getSelectionCount">getSelectionCount</a></td> | |
| 242 <td>Public method to get the number of active selections.</td> | |
| 243 </tr><tr> | |
| 244 <td><a href="#QsciScintillaCompat.getSelectionN">getSelectionN</a></td> | |
| 245 <td>Public method to get the start and end of a selection given by its index.</td> | |
| 246 </tr><tr> | |
| 247 <td><a href="#QsciScintillaCompat.getSelections">getSelections</a></td> | |
| 248 <td>Public method to get the start and end coordinates of all active selections.</td> | |
| 249 </tr><tr> | |
| 250 <td><a href="#QsciScintillaCompat.getVisibleLineFromDocLine">getVisibleLineFromDocLine</a></td> | |
| 251 <td>Public method to convert a document line number to a visible line number (i.e.</td> | |
| 252 </tr><tr> | |
| 253 <td><a href="#QsciScintillaCompat.getZoom">getZoom</a></td> | |
| 254 <td>Public method used to retrieve the current zoom factor.</td> | |
| 255 </tr><tr> | |
| 256 <td><a href="#QsciScintillaCompat.gotoNextIndicator">gotoNextIndicator</a></td> | |
| 257 <td>Public method to move the cursor to the next position of an indicator.</td> | |
| 258 </tr><tr> | |
| 259 <td><a href="#QsciScintillaCompat.gotoPreviousIndicator">gotoPreviousIndicator</a></td> | |
| 260 <td>Public method to move the cursor to the previous position of an indicator.</td> | |
| 261 </tr><tr> | |
| 262 <td><a href="#QsciScintillaCompat.hasIndicator">hasIndicator</a></td> | |
| 263 <td>Public method to test for the existence of an indicator.</td> | |
| 264 </tr><tr> | |
| 265 <td><a href="#QsciScintillaCompat.hasSelectedText">hasSelectedText</a></td> | |
| 266 <td>Public method to indicate the presence of selected text.</td> | |
| 267 </tr><tr> | |
| 268 <td><a href="#QsciScintillaCompat.hasSelection">hasSelection</a></td> | |
| 269 <td>Public method to check for a selection.</td> | |
| 270 </tr><tr> | |
| 271 <td><a href="#QsciScintillaCompat.hideFindIndicator">hideFindIndicator</a></td> | |
| 272 <td>Public method to hide the find indicator.</td> | |
| 273 </tr><tr> | |
| 274 <td><a href="#QsciScintillaCompat.indentationGuideView">indentationGuideView</a></td> | |
| 275 <td>Public method to get the indentation guide view.</td> | |
| 276 </tr><tr> | |
| 277 <td><a href="#QsciScintillaCompat.indicatorDefine">indicatorDefine</a></td> | |
| 278 <td>Public method to define the appearance of an indicator.</td> | |
| 279 </tr><tr> | |
| 280 <td><a href="#QsciScintillaCompat.inputMethodEvent">inputMethodEvent</a></td> | |
| 281 <td>Protected method to cope with a glitch in some Qscintilla versions handling input events.</td> | |
| 282 </tr><tr> | |
| 283 <td><a href="#QsciScintillaCompat.inputMethodQuery">inputMethodQuery</a></td> | |
| 284 <td>Public method to cope with a glitch in some Qscintilla versions handling input events.</td> | |
| 285 </tr><tr> | |
| 286 <td><a href="#QsciScintillaCompat.insert">insert</a></td> | |
| 287 <td>Public method to insert text at the cursor position.</td> | |
| 288 </tr><tr> | |
| 289 <td><a href="#QsciScintillaCompat.isModified">isModified</a></td> | |
| 290 <td>Public method to return the modification status.</td> | |
| 291 </tr><tr> | |
| 292 <td><a href="#QsciScintillaCompat.lineAt">lineAt</a></td> | |
| 293 <td>Public method to calculate the line at a position.</td> | |
| 294 </tr><tr> | |
| 295 <td><a href="#QsciScintillaCompat.lineEndPosition">lineEndPosition</a></td> | |
| 296 <td>Public method to determine the line end position of the given line.</td> | |
| 297 </tr><tr> | |
| 298 <td><a href="#QsciScintillaCompat.lineIndexFromPosition">lineIndexFromPosition</a></td> | |
| 299 <td>Public method to convert an absolute position to line and index.</td> | |
| 300 </tr><tr> | |
| 301 <td><a href="#QsciScintillaCompat.linesOnScreen">linesOnScreen</a></td> | |
| 302 <td>Public method to get the amount of visible lines.</td> | |
| 303 </tr><tr> | |
| 304 <td><a href="#QsciScintillaCompat.monospacedStyles">monospacedStyles</a></td> | |
| 305 <td>Public method to set the current style to be monospaced.</td> | |
| 306 </tr><tr> | |
| 307 <td><a href="#QsciScintillaCompat.moveCursorLeft">moveCursorLeft</a></td> | |
| 308 <td>Public method to move the cursor left.</td> | |
| 309 </tr><tr> | |
| 310 <td><a href="#QsciScintillaCompat.moveCursorRight">moveCursorRight</a></td> | |
| 311 <td>Public method to move the cursor right.</td> | |
| 312 </tr><tr> | |
| 313 <td><a href="#QsciScintillaCompat.moveCursorToEOL">moveCursorToEOL</a></td> | |
| 314 <td>Public method to move the cursor to the end of line.</td> | |
| 315 </tr><tr> | |
| 316 <td><a href="#QsciScintillaCompat.moveCursorWordLeft">moveCursorWordLeft</a></td> | |
| 317 <td>Public method to move the cursor left one word.</td> | |
| 318 </tr><tr> | |
| 319 <td><a href="#QsciScintillaCompat.moveCursorWordRight">moveCursorWordRight</a></td> | |
| 320 <td>Public method to move the cursor right one word.</td> | |
| 321 </tr><tr> | |
| 322 <td><a href="#QsciScintillaCompat.newLineBelow">newLineBelow</a></td> | |
| 323 <td>Public method to insert a new line below the current one.</td> | |
| 324 </tr><tr> | |
| 325 <td><a href="#QsciScintillaCompat.positionAfter">positionAfter</a></td> | |
| 326 <td>Public method to get the position after the given position taking into account multibyte characters.</td> | |
| 327 </tr><tr> | |
| 328 <td><a href="#QsciScintillaCompat.positionBefore">positionBefore</a></td> | |
| 329 <td>Public method to get the position before the given position taking into account multibyte characters.</td> | |
| 330 </tr><tr> | |
| 331 <td><a href="#QsciScintillaCompat.positionFromLineIndex">positionFromLineIndex</a></td> | |
| 332 <td>Public method to convert line and index to an absolute position.</td> | |
| 333 </tr><tr> | |
| 334 <td><a href="#QsciScintillaCompat.positionFromPoint">positionFromPoint</a></td> | |
| 335 <td>Public method to calculate the scintilla position from a point in the window.</td> | |
| 336 </tr><tr> | |
| 337 <td><a href="#QsciScintillaCompat.replaceTarget">replaceTarget</a></td> | |
| 338 <td>Public method to replace the string found by the last search in target.</td> | |
| 339 </tr><tr> | |
| 340 <td><a href="#QsciScintillaCompat.scrollVertical">scrollVertical</a></td> | |
| 341 <td>Public method to scroll the text area.</td> | |
| 342 </tr><tr> | |
| 343 <td><a href="#QsciScintillaCompat.selectionIsRectangle">selectionIsRectangle</a></td> | |
| 344 <td>Public method to check, if the current selection is rectangular.</td> | |
| 345 </tr><tr> | |
| 346 <td><a href="#QsciScintillaCompat.setCaretLineAlwaysVisible">setCaretLineAlwaysVisible</a></td> | |
| 347 <td>Public method to set the caret line visible even if the editor doesn't have the focus.</td> | |
| 348 </tr><tr> | |
| 349 <td><a href="#QsciScintillaCompat.setContractedFolds">setContractedFolds</a></td> | |
| 350 <td>Public method to set a list of line numbers of collapsed folds.</td> | |
| 351 </tr><tr> | |
| 352 <td><a href="#QsciScintillaCompat.setCurrentIndicator">setCurrentIndicator</a></td> | |
| 353 <td>Public method to set the current indicator.</td> | |
| 354 </tr><tr> | |
| 355 <td><a href="#QsciScintillaCompat.setCursorFlashTime">setCursorFlashTime</a></td> | |
| 356 <td>Public method to set the flash (blink) time of the cursor in milliseconds.</td> | |
| 357 </tr><tr> | |
| 358 <td><a href="#QsciScintillaCompat.setEolModeByEolString">setEolModeByEolString</a></td> | |
| 359 <td>Public method to set the eol mode given the eol string.</td> | |
| 360 </tr><tr> | |
| 361 <td><a href="#QsciScintillaCompat.setFoldMarkersColors">setFoldMarkersColors</a></td> | |
| 362 <td>Public method to set the foreground and background colors of the fold markers.</td> | |
| 363 </tr><tr> | |
| 364 <td><a href="#QsciScintillaCompat.setFolding">setFolding</a></td> | |
| 365 <td>Public method to set the folding style and margin.</td> | |
| 366 </tr><tr> | |
| 367 <td><a href="#QsciScintillaCompat.setIndentationGuideView">setIndentationGuideView</a></td> | |
| 368 <td>Public method to set the view of the indentation guides.</td> | |
| 369 </tr><tr> | |
| 370 <td><a href="#QsciScintillaCompat.setIndicator">setIndicator</a></td> | |
| 371 <td>Public method to set an indicator for the given range.</td> | |
| 372 </tr><tr> | |
| 373 <td><a href="#QsciScintillaCompat.setIndicatorRange">setIndicatorRange</a></td> | |
| 374 <td>Public method to set an indicator for the given range.</td> | |
| 375 </tr><tr> | |
| 376 <td><a href="#QsciScintillaCompat.setLexer">setLexer</a></td> | |
| 377 <td>Public method to set the lexer.</td> | |
| 378 </tr><tr> | |
| 379 <td><a href="#QsciScintillaCompat.setModified">setModified</a></td> | |
| 380 <td>Public slot to set the modification status.</td> | |
| 381 </tr><tr> | |
| 382 <td><a href="#QsciScintillaCompat.setRectangularSelection">setRectangularSelection</a></td> | |
| 383 <td>Public method to set a rectangular selection.</td> | |
| 384 </tr><tr> | |
| 385 <td><a href="#QsciScintillaCompat.setStyling">setStyling</a></td> | |
| 386 <td>Public method to style some text.</td> | |
| 387 </tr><tr> | |
| 388 <td><a href="#QsciScintillaCompat.setVirtualSpaceOptions">setVirtualSpaceOptions</a></td> | |
| 389 <td>Public method to set the virtual space usage options.</td> | |
| 390 </tr><tr> | |
| 391 <td><a href="#QsciScintillaCompat.setWrapStartIndent">setWrapStartIndent</a></td> | |
| 392 <td>Public method to set a the amount of characters wrapped sublines shall be indented.</td> | |
| 393 </tr><tr> | |
| 394 <td><a href="#QsciScintillaCompat.showFindIndicator">showFindIndicator</a></td> | |
| 395 <td>Public method to show the find indicator for the given range.</td> | |
| 396 </tr><tr> | |
| 397 <td><a href="#QsciScintillaCompat.showUserList">showUserList</a></td> | |
| 398 <td>Public method to show a user supplied list.</td> | |
| 399 </tr><tr> | |
| 400 <td><a href="#QsciScintillaCompat.startStyling">startStyling</a></td> | |
| 401 <td>Public method to prepare styling.</td> | |
| 402 </tr><tr> | |
| 403 <td><a href="#QsciScintillaCompat.styleAt">styleAt</a></td> | |
| 404 <td>Public method to get the style at a position in the text.</td> | |
| 405 </tr><tr> | |
| 406 <td><a href="#QsciScintillaCompat.updateUserListSize">updateUserListSize</a></td> | |
| 407 <td>Public method to resize the completion list to fit with contents.</td> | |
| 408 </tr><tr> | |
| 409 <td><a href="#QsciScintillaCompat.updateVerticalScrollBar">updateVerticalScrollBar</a></td> | |
| 410 <td>Public method to update the vertical scroll bar to reflect the additional lines added by annotations.</td> | |
| 411 </tr><tr> | |
| 412 <td><a href="#QsciScintillaCompat.zoomIn">zoomIn</a></td> | |
| 413 <td>Public method used to increase the zoom factor.</td> | |
| 414 </tr><tr> | |
| 415 <td><a href="#QsciScintillaCompat.zoomOut">zoomOut</a></td> | |
| 416 <td>Public method used to decrease the zoom factor.</td> | |
| 417 </tr><tr> | |
| 418 <td><a href="#QsciScintillaCompat.zoomTo">zoomTo</a></td> | |
| 419 <td>Public method used to zoom to a specific zoom factor.</td> | |
| 420 </tr> | |
| 421 </table> | |
| 422 <h3>Static Methods</h3> | |
| 423 <table> | |
| 424 <tr><td>None</td></tr> | |
| 425 </table> | |
| 426 <a NAME="QsciScintillaCompat.__init__" ID="QsciScintillaCompat.__init__"></a> | |
| 427 <h4>QsciScintillaCompat (Constructor)</h4> | |
| 428 <b>QsciScintillaCompat</b>(<i>parent=None</i>) | |
| 429 <p> | |
| 430 Constructor | |
| 431 </p><dl> | |
| 432 <dt><i>parent</i></dt> | |
| 433 <dd> | |
| 434 parent widget (QWidget) | |
| 435 </dd> | |
| 436 </dl><a NAME="QsciScintillaCompat.__completionListSelected" ID="QsciScintillaCompat.__completionListSelected"></a> | |
| 437 <h4>QsciScintillaCompat.__completionListSelected</h4> | |
| 438 <b>__completionListSelected</b>(<i>listId, txt</i>) | |
| 439 <p> | |
| 440 Private slot to handle the selection from the completion list. | |
| 441 </p><p> | |
| 442 Note: This works around an issue of some window managers taking | |
| 443 focus away from the application when clicked inside a completion | |
| 444 list but not giving it back when an item is selected via a | |
| 445 double-click. | |
| 446 </p><dl> | |
| 447 <dt><i>listId</i></dt> | |
| 448 <dd> | |
| 449 the ID of the user list (integer) | |
| 450 </dd><dt><i>txt</i></dt> | |
| 451 <dd> | |
| 452 the selected text (string) | |
| 453 </dd> | |
| 454 </dl><a NAME="QsciScintillaCompat.__doSearchTarget" ID="QsciScintillaCompat.__doSearchTarget"></a> | |
| 455 <h4>QsciScintillaCompat.__doSearchTarget</h4> | |
| 456 <b>__doSearchTarget</b>(<i></i>) | |
| 457 <p> | |
| 458 Private method to perform the search in target. | |
| 459 </p><dl> | |
| 460 <dt>Returns:</dt> | |
| 461 <dd> | |
| 462 flag indicating a successful search (boolean) | |
| 463 </dd> | |
| 464 </dl><a NAME="QsciScintillaCompat.__modificationChanged" ID="QsciScintillaCompat.__modificationChanged"></a> | |
| 465 <h4>QsciScintillaCompat.__modificationChanged</h4> | |
| 466 <b>__modificationChanged</b>(<i>m</i>) | |
| 467 <p> | |
| 468 Private slot to handle the modificationChanged signal. | |
| 469 </p><dl> | |
| 470 <dt><i>m</i></dt> | |
| 471 <dd> | |
| 472 modification status (boolean) | |
| 473 </dd> | |
| 474 </dl><a NAME="QsciScintillaCompat.__setFoldMarker" ID="QsciScintillaCompat.__setFoldMarker"></a> | |
| 475 <h4>QsciScintillaCompat.__setFoldMarker</h4> | |
| 476 <b>__setFoldMarker</b>(<i>marknr, mark=QsciScintilla.SC_MARK_EMPTY</i>) | |
| 477 <p> | |
| 478 Private method to define a fold marker. | |
| 479 </p><dl> | |
| 480 <dt><i>marknr</i></dt> | |
| 481 <dd> | |
| 482 marker number to define (integer) | |
| 483 </dd><dt><i>mark</i></dt> | |
| 484 <dd> | |
| 485 fold mark symbol to be used (integer) | |
| 486 </dd> | |
| 487 </dl><a NAME="QsciScintillaCompat._encodeString" ID="QsciScintillaCompat._encodeString"></a> | |
| 488 <h4>QsciScintillaCompat._encodeString</h4> | |
| 489 <b>_encodeString</b>(<i>string</i>) | |
| 490 <p> | |
| 491 Protected method to encode a string depending on the current mode. | |
| 492 </p><dl> | |
| 493 <dt><i>string</i></dt> | |
| 494 <dd> | |
| 495 string to be encoded (str) | |
| 496 </dd> | |
| 497 </dl><dl> | |
| 498 <dt>Returns:</dt> | |
| 499 <dd> | |
| 500 encoded string (bytes) | |
| 501 </dd> | |
| 502 </dl><a NAME="QsciScintillaCompat.autoCompleteFromAPIs" ID="QsciScintillaCompat.autoCompleteFromAPIs"></a> | |
| 503 <h4>QsciScintillaCompat.autoCompleteFromAPIs</h4> | |
| 504 <b>autoCompleteFromAPIs</b>(<i></i>) | |
| 505 <p> | |
| 506 Public method to resize list box after creation. | |
| 507 </p><a NAME="QsciScintillaCompat.autoCompleteFromAll" ID="QsciScintillaCompat.autoCompleteFromAll"></a> | |
| 508 <h4>QsciScintillaCompat.autoCompleteFromAll</h4> | |
| 509 <b>autoCompleteFromAll</b>(<i></i>) | |
| 510 <p> | |
| 511 Public method to resize list box after creation. | |
| 512 </p><a NAME="QsciScintillaCompat.autoCompleteFromDocument" ID="QsciScintillaCompat.autoCompleteFromDocument"></a> | |
| 513 <h4>QsciScintillaCompat.autoCompleteFromDocument</h4> | |
| 514 <b>autoCompleteFromDocument</b>(<i></i>) | |
| 515 <p> | |
| 516 Public method to resize list box after creation. | |
| 517 </p><a NAME="QsciScintillaCompat.byteAt" ID="QsciScintillaCompat.byteAt"></a> | |
| 518 <h4>QsciScintillaCompat.byteAt</h4> | |
| 519 <b>byteAt</b>(<i>pos</i>) | |
| 520 <p> | |
| 521 Public method to get the raw character (bytes) at a position in the | |
| 522 text. | |
| 523 </p><dl> | |
| 524 <dt><i>pos</i></dt> | |
| 525 <dd> | |
| 526 position in the text (integer) | |
| 527 </dd> | |
| 528 </dl><dl> | |
| 529 <dt>Returns:</dt> | |
| 530 <dd> | |
| 531 raw character at the requested position or empty bytes, if the | |
| 532 position is negative or past the end of the document (bytes) | |
| 533 </dd> | |
| 534 </dl><a NAME="QsciScintillaCompat.canPaste" ID="QsciScintillaCompat.canPaste"></a> | |
| 535 <h4>QsciScintillaCompat.canPaste</h4> | |
| 536 <b>canPaste</b>(<i></i>) | |
| 537 <p> | |
| 538 Public method to test, if the paste action is available (i.e. if the | |
| 539 clipboard contains some text). | |
| 540 </p><dl> | |
| 541 <dt>Returns:</dt> | |
| 542 <dd> | |
| 543 flag indicating the availability of 'paste' | |
| 544 </dd> | |
| 545 </dl><dl> | |
| 546 <dt>Return Type:</dt> | |
| 547 <dd> | |
| 548 bool | |
| 549 </dd> | |
| 550 </dl><a NAME="QsciScintillaCompat.charAt" ID="QsciScintillaCompat.charAt"></a> | |
| 551 <h4>QsciScintillaCompat.charAt</h4> | |
| 552 <b>charAt</b>(<i>pos</i>) | |
| 553 <p> | |
| 554 Public method to get the character at a position in the text observing | |
| 555 multibyte characters. | |
| 556 </p><dl> | |
| 557 <dt><i>pos</i></dt> | |
| 558 <dd> | |
| 559 position in the text (integer) | |
| 560 </dd> | |
| 561 </dl><dl> | |
| 562 <dt>Returns:</dt> | |
| 563 <dd> | |
| 564 character at the requested position or empty string, if the | |
| 565 position is negative or past the end of the document (string) | |
| 566 </dd> | |
| 567 </dl><a NAME="QsciScintillaCompat.clearAllIndicators" ID="QsciScintillaCompat.clearAllIndicators"></a> | |
| 568 <h4>QsciScintillaCompat.clearAllIndicators</h4> | |
| 569 <b>clearAllIndicators</b>(<i>indicator</i>) | |
| 570 <p> | |
| 571 Public method to clear all occurrences of an indicator. | |
| 572 </p><dl> | |
| 573 <dt><i>indicator</i></dt> | |
| 574 <dd> | |
| 575 number of the indicator (integer, | |
| 576 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 577 </dd> | |
| 578 </dl><a NAME="QsciScintillaCompat.clearAlternateKeys" ID="QsciScintillaCompat.clearAlternateKeys"></a> | |
| 579 <h4>QsciScintillaCompat.clearAlternateKeys</h4> | |
| 580 <b>clearAlternateKeys</b>(<i></i>) | |
| 581 <p> | |
| 582 Public method to clear the alternate key commands. | |
| 583 </p><a NAME="QsciScintillaCompat.clearIndicator" ID="QsciScintillaCompat.clearIndicator"></a> | |
| 584 <h4>QsciScintillaCompat.clearIndicator</h4> | |
| 585 <b>clearIndicator</b>(<i>indicator, sline, sindex, eline, eindex</i>) | |
| 586 <p> | |
| 587 Public method to clear an indicator for the given range. | |
| 588 </p><dl> | |
| 589 <dt><i>indicator</i></dt> | |
| 590 <dd> | |
| 591 number of the indicator (integer, | |
| 592 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 593 </dd><dt><i>sline</i></dt> | |
| 594 <dd> | |
| 595 line number of the indicator start (integer) | |
| 596 </dd><dt><i>sindex</i></dt> | |
| 597 <dd> | |
| 598 index of the indicator start (integer) | |
| 599 </dd><dt><i>eline</i></dt> | |
| 600 <dd> | |
| 601 line number of the indicator end (integer) | |
| 602 </dd><dt><i>eindex</i></dt> | |
| 603 <dd> | |
| 604 index of the indicator end (integer) | |
| 605 </dd> | |
| 606 </dl><a NAME="QsciScintillaCompat.clearIndicatorRange" ID="QsciScintillaCompat.clearIndicatorRange"></a> | |
| 607 <h4>QsciScintillaCompat.clearIndicatorRange</h4> | |
| 608 <b>clearIndicatorRange</b>(<i>indicator, spos, length</i>) | |
| 609 <p> | |
| 610 Public method to clear an indicator for the given range. | |
| 611 </p><dl> | |
| 612 <dt><i>indicator</i></dt> | |
| 613 <dd> | |
| 614 number of the indicator (integer, | |
| 615 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 616 </dd><dt><i>spos</i></dt> | |
| 617 <dd> | |
| 618 position of the indicator start (integer) | |
| 619 </dd><dt><i>length</i></dt> | |
| 620 <dd> | |
| 621 length of the indicator (integer) | |
| 622 </dd> | |
| 623 </dl><a NAME="QsciScintillaCompat.clearKeys" ID="QsciScintillaCompat.clearKeys"></a> | |
| 624 <h4>QsciScintillaCompat.clearKeys</h4> | |
| 625 <b>clearKeys</b>(<i></i>) | |
| 626 <p> | |
| 627 Public method to clear the key commands. | |
| 628 </p><a NAME="QsciScintillaCompat.clearStyles" ID="QsciScintillaCompat.clearStyles"></a> | |
| 629 <h4>QsciScintillaCompat.clearStyles</h4> | |
| 630 <b>clearStyles</b>(<i></i>) | |
| 631 <p> | |
| 632 Public method to set the styles according the selected Qt style. | |
| 633 </p><a NAME="QsciScintillaCompat.contractedFolds" ID="QsciScintillaCompat.contractedFolds"></a> | |
| 634 <h4>QsciScintillaCompat.contractedFolds</h4> | |
| 635 <b>contractedFolds</b>(<i></i>) | |
| 636 <p> | |
| 637 Public method to get a list of line numbers of collapsed folds. | |
| 638 </p><dl> | |
| 639 <dt>Returns:</dt> | |
| 640 <dd> | |
| 641 list of line numbers of folded lines (list of integer) | |
| 642 </dd> | |
| 643 </dl><a NAME="QsciScintillaCompat.currentPosition" ID="QsciScintillaCompat.currentPosition"></a> | |
| 644 <h4>QsciScintillaCompat.currentPosition</h4> | |
| 645 <b>currentPosition</b>(<i></i>) | |
| 646 <p> | |
| 647 Public method to get the current position. | |
| 648 </p><dl> | |
| 649 <dt>Returns:</dt> | |
| 650 <dd> | |
| 651 absolute position of the cursor (integer) | |
| 652 </dd> | |
| 653 </dl><a NAME="QsciScintillaCompat.currentStyle" ID="QsciScintillaCompat.currentStyle"></a> | |
| 654 <h4>QsciScintillaCompat.currentStyle</h4> | |
| 655 <b>currentStyle</b>(<i></i>) | |
| 656 <p> | |
| 657 Public method to get the style at the current position. | |
| 658 </p><dl> | |
| 659 <dt>Returns:</dt> | |
| 660 <dd> | |
| 661 style at the current position (integer) | |
| 662 </dd> | |
| 663 </dl><a NAME="QsciScintillaCompat.delete" ID="QsciScintillaCompat.delete"></a> | |
| 664 <h4>QsciScintillaCompat.delete</h4> | |
| 665 <b>delete</b>(<i></i>) | |
| 666 <p> | |
| 667 Public method to delete the character to the right of the cursor. | |
| 668 </p><a NAME="QsciScintillaCompat.deleteBack" ID="QsciScintillaCompat.deleteBack"></a> | |
| 669 <h4>QsciScintillaCompat.deleteBack</h4> | |
| 670 <b>deleteBack</b>(<i></i>) | |
| 671 <p> | |
| 672 Public method to delete the character to the left of the cursor. | |
| 673 </p><a NAME="QsciScintillaCompat.deleteLineLeft" ID="QsciScintillaCompat.deleteLineLeft"></a> | |
| 674 <h4>QsciScintillaCompat.deleteLineLeft</h4> | |
| 675 <b>deleteLineLeft</b>(<i></i>) | |
| 676 <p> | |
| 677 Public method to delete the line to the left of the cursor. | |
| 678 </p><a NAME="QsciScintillaCompat.deleteLineRight" ID="QsciScintillaCompat.deleteLineRight"></a> | |
| 679 <h4>QsciScintillaCompat.deleteLineRight</h4> | |
| 680 <b>deleteLineRight</b>(<i></i>) | |
| 681 <p> | |
| 682 Public method to delete the line to the right of the cursor. | |
| 683 </p><a NAME="QsciScintillaCompat.deleteWordLeft" ID="QsciScintillaCompat.deleteWordLeft"></a> | |
| 684 <h4>QsciScintillaCompat.deleteWordLeft</h4> | |
| 685 <b>deleteWordLeft</b>(<i></i>) | |
| 686 <p> | |
| 687 Public method to delete the word to the left of the cursor. | |
| 688 </p><a NAME="QsciScintillaCompat.deleteWordRight" ID="QsciScintillaCompat.deleteWordRight"></a> | |
| 689 <h4>QsciScintillaCompat.deleteWordRight</h4> | |
| 690 <b>deleteWordRight</b>(<i></i>) | |
| 691 <p> | |
| 692 Public method to delete the word to the right of the cursor. | |
| 693 </p><a NAME="QsciScintillaCompat.detectEolString" ID="QsciScintillaCompat.detectEolString"></a> | |
| 694 <h4>QsciScintillaCompat.detectEolString</h4> | |
| 695 <b>detectEolString</b>(<i>txt</i>) | |
| 696 <p> | |
| 697 Public method to determine the eol string used. | |
| 698 </p><dl> | |
| 699 <dt><i>txt</i></dt> | |
| 700 <dd> | |
| 701 text from which to determine the eol string (string) | |
| 702 </dd> | |
| 703 </dl><dl> | |
| 704 <dt>Returns:</dt> | |
| 705 <dd> | |
| 706 eol string (string) | |
| 707 </dd> | |
| 708 </dl><a NAME="QsciScintillaCompat.editorCommand" ID="QsciScintillaCompat.editorCommand"></a> | |
| 709 <h4>QsciScintillaCompat.editorCommand</h4> | |
| 710 <b>editorCommand</b>(<i>cmd</i>) | |
| 711 <p> | |
| 712 Public method to perform a simple editor command. | |
| 713 </p><dl> | |
| 714 <dt><i>cmd</i></dt> | |
| 715 <dd> | |
| 716 the scintilla command to be performed (integer) | |
| 717 </dd> | |
| 718 </dl><a NAME="QsciScintillaCompat.event" ID="QsciScintillaCompat.event"></a> | |
| 719 <h4>QsciScintillaCompat.event</h4> | |
| 720 <b>event</b>(<i>evt</i>) | |
| 721 <p> | |
| 722 Public method to handle events. | |
| 723 </p><p> | |
| 724 Note: We are not interested in the standard QsciScintilla event | |
| 725 handling because we do it ourselves. | |
| 726 </p><dl> | |
| 727 <dt><i>evt</i></dt> | |
| 728 <dd> | |
| 729 event object to handle (QEvent) | |
| 730 </dd> | |
| 731 </dl><dl> | |
| 732 <dt>Returns:</dt> | |
| 733 <dd> | |
| 734 result of the event handling (boolean) | |
| 735 </dd> | |
| 736 </dl><a NAME="QsciScintillaCompat.extendSelectionLeft" ID="QsciScintillaCompat.extendSelectionLeft"></a> | |
| 737 <h4>QsciScintillaCompat.extendSelectionLeft</h4> | |
| 738 <b>extendSelectionLeft</b>(<i></i>) | |
| 739 <p> | |
| 740 Public method to extend the selection one character to the left. | |
| 741 </p><a NAME="QsciScintillaCompat.extendSelectionRight" ID="QsciScintillaCompat.extendSelectionRight"></a> | |
| 742 <h4>QsciScintillaCompat.extendSelectionRight</h4> | |
| 743 <b>extendSelectionRight</b>(<i></i>) | |
| 744 <p> | |
| 745 Public method to extend the selection one character to the right. | |
| 746 </p><a NAME="QsciScintillaCompat.extendSelectionToBOL" ID="QsciScintillaCompat.extendSelectionToBOL"></a> | |
| 747 <h4>QsciScintillaCompat.extendSelectionToBOL</h4> | |
| 748 <b>extendSelectionToBOL</b>(<i></i>) | |
| 749 <p> | |
| 750 Public method to extend the selection to the beginning of the line. | |
| 751 </p><a NAME="QsciScintillaCompat.extendSelectionToEOL" ID="QsciScintillaCompat.extendSelectionToEOL"></a> | |
| 752 <h4>QsciScintillaCompat.extendSelectionToEOL</h4> | |
| 753 <b>extendSelectionToEOL</b>(<i></i>) | |
| 754 <p> | |
| 755 Public method to extend the selection to the end of the line. | |
| 756 </p><a NAME="QsciScintillaCompat.extendSelectionWordLeft" ID="QsciScintillaCompat.extendSelectionWordLeft"></a> | |
| 757 <h4>QsciScintillaCompat.extendSelectionWordLeft</h4> | |
| 758 <b>extendSelectionWordLeft</b>(<i></i>) | |
| 759 <p> | |
| 760 Public method to extend the selection one word to the left. | |
| 761 </p><a NAME="QsciScintillaCompat.extendSelectionWordRight" ID="QsciScintillaCompat.extendSelectionWordRight"></a> | |
| 762 <h4>QsciScintillaCompat.extendSelectionWordRight</h4> | |
| 763 <b>extendSelectionWordRight</b>(<i></i>) | |
| 764 <p> | |
| 765 Public method to extend the selection one word to the right. | |
| 766 </p><a NAME="QsciScintillaCompat.findFirst" ID="QsciScintillaCompat.findFirst"></a> | |
| 767 <h4>QsciScintillaCompat.findFirst</h4> | |
| 768 <b>findFirst</b>(<i>expression, regexp, caseSensitive, word, wrap, forward=True, line=-1, index=-1, show=True, posix=False, cxx11=False</i>) | |
| 769 <p> | |
| 770 Public method to search in the current editor text. | |
| 771 </p><dl> | |
| 772 <dt><i>expression</i> (str)</dt> | |
| 773 <dd> | |
| 774 search expression | |
| 775 </dd><dt><i>regexp</i> (bool)</dt> | |
| 776 <dd> | |
| 777 flag indicating a regular expression | |
| 778 </dd><dt><i>caseSensitive</i> (bool)</dt> | |
| 779 <dd> | |
| 780 flag indicating a case sensitive search | |
| 781 </dd><dt><i>word</i> (bool)</dt> | |
| 782 <dd> | |
| 783 flag indicating a word only search | |
| 784 </dd><dt><i>wrap</i> (bool)</dt> | |
| 785 <dd> | |
| 786 flag indicating to warp around | |
| 787 </dd><dt><i>forward</i> (bool)</dt> | |
| 788 <dd> | |
| 789 flag indicating the search direction | |
| 790 </dd><dt><i>line</i> (int)</dt> | |
| 791 <dd> | |
| 792 line to start the search on | |
| 793 </dd><dt><i>index</i> (int)</dt> | |
| 794 <dd> | |
| 795 index to start the search on | |
| 796 </dd><dt><i>show</i> (bool)</dt> | |
| 797 <dd> | |
| 798 flag indicating to set the selection to the found | |
| 799 expression | |
| 800 </dd><dt><i>posix</i> (bool)</dt> | |
| 801 <dd> | |
| 802 flag indicating the POSIX regular expression search mode | |
| 803 </dd><dt><i>cxx11</i> (bool)</dt> | |
| 804 <dd> | |
| 805 flag indicating the CXX11 regular expression search mode | |
| 806 </dd> | |
| 807 </dl><dl> | |
| 808 <dt>Returns:</dt> | |
| 809 <dd> | |
| 810 flag indicating a successful search | |
| 811 </dd> | |
| 812 </dl><dl> | |
| 813 <dt>Return Type:</dt> | |
| 814 <dd> | |
| 815 bool | |
| 816 </dd> | |
| 817 </dl><a NAME="QsciScintillaCompat.findFirstTarget" ID="QsciScintillaCompat.findFirstTarget"></a> | |
| 818 <h4>QsciScintillaCompat.findFirstTarget</h4> | |
| 819 <b>findFirstTarget</b>(<i>expr_, re_, cs_, wo_, begline=-1, begindex=-1, endline=-1, endindex=-1, ws_=False, posix=False, cxx11=False</i>) | |
| 820 <p> | |
| 821 Public method to search in a specified range of text without | |
| 822 setting the selection. | |
| 823 </p><dl> | |
| 824 <dt><i>expr_</i> (str)</dt> | |
| 825 <dd> | |
| 826 search expression | |
| 827 </dd><dt><i>re_</i> (bool)</dt> | |
| 828 <dd> | |
| 829 flag indicating a regular expression | |
| 830 </dd><dt><i>cs_</i> (bool)</dt> | |
| 831 <dd> | |
| 832 flag indicating a case sensitive search | |
| 833 </dd><dt><i>wo_</i> (bool)</dt> | |
| 834 <dd> | |
| 835 flag indicating a word only search | |
| 836 </dd><dt><i>begline</i> (int)</dt> | |
| 837 <dd> | |
| 838 line number to start from (-1 to indicate current | |
| 839 position) | |
| 840 </dd><dt><i>begindex</i> (int)</dt> | |
| 841 <dd> | |
| 842 index to start from (-1 to indicate current position) | |
| 843 </dd><dt><i>endline</i> (int)</dt> | |
| 844 <dd> | |
| 845 line number to stop at (-1 to indicate end of document) | |
| 846 </dd><dt><i>endindex</i> (int)</dt> | |
| 847 <dd> | |
| 848 index number to stop at (-1 to indicate end of | |
| 849 document) | |
| 850 </dd><dt><i>ws_</i> (bool)</dt> | |
| 851 <dd> | |
| 852 flag indicating a word start search (boolean) | |
| 853 </dd><dt><i>posix</i> (bool)</dt> | |
| 854 <dd> | |
| 855 | |
| 856 </dd><dt><i>cxx11</i> (bool)</dt> | |
| 857 <dd> | |
| 858 | |
| 859 </dd> | |
| 860 </dl><dl> | |
| 861 <dt>Returns:</dt> | |
| 862 <dd> | |
| 863 flag indicating a successful search | |
| 864 </dd> | |
| 865 </dl><dl> | |
| 866 <dt>Return Type:</dt> | |
| 867 <dd> | |
| 868 bool | |
| 869 </dd> | |
| 870 </dl><a NAME="QsciScintillaCompat.findNextTarget" ID="QsciScintillaCompat.findNextTarget"></a> | |
| 871 <h4>QsciScintillaCompat.findNextTarget</h4> | |
| 872 <b>findNextTarget</b>(<i></i>) | |
| 873 <p> | |
| 874 Public method to find the next occurrence in the target range. | |
| 875 </p><dl> | |
| 876 <dt>Returns:</dt> | |
| 877 <dd> | |
| 878 flag indicating a successful search (boolean) | |
| 879 </dd> | |
| 880 </dl><a NAME="QsciScintillaCompat.flashFindIndicator" ID="QsciScintillaCompat.flashFindIndicator"></a> | |
| 881 <h4>QsciScintillaCompat.flashFindIndicator</h4> | |
| 882 <b>flashFindIndicator</b>(<i>sline, sindex, eline, eindex</i>) | |
| 883 <p> | |
| 884 Public method to flash the find indicator for the given range. | |
| 885 </p><dl> | |
| 886 <dt><i>sline</i></dt> | |
| 887 <dd> | |
| 888 line number of the indicator start (integer) | |
| 889 </dd><dt><i>sindex</i></dt> | |
| 890 <dd> | |
| 891 index of the indicator start (integer) | |
| 892 </dd><dt><i>eline</i></dt> | |
| 893 <dd> | |
| 894 line number of the indicator end (integer) | |
| 895 </dd><dt><i>eindex</i></dt> | |
| 896 <dd> | |
| 897 index of the indicator end (integer) | |
| 898 </dd> | |
| 899 </dl><a NAME="QsciScintillaCompat.focusOutEvent" ID="QsciScintillaCompat.focusOutEvent"></a> | |
| 900 <h4>QsciScintillaCompat.focusOutEvent</h4> | |
| 901 <b>focusOutEvent</b>(<i>event</i>) | |
| 902 <p> | |
| 903 Protected method called when the editor loses focus. | |
| 904 </p><dl> | |
| 905 <dt><i>event</i></dt> | |
| 906 <dd> | |
| 907 event object (QFocusEvent) | |
| 908 </dd> | |
| 909 </dl><a NAME="QsciScintillaCompat.foldExpandedAt" ID="QsciScintillaCompat.foldExpandedAt"></a> | |
| 910 <h4>QsciScintillaCompat.foldExpandedAt</h4> | |
| 911 <b>foldExpandedAt</b>(<i>line</i>) | |
| 912 <p> | |
| 913 Public method to determine, if a fold is expanded. | |
| 914 </p><dl> | |
| 915 <dt><i>line</i></dt> | |
| 916 <dd> | |
| 917 line number (integer) | |
| 918 </dd> | |
| 919 </dl><dl> | |
| 920 <dt>Returns:</dt> | |
| 921 <dd> | |
| 922 flag indicating the fold expansion state of the line (boolean) | |
| 923 </dd> | |
| 924 </dl><a NAME="QsciScintillaCompat.foldFlagsAt" ID="QsciScintillaCompat.foldFlagsAt"></a> | |
| 925 <h4>QsciScintillaCompat.foldFlagsAt</h4> | |
| 926 <b>foldFlagsAt</b>(<i>line</i>) | |
| 927 <p> | |
| 928 Public method to get the fold flags of a line of the document. | |
| 929 </p><dl> | |
| 930 <dt><i>line</i></dt> | |
| 931 <dd> | |
| 932 line number (integer) | |
| 933 </dd> | |
| 934 </dl><dl> | |
| 935 <dt>Returns:</dt> | |
| 936 <dd> | |
| 937 fold flags of the given line (integer) | |
| 938 </dd> | |
| 939 </dl><a NAME="QsciScintillaCompat.foldHeaderAt" ID="QsciScintillaCompat.foldHeaderAt"></a> | |
| 940 <h4>QsciScintillaCompat.foldHeaderAt</h4> | |
| 941 <b>foldHeaderAt</b>(<i>line</i>) | |
| 942 <p> | |
| 943 Public method to determine, if a line of the document is a fold header | |
| 944 line. | |
| 945 </p><dl> | |
| 946 <dt><i>line</i></dt> | |
| 947 <dd> | |
| 948 line number (integer) | |
| 949 </dd> | |
| 950 </dl><dl> | |
| 951 <dt>Returns:</dt> | |
| 952 <dd> | |
| 953 flag indicating a fold header line (boolean) | |
| 954 </dd> | |
| 955 </dl><a NAME="QsciScintillaCompat.foldLevelAt" ID="QsciScintillaCompat.foldLevelAt"></a> | |
| 956 <h4>QsciScintillaCompat.foldLevelAt</h4> | |
| 957 <b>foldLevelAt</b>(<i>line</i>) | |
| 958 <p> | |
| 959 Public method to get the fold level of a line of the document. | |
| 960 </p><dl> | |
| 961 <dt><i>line</i></dt> | |
| 962 <dd> | |
| 963 line number (integer) | |
| 964 </dd> | |
| 965 </dl><dl> | |
| 966 <dt>Returns:</dt> | |
| 967 <dd> | |
| 968 fold level of the given line (integer) | |
| 969 </dd> | |
| 970 </dl><a NAME="QsciScintillaCompat.getCaretLineAlwaysVisible" ID="QsciScintillaCompat.getCaretLineAlwaysVisible"></a> | |
| 971 <h4>QsciScintillaCompat.getCaretLineAlwaysVisible</h4> | |
| 972 <b>getCaretLineAlwaysVisible</b>(<i></i>) | |
| 973 <p> | |
| 974 Public method to determine, if the caret line is visible even if | |
| 975 the editor doesn't have the focus. | |
| 976 </p><dl> | |
| 977 <dt>Returns:</dt> | |
| 978 <dd> | |
| 979 flag indicating an always visible caret line (boolean) | |
| 980 </dd> | |
| 981 </dl><a NAME="QsciScintillaCompat.getCursorFlashTime" ID="QsciScintillaCompat.getCursorFlashTime"></a> | |
| 982 <h4>QsciScintillaCompat.getCursorFlashTime</h4> | |
| 983 <b>getCursorFlashTime</b>(<i></i>) | |
| 984 <p> | |
| 985 Public method to get the flash (blink) time of the cursor in | |
| 986 milliseconds. | |
| 987 </p><p> | |
| 988 The flash time is the time required to display, invert and restore the | |
| 989 caret display. Usually the text cursor is displayed for half the cursor | |
| 990 flash time, then hidden for the same amount of time. | |
| 991 </p><dl> | |
| 992 <dt>Returns:</dt> | |
| 993 <dd> | |
| 994 flash time of the cursor in milliseconds (integer) | |
| 995 </dd> | |
| 996 </dl><a NAME="QsciScintillaCompat.getDocLineFromVisibleLine" ID="QsciScintillaCompat.getDocLineFromVisibleLine"></a> | |
| 997 <h4>QsciScintillaCompat.getDocLineFromVisibleLine</h4> | |
| 998 <b>getDocLineFromVisibleLine</b>(<i>displayLine</i>) | |
| 999 <p> | |
| 1000 Public method to convert a visible line number to a document line | |
| 1001 number (i.e. respect folded lines and annotations). | |
| 1002 </p><dl> | |
| 1003 <dt><i>displayLine</i> (int)</dt> | |
| 1004 <dd> | |
| 1005 display line number to be converted | |
| 1006 </dd> | |
| 1007 </dl><dl> | |
| 1008 <dt>Returns:</dt> | |
| 1009 <dd> | |
| 1010 document line number | |
| 1011 </dd> | |
| 1012 </dl><dl> | |
| 1013 <dt>Return Type:</dt> | |
| 1014 <dd> | |
| 1015 int | |
| 1016 </dd> | |
| 1017 </dl><a NAME="QsciScintillaCompat.getEndStyled" ID="QsciScintillaCompat.getEndStyled"></a> | |
| 1018 <h4>QsciScintillaCompat.getEndStyled</h4> | |
| 1019 <b>getEndStyled</b>(<i></i>) | |
| 1020 <p> | |
| 1021 Public method to get the last styled position. | |
| 1022 </p><dl> | |
| 1023 <dt>Returns:</dt> | |
| 1024 <dd> | |
| 1025 end position of the last styling run (integer) | |
| 1026 </dd> | |
| 1027 </dl><a NAME="QsciScintillaCompat.getEolIndicator" ID="QsciScintillaCompat.getEolIndicator"></a> | |
| 1028 <h4>QsciScintillaCompat.getEolIndicator</h4> | |
| 1029 <b>getEolIndicator</b>(<i></i>) | |
| 1030 <p> | |
| 1031 Public method to get the eol indicator for the current eol mode. | |
| 1032 </p><dl> | |
| 1033 <dt>Returns:</dt> | |
| 1034 <dd> | |
| 1035 eol indicator (string) | |
| 1036 </dd> | |
| 1037 </dl><a NAME="QsciScintillaCompat.getFileName" ID="QsciScintillaCompat.getFileName"></a> | |
| 1038 <h4>QsciScintillaCompat.getFileName</h4> | |
| 1039 <b>getFileName</b>(<i></i>) | |
| 1040 <p> | |
| 1041 Public method to return the name of the file being displayed. | |
| 1042 </p><dl> | |
| 1043 <dt>Returns:</dt> | |
| 1044 <dd> | |
| 1045 filename of the displayed file (string) | |
| 1046 </dd> | |
| 1047 </dl><a NAME="QsciScintillaCompat.getFoundTarget" ID="QsciScintillaCompat.getFoundTarget"></a> | |
| 1048 <h4>QsciScintillaCompat.getFoundTarget</h4> | |
| 1049 <b>getFoundTarget</b>(<i></i>) | |
| 1050 <p> | |
| 1051 Public method to get the recently found target. | |
| 1052 </p><dl> | |
| 1053 <dt>Returns:</dt> | |
| 1054 <dd> | |
| 1055 found target as a tuple of starting position and target length | |
| 1056 (integer, integer) | |
| 1057 </dd> | |
| 1058 </dl><a NAME="QsciScintillaCompat.getIndicatorEndPos" ID="QsciScintillaCompat.getIndicatorEndPos"></a> | |
| 1059 <h4>QsciScintillaCompat.getIndicatorEndPos</h4> | |
| 1060 <b>getIndicatorEndPos</b>(<i>indicator, pos</i>) | |
| 1061 <p> | |
| 1062 Public method to get the end position of an indicator at a position. | |
| 1063 </p><dl> | |
| 1064 <dt><i>indicator</i></dt> | |
| 1065 <dd> | |
| 1066 ID of the indicator (integer) | |
| 1067 </dd><dt><i>pos</i></dt> | |
| 1068 <dd> | |
| 1069 position within the indicator (integer) | |
| 1070 </dd> | |
| 1071 </dl><dl> | |
| 1072 <dt>Returns:</dt> | |
| 1073 <dd> | |
| 1074 end position of the indicator (integer) | |
| 1075 </dd> | |
| 1076 </dl><a NAME="QsciScintillaCompat.getIndicatorStartPos" ID="QsciScintillaCompat.getIndicatorStartPos"></a> | |
| 1077 <h4>QsciScintillaCompat.getIndicatorStartPos</h4> | |
| 1078 <b>getIndicatorStartPos</b>(<i>indicator, pos</i>) | |
| 1079 <p> | |
| 1080 Public method to get the start position of an indicator at a position. | |
| 1081 </p><dl> | |
| 1082 <dt><i>indicator</i></dt> | |
| 1083 <dd> | |
| 1084 ID of the indicator (integer) | |
| 1085 </dd><dt><i>pos</i></dt> | |
| 1086 <dd> | |
| 1087 position within the indicator (integer) | |
| 1088 </dd> | |
| 1089 </dl><dl> | |
| 1090 <dt>Returns:</dt> | |
| 1091 <dd> | |
| 1092 start position of the indicator (integer) | |
| 1093 </dd> | |
| 1094 </dl><a NAME="QsciScintillaCompat.getLineSeparator" ID="QsciScintillaCompat.getLineSeparator"></a> | |
| 1095 <h4>QsciScintillaCompat.getLineSeparator</h4> | |
| 1096 <b>getLineSeparator</b>(<i></i>) | |
| 1097 <p> | |
| 1098 Public method to get the line separator for the current eol mode. | |
| 1099 </p><dl> | |
| 1100 <dt>Returns:</dt> | |
| 1101 <dd> | |
| 1102 eol string (string) | |
| 1103 </dd> | |
| 1104 </dl><a NAME="QsciScintillaCompat.getRectangularSelection" ID="QsciScintillaCompat.getRectangularSelection"></a> | |
| 1105 <h4>QsciScintillaCompat.getRectangularSelection</h4> | |
| 1106 <b>getRectangularSelection</b>(<i></i>) | |
| 1107 <p> | |
| 1108 Public method to retrieve the start and end of a rectangular selection. | |
| 1109 </p><dl> | |
| 1110 <dt>Returns:</dt> | |
| 1111 <dd> | |
| 1112 tuple with start line and index and end line and index | |
| 1113 (tuple of four int) | |
| 1114 </dd> | |
| 1115 </dl><a NAME="QsciScintillaCompat.getSelectionCount" ID="QsciScintillaCompat.getSelectionCount"></a> | |
| 1116 <h4>QsciScintillaCompat.getSelectionCount</h4> | |
| 1117 <b>getSelectionCount</b>(<i></i>) | |
| 1118 <p> | |
| 1119 Public method to get the number of active selections. | |
| 1120 </p><dl> | |
| 1121 <dt>Returns:</dt> | |
| 1122 <dd> | |
| 1123 number of active selection (integer) | |
| 1124 </dd> | |
| 1125 </dl><a NAME="QsciScintillaCompat.getSelectionN" ID="QsciScintillaCompat.getSelectionN"></a> | |
| 1126 <h4>QsciScintillaCompat.getSelectionN</h4> | |
| 1127 <b>getSelectionN</b>(<i>index</i>) | |
| 1128 <p> | |
| 1129 Public method to get the start and end of a selection given by its | |
| 1130 index. | |
| 1131 </p><dl> | |
| 1132 <dt><i>index</i></dt> | |
| 1133 <dd> | |
| 1134 index of the selection (integer) | |
| 1135 </dd> | |
| 1136 </dl><dl> | |
| 1137 <dt>Returns:</dt> | |
| 1138 <dd> | |
| 1139 tuple with start line and index and end line and index | |
| 1140 (tuple of four int) for the given selection | |
| 1141 </dd> | |
| 1142 </dl><a NAME="QsciScintillaCompat.getSelections" ID="QsciScintillaCompat.getSelections"></a> | |
| 1143 <h4>QsciScintillaCompat.getSelections</h4> | |
| 1144 <b>getSelections</b>(<i></i>) | |
| 1145 <p> | |
| 1146 Public method to get the start and end coordinates of all active | |
| 1147 selections. | |
| 1148 </p><dl> | |
| 1149 <dt>Returns:</dt> | |
| 1150 <dd> | |
| 1151 list of tuples with start line and index and end line and index | |
| 1152 of each active selection (list of tuples of four int) | |
| 1153 </dd> | |
| 1154 </dl><a NAME="QsciScintillaCompat.getVisibleLineFromDocLine" ID="QsciScintillaCompat.getVisibleLineFromDocLine"></a> | |
| 1155 <h4>QsciScintillaCompat.getVisibleLineFromDocLine</h4> | |
| 1156 <b>getVisibleLineFromDocLine</b>(<i>docLine</i>) | |
| 1157 <p> | |
| 1158 Public method to convert a document line number to a visible line | |
| 1159 number (i.e. respect folded lines and annotations). | |
| 1160 </p><dl> | |
| 1161 <dt><i>docLine</i> (int)</dt> | |
| 1162 <dd> | |
| 1163 document line number to be converted | |
| 1164 </dd> | |
| 1165 </dl><dl> | |
| 1166 <dt>Returns:</dt> | |
| 1167 <dd> | |
| 1168 visible line number | |
| 1169 </dd> | |
| 1170 </dl><dl> | |
| 1171 <dt>Return Type:</dt> | |
| 1172 <dd> | |
| 1173 int | |
| 1174 </dd> | |
| 1175 </dl><a NAME="QsciScintillaCompat.getZoom" ID="QsciScintillaCompat.getZoom"></a> | |
| 1176 <h4>QsciScintillaCompat.getZoom</h4> | |
| 1177 <b>getZoom</b>(<i></i>) | |
| 1178 <p> | |
| 1179 Public method used to retrieve the current zoom factor. | |
| 1180 </p><dl> | |
| 1181 <dt>Returns:</dt> | |
| 1182 <dd> | |
| 1183 zoom factor (integer) | |
| 1184 </dd> | |
| 1185 </dl><a NAME="QsciScintillaCompat.gotoNextIndicator" ID="QsciScintillaCompat.gotoNextIndicator"></a> | |
| 1186 <h4>QsciScintillaCompat.gotoNextIndicator</h4> | |
| 1187 <b>gotoNextIndicator</b>(<i>indicator, wrap</i>) | |
| 1188 <p> | |
| 1189 Public method to move the cursor to the next position of an indicator. | |
| 1190 </p><p> | |
| 1191 This method ensures, that the position found is visible (i.e. unfolded | |
| 1192 and inside the visible range). The text containing the indicator is | |
| 1193 selected. | |
| 1194 </p><dl> | |
| 1195 <dt><i>indicator</i></dt> | |
| 1196 <dd> | |
| 1197 ID of the indicator to search (integer) | |
| 1198 </dd><dt><i>wrap</i></dt> | |
| 1199 <dd> | |
| 1200 flag indicating to wrap around at the beginning of the | |
| 1201 text (boolean) | |
| 1202 </dd> | |
| 1203 </dl><dl> | |
| 1204 <dt>Returns:</dt> | |
| 1205 <dd> | |
| 1206 flag indicating if the indicator was found (boolean) | |
| 1207 </dd> | |
| 1208 </dl><a NAME="QsciScintillaCompat.gotoPreviousIndicator" ID="QsciScintillaCompat.gotoPreviousIndicator"></a> | |
| 1209 <h4>QsciScintillaCompat.gotoPreviousIndicator</h4> | |
| 1210 <b>gotoPreviousIndicator</b>(<i>indicator, wrap</i>) | |
| 1211 <p> | |
| 1212 Public method to move the cursor to the previous position of an | |
| 1213 indicator. | |
| 1214 </p><p> | |
| 1215 This method ensures, that the position found is visible (i.e. unfolded | |
| 1216 and inside the visible range). The text containing the indicator is | |
| 1217 selected. | |
| 1218 </p><dl> | |
| 1219 <dt><i>indicator</i></dt> | |
| 1220 <dd> | |
| 1221 ID of the indicator to search (integer) | |
| 1222 </dd><dt><i>wrap</i></dt> | |
| 1223 <dd> | |
| 1224 flag indicating to wrap around at the beginning of the | |
| 1225 text (boolean) | |
| 1226 </dd> | |
| 1227 </dl><dl> | |
| 1228 <dt>Returns:</dt> | |
| 1229 <dd> | |
| 1230 flag indicating if the indicator was found (boolean) | |
| 1231 </dd> | |
| 1232 </dl><a NAME="QsciScintillaCompat.hasIndicator" ID="QsciScintillaCompat.hasIndicator"></a> | |
| 1233 <h4>QsciScintillaCompat.hasIndicator</h4> | |
| 1234 <b>hasIndicator</b>(<i>indicator, pos</i>) | |
| 1235 <p> | |
| 1236 Public method to test for the existence of an indicator. | |
| 1237 </p><dl> | |
| 1238 <dt><i>indicator</i></dt> | |
| 1239 <dd> | |
| 1240 number of the indicator (integer, | |
| 1241 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1242 </dd><dt><i>pos</i></dt> | |
| 1243 <dd> | |
| 1244 position to test (integer) | |
| 1245 </dd> | |
| 1246 </dl><dl> | |
| 1247 <dt>Returns:</dt> | |
| 1248 <dd> | |
| 1249 flag indicating the existence of the indicator (boolean) | |
| 1250 </dd> | |
| 1251 </dl><a NAME="QsciScintillaCompat.hasSelectedText" ID="QsciScintillaCompat.hasSelectedText"></a> | |
| 1252 <h4>QsciScintillaCompat.hasSelectedText</h4> | |
| 1253 <b>hasSelectedText</b>(<i></i>) | |
| 1254 <p> | |
| 1255 Public method to indicate the presence of selected text. | |
| 1256 </p><p> | |
| 1257 This is an overriding method to cope with a bug in QsciScintilla. | |
| 1258 </p><dl> | |
| 1259 <dt>Returns:</dt> | |
| 1260 <dd> | |
| 1261 flag indicating the presence of selected text (boolean) | |
| 1262 </dd> | |
| 1263 </dl><a NAME="QsciScintillaCompat.hasSelection" ID="QsciScintillaCompat.hasSelection"></a> | |
| 1264 <h4>QsciScintillaCompat.hasSelection</h4> | |
| 1265 <b>hasSelection</b>(<i></i>) | |
| 1266 <p> | |
| 1267 Public method to check for a selection. | |
| 1268 </p><dl> | |
| 1269 <dt>Returns:</dt> | |
| 1270 <dd> | |
| 1271 flag indicating the presence of a selection (boolean) | |
| 1272 </dd> | |
| 1273 </dl><a NAME="QsciScintillaCompat.hideFindIndicator" ID="QsciScintillaCompat.hideFindIndicator"></a> | |
| 1274 <h4>QsciScintillaCompat.hideFindIndicator</h4> | |
| 1275 <b>hideFindIndicator</b>(<i></i>) | |
| 1276 <p> | |
| 1277 Public method to hide the find indicator. | |
| 1278 </p><a NAME="QsciScintillaCompat.indentationGuideView" ID="QsciScintillaCompat.indentationGuideView"></a> | |
| 1279 <h4>QsciScintillaCompat.indentationGuideView</h4> | |
| 1280 <b>indentationGuideView</b>(<i></i>) | |
| 1281 <p> | |
| 1282 Public method to get the indentation guide view. | |
| 1283 </p><dl> | |
| 1284 <dt>Returns:</dt> | |
| 1285 <dd> | |
| 1286 indentation guide view (SC_IV_NONE, SC_IV_REAL, | |
| 1287 SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH) | |
| 1288 </dd> | |
| 1289 </dl><a NAME="QsciScintillaCompat.indicatorDefine" ID="QsciScintillaCompat.indicatorDefine"></a> | |
| 1290 <h4>QsciScintillaCompat.indicatorDefine</h4> | |
| 1291 <b>indicatorDefine</b>(<i>indicator, style, color</i>) | |
| 1292 <p> | |
| 1293 Public method to define the appearance of an indicator. | |
| 1294 </p><dl> | |
| 1295 <dt><i>indicator</i></dt> | |
| 1296 <dd> | |
| 1297 number of the indicator (integer, | |
| 1298 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1299 </dd><dt><i>style</i></dt> | |
| 1300 <dd> | |
| 1301 style to be used for the indicator | |
| 1302 (QsciScintilla.INDIC_PLAIN, QsciScintilla.INDIC_SQUIGGLE, | |
| 1303 QsciScintilla.INDIC_TT, QsciScintilla.INDIC_DIAGONAL, | |
| 1304 QsciScintilla.INDIC_STRIKE, QsciScintilla.INDIC_HIDDEN, | |
| 1305 QsciScintilla.INDIC_BOX, QsciScintilla.INDIC_ROUNDBOX, | |
| 1306 QsciScintilla.INDIC_STRAIGHTBOX, QsciScintilla.INDIC_FULLBOX, | |
| 1307 QsciScintilla.INDIC_DASH, QsciScintilla.INDIC_DOTS, | |
| 1308 QsciScintilla.INDIC_SQUIGGLELOW, QsciScintilla.INDIC_DOTBOX, | |
| 1309 QsciScintilla.INDIC_GRADIENT, QsciScintilla.INDIC_GRADIENTCENTRE, | |
| 1310 QsciScintilla.INDIC_SQUIGGLEPIXMAP, | |
| 1311 QsciScintilla.INDIC_COMPOSITIONTHICK, | |
| 1312 QsciScintilla.INDIC_COMPOSITIONTHIN, QsciScintilla.INDIC_TEXTFORE, | |
| 1313 QsciScintilla.INDIC_POINT, QsciScintilla.INDIC_POINTCHARACTER | |
| 1314 depending upon QScintilla version) | |
| 1315 </dd><dt><i>color</i></dt> | |
| 1316 <dd> | |
| 1317 color to be used by the indicator (QColor) | |
| 1318 </dd> | |
| 1319 </dl><dl> | |
| 1320 <dt>Raises <b>ValueError</b>:</dt> | |
| 1321 <dd> | |
| 1322 the indicator or style are not valid | |
| 1323 </dd> | |
| 1324 </dl><a NAME="QsciScintillaCompat.inputMethodEvent" ID="QsciScintillaCompat.inputMethodEvent"></a> | |
| 1325 <h4>QsciScintillaCompat.inputMethodEvent</h4> | |
| 1326 <b>inputMethodEvent</b>(<i>evt</i>) | |
| 1327 <p> | |
| 1328 Protected method to cope with a glitch in some Qscintilla versions | |
| 1329 handling input events. | |
| 1330 </p><p> | |
| 1331 Note: This simply disables the Qscintilla behavior. | |
| 1332 </p><dl> | |
| 1333 <dt><i>evt</i></dt> | |
| 1334 <dd> | |
| 1335 reference to the input method event object | |
| 1336 (QInputMethodEvent) | |
| 1337 </dd> | |
| 1338 </dl><a NAME="QsciScintillaCompat.inputMethodQuery" ID="QsciScintillaCompat.inputMethodQuery"></a> | |
| 1339 <h4>QsciScintillaCompat.inputMethodQuery</h4> | |
| 1340 <b>inputMethodQuery</b>(<i>query</i>) | |
| 1341 <p> | |
| 1342 Public method to cope with a glitch in some Qscintilla versions | |
| 1343 handling input events. | |
| 1344 </p><p> | |
| 1345 Note: This simply disables the Qscintilla behavior. | |
| 1346 </p><dl> | |
| 1347 <dt><i>query</i></dt> | |
| 1348 <dd> | |
| 1349 reference to the input method query object | |
| 1350 (Qt.InputMethodQuery) | |
| 1351 </dd> | |
| 1352 </dl><dl> | |
| 1353 <dt>Returns:</dt> | |
| 1354 <dd> | |
| 1355 object containing the requested information | |
| 1356 </dd> | |
| 1357 </dl><a NAME="QsciScintillaCompat.insert" ID="QsciScintillaCompat.insert"></a> | |
| 1358 <h4>QsciScintillaCompat.insert</h4> | |
| 1359 <b>insert</b>(<i>txt</i>) | |
| 1360 <p> | |
| 1361 Public method to insert text at the cursor position. | |
| 1362 </p><dl> | |
| 1363 <dt><i>txt</i> (str)</dt> | |
| 1364 <dd> | |
| 1365 text to be inserted | |
| 1366 </dd> | |
| 1367 </dl><a NAME="QsciScintillaCompat.isModified" ID="QsciScintillaCompat.isModified"></a> | |
| 1368 <h4>QsciScintillaCompat.isModified</h4> | |
| 1369 <b>isModified</b>(<i></i>) | |
| 1370 <p> | |
| 1371 Public method to return the modification status. | |
| 1372 </p><dl> | |
| 1373 <dt>Returns:</dt> | |
| 1374 <dd> | |
| 1375 flag indicating the modification status (boolean) | |
| 1376 </dd> | |
| 1377 </dl><a NAME="QsciScintillaCompat.lineAt" ID="QsciScintillaCompat.lineAt"></a> | |
| 1378 <h4>QsciScintillaCompat.lineAt</h4> | |
| 1379 <b>lineAt</b>(<i>pos</i>) | |
| 1380 <p> | |
| 1381 Public method to calculate the line at a position. | |
| 1382 </p><p> | |
| 1383 This variant is able to calculate the line for positions in the | |
| 1384 margins and for empty lines. | |
| 1385 </p><dl> | |
| 1386 <dt><i>pos</i></dt> | |
| 1387 <dd> | |
| 1388 position to calculate the line for (integer or QPoint) | |
| 1389 </dd> | |
| 1390 </dl><dl> | |
| 1391 <dt>Returns:</dt> | |
| 1392 <dd> | |
| 1393 linenumber at position or -1, if there is no line at pos | |
| 1394 (integer, zero based) | |
| 1395 </dd> | |
| 1396 </dl><a NAME="QsciScintillaCompat.lineEndPosition" ID="QsciScintillaCompat.lineEndPosition"></a> | |
| 1397 <h4>QsciScintillaCompat.lineEndPosition</h4> | |
| 1398 <b>lineEndPosition</b>(<i>line</i>) | |
| 1399 <p> | |
| 1400 Public method to determine the line end position of the given line. | |
| 1401 </p><dl> | |
| 1402 <dt><i>line</i></dt> | |
| 1403 <dd> | |
| 1404 line number (integer) | |
| 1405 </dd> | |
| 1406 </dl><dl> | |
| 1407 <dt>Returns:</dt> | |
| 1408 <dd> | |
| 1409 position of the line end disregarding line end characters | |
| 1410 (integer) | |
| 1411 </dd> | |
| 1412 </dl><a NAME="QsciScintillaCompat.lineIndexFromPosition" ID="QsciScintillaCompat.lineIndexFromPosition"></a> | |
| 1413 <h4>QsciScintillaCompat.lineIndexFromPosition</h4> | |
| 1414 <b>lineIndexFromPosition</b>(<i>pos</i>) | |
| 1415 <p> | |
| 1416 Public method to convert an absolute position to line and index. | |
| 1417 </p><dl> | |
| 1418 <dt><i>pos</i></dt> | |
| 1419 <dd> | |
| 1420 absolute position in the editor (integer) | |
| 1421 </dd> | |
| 1422 </dl><dl> | |
| 1423 <dt>Returns:</dt> | |
| 1424 <dd> | |
| 1425 tuple of line number (integer) and index number (integer) | |
| 1426 </dd> | |
| 1427 </dl><a NAME="QsciScintillaCompat.linesOnScreen" ID="QsciScintillaCompat.linesOnScreen"></a> | |
| 1428 <h4>QsciScintillaCompat.linesOnScreen</h4> | |
| 1429 <b>linesOnScreen</b>(<i></i>) | |
| 1430 <p> | |
| 1431 Public method to get the amount of visible lines. | |
| 1432 </p><dl> | |
| 1433 <dt>Returns:</dt> | |
| 1434 <dd> | |
| 1435 amount of visible lines (integer) | |
| 1436 </dd> | |
| 1437 </dl><a NAME="QsciScintillaCompat.monospacedStyles" ID="QsciScintillaCompat.monospacedStyles"></a> | |
| 1438 <h4>QsciScintillaCompat.monospacedStyles</h4> | |
| 1439 <b>monospacedStyles</b>(<i>font</i>) | |
| 1440 <p> | |
| 1441 Public method to set the current style to be monospaced. | |
| 1442 </p><dl> | |
| 1443 <dt><i>font</i></dt> | |
| 1444 <dd> | |
| 1445 font to be used (QFont) | |
| 1446 </dd> | |
| 1447 </dl><a NAME="QsciScintillaCompat.moveCursorLeft" ID="QsciScintillaCompat.moveCursorLeft"></a> | |
| 1448 <h4>QsciScintillaCompat.moveCursorLeft</h4> | |
| 1449 <b>moveCursorLeft</b>(<i></i>) | |
| 1450 <p> | |
| 1451 Public method to move the cursor left. | |
| 1452 </p><a NAME="QsciScintillaCompat.moveCursorRight" ID="QsciScintillaCompat.moveCursorRight"></a> | |
| 1453 <h4>QsciScintillaCompat.moveCursorRight</h4> | |
| 1454 <b>moveCursorRight</b>(<i></i>) | |
| 1455 <p> | |
| 1456 Public method to move the cursor right. | |
| 1457 </p><a NAME="QsciScintillaCompat.moveCursorToEOL" ID="QsciScintillaCompat.moveCursorToEOL"></a> | |
| 1458 <h4>QsciScintillaCompat.moveCursorToEOL</h4> | |
| 1459 <b>moveCursorToEOL</b>(<i></i>) | |
| 1460 <p> | |
| 1461 Public method to move the cursor to the end of line. | |
| 1462 </p><a NAME="QsciScintillaCompat.moveCursorWordLeft" ID="QsciScintillaCompat.moveCursorWordLeft"></a> | |
| 1463 <h4>QsciScintillaCompat.moveCursorWordLeft</h4> | |
| 1464 <b>moveCursorWordLeft</b>(<i></i>) | |
| 1465 <p> | |
| 1466 Public method to move the cursor left one word. | |
| 1467 </p><a NAME="QsciScintillaCompat.moveCursorWordRight" ID="QsciScintillaCompat.moveCursorWordRight"></a> | |
| 1468 <h4>QsciScintillaCompat.moveCursorWordRight</h4> | |
| 1469 <b>moveCursorWordRight</b>(<i></i>) | |
| 1470 <p> | |
| 1471 Public method to move the cursor right one word. | |
| 1472 </p><a NAME="QsciScintillaCompat.newLineBelow" ID="QsciScintillaCompat.newLineBelow"></a> | |
| 1473 <h4>QsciScintillaCompat.newLineBelow</h4> | |
| 1474 <b>newLineBelow</b>(<i></i>) | |
| 1475 <p> | |
| 1476 Public method to insert a new line below the current one. | |
| 1477 </p><a NAME="QsciScintillaCompat.positionAfter" ID="QsciScintillaCompat.positionAfter"></a> | |
| 1478 <h4>QsciScintillaCompat.positionAfter</h4> | |
| 1479 <b>positionAfter</b>(<i>pos</i>) | |
| 1480 <p> | |
| 1481 Public method to get the position after the given position taking into | |
| 1482 account multibyte characters. | |
| 1483 </p><dl> | |
| 1484 <dt><i>pos</i></dt> | |
| 1485 <dd> | |
| 1486 position (integer) | |
| 1487 </dd> | |
| 1488 </dl><dl> | |
| 1489 <dt>Returns:</dt> | |
| 1490 <dd> | |
| 1491 position after the given one (integer) | |
| 1492 </dd> | |
| 1493 </dl><a NAME="QsciScintillaCompat.positionBefore" ID="QsciScintillaCompat.positionBefore"></a> | |
| 1494 <h4>QsciScintillaCompat.positionBefore</h4> | |
| 1495 <b>positionBefore</b>(<i>pos</i>) | |
| 1496 <p> | |
| 1497 Public method to get the position before the given position taking into | |
| 1498 account multibyte characters. | |
| 1499 </p><dl> | |
| 1500 <dt><i>pos</i></dt> | |
| 1501 <dd> | |
| 1502 position (integer) | |
| 1503 </dd> | |
| 1504 </dl><dl> | |
| 1505 <dt>Returns:</dt> | |
| 1506 <dd> | |
| 1507 position before the given one (integer) | |
| 1508 </dd> | |
| 1509 </dl><a NAME="QsciScintillaCompat.positionFromLineIndex" ID="QsciScintillaCompat.positionFromLineIndex"></a> | |
| 1510 <h4>QsciScintillaCompat.positionFromLineIndex</h4> | |
| 1511 <b>positionFromLineIndex</b>(<i>line, index</i>) | |
| 1512 <p> | |
| 1513 Public method to convert line and index to an absolute position. | |
| 1514 </p><dl> | |
| 1515 <dt><i>line</i></dt> | |
| 1516 <dd> | |
| 1517 line number (integer) | |
| 1518 </dd><dt><i>index</i></dt> | |
| 1519 <dd> | |
| 1520 index number (integer) | |
| 1521 </dd> | |
| 1522 </dl><dl> | |
| 1523 <dt>Returns:</dt> | |
| 1524 <dd> | |
| 1525 absolute position in the editor (integer) | |
| 1526 </dd> | |
| 1527 </dl><a NAME="QsciScintillaCompat.positionFromPoint" ID="QsciScintillaCompat.positionFromPoint"></a> | |
| 1528 <h4>QsciScintillaCompat.positionFromPoint</h4> | |
| 1529 <b>positionFromPoint</b>(<i>point</i>) | |
| 1530 <p> | |
| 1531 Public method to calculate the scintilla position from a point in the | |
| 1532 window. | |
| 1533 </p><dl> | |
| 1534 <dt><i>point</i></dt> | |
| 1535 <dd> | |
| 1536 point in the window (QPoint) | |
| 1537 </dd> | |
| 1538 </dl><dl> | |
| 1539 <dt>Returns:</dt> | |
| 1540 <dd> | |
| 1541 scintilla position (integer) or -1 to indicate, that the point | |
| 1542 is not near any character | |
| 1543 </dd> | |
| 1544 </dl><a NAME="QsciScintillaCompat.replaceTarget" ID="QsciScintillaCompat.replaceTarget"></a> | |
| 1545 <h4>QsciScintillaCompat.replaceTarget</h4> | |
| 1546 <b>replaceTarget</b>(<i>replaceStr</i>) | |
| 1547 <p> | |
| 1548 Public method to replace the string found by the last search in target. | |
| 1549 </p><dl> | |
| 1550 <dt><i>replaceStr</i></dt> | |
| 1551 <dd> | |
| 1552 replacement string or regexp (string) | |
| 1553 </dd> | |
| 1554 </dl><a NAME="QsciScintillaCompat.scrollVertical" ID="QsciScintillaCompat.scrollVertical"></a> | |
| 1555 <h4>QsciScintillaCompat.scrollVertical</h4> | |
| 1556 <b>scrollVertical</b>(<i>lines</i>) | |
| 1557 <p> | |
| 1558 Public method to scroll the text area. | |
| 1559 </p><dl> | |
| 1560 <dt><i>lines</i></dt> | |
| 1561 <dd> | |
| 1562 number of lines to scroll (negative scrolls up, | |
| 1563 positive scrolls down) (integer) | |
| 1564 </dd> | |
| 1565 </dl><a NAME="QsciScintillaCompat.selectionIsRectangle" ID="QsciScintillaCompat.selectionIsRectangle"></a> | |
| 1566 <h4>QsciScintillaCompat.selectionIsRectangle</h4> | |
| 1567 <b>selectionIsRectangle</b>(<i></i>) | |
| 1568 <p> | |
| 1569 Public method to check, if the current selection is rectangular. | |
| 1570 </p><dl> | |
| 1571 <dt>Returns:</dt> | |
| 1572 <dd> | |
| 1573 flag indicating a rectangular selection (boolean) | |
| 1574 </dd> | |
| 1575 </dl><a NAME="QsciScintillaCompat.setCaretLineAlwaysVisible" ID="QsciScintillaCompat.setCaretLineAlwaysVisible"></a> | |
| 1576 <h4>QsciScintillaCompat.setCaretLineAlwaysVisible</h4> | |
| 1577 <b>setCaretLineAlwaysVisible</b>(<i>alwaysVisible</i>) | |
| 1578 <p> | |
| 1579 Public method to set the caret line visible even if the editor doesn't | |
| 1580 have the focus. | |
| 1581 </p><dl> | |
| 1582 <dt><i>alwaysVisible</i></dt> | |
| 1583 <dd> | |
| 1584 flag indicating that the caret line shall be | |
| 1585 visible even if the editor doesn't have the focus (boolean) | |
| 1586 </dd> | |
| 1587 </dl><a NAME="QsciScintillaCompat.setContractedFolds" ID="QsciScintillaCompat.setContractedFolds"></a> | |
| 1588 <h4>QsciScintillaCompat.setContractedFolds</h4> | |
| 1589 <b>setContractedFolds</b>(<i>folds</i>) | |
| 1590 <p> | |
| 1591 Public method to set a list of line numbers of collapsed folds. | |
| 1592 </p><dl> | |
| 1593 <dt><i>folds</i></dt> | |
| 1594 <dd> | |
| 1595 list of line numbers of folded lines (list of integer) | |
| 1596 </dd> | |
| 1597 </dl><a NAME="QsciScintillaCompat.setCurrentIndicator" ID="QsciScintillaCompat.setCurrentIndicator"></a> | |
| 1598 <h4>QsciScintillaCompat.setCurrentIndicator</h4> | |
| 1599 <b>setCurrentIndicator</b>(<i>indicator</i>) | |
| 1600 <p> | |
| 1601 Public method to set the current indicator. | |
| 1602 </p><dl> | |
| 1603 <dt><i>indicator</i></dt> | |
| 1604 <dd> | |
| 1605 number of the indicator (integer, | |
| 1606 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1607 </dd> | |
| 1608 </dl><dl> | |
| 1609 <dt>Raises <b>ValueError</b>:</dt> | |
| 1610 <dd> | |
| 1611 the indicator or style are not valid | |
| 1612 </dd> | |
| 1613 </dl><a NAME="QsciScintillaCompat.setCursorFlashTime" ID="QsciScintillaCompat.setCursorFlashTime"></a> | |
| 1614 <h4>QsciScintillaCompat.setCursorFlashTime</h4> | |
| 1615 <b>setCursorFlashTime</b>(<i>time</i>) | |
| 1616 <p> | |
| 1617 Public method to set the flash (blink) time of the cursor in | |
| 1618 milliseconds. | |
| 1619 </p><p> | |
| 1620 The flash time is the time required to display, invert and restore the | |
| 1621 caret display. Usually the text cursor is displayed for half the cursor | |
| 1622 flash time, then hidden for the same amount of time. | |
| 1623 </p><dl> | |
| 1624 <dt><i>time</i></dt> | |
| 1625 <dd> | |
| 1626 flash time of the cursor in milliseconds (integer) | |
| 1627 </dd> | |
| 1628 </dl><a NAME="QsciScintillaCompat.setEolModeByEolString" ID="QsciScintillaCompat.setEolModeByEolString"></a> | |
| 1629 <h4>QsciScintillaCompat.setEolModeByEolString</h4> | |
| 1630 <b>setEolModeByEolString</b>(<i>eolStr</i>) | |
| 1631 <p> | |
| 1632 Public method to set the eol mode given the eol string. | |
| 1633 </p><dl> | |
| 1634 <dt><i>eolStr</i></dt> | |
| 1635 <dd> | |
| 1636 eol string (string) | |
| 1637 </dd> | |
| 1638 </dl><a NAME="QsciScintillaCompat.setFoldMarkersColors" ID="QsciScintillaCompat.setFoldMarkersColors"></a> | |
| 1639 <h4>QsciScintillaCompat.setFoldMarkersColors</h4> | |
| 1640 <b>setFoldMarkersColors</b>(<i>foreColor, backColor</i>) | |
| 1641 <p> | |
| 1642 Public method to set the foreground and background colors of the | |
| 1643 fold markers. | |
| 1644 </p><dl> | |
| 1645 <dt><i>foreColor</i></dt> | |
| 1646 <dd> | |
| 1647 foreground color (QColor) | |
| 1648 </dd><dt><i>backColor</i></dt> | |
| 1649 <dd> | |
| 1650 background color (QColor) | |
| 1651 </dd> | |
| 1652 </dl><a NAME="QsciScintillaCompat.setFolding" ID="QsciScintillaCompat.setFolding"></a> | |
| 1653 <h4>QsciScintillaCompat.setFolding</h4> | |
| 1654 <b>setFolding</b>(<i>style, margin=2</i>) | |
| 1655 <p> | |
| 1656 Public method to set the folding style and margin. | |
| 1657 </p><dl> | |
| 1658 <dt><i>style</i></dt> | |
| 1659 <dd> | |
| 1660 folding style to set (integer) | |
| 1661 </dd><dt><i>margin</i></dt> | |
| 1662 <dd> | |
| 1663 margin number (integer) | |
| 1664 </dd> | |
| 1665 </dl><a NAME="QsciScintillaCompat.setIndentationGuideView" ID="QsciScintillaCompat.setIndentationGuideView"></a> | |
| 1666 <h4>QsciScintillaCompat.setIndentationGuideView</h4> | |
| 1667 <b>setIndentationGuideView</b>(<i>view</i>) | |
| 1668 <p> | |
| 1669 Public method to set the view of the indentation guides. | |
| 1670 </p><dl> | |
| 1671 <dt><i>view</i></dt> | |
| 1672 <dd> | |
| 1673 view of the indentation guides (SC_IV_NONE, SC_IV_REAL, | |
| 1674 SC_IV_LOOKFORWARD or SC_IV_LOOKBOTH) | |
| 1675 </dd> | |
| 1676 </dl><a NAME="QsciScintillaCompat.setIndicator" ID="QsciScintillaCompat.setIndicator"></a> | |
| 1677 <h4>QsciScintillaCompat.setIndicator</h4> | |
| 1678 <b>setIndicator</b>(<i>indicator, sline, sindex, eline, eindex</i>) | |
| 1679 <p> | |
| 1680 Public method to set an indicator for the given range. | |
| 1681 </p><dl> | |
| 1682 <dt><i>indicator</i></dt> | |
| 1683 <dd> | |
| 1684 number of the indicator (integer, | |
| 1685 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1686 </dd><dt><i>sline</i></dt> | |
| 1687 <dd> | |
| 1688 line number of the indicator start (integer) | |
| 1689 </dd><dt><i>sindex</i></dt> | |
| 1690 <dd> | |
| 1691 index of the indicator start (integer) | |
| 1692 </dd><dt><i>eline</i></dt> | |
| 1693 <dd> | |
| 1694 line number of the indicator end (integer) | |
| 1695 </dd><dt><i>eindex</i></dt> | |
| 1696 <dd> | |
| 1697 index of the indicator end (integer) | |
| 1698 </dd> | |
| 1699 </dl><a NAME="QsciScintillaCompat.setIndicatorRange" ID="QsciScintillaCompat.setIndicatorRange"></a> | |
| 1700 <h4>QsciScintillaCompat.setIndicatorRange</h4> | |
| 1701 <b>setIndicatorRange</b>(<i>indicator, spos, length</i>) | |
| 1702 <p> | |
| 1703 Public method to set an indicator for the given range. | |
| 1704 </p><dl> | |
| 1705 <dt><i>indicator</i></dt> | |
| 1706 <dd> | |
| 1707 number of the indicator (integer, | |
| 1708 QsciScintilla.INDIC_CONTAINER .. QsciScintilla.INDIC_MAX) | |
| 1709 </dd><dt><i>spos</i></dt> | |
| 1710 <dd> | |
| 1711 position of the indicator start (integer) | |
| 1712 </dd><dt><i>length</i></dt> | |
| 1713 <dd> | |
| 1714 length of the indicator (integer) | |
| 1715 </dd> | |
| 1716 </dl><a NAME="QsciScintillaCompat.setLexer" ID="QsciScintillaCompat.setLexer"></a> | |
| 1717 <h4>QsciScintillaCompat.setLexer</h4> | |
| 1718 <b>setLexer</b>(<i>lex=None</i>) | |
| 1719 <p> | |
| 1720 Public method to set the lexer. | |
| 1721 </p><dl> | |
| 1722 <dt><i>lex</i></dt> | |
| 1723 <dd> | |
| 1724 the lexer to be set or None to reset it. | |
| 1725 </dd> | |
| 1726 </dl><a NAME="QsciScintillaCompat.setModified" ID="QsciScintillaCompat.setModified"></a> | |
| 1727 <h4>QsciScintillaCompat.setModified</h4> | |
| 1728 <b>setModified</b>(<i>m</i>) | |
| 1729 <p> | |
| 1730 Public slot to set the modification status. | |
| 1731 </p><dl> | |
| 1732 <dt><i>m</i></dt> | |
| 1733 <dd> | |
| 1734 new modification status (boolean) | |
| 1735 </dd> | |
| 1736 </dl><a NAME="QsciScintillaCompat.setRectangularSelection" ID="QsciScintillaCompat.setRectangularSelection"></a> | |
| 1737 <h4>QsciScintillaCompat.setRectangularSelection</h4> | |
| 1738 <b>setRectangularSelection</b>(<i>startLine, startIndex, endLine, endIndex</i>) | |
| 1739 <p> | |
| 1740 Public method to set a rectangular selection. | |
| 1741 </p><dl> | |
| 1742 <dt><i>startLine</i></dt> | |
| 1743 <dd> | |
| 1744 line number of the start of the selection (int) | |
| 1745 </dd><dt><i>startIndex</i></dt> | |
| 1746 <dd> | |
| 1747 index number of the start of the selection (int) | |
| 1748 </dd><dt><i>endLine</i></dt> | |
| 1749 <dd> | |
| 1750 line number of the end of the selection (int) | |
| 1751 </dd><dt><i>endIndex</i></dt> | |
| 1752 <dd> | |
| 1753 index number of the end of the selection (int) | |
| 1754 </dd> | |
| 1755 </dl><a NAME="QsciScintillaCompat.setStyling" ID="QsciScintillaCompat.setStyling"></a> | |
| 1756 <h4>QsciScintillaCompat.setStyling</h4> | |
| 1757 <b>setStyling</b>(<i>length, style</i>) | |
| 1758 <p> | |
| 1759 Public method to style some text. | |
| 1760 </p><dl> | |
| 1761 <dt><i>length</i></dt> | |
| 1762 <dd> | |
| 1763 length of text to style (integer) | |
| 1764 </dd><dt><i>style</i></dt> | |
| 1765 <dd> | |
| 1766 style to set for text (integer) | |
| 1767 </dd> | |
| 1768 </dl><a NAME="QsciScintillaCompat.setVirtualSpaceOptions" ID="QsciScintillaCompat.setVirtualSpaceOptions"></a> | |
| 1769 <h4>QsciScintillaCompat.setVirtualSpaceOptions</h4> | |
| 1770 <b>setVirtualSpaceOptions</b>(<i>options</i>) | |
| 1771 <p> | |
| 1772 Public method to set the virtual space usage options. | |
| 1773 </p><dl> | |
| 1774 <dt><i>options</i></dt> | |
| 1775 <dd> | |
| 1776 usage options to set (integer, 0 to 3) | |
| 1777 </dd> | |
| 1778 </dl><a NAME="QsciScintillaCompat.setWrapStartIndent" ID="QsciScintillaCompat.setWrapStartIndent"></a> | |
| 1779 <h4>QsciScintillaCompat.setWrapStartIndent</h4> | |
| 1780 <b>setWrapStartIndent</b>(<i>indent</i>) | |
| 1781 <p> | |
| 1782 Public method to set a the amount of characters wrapped sublines | |
| 1783 shall be indented. | |
| 1784 </p><dl> | |
| 1785 <dt><i>indent</i> (int)</dt> | |
| 1786 <dd> | |
| 1787 amount of characters to indent | |
| 1788 </dd> | |
| 1789 </dl><a NAME="QsciScintillaCompat.showFindIndicator" ID="QsciScintillaCompat.showFindIndicator"></a> | |
| 1790 <h4>QsciScintillaCompat.showFindIndicator</h4> | |
| 1791 <b>showFindIndicator</b>(<i>sline, sindex, eline, eindex</i>) | |
| 1792 <p> | |
| 1793 Public method to show the find indicator for the given range. | |
| 1794 </p><dl> | |
| 1795 <dt><i>sline</i></dt> | |
| 1796 <dd> | |
| 1797 line number of the indicator start (integer) | |
| 1798 </dd><dt><i>sindex</i></dt> | |
| 1799 <dd> | |
| 1800 index of the indicator start (integer) | |
| 1801 </dd><dt><i>eline</i></dt> | |
| 1802 <dd> | |
| 1803 line number of the indicator end (integer) | |
| 1804 </dd><dt><i>eindex</i></dt> | |
| 1805 <dd> | |
| 1806 index of the indicator end (integer) | |
| 1807 </dd> | |
| 1808 </dl><a NAME="QsciScintillaCompat.showUserList" ID="QsciScintillaCompat.showUserList"></a> | |
| 1809 <h4>QsciScintillaCompat.showUserList</h4> | |
| 1810 <b>showUserList</b>(<i>listId, lst</i>) | |
| 1811 <p> | |
| 1812 Public method to show a user supplied list. | |
| 1813 </p><dl> | |
| 1814 <dt><i>listId</i></dt> | |
| 1815 <dd> | |
| 1816 id of the list (integer) | |
| 1817 </dd><dt><i>lst</i></dt> | |
| 1818 <dd> | |
| 1819 list to be show (list of strings) | |
| 1820 </dd> | |
| 1821 </dl><a NAME="QsciScintillaCompat.startStyling" ID="QsciScintillaCompat.startStyling"></a> | |
| 1822 <h4>QsciScintillaCompat.startStyling</h4> | |
| 1823 <b>startStyling</b>(<i>pos, mask</i>) | |
| 1824 <p> | |
| 1825 Public method to prepare styling. | |
| 1826 </p><dl> | |
| 1827 <dt><i>pos</i></dt> | |
| 1828 <dd> | |
| 1829 styling positition to start at (integer) | |
| 1830 </dd><dt><i>mask</i></dt> | |
| 1831 <dd> | |
| 1832 mask of bits to use for styling (integer) | |
| 1833 </dd> | |
| 1834 </dl><a NAME="QsciScintillaCompat.styleAt" ID="QsciScintillaCompat.styleAt"></a> | |
| 1835 <h4>QsciScintillaCompat.styleAt</h4> | |
| 1836 <b>styleAt</b>(<i>pos</i>) | |
| 1837 <p> | |
| 1838 Public method to get the style at a position in the text. | |
| 1839 </p><dl> | |
| 1840 <dt><i>pos</i></dt> | |
| 1841 <dd> | |
| 1842 position in the text (integer) | |
| 1843 </dd> | |
| 1844 </dl><dl> | |
| 1845 <dt>Returns:</dt> | |
| 1846 <dd> | |
| 1847 style at the requested position or 0, if the position | |
| 1848 is negative or past the end of the document (integer) | |
| 1849 </dd> | |
| 1850 </dl><a NAME="QsciScintillaCompat.updateUserListSize" ID="QsciScintillaCompat.updateUserListSize"></a> | |
| 1851 <h4>QsciScintillaCompat.updateUserListSize</h4> | |
| 1852 <b>updateUserListSize</b>(<i></i>) | |
| 1853 <p> | |
| 1854 Public method to resize the completion list to fit with contents. | |
| 1855 </p><a NAME="QsciScintillaCompat.updateVerticalScrollBar" ID="QsciScintillaCompat.updateVerticalScrollBar"></a> | |
| 1856 <h4>QsciScintillaCompat.updateVerticalScrollBar</h4> | |
| 1857 <b>updateVerticalScrollBar</b>(<i></i>) | |
| 1858 <p> | |
| 1859 Public method to update the vertical scroll bar to reflect the | |
| 1860 additional lines added by annotations. | |
| 1861 </p><a NAME="QsciScintillaCompat.zoomIn" ID="QsciScintillaCompat.zoomIn"></a> | |
| 1862 <h4>QsciScintillaCompat.zoomIn</h4> | |
| 1863 <b>zoomIn</b>(<i>zoom=1</i>) | |
| 1864 <p> | |
| 1865 Public method used to increase the zoom factor. | |
| 1866 </p><dl> | |
| 1867 <dt><i>zoom</i></dt> | |
| 1868 <dd> | |
| 1869 zoom factor increment (integer) | |
| 1870 </dd> | |
| 1871 </dl><a NAME="QsciScintillaCompat.zoomOut" ID="QsciScintillaCompat.zoomOut"></a> | |
| 1872 <h4>QsciScintillaCompat.zoomOut</h4> | |
| 1873 <b>zoomOut</b>(<i>zoom=1</i>) | |
| 1874 <p> | |
| 1875 Public method used to decrease the zoom factor. | |
| 1876 </p><dl> | |
| 1877 <dt><i>zoom</i></dt> | |
| 1878 <dd> | |
| 1879 zoom factor decrement (integer) | |
| 1880 </dd> | |
| 1881 </dl><a NAME="QsciScintillaCompat.zoomTo" ID="QsciScintillaCompat.zoomTo"></a> | |
| 1882 <h4>QsciScintillaCompat.zoomTo</h4> | |
| 1883 <b>zoomTo</b>(<i>zoom</i>) | |
| 1884 <p> | |
| 1885 Public method used to zoom to a specific zoom factor. | |
| 1886 </p><dl> | |
| 1887 <dt><i>zoom</i></dt> | |
| 1888 <dd> | |
| 1889 zoom factor (integer) | |
| 1890 </dd> | |
| 1891 </dl> | |
| 1892 <div align="right"><a href="#top">Up</a></div> | |
| 1893 <hr /><hr /> | |
| 1894 <a NAME="QSCINTILLA_VERSION" ID="QSCINTILLA_VERSION"></a> | |
| 1895 <h2>QSCINTILLA_VERSION</h2> | |
| 1896 <b>QSCINTILLA_VERSION</b>(<i></i>) | |
| 1897 <p> | |
| 1898 Module function to return the QScintilla version. | |
| 1899 </p><dl> | |
| 1900 <dt>Returns:</dt> | |
| 1901 <dd> | |
| 1902 QScintilla version (integer) | |
| 1903 </dd> | |
| 1904 </dl> | |
| 1905 <div align="right"><a href="#top">Up</a></div> | |
| 1906 <hr /> | |
| 1907 </body></html> |
