Editor Object¶
The Editor class, with the instance name of Npp.editor
(or normally simply editor
) represents
the Scintilla component of Notepad++. Scintilla is the “edit” component, the place where text is
entered and altered. Scintilla is well documented, and Python Script
allows you to call any of the Scintilla functions in a Pythonised way.
Npp.editor
(or editor
) always refers to the active document. To switch to another document
(or open a new one, etc), use the notepad
object.
The arguments to the functions are therefore slightly different to the original Scintilla arguments, effectively simplified by Python.
- For example:
SCI_ADDTEXT has the arguments:
SCI_ADDTEXT(int length, const char *text)
In Python, that just becomes:
editor.addText(text)
Likewise, return parameters are converted to return values. So SCI_GETTEXT has the arguments:
SCI_GETTEXT(int length, char *text)
In Python, that becomes:
text = editor.getText()
The comments for each function have been taken directly from Scintilla, so occasionally you may see reference to a parameter that doesn’t exist. I’m sure you’ll cope :)
Colours are a tuple of (red, green, blue)
where each of red
, green
, and blue
is between 0 and 255.
There are some Helper Methods discussed at the end, that perform some common functions with Scintilla. For instance, searching and replacing, regular expressions, replacing and deleting lines and so on.
Scintilla Methods¶
-
class
Editor
¶
-
editor.
getCharacterPointer
() → str¶ Gets a copy of the text of the document, without first allowing Scintilla to make it’s copy of it. In practice, that means it does exactly the same as
editor.getText
, however, if you have the possibility of the user interfering with the document _whilst_getCharacterPointer()
is running, then it’s safer to use getText(). On larger documents, getCharacterPointer() could be noticeable quicker.See Scintilla documentation for SCI_GETCHARACTERPOINTER
-
editor.
addText
(text) → int¶ Add text to the document at current position.
See Scintilla documentation for SCI_ADDTEXT
-
editor.
addStyledText
(c) → int¶ Add array of cells to document.
See Scintilla documentation for SCI_ADDSTYLEDTEXT
-
editor.
insertText
(pos, text)¶ Insert string at a position.
See Scintilla documentation for SCI_INSERTTEXT
-
editor.
changeInsertion
(text) → int¶ Change the text that is being inserted in response to SC_MOD_INSERTCHECK
See Scintilla documentation for SCI_CHANGEINSERTION
-
editor.
clearAll
()¶ Delete all text in the document.
See Scintilla documentation for SCI_CLEARALL
-
editor.
deleteRange
(start, lengthDelete)¶ Delete a range of text in the document.
See Scintilla documentation for SCI_DELETERANGE
-
editor.
clearDocumentStyle
()¶ Set all style bytes to 0, remove all folding information.
See Scintilla documentation for SCI_CLEARDOCUMENTSTYLE
-
editor.
getLength
() → int¶ Returns the number of bytes in the document.
See Scintilla documentation for SCI_GETLENGTH
-
editor.
getCharAt
(pos) → int¶ Returns the character byte at the position.
See Scintilla documentation for SCI_GETCHARAT
-
editor.
getCurrentPos
() → int¶ Returns the position of the caret.
See Scintilla documentation for SCI_GETCURRENTPOS
-
editor.
getAnchor
() → int¶ Returns the position of the opposite end of the selection to the caret.
See Scintilla documentation for SCI_GETANCHOR
-
editor.
getStyleAt
(pos) → int¶ Returns the style byte at the position.
See Scintilla documentation for SCI_GETSTYLEAT
-
editor.
setUndoCollection
(collectUndo)¶ Choose between collecting actions into the undo history and discarding them.
See Scintilla documentation for SCI_SETUNDOCOLLECTION
-
editor.
selectAll
()¶ Select all the text in the document.
See Scintilla documentation for SCI_SELECTALL
-
editor.
setSavePoint
()¶ Remember the current position in the undo history as the position at which the document was saved.
See Scintilla documentation for SCI_SETSAVEPOINT
-
editor.
getStyledText
(start, end) → tuple¶ Retrieve a buffer of cells. Returns the number of bytes in the buffer not including terminating NULs.
See Scintilla documentation for SCI_GETSTYLEDTEXT
-
editor.
canRedo
() → bool¶ Are there any redoable actions in the undo history?
See Scintilla documentation for SCI_CANREDO
-
editor.
markerLineFromHandle
(markerHandle) → int¶ Retrieve the line number at which a particular marker is located.
See Scintilla documentation for SCI_MARKERLINEFROMHANDLE
-
editor.
markerDeleteHandle
(markerHandle)¶ Delete a marker.
See Scintilla documentation for SCI_MARKERDELETEHANDLE
-
editor.
getUndoCollection
() → bool¶ Is undo history being collected?
See Scintilla documentation for SCI_GETUNDOCOLLECTION
-
editor.
getViewWS
() → int¶ Are white space characters currently visible? Returns one of SCWS_* constants.
See Scintilla documentation for SCI_GETVIEWWS
-
editor.
setViewWS
(viewWS)¶ Make white space characters invisible, always visible or visible outside indentation.
See Scintilla documentation for SCI_SETVIEWWS
-
editor.
getTabDrawMode
() → int¶ Retrieve the current tab draw mode. Returns one of SCTD_* constants.
See Scintilla documentation for SCI_GETTABDRAWMODE
-
editor.
setTabDrawMode
(tabDrawMode)¶ Set how tabs are drawn when visible.
See Scintilla documentation for SCI_SETTABDRAWMODE
-
editor.
positionFromPoint
(x, y) → int¶ Find the position from a point within the window.
See Scintilla documentation for SCI_POSITIONFROMPOINT
-
editor.
positionFromPointClose
(x, y) → int¶ Find the position from a point within the window but return INVALID_POSITION if not close to text.
See Scintilla documentation for SCI_POSITIONFROMPOINTCLOSE
-
editor.
gotoLine
(line)¶ Set caret to start of a line and ensure it is visible.
See Scintilla documentation for SCI_GOTOLINE
-
editor.
gotoPos
(caret)¶ Set caret to a position and ensure it is visible.
See Scintilla documentation for SCI_GOTOPOS
-
editor.
setAnchor
(anchor)¶ Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret.
See Scintilla documentation for SCI_SETANCHOR
-
editor.
getCurLine
() → str¶ Retrieve the text of the line containing the caret. Returns the index of the caret on the line. Result is NUL-terminated.
See Scintilla documentation for SCI_GETCURLINE
-
editor.
getEndStyled
() → int¶ Retrieve the position of the last correctly styled character.
See Scintilla documentation for SCI_GETENDSTYLED
-
editor.
convertEOLs
(eolMode)¶ Convert all line endings in the document to one mode.
See Scintilla documentation for SCI_CONVERTEOLS
-
editor.
getEOLMode
() → int¶ Retrieve the current end of line mode - one of CRLF, CR, or LF.
See Scintilla documentation for SCI_GETEOLMODE
-
editor.
setEOLMode
(eolMode)¶ Set the current end of line mode.
See Scintilla documentation for SCI_SETEOLMODE
-
editor.
startStyling
(start, unused)¶ Set the current styling position to start. The unused parameter is no longer used and should be set to 0.
See Scintilla documentation for SCI_STARTSTYLING
-
editor.
setStyling
(length, style)¶ Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.
See Scintilla documentation for SCI_SETSTYLING
-
editor.
getBufferedDraw
() → bool¶ Is drawing done first into a buffer or direct to the screen?
See Scintilla documentation for SCI_GETBUFFEREDDRAW
-
editor.
setBufferedDraw
(buffered)¶ If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
See Scintilla documentation for SCI_SETBUFFEREDDRAW
-
editor.
setTabWidth
(tabWidth)¶ Change the visible size of a tab to be a multiple of the width of a space character.
See Scintilla documentation for SCI_SETTABWIDTH
-
editor.
getTabWidth
() → int¶ Retrieve the visible size of a tab.
See Scintilla documentation for SCI_GETTABWIDTH
-
editor.
clearTabStops
(line)¶ Clear explicit tabstops on a line.
See Scintilla documentation for SCI_CLEARTABSTOPS
-
editor.
addTabStop
(line, x)¶ Add an explicit tab stop for a line.
See Scintilla documentation for SCI_ADDTABSTOP
-
editor.
getNextTabStop
(line, x) → int¶ Find the next explicit tab stop position on a line after a position.
See Scintilla documentation for SCI_GETNEXTTABSTOP
-
editor.
setCodePage
(codePage)¶ Set the code page used to interpret the bytes of the document as characters. The SC_CP_UTF8 value can be used to enter Unicode mode.
See Scintilla documentation for SCI_SETCODEPAGE
-
editor.
getIMEInteraction
() → int¶ Is the IME displayed in a window or inline?
See Scintilla documentation for SCI_GETIMEINTERACTION
-
editor.
setIMEInteraction
(imeInteraction)¶ Choose to display the the IME in a window or inline.
See Scintilla documentation for SCI_SETIMEINTERACTION
-
editor.
markerDefine
(markerNumber, markerSymbol)¶ Set the symbol used for a particular marker number.
See Scintilla documentation for SCI_MARKERDEFINE
-
editor.
markerSetFore
(markerNumber, fore)¶ Set the foreground colour used for a particular marker number.
See Scintilla documentation for SCI_MARKERSETFORE
-
editor.
markerSetBack
(markerNumber, back)¶ Set the background colour used for a particular marker number.
See Scintilla documentation for SCI_MARKERSETBACK
-
editor.
markerSetBackSelected
(markerNumber, back)¶ Set the background colour used for a particular marker number when its folding block is selected.
See Scintilla documentation for SCI_MARKERSETBACKSELECTED
-
editor.
markerEnableHighlight
(enabled)¶ Enable/disable highlight for current folding bloc (smallest one that contains the caret)
See Scintilla documentation for SCI_MARKERENABLEHIGHLIGHT
-
editor.
markerAdd
(line, markerNumber) → int¶ Add a marker to a line, returning an ID which can be used to find or delete the marker.
See Scintilla documentation for SCI_MARKERADD
-
editor.
markerDelete
(line, markerNumber)¶ Delete a marker from a line.
See Scintilla documentation for SCI_MARKERDELETE
-
editor.
markerDeleteAll
(markerNumber)¶ Delete all markers with a particular number from all lines.
See Scintilla documentation for SCI_MARKERDELETEALL
-
editor.
markerGet
(line) → int¶ Get a bit mask of all the markers set on a line.
See Scintilla documentation for SCI_MARKERGET
-
editor.
markerNext
(lineStart, markerMask) → int¶ Find the next line at or after lineStart that includes a marker in mask. Return -1 when no more lines.
See Scintilla documentation for SCI_MARKERNEXT
-
editor.
markerPrevious
(lineStart, markerMask) → int¶ Find the previous line before lineStart that includes a marker in mask.
See Scintilla documentation for SCI_MARKERPREVIOUS
-
editor.
markerDefinePixmap
(markerNumber, pixmap)¶ Define a marker from a pixmap.
See Scintilla documentation for SCI_MARKERDEFINEPIXMAP
-
editor.
markerAddSet
(line, markerSet)¶ Add a set of markers to a line.
See Scintilla documentation for SCI_MARKERADDSET
-
editor.
markerSetAlpha
(markerNumber, alpha)¶ Set the alpha used for a marker that is drawn in the text area, not the margin.
See Scintilla documentation for SCI_MARKERSETALPHA
-
editor.
setMarginTypeN
(margin, marginType)¶ Set a margin to be either numeric or symbolic.
See Scintilla documentation for SCI_SETMARGINTYPEN
-
editor.
getMarginTypeN
(margin) → int¶ Retrieve the type of a margin.
See Scintilla documentation for SCI_GETMARGINTYPEN
-
editor.
setMarginWidthN
(margin, pixelWidth)¶ Set the width of a margin to a width expressed in pixels.
See Scintilla documentation for SCI_SETMARGINWIDTHN
-
editor.
getMarginWidthN
(margin) → int¶ Retrieve the width of a margin in pixels.
See Scintilla documentation for SCI_GETMARGINWIDTHN
-
editor.
setMarginMaskN
(margin, mask)¶ Set a mask that determines which markers are displayed in a margin.
See Scintilla documentation for SCI_SETMARGINMASKN
-
editor.
getMarginMaskN
(margin) → int¶ Retrieve the marker mask of a margin.
See Scintilla documentation for SCI_GETMARGINMASKN
-
editor.
setMarginSensitiveN
(margin, sensitive)¶ Make a margin sensitive or insensitive to mouse clicks.
See Scintilla documentation for SCI_SETMARGINSENSITIVEN
-
editor.
getMarginSensitiveN
(margin) → bool¶ Retrieve the mouse click sensitivity of a margin.
See Scintilla documentation for SCI_GETMARGINSENSITIVEN
-
editor.
setMarginCursorN
(margin, cursor)¶ Set the cursor shown when the mouse is inside a margin.
See Scintilla documentation for SCI_SETMARGINCURSORN
-
editor.
getMarginCursorN
(margin) → int¶ Retrieve the cursor shown in a margin.
See Scintilla documentation for SCI_GETMARGINCURSORN
-
editor.
setMarginBackN
(margin, back)¶ Set the background colour of a margin. Only visible for SC_MARGIN_COLOUR.
See Scintilla documentation for SCI_SETMARGINBACKN
-
editor.
getMarginBackN
(margin) → tuple¶ Retrieve the background colour of a margin
See Scintilla documentation for SCI_GETMARGINBACKN
-
editor.
setMargins
(margins)¶ Allocate a non-standard number of margins.
See Scintilla documentation for SCI_SETMARGINS
-
editor.
getMargins
() → int¶ How many margins are there?.
See Scintilla documentation for SCI_GETMARGINS
-
editor.
styleClearAll
()¶ Clear all the styles and make equivalent to the global default style.
See Scintilla documentation for SCI_STYLECLEARALL
-
editor.
styleSetFore
(style, fore)¶ Set the foreground colour of a style.
See Scintilla documentation for SCI_STYLESETFORE
-
editor.
styleSetBack
(style, back)¶ Set the background colour of a style.
See Scintilla documentation for SCI_STYLESETBACK
-
editor.
styleSetBold
(style, bold)¶ Set a style to be bold or not.
See Scintilla documentation for SCI_STYLESETBOLD
-
editor.
styleSetItalic
(style, italic)¶ Set a style to be italic or not.
See Scintilla documentation for SCI_STYLESETITALIC
-
editor.
styleSetSize
(style, sizePoints)¶ Set the size of characters of a style.
See Scintilla documentation for SCI_STYLESETSIZE
-
editor.
styleSetFont
(style, fontName)¶ Set the font of a style.
See Scintilla documentation for SCI_STYLESETFONT
-
editor.
styleSetEOLFilled
(style, eolFilled)¶ Set a style to have its end of line filled or not.
See Scintilla documentation for SCI_STYLESETEOLFILLED
-
editor.
styleResetDefault
()¶ Reset the default style to its state at startup
See Scintilla documentation for SCI_STYLERESETDEFAULT
-
editor.
styleSetUnderline
(style, underline)¶ Set a style to be underlined or not.
See Scintilla documentation for SCI_STYLESETUNDERLINE
-
editor.
styleGetFore
(style) → tuple¶ Get the foreground colour of a style.
See Scintilla documentation for SCI_STYLEGETFORE
-
editor.
styleGetBack
(style) → tuple¶ Get the background colour of a style.
See Scintilla documentation for SCI_STYLEGETBACK
-
editor.
styleGetBold
(style) → bool¶ Get is a style bold or not.
See Scintilla documentation for SCI_STYLEGETBOLD
-
editor.
styleGetItalic
(style) → bool¶ Get is a style italic or not.
See Scintilla documentation for SCI_STYLEGETITALIC
-
editor.
styleGetSize
(style) → int¶ Get the size of characters of a style.
See Scintilla documentation for SCI_STYLEGETSIZE
-
editor.
styleGetFont
(style) → str¶ Get the font of a style. Returns the length of the fontName Result is NUL-terminated.
See Scintilla documentation for SCI_STYLEGETFONT
-
editor.
styleGetEOLFilled
(style) → bool¶ Get is a style to have its end of line filled or not.
See Scintilla documentation for SCI_STYLEGETEOLFILLED
-
editor.
styleGetUnderline
(style) → bool¶ Get is a style underlined or not.
See Scintilla documentation for SCI_STYLEGETUNDERLINE
-
editor.
styleGetCase
(style) → int¶ Get is a style mixed case, or to force upper or lower case.
See Scintilla documentation for SCI_STYLEGETCASE
-
editor.
styleGetCharacterSet
(style) → int¶ Get the character get of the font in a style.
See Scintilla documentation for SCI_STYLEGETCHARACTERSET
-
editor.
styleGetVisible
(style) → bool¶ Get is a style visible or not.
See Scintilla documentation for SCI_STYLEGETVISIBLE
-
editor.
styleGetChangeable
(style) → bool¶ Get is a style changeable or not (read only). Experimental feature, currently buggy.
See Scintilla documentation for SCI_STYLEGETCHANGEABLE
-
editor.
styleGetHotSpot
(style) → bool¶ Get is a style a hotspot or not.
See Scintilla documentation for SCI_STYLEGETHOTSPOT
-
editor.
styleSetCase
(style, caseVisible)¶ Set a style to be mixed case, or to force upper or lower case.
See Scintilla documentation for SCI_STYLESETCASE
-
editor.
styleSetSizeFractional
(style, sizeHundredthPoints)¶ Set the size of characters of a style. Size is in points multiplied by 100.
See Scintilla documentation for SCI_STYLESETSIZEFRACTIONAL
-
editor.
styleGetSizeFractional
(style) → int¶ Get the size of characters of a style in points multiplied by 100
See Scintilla documentation for SCI_STYLEGETSIZEFRACTIONAL
-
editor.
styleSetWeight
(style, weight)¶ Set the weight of characters of a style.
See Scintilla documentation for SCI_STYLESETWEIGHT
-
editor.
styleGetWeight
(style) → int¶ Get the weight of characters of a style.
See Scintilla documentation for SCI_STYLEGETWEIGHT
-
editor.
styleSetCharacterSet
(style, characterSet)¶ Set the character set of the font in a style.
See Scintilla documentation for SCI_STYLESETCHARACTERSET
-
editor.
styleSetHotSpot
(style, hotspot)¶ Set a style to be a hotspot or not.
See Scintilla documentation for SCI_STYLESETHOTSPOT
-
editor.
setSelFore
(useSetting, fore)¶ Set the foreground colour of the main and additional selections and whether to use this setting.
See Scintilla documentation for SCI_SETSELFORE
-
editor.
setSelBack
(useSetting, back)¶ Set the background colour of the main and additional selections and whether to use this setting.
See Scintilla documentation for SCI_SETSELBACK
-
editor.
getSelAlpha
() → int¶ Get the alpha of the selection.
See Scintilla documentation for SCI_GETSELALPHA
-
editor.
setSelAlpha
(alpha)¶ Set the alpha of the selection.
See Scintilla documentation for SCI_SETSELALPHA
-
editor.
getSelEOLFilled
() → bool¶ Is the selection end of line filled?
See Scintilla documentation for SCI_GETSELEOLFILLED
-
editor.
setSelEOLFilled
(filled)¶ Set the selection to have its end of line filled or not.
See Scintilla documentation for SCI_SETSELEOLFILLED
-
editor.
setCaretFore
(fore)¶ Set the foreground colour of the caret.
See Scintilla documentation for SCI_SETCARETFORE
-
editor.
assignCmdKey
(keyDefinition, sciCommand)¶ When key+modifier combination keyDefinition is pressed perform sciCommand.
See Scintilla documentation for SCI_ASSIGNCMDKEY
-
editor.
clearCmdKey
(keyDefinition)¶ When key+modifier combination keyDefinition is pressed do nothing.
See Scintilla documentation for SCI_CLEARCMDKEY
-
editor.
clearAllCmdKeys
()¶ Drop all key mappings.
See Scintilla documentation for SCI_CLEARALLCMDKEYS
-
editor.
setStylingEx
(styles) → int¶ Set the styles for a segment of the document.
See Scintilla documentation for SCI_SETSTYLINGEX
-
editor.
styleSetVisible
(style, visible)¶ Set a style to be visible or not.
See Scintilla documentation for SCI_STYLESETVISIBLE
-
editor.
getCaretPeriod
() → int¶ Get the time in milliseconds that the caret is on and off.
See Scintilla documentation for SCI_GETCARETPERIOD
-
editor.
setCaretPeriod
(periodMilliseconds)¶ Get the time in milliseconds that the caret is on and off. 0 = steady on.
See Scintilla documentation for SCI_SETCARETPERIOD
-
editor.
setWordChars
(characters)¶ Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault.
See Scintilla documentation for SCI_SETWORDCHARS
-
editor.
getWordChars
() → str¶ Get the set of characters making up words for when moving or selecting by word. Returns the number of characters
See Scintilla documentation for SCI_GETWORDCHARS
-
editor.
setCharacterCategoryOptimization
(countCharacters)¶ Set the number of characters to have directly indexed categories
See Scintilla documentation for SCI_SETCHARACTERCATEGORYOPTIMIZATION
-
editor.
getCharacterCategoryOptimization
() → int¶ Get the number of characters to have directly indexed categories
See Scintilla documentation for SCI_GETCHARACTERCATEGORYOPTIMIZATION
-
editor.
beginUndoAction
()¶ Start a sequence of actions that is undone and redone as a unit. May be nested.
See Scintilla documentation for SCI_BEGINUNDOACTION
-
editor.
endUndoAction
()¶ End a sequence of actions that is undone and redone as a unit.
See Scintilla documentation for SCI_ENDUNDOACTION
-
editor.
indicSetStyle
(indicator, indicatorStyle)¶ Set an indicator to plain, squiggle or TT.
See Scintilla documentation for SCI_INDICSETSTYLE
-
editor.
indicGetStyle
(indicator) → int¶ Retrieve the style of an indicator.
See Scintilla documentation for SCI_INDICGETSTYLE
-
editor.
indicSetFore
(indicator, fore)¶ Set the foreground colour of an indicator.
See Scintilla documentation for SCI_INDICSETFORE
-
editor.
indicGetFore
(indicator) → tuple¶ Retrieve the foreground colour of an indicator.
See Scintilla documentation for SCI_INDICGETFORE
-
editor.
indicSetUnder
(indicator, under)¶ Set an indicator to draw under text or over(default).
See Scintilla documentation for SCI_INDICSETUNDER
-
editor.
indicGetUnder
(indicator) → bool¶ Retrieve whether indicator drawn under or over text.
See Scintilla documentation for SCI_INDICGETUNDER
-
editor.
indicSetHoverStyle
(indicator, indicatorStyle)¶ Set a hover indicator to plain, squiggle or TT.
See Scintilla documentation for SCI_INDICSETHOVERSTYLE
-
editor.
indicGetHoverStyle
(indicator) → int¶ Retrieve the hover style of an indicator.
See Scintilla documentation for SCI_INDICGETHOVERSTYLE
-
editor.
indicSetHoverFore
(indicator, fore)¶ Set the foreground hover colour of an indicator.
See Scintilla documentation for SCI_INDICSETHOVERFORE
-
editor.
indicGetHoverFore
(indicator) → tuple¶ Retrieve the foreground hover colour of an indicator.
See Scintilla documentation for SCI_INDICGETHOVERFORE
-
editor.
indicSetFlags
(indicator, flags)¶ Set the attributes of an indicator.
See Scintilla documentation for SCI_INDICSETFLAGS
-
editor.
indicGetFlags
(indicator) → int¶ Retrieve the attributes of an indicator.
See Scintilla documentation for SCI_INDICGETFLAGS
-
editor.
setWhitespaceFore
(useSetting, fore)¶ Set the foreground colour of all whitespace and whether to use this setting.
See Scintilla documentation for SCI_SETWHITESPACEFORE
-
editor.
setWhitespaceBack
(useSetting, back)¶ Set the background colour of all whitespace and whether to use this setting.
See Scintilla documentation for SCI_SETWHITESPACEBACK
-
editor.
setWhitespaceSize
(size)¶ Set the size of the dots used to mark space characters.
See Scintilla documentation for SCI_SETWHITESPACESIZE
-
editor.
getWhitespaceSize
() → int¶ Get the size of the dots used to mark space characters.
See Scintilla documentation for SCI_GETWHITESPACESIZE
-
editor.
setLineState
(line, state)¶ Used to hold extra styling information for each line.
See Scintilla documentation for SCI_SETLINESTATE
-
editor.
getLineState
(line) → int¶ Retrieve the extra styling information for a line.
See Scintilla documentation for SCI_GETLINESTATE
-
editor.
getMaxLineState
() → int¶ Retrieve the last line number that has line state.
See Scintilla documentation for SCI_GETMAXLINESTATE
-
editor.
getCaretLineVisible
() → bool¶ Is the background of the line containing the caret in a different colour?
See Scintilla documentation for SCI_GETCARETLINEVISIBLE
-
editor.
setCaretLineVisible
(show)¶ Display the background of the line containing the caret in a different colour.
See Scintilla documentation for SCI_SETCARETLINEVISIBLE
-
editor.
getCaretLineBack
() → tuple¶ Get the colour of the background of the line containing the caret.
See Scintilla documentation for SCI_GETCARETLINEBACK
-
editor.
setCaretLineBack
(back)¶ Set the colour of the background of the line containing the caret.
See Scintilla documentation for SCI_SETCARETLINEBACK
-
editor.
getCaretLineFrame
() → int¶ Retrieve the caret line frame width. Width = 0 means this option is disabled.
See Scintilla documentation for SCI_GETCARETLINEFRAME
-
editor.
setCaretLineFrame
(width)¶ Display the caret line framed. Set width != 0 to enable this option and width = 0 to disable it.
See Scintilla documentation for SCI_SETCARETLINEFRAME
-
editor.
styleSetChangeable
(style, changeable)¶ Set a style to be changeable or not (read only). Experimental feature, currently buggy.
See Scintilla documentation for SCI_STYLESETCHANGEABLE
-
editor.
autoCShow
(lengthEntered, itemList)¶ Display a auto-completion list. The lengthEntered parameter indicates how many characters before the caret should be used to provide context.
See Scintilla documentation for SCI_AUTOCSHOW
-
editor.
autoCCancel
()¶ Remove the auto-completion list from the screen.
See Scintilla documentation for SCI_AUTOCCANCEL
-
editor.
autoCActive
() → bool¶ Is there an auto-completion list visible?
See Scintilla documentation for SCI_AUTOCACTIVE
-
editor.
autoCPosStart
() → int¶ Retrieve the position of the caret when the auto-completion list was displayed.
See Scintilla documentation for SCI_AUTOCPOSSTART
-
editor.
autoCComplete
()¶ User has selected an item so remove the list and insert the selection.
See Scintilla documentation for SCI_AUTOCCOMPLETE
-
editor.
autoCStops
(characterSet)¶ Define a set of character that when typed cancel the auto-completion list.
See Scintilla documentation for SCI_AUTOCSTOPS
-
editor.
autoCSetSeparator
(separatorCharacter)¶ Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space.
See Scintilla documentation for SCI_AUTOCSETSEPARATOR
-
editor.
autoCGetSeparator
() → int¶ Retrieve the auto-completion list separator character.
See Scintilla documentation for SCI_AUTOCGETSEPARATOR
-
editor.
autoCSelect
(select)¶ Select the item in the auto-completion list that starts with a string.
See Scintilla documentation for SCI_AUTOCSELECT
-
editor.
autoCSetCancelAtStart
(cancel)¶ Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
See Scintilla documentation for SCI_AUTOCSETCANCELATSTART
-
editor.
autoCGetCancelAtStart
() → bool¶ Retrieve whether auto-completion cancelled by backspacing before start.
See Scintilla documentation for SCI_AUTOCGETCANCELATSTART
-
editor.
autoCSetFillUps
(characterSet)¶ Define a set of characters that when typed will cause the autocompletion to choose the selected item.
See Scintilla documentation for SCI_AUTOCSETFILLUPS
-
editor.
autoCSetChooseSingle
(chooseSingle)¶ Should a single item auto-completion list automatically choose the item.
See Scintilla documentation for SCI_AUTOCSETCHOOSESINGLE
-
editor.
autoCGetChooseSingle
() → bool¶ Retrieve whether a single item auto-completion list automatically choose the item.
See Scintilla documentation for SCI_AUTOCGETCHOOSESINGLE
-
editor.
autoCSetIgnoreCase
(ignoreCase)¶ Set whether case is significant when performing auto-completion searches.
See Scintilla documentation for SCI_AUTOCSETIGNORECASE
-
editor.
autoCGetIgnoreCase
() → bool¶ Retrieve state of ignore case flag.
See Scintilla documentation for SCI_AUTOCGETIGNORECASE
-
editor.
userListShow
(listType, itemList)¶ Display a list of strings and send notification when user chooses one.
See Scintilla documentation for SCI_USERLISTSHOW
-
editor.
autoCSetAutoHide
(autoHide)¶ Set whether or not autocompletion is hidden automatically when nothing matches.
See Scintilla documentation for SCI_AUTOCSETAUTOHIDE
-
editor.
autoCGetAutoHide
() → bool¶ Retrieve whether or not autocompletion is hidden automatically when nothing matches.
See Scintilla documentation for SCI_AUTOCGETAUTOHIDE
-
editor.
autoCSetDropRestOfWord
(dropRestOfWord)¶ Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
See Scintilla documentation for SCI_AUTOCSETDROPRESTOFWORD
-
editor.
autoCGetDropRestOfWord
() → bool¶ Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
See Scintilla documentation for SCI_AUTOCGETDROPRESTOFWORD
-
editor.
registerImage
(type, xpmData)¶ Register an XPM image for use in autocompletion lists.
See Scintilla documentation for SCI_REGISTERIMAGE
-
editor.
clearRegisteredImages
()¶ Clear all the registered XPM images.
See Scintilla documentation for SCI_CLEARREGISTEREDIMAGES
-
editor.
autoCGetTypeSeparator
() → int¶ Retrieve the auto-completion list type-separator character.
See Scintilla documentation for SCI_AUTOCGETTYPESEPARATOR
-
editor.
autoCSetTypeSeparator
(separatorCharacter)¶ Change the type-separator character in the string setting up an auto-completion list. Default is ‘?’ but can be changed if items contain ‘?’.
See Scintilla documentation for SCI_AUTOCSETTYPESEPARATOR
-
editor.
autoCSetMaxWidth
(characterCount)¶ Set the maximum width, in characters, of auto-completion and user lists. Set to 0 to autosize to fit longest item, which is the default.
See Scintilla documentation for SCI_AUTOCSETMAXWIDTH
-
editor.
autoCGetMaxWidth
() → int¶ Get the maximum width, in characters, of auto-completion and user lists.
See Scintilla documentation for SCI_AUTOCGETMAXWIDTH
-
editor.
autoCSetMaxHeight
(rowCount)¶ Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows.
See Scintilla documentation for SCI_AUTOCSETMAXHEIGHT
-
editor.
autoCGetMaxHeight
() → int¶ Set the maximum height, in rows, of auto-completion and user lists.
See Scintilla documentation for SCI_AUTOCGETMAXHEIGHT
-
editor.
setIndent
(indentSize)¶ Set the number of spaces used for one level of indentation.
See Scintilla documentation for SCI_SETINDENT
-
editor.
getIndent
() → int¶ Retrieve indentation size.
See Scintilla documentation for SCI_GETINDENT
-
editor.
setUseTabs
(useTabs)¶ Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
See Scintilla documentation for SCI_SETUSETABS
-
editor.
getUseTabs
() → bool¶ Retrieve whether tabs will be used in indentation.
See Scintilla documentation for SCI_GETUSETABS
-
editor.
setLineIndentation
(line, indentation)¶ Change the indentation of a line to a number of columns.
See Scintilla documentation for SCI_SETLINEINDENTATION
-
editor.
getLineIndentation
(line) → int¶ Retrieve the number of columns that a line is indented.
See Scintilla documentation for SCI_GETLINEINDENTATION
-
editor.
getLineIndentPosition
(line) → int¶ Retrieve the position before the first non indentation character on a line.
See Scintilla documentation for SCI_GETLINEINDENTPOSITION
-
editor.
getColumn
(pos) → int¶ Retrieve the column number of a position, taking tab width into account.
See Scintilla documentation for SCI_GETCOLUMN
-
editor.
countCharacters
(start, end) → int¶ Count characters between two positions.
See Scintilla documentation for SCI_COUNTCHARACTERS
-
editor.
countCodeUnits
(start, end) → int¶ Count code units between two positions.
See Scintilla documentation for SCI_COUNTCODEUNITS
-
editor.
setHScrollBar
(visible)¶ Show or hide the horizontal scroll bar.
See Scintilla documentation for SCI_SETHSCROLLBAR
-
editor.
getHScrollBar
() → bool¶ Is the horizontal scroll bar visible?
See Scintilla documentation for SCI_GETHSCROLLBAR
-
editor.
setIndentationGuides
(indentView)¶ Show or hide indentation guides.
See Scintilla documentation for SCI_SETINDENTATIONGUIDES
-
editor.
getIndentationGuides
() → int¶ Are the indentation guides visible?
See Scintilla documentation for SCI_GETINDENTATIONGUIDES
-
editor.
setHighlightGuide
(column)¶ Set the highlighted indentation guide column. 0 = no highlighted guide.
See Scintilla documentation for SCI_SETHIGHLIGHTGUIDE
-
editor.
getHighlightGuide
() → int¶ Get the highlighted indentation guide column.
See Scintilla documentation for SCI_GETHIGHLIGHTGUIDE
-
editor.
getLineEndPosition
(line) → int¶ Get the position after the last visible characters on a line.
See Scintilla documentation for SCI_GETLINEENDPOSITION
-
editor.
getCodePage
() → int¶ Get the code page used to interpret the bytes of the document as characters.
See Scintilla documentation for SCI_GETCODEPAGE
-
editor.
getCaretFore
() → tuple¶ Get the foreground colour of the caret.
See Scintilla documentation for SCI_GETCARETFORE
-
editor.
getReadOnly
() → bool¶ In read-only mode?
See Scintilla documentation for SCI_GETREADONLY
-
editor.
setCurrentPos
(caret)¶ Sets the position of the caret.
See Scintilla documentation for SCI_SETCURRENTPOS
-
editor.
setSelectionStart
(anchor)¶ Sets the position that starts the selection - this becomes the anchor.
See Scintilla documentation for SCI_SETSELECTIONSTART
-
editor.
getSelectionStart
() → int¶ Returns the position at the start of the selection.
See Scintilla documentation for SCI_GETSELECTIONSTART
-
editor.
setSelectionEnd
(caret)¶ Sets the position that ends the selection - this becomes the caret.
See Scintilla documentation for SCI_SETSELECTIONEND
-
editor.
getSelectionEnd
() → int¶ Returns the position at the end of the selection.
See Scintilla documentation for SCI_GETSELECTIONEND
-
editor.
setEmptySelection
(caret)¶ Set caret to a position, while removing any existing selection.
See Scintilla documentation for SCI_SETEMPTYSELECTION
-
editor.
setPrintMagnification
(magnification)¶ Sets the print magnification added to the point size of each style for printing.
See Scintilla documentation for SCI_SETPRINTMAGNIFICATION
-
editor.
getPrintMagnification
() → int¶ Returns the print magnification.
See Scintilla documentation for SCI_GETPRINTMAGNIFICATION
-
editor.
setPrintColourMode
(mode)¶ Modify colours when printing for clearer printed text.
See Scintilla documentation for SCI_SETPRINTCOLOURMODE
-
editor.
getPrintColourMode
() → int¶ Returns the print colour mode.
See Scintilla documentation for SCI_GETPRINTCOLOURMODE
-
editor.
findText
(searchFlags, start, end, ft) → object¶ Find some text in the document.
See Scintilla documentation for SCI_FINDTEXT
-
editor.
getFirstVisibleLine
() → int¶ Retrieve the display line at the top of the display.
See Scintilla documentation for SCI_GETFIRSTVISIBLELINE
-
editor.
getLine
(line) → str¶ Retrieve the contents of a line. Returns the length of the line.
See Scintilla documentation for SCI_GETLINE
-
editor.
getLineCount
() → int¶ Returns the number of lines in the document. There is always at least one.
See Scintilla documentation for SCI_GETLINECOUNT
-
editor.
setMarginLeft
(pixelWidth)¶ Sets the size in pixels of the left margin.
See Scintilla documentation for SCI_SETMARGINLEFT
-
editor.
getMarginLeft
() → int¶ Returns the size in pixels of the left margin.
See Scintilla documentation for SCI_GETMARGINLEFT
-
editor.
setMarginRight
(pixelWidth)¶ Sets the size in pixels of the right margin.
See Scintilla documentation for SCI_SETMARGINRIGHT
-
editor.
getMarginRight
() → int¶ Returns the size in pixels of the right margin.
See Scintilla documentation for SCI_GETMARGINRIGHT
-
editor.
getModify
() → bool¶ Is the document different from when it was last saved?
See Scintilla documentation for SCI_GETMODIFY
-
editor.
setSel
(anchor, caret)¶ Select a range of text.
See Scintilla documentation for SCI_SETSEL
-
editor.
getSelText
() → str¶ Retrieve the selected text. Return the length of the text. Result is NUL-terminated.
See Scintilla documentation for SCI_GETSELTEXT
-
editor.
getTextRange
(start, end) → str¶ Retrieve a range of text. Return the length of the text.
See Scintilla documentation for SCI_GETTEXTRANGE
-
editor.
hideSelection
(hide)¶ Draw the selection either highlighted or in normal (non-highlighted) style.
See Scintilla documentation for SCI_HIDESELECTION
-
editor.
pointXFromPosition
(pos) → int¶ Retrieve the x value of the point in the window where a position is displayed.
See Scintilla documentation for SCI_POINTXFROMPOSITION
-
editor.
pointYFromPosition
(pos) → int¶ Retrieve the y value of the point in the window where a position is displayed.
See Scintilla documentation for SCI_POINTYFROMPOSITION
-
editor.
lineFromPosition
(pos) → int¶ Retrieve the line containing a position.
See Scintilla documentation for SCI_LINEFROMPOSITION
-
editor.
positionFromLine
(line) → int¶ Retrieve the position at the start of a line.
See Scintilla documentation for SCI_POSITIONFROMLINE
-
editor.
lineScroll
(columns, lines)¶ Scroll horizontally and vertically.
See Scintilla documentation for SCI_LINESCROLL
-
editor.
scrollCaret
()¶ Ensure the caret is visible.
See Scintilla documentation for SCI_SCROLLCARET
-
editor.
scrollRange
(secondary, primary)¶ Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position. This may be used to make a search match visible.
See Scintilla documentation for SCI_SCROLLRANGE
-
editor.
replaceSel
(text)¶ Replace the selected text with the argument text.
See Scintilla documentation for SCI_REPLACESEL
-
editor.
setReadOnly
(readOnly)¶ Set to read only or read write.
See Scintilla documentation for SCI_SETREADONLY
-
editor.
canPaste
() → bool¶ Will a paste succeed?
See Scintilla documentation for SCI_CANPASTE
-
editor.
canUndo
() → bool¶ Are there any undoable actions in the undo history?
See Scintilla documentation for SCI_CANUNDO
-
editor.
emptyUndoBuffer
()¶ Delete the undo history.
See Scintilla documentation for SCI_EMPTYUNDOBUFFER
-
editor.
paste
()¶ Paste the contents of the clipboard into the document replacing the selection.
See Scintilla documentation for SCI_PASTE
-
editor.
setText
(text)¶ Replace the contents of the document with the argument text.
See Scintilla documentation for SCI_SETTEXT
-
editor.
getText
() → str¶ Retrieve all the text in the document. Returns number of characters retrieved. Result is NUL-terminated.
See Scintilla documentation for SCI_GETTEXT
-
editor.
getTextLength
() → int¶ Retrieve the number of characters in the document.
See Scintilla documentation for SCI_GETTEXTLENGTH
-
editor.
getDirectFunction
() → int¶ Retrieve a pointer to a function that processes messages for this Scintilla.
See Scintilla documentation for SCI_GETDIRECTFUNCTION
-
editor.
getDirectPointer
() → int¶ Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction.
See Scintilla documentation for SCI_GETDIRECTPOINTER
-
editor.
setOvertype
(overType)¶ Set to overtype (true) or insert mode.
See Scintilla documentation for SCI_SETOVERTYPE
-
editor.
getOvertype
() → bool¶ Returns true if overtype mode is active otherwise false is returned.
See Scintilla documentation for SCI_GETOVERTYPE
-
editor.
setCaretWidth
(pixelWidth)¶ Set the width of the insert mode caret.
See Scintilla documentation for SCI_SETCARETWIDTH
-
editor.
getCaretWidth
() → int¶ Returns the width of the insert mode caret.
See Scintilla documentation for SCI_GETCARETWIDTH
-
editor.
setTargetStart
(start)¶ Sets the position that starts the target which is used for updating the document without affecting the scroll position.
See Scintilla documentation for SCI_SETTARGETSTART
-
editor.
getTargetStart
() → int¶ Get the position that starts the target.
See Scintilla documentation for SCI_GETTARGETSTART
-
editor.
setTargetEnd
(end)¶ Sets the position that ends the target which is used for updating the document without affecting the scroll position.
See Scintilla documentation for SCI_SETTARGETEND
-
editor.
getTargetEnd
() → int¶ Get the position that ends the target.
See Scintilla documentation for SCI_GETTARGETEND
-
editor.
setTargetRange
(start, end)¶ Sets both the start and end of the target in one call.
See Scintilla documentation for SCI_SETTARGETRANGE
-
editor.
getTargetText
() → str¶ Retrieve the text in the target.
See Scintilla documentation for SCI_GETTARGETTEXT
-
editor.
targetFromSelection
()¶ Make the target range start and end be the same as the selection range start and end.
See Scintilla documentation for SCI_TARGETFROMSELECTION
-
editor.
targetWholeDocument
()¶ Sets the target to the whole document.
See Scintilla documentation for SCI_TARGETWHOLEDOCUMENT
-
editor.
replaceTarget
(text) → int¶ Replace the target text with the argument text. Text is counted so it can contain NULs. Returns the length of the replacement text.
See Scintilla documentation for SCI_REPLACETARGET
-
editor.
replaceTargetRE
(text) → int¶ Replace the target text with the argument text after \d processing. Text is counted so it can contain NULs. Looks for \d where d is between 1 and 9 and replaces these with the strings matched in the last search operation which were surrounded by \( and \). Returns the length of the replacement text including any change caused by processing the \d patterns.
See Scintilla documentation for SCI_REPLACETARGETRE
-
editor.
searchInTarget
(text) → int¶ Search for a counted string in the target and set the target to the found range. Text is counted so it can contain NULs. Returns start of found range or -1 for failure in which case target is not moved.
See Scintilla documentation for SCI_SEARCHINTARGET
-
editor.
setSearchFlags
(searchFlags)¶ Set the search flags used by SearchInTarget.
See Scintilla documentation for SCI_SETSEARCHFLAGS
-
editor.
getSearchFlags
() → int¶ Get the search flags used by SearchInTarget.
See Scintilla documentation for SCI_GETSEARCHFLAGS
-
editor.
callTipShow
(pos, definition)¶ Show a call tip containing a definition near position pos.
See Scintilla documentation for SCI_CALLTIPSHOW
-
editor.
callTipCancel
()¶ Remove the call tip from the screen.
See Scintilla documentation for SCI_CALLTIPCANCEL
-
editor.
callTipActive
() → bool¶ Is there an active call tip?
See Scintilla documentation for SCI_CALLTIPACTIVE
-
editor.
callTipPosStart
() → int¶ Retrieve the position where the caret was before displaying the call tip.
See Scintilla documentation for SCI_CALLTIPPOSSTART
-
editor.
callTipSetPosStart
(posStart)¶ Set the start position in order to change when backspacing removes the calltip.
See Scintilla documentation for SCI_CALLTIPSETPOSSTART
-
editor.
callTipSetHlt
(highlightStart, highlightEnd)¶ Highlight a segment of the definition.
See Scintilla documentation for SCI_CALLTIPSETHLT
-
editor.
callTipSetBack
(back)¶ Set the background colour for the call tip.
See Scintilla documentation for SCI_CALLTIPSETBACK
-
editor.
callTipSetFore
(fore)¶ Set the foreground colour for the call tip.
See Scintilla documentation for SCI_CALLTIPSETFORE
-
editor.
callTipSetForeHlt
(fore)¶ Set the foreground colour for the highlighted part of the call tip.
See Scintilla documentation for SCI_CALLTIPSETFOREHLT
-
editor.
callTipUseStyle
(tabSize)¶ Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
See Scintilla documentation for SCI_CALLTIPUSESTYLE
-
editor.
callTipSetPosition
(above)¶ Set position of calltip, above or below text.
See Scintilla documentation for SCI_CALLTIPSETPOSITION
-
editor.
visibleFromDocLine
(docLine) → int¶ Find the display line of a document line taking hidden lines into account.
See Scintilla documentation for SCI_VISIBLEFROMDOCLINE
-
editor.
docLineFromVisible
(displayLine) → int¶ Find the document line of a display line taking hidden lines into account.
See Scintilla documentation for SCI_DOCLINEFROMVISIBLE
-
editor.
wrapCount
(docLine) → int¶ The number of display lines needed to wrap a document line
See Scintilla documentation for SCI_WRAPCOUNT
-
editor.
setFoldLevel
(line, level)¶ Set the fold level of a line. This encodes an integer level along with flags indicating whether the line is a header and whether it is effectively white space.
See Scintilla documentation for SCI_SETFOLDLEVEL
-
editor.
getFoldLevel
(line) → int¶ Retrieve the fold level of a line.
See Scintilla documentation for SCI_GETFOLDLEVEL
-
editor.
getLastChild
(line, level) → int¶ Find the last child line of a header line.
See Scintilla documentation for SCI_GETLASTCHILD
-
editor.
getFoldParent
(line) → int¶ Find the parent line of a child line.
See Scintilla documentation for SCI_GETFOLDPARENT
-
editor.
showLines
(lineStart, lineEnd)¶ Make a range of lines visible.
See Scintilla documentation for SCI_SHOWLINES
-
editor.
hideLines
(lineStart, lineEnd)¶ Make a range of lines invisible.
See Scintilla documentation for SCI_HIDELINES
-
editor.
getLineVisible
(line) → bool¶ Is a line visible?
See Scintilla documentation for SCI_GETLINEVISIBLE
-
editor.
getAllLinesVisible
() → bool¶ Are all lines visible?
See Scintilla documentation for SCI_GETALLLINESVISIBLE
-
editor.
setFoldExpanded
(line, expanded)¶ Show the children of a header line.
See Scintilla documentation for SCI_SETFOLDEXPANDED
-
editor.
getFoldExpanded
(line) → bool¶ Is a header line expanded?
See Scintilla documentation for SCI_GETFOLDEXPANDED
-
editor.
toggleFold
(line)¶ Switch a header line between expanded and contracted.
See Scintilla documentation for SCI_TOGGLEFOLD
-
editor.
toggleFoldShowText
(line, text)¶ Switch a header line between expanded and contracted and show some text after the line.
See Scintilla documentation for SCI_TOGGLEFOLDSHOWTEXT
-
editor.
foldDisplayTextSetStyle
(style)¶ Set the style of fold display text.
See Scintilla documentation for SCI_FOLDDISPLAYTEXTSETSTYLE
-
editor.
foldDisplayTextGetStyle
() → int¶ Get the style of fold display text.
See Scintilla documentation for SCI_FOLDDISPLAYTEXTGETSTYLE
-
editor.
setDefaultFoldDisplayText
(text)¶ Set the default fold display text.
See Scintilla documentation for SCI_SETDEFAULTFOLDDISPLAYTEXT
-
editor.
getDefaultFoldDisplayText
() → str¶ Get the default fold display text.
See Scintilla documentation for SCI_GETDEFAULTFOLDDISPLAYTEXT
-
editor.
foldLine
(line, action)¶ Expand or contract a fold header.
See Scintilla documentation for SCI_FOLDLINE
-
editor.
foldChildren
(line, action)¶ Expand or contract a fold header and its children.
See Scintilla documentation for SCI_FOLDCHILDREN
-
editor.
expandChildren
(line, level)¶ Expand a fold header and all children. Use the level argument instead of the line’s current level.
See Scintilla documentation for SCI_EXPANDCHILDREN
-
editor.
foldAll
(action)¶ Expand or contract all fold headers.
See Scintilla documentation for SCI_FOLDALL
-
editor.
ensureVisible
(line)¶ Ensure a particular line is visible by expanding any header line hiding it.
See Scintilla documentation for SCI_ENSUREVISIBLE
-
editor.
setAutomaticFold
(automaticFold)¶ Set automatic folding behaviours.
See Scintilla documentation for SCI_SETAUTOMATICFOLD
-
editor.
getAutomaticFold
() → int¶ Get automatic folding behaviours.
See Scintilla documentation for SCI_GETAUTOMATICFOLD
-
editor.
setFoldFlags
(flags)¶ Set some style options for folding.
See Scintilla documentation for SCI_SETFOLDFLAGS
-
editor.
ensureVisibleEnforcePolicy
(line)¶ Ensure a particular line is visible by expanding any header line hiding it. Use the currently set visibility policy to determine which range to display.
See Scintilla documentation for SCI_ENSUREVISIBLEENFORCEPOLICY
-
editor.
setTabIndents
(tabIndents)¶ Sets whether a tab pressed when caret is within indentation indents.
See Scintilla documentation for SCI_SETTABINDENTS
-
editor.
getTabIndents
() → bool¶ Does a tab pressed when caret is within indentation indent?
See Scintilla documentation for SCI_GETTABINDENTS
-
editor.
setBackSpaceUnIndents
(bsUnIndents)¶ Sets whether a backspace pressed when caret is within indentation unindents.
See Scintilla documentation for SCI_SETBACKSPACEUNINDENTS
-
editor.
getBackSpaceUnIndents
() → bool¶ Does a backspace pressed when caret is within indentation unindent?
See Scintilla documentation for SCI_GETBACKSPACEUNINDENTS
-
editor.
setMouseDwellTime
(periodMilliseconds)¶ Sets the time the mouse must sit still to generate a mouse dwell event.
See Scintilla documentation for SCI_SETMOUSEDWELLTIME
-
editor.
getMouseDwellTime
() → int¶ Retrieve the time the mouse must sit still to generate a mouse dwell event.
See Scintilla documentation for SCI_GETMOUSEDWELLTIME
-
editor.
wordStartPosition
(pos, onlyWordCharacters) → int¶ Get position of start of word.
See Scintilla documentation for SCI_WORDSTARTPOSITION
-
editor.
wordEndPosition
(pos, onlyWordCharacters) → int¶ Get position of end of word.
See Scintilla documentation for SCI_WORDENDPOSITION
-
editor.
isRangeWord
(start, end) → bool¶ Is the range start..end considered a word?
See Scintilla documentation for SCI_ISRANGEWORD
-
editor.
setIdleStyling
(idleStyling)¶ Sets limits to idle styling.
See Scintilla documentation for SCI_SETIDLESTYLING
-
editor.
getIdleStyling
() → int¶ Retrieve the limits to idle styling.
See Scintilla documentation for SCI_GETIDLESTYLING
-
editor.
setWrapMode
(wrapMode)¶ Sets whether text is word wrapped.
See Scintilla documentation for SCI_SETWRAPMODE
-
editor.
getWrapMode
() → int¶ Retrieve whether text is word wrapped.
See Scintilla documentation for SCI_GETWRAPMODE
-
editor.
setWrapVisualFlags
(wrapVisualFlags)¶ Set the display mode of visual flags for wrapped lines.
See Scintilla documentation for SCI_SETWRAPVISUALFLAGS
-
editor.
getWrapVisualFlags
() → int¶ Retrive the display mode of visual flags for wrapped lines.
See Scintilla documentation for SCI_GETWRAPVISUALFLAGS
-
editor.
setWrapVisualFlagsLocation
(wrapVisualFlagsLocation)¶ Set the location of visual flags for wrapped lines.
See Scintilla documentation for SCI_SETWRAPVISUALFLAGSLOCATION
-
editor.
getWrapVisualFlagsLocation
() → int¶ Retrive the location of visual flags for wrapped lines.
See Scintilla documentation for SCI_GETWRAPVISUALFLAGSLOCATION
-
editor.
setWrapStartIndent
(indent)¶ Set the start indent for wrapped lines.
See Scintilla documentation for SCI_SETWRAPSTARTINDENT
-
editor.
getWrapStartIndent
() → int¶ Retrive the start indent for wrapped lines.
See Scintilla documentation for SCI_GETWRAPSTARTINDENT
-
editor.
setWrapIndentMode
(wrapIndentMode)¶ Sets how wrapped sublines are placed. Default is fixed.
See Scintilla documentation for SCI_SETWRAPINDENTMODE
-
editor.
getWrapIndentMode
() → int¶ Retrieve how wrapped sublines are placed. Default is fixed.
See Scintilla documentation for SCI_GETWRAPINDENTMODE
-
editor.
setLayoutCache
(cacheMode)¶ Sets the degree of caching of layout information.
See Scintilla documentation for SCI_SETLAYOUTCACHE
-
editor.
getLayoutCache
() → int¶ Retrieve the degree of caching of layout information.
See Scintilla documentation for SCI_GETLAYOUTCACHE
-
editor.
setScrollWidth
(pixelWidth)¶ Sets the document width assumed for scrolling.
See Scintilla documentation for SCI_SETSCROLLWIDTH
-
editor.
getScrollWidth
() → int¶ Retrieve the document width assumed for scrolling.
See Scintilla documentation for SCI_GETSCROLLWIDTH
-
editor.
setScrollWidthTracking
(tracking)¶ Sets whether the maximum width line displayed is used to set scroll width.
See Scintilla documentation for SCI_SETSCROLLWIDTHTRACKING
-
editor.
getScrollWidthTracking
() → bool¶ Retrieve whether the scroll width tracks wide lines.
See Scintilla documentation for SCI_GETSCROLLWIDTHTRACKING
-
editor.
textWidth
(style, text) → int¶ Measure the pixel width of some text in a particular style. NUL terminated text argument. Does not handle tab or control characters.
See Scintilla documentation for SCI_TEXTWIDTH
-
editor.
setEndAtLastLine
(endAtLastLine)¶ Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default). Setting this to false allows scrolling one page below the last line.
See Scintilla documentation for SCI_SETENDATLASTLINE
-
editor.
getEndAtLastLine
() → bool¶ Retrieve whether the maximum scroll position has the last line at the bottom of the view.
See Scintilla documentation for SCI_GETENDATLASTLINE
-
editor.
textHeight
(line) → int¶ Retrieve the height of a particular line of text in pixels.
See Scintilla documentation for SCI_TEXTHEIGHT
-
editor.
setVScrollBar
(visible)¶ Show or hide the vertical scroll bar.
See Scintilla documentation for SCI_SETVSCROLLBAR
-
editor.
getVScrollBar
() → bool¶ Is the vertical scroll bar visible?
See Scintilla documentation for SCI_GETVSCROLLBAR
-
editor.
appendText
(text) → int¶ Append a string to the end of the document without changing the selection.
See Scintilla documentation for SCI_APPENDTEXT
-
editor.
getPhasesDraw
() → int¶ How many phases is drawing done in?
See Scintilla documentation for SCI_GETPHASESDRAW
-
editor.
setPhasesDraw
(phases)¶ In one phase draw, text is drawn in a series of rectangular blocks with no overlap. In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally. In multiple phase draw, each element is drawn over the whole drawing area, allowing text to overlap from one line to the next.
See Scintilla documentation for SCI_SETPHASESDRAW
-
editor.
setFontQuality
(fontQuality)¶ Choose the quality level for text from the FontQuality enumeration.
See Scintilla documentation for SCI_SETFONTQUALITY
-
editor.
getFontQuality
() → int¶ Retrieve the quality level for text.
See Scintilla documentation for SCI_GETFONTQUALITY
-
editor.
setFirstVisibleLine
(displayLine)¶ Scroll so that a display line is at the top of the display.
See Scintilla documentation for SCI_SETFIRSTVISIBLELINE
-
editor.
setMultiPaste
(multiPaste)¶ Change the effect of pasting when there are multiple selections.
See Scintilla documentation for SCI_SETMULTIPASTE
-
editor.
getMultiPaste
() → int¶ Retrieve the effect of pasting when there are multiple selections.
See Scintilla documentation for SCI_GETMULTIPASTE
-
editor.
getTag
(tagNumber) → str¶ Retrieve the value of a tag from a regular expression search. Result is NUL-terminated.
See Scintilla documentation for SCI_GETTAG
-
editor.
linesJoin
()¶ Join the lines in the target.
See Scintilla documentation for SCI_LINESJOIN
-
editor.
linesSplit
(pixelWidth)¶ Split the lines in the target into lines that are less wide than pixelWidth where possible.
See Scintilla documentation for SCI_LINESSPLIT
-
editor.
setFoldMarginColour
(useSetting, back)¶ Set one of the colours used as a chequerboard pattern in the fold margin
See Scintilla documentation for SCI_SETFOLDMARGINCOLOUR
-
editor.
setFoldMarginHiColour
(useSetting, fore)¶ Set the other colour used as a chequerboard pattern in the fold margin
See Scintilla documentation for SCI_SETFOLDMARGINHICOLOUR
-
editor.
setAccessibility
(accessibility)¶ Enable or disable accessibility.
See Scintilla documentation for SCI_SETACCESSIBILITY
-
editor.
getAccessibility
() → int¶ Report accessibility status.
See Scintilla documentation for SCI_GETACCESSIBILITY
-
editor.
lineDown
()¶ Move caret down one line.
See Scintilla documentation for SCI_LINEDOWN
-
editor.
lineDownExtend
()¶ Move caret down one line extending selection to new caret position.
See Scintilla documentation for SCI_LINEDOWNEXTEND
-
editor.
lineUp
()¶ Move caret up one line.
See Scintilla documentation for SCI_LINEUP
-
editor.
lineUpExtend
()¶ Move caret up one line extending selection to new caret position.
See Scintilla documentation for SCI_LINEUPEXTEND
-
editor.
charLeft
()¶ Move caret left one character.
See Scintilla documentation for SCI_CHARLEFT
-
editor.
charLeftExtend
()¶ Move caret left one character extending selection to new caret position.
See Scintilla documentation for SCI_CHARLEFTEXTEND
-
editor.
charRight
()¶ Move caret right one character.
See Scintilla documentation for SCI_CHARRIGHT
-
editor.
charRightExtend
()¶ Move caret right one character extending selection to new caret position.
See Scintilla documentation for SCI_CHARRIGHTEXTEND
-
editor.
wordLeft
()¶ Move caret left one word.
See Scintilla documentation for SCI_WORDLEFT
-
editor.
wordLeftExtend
()¶ Move caret left one word extending selection to new caret position.
See Scintilla documentation for SCI_WORDLEFTEXTEND
-
editor.
wordRight
()¶ Move caret right one word.
See Scintilla documentation for SCI_WORDRIGHT
-
editor.
wordRightExtend
()¶ Move caret right one word extending selection to new caret position.
See Scintilla documentation for SCI_WORDRIGHTEXTEND
-
editor.
homeExtend
()¶ Move caret to first position on line extending selection to new caret position.
See Scintilla documentation for SCI_HOMEEXTEND
-
editor.
lineEnd
()¶ Move caret to last position on line.
See Scintilla documentation for SCI_LINEEND
-
editor.
lineEndExtend
()¶ Move caret to last position on line extending selection to new caret position.
See Scintilla documentation for SCI_LINEENDEXTEND
-
editor.
documentStart
()¶ Move caret to first position in document.
See Scintilla documentation for SCI_DOCUMENTSTART
-
editor.
documentStartExtend
()¶ Move caret to first position in document extending selection to new caret position.
See Scintilla documentation for SCI_DOCUMENTSTARTEXTEND
-
editor.
documentEnd
()¶ Move caret to last position in document.
See Scintilla documentation for SCI_DOCUMENTEND
-
editor.
documentEndExtend
()¶ Move caret to last position in document extending selection to new caret position.
See Scintilla documentation for SCI_DOCUMENTENDEXTEND
-
editor.
pageUp
()¶ Move caret one page up.
See Scintilla documentation for SCI_PAGEUP
-
editor.
pageUpExtend
()¶ Move caret one page up extending selection to new caret position.
See Scintilla documentation for SCI_PAGEUPEXTEND
-
editor.
pageDown
()¶ Move caret one page down.
See Scintilla documentation for SCI_PAGEDOWN
-
editor.
pageDownExtend
()¶ Move caret one page down extending selection to new caret position.
See Scintilla documentation for SCI_PAGEDOWNEXTEND
-
editor.
editToggleOvertype
()¶ Switch from insert to overtype mode or the reverse.
See Scintilla documentation for SCI_EDITTOGGLEOVERTYPE
-
editor.
cancel
()¶ Cancel any modes such as call tip or auto-completion list display.
See Scintilla documentation for SCI_CANCEL
-
editor.
deleteBack
()¶ Delete the selection or if no selection, the character before the caret.
See Scintilla documentation for SCI_DELETEBACK
-
editor.
tab
()¶ If selection is empty or all on one line replace the selection with a tab character. If more than one line selected, indent the lines.
See Scintilla documentation for SCI_TAB
-
editor.
backTab
()¶ Dedent the selected lines.
See Scintilla documentation for SCI_BACKTAB
-
editor.
newLine
()¶ Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
See Scintilla documentation for SCI_NEWLINE
-
editor.
formFeed
()¶ Insert a Form Feed character.
See Scintilla documentation for SCI_FORMFEED
-
editor.
vCHome
()¶ Move caret to before first visible character on line. If already there move to first character on line.
See Scintilla documentation for SCI_VCHOME
-
editor.
vCHomeExtend
()¶ Like VCHome but extending selection to new caret position.
See Scintilla documentation for SCI_VCHOMEEXTEND
-
editor.
zoomIn
()¶ Magnify the displayed text by increasing the sizes by 1 point.
See Scintilla documentation for SCI_ZOOMIN
-
editor.
zoomOut
()¶ Make the displayed text smaller by decreasing the sizes by 1 point.
See Scintilla documentation for SCI_ZOOMOUT
-
editor.
delWordLeft
()¶ Delete the word to the left of the caret.
See Scintilla documentation for SCI_DELWORDLEFT
-
editor.
delWordRight
()¶ Delete the word to the right of the caret.
See Scintilla documentation for SCI_DELWORDRIGHT
-
editor.
delWordRightEnd
()¶ Delete the word to the right of the caret, but not the trailing non-word characters.
See Scintilla documentation for SCI_DELWORDRIGHTEND
-
editor.
lineCut
()¶ Cut the line containing the caret.
See Scintilla documentation for SCI_LINECUT
-
editor.
lineDelete
()¶ Delete the line containing the caret.
See Scintilla documentation for SCI_LINEDELETE
-
editor.
lineTranspose
()¶ Switch the current line with the previous.
See Scintilla documentation for SCI_LINETRANSPOSE
-
editor.
lineReverse
()¶ Reverse order of selected lines.
See Scintilla documentation for SCI_LINEREVERSE
-
editor.
lineDuplicate
()¶ Duplicate the current line.
See Scintilla documentation for SCI_LINEDUPLICATE
-
editor.
lowerCase
()¶ Transform the selection to lower case.
See Scintilla documentation for SCI_LOWERCASE
-
editor.
upperCase
()¶ Transform the selection to upper case.
See Scintilla documentation for SCI_UPPERCASE
-
editor.
lineScrollDown
()¶ Scroll the document down, keeping the caret visible.
See Scintilla documentation for SCI_LINESCROLLDOWN
-
editor.
lineScrollUp
()¶ Scroll the document up, keeping the caret visible.
See Scintilla documentation for SCI_LINESCROLLUP
-
editor.
deleteBackNotLine
()¶ Delete the selection or if no selection, the character before the caret. Will not delete the character before at the start of a line.
See Scintilla documentation for SCI_DELETEBACKNOTLINE
-
editor.
homeDisplay
()¶ Move caret to first position on display line.
See Scintilla documentation for SCI_HOMEDISPLAY
-
editor.
homeDisplayExtend
()¶ Move caret to first position on display line extending selection to new caret position.
See Scintilla documentation for SCI_HOMEDISPLAYEXTEND
-
editor.
lineEndDisplay
()¶ Move caret to last position on display line.
See Scintilla documentation for SCI_LINEENDDISPLAY
-
editor.
lineEndDisplayExtend
()¶ Move caret to last position on display line extending selection to new caret position.
See Scintilla documentation for SCI_LINEENDDISPLAYEXTEND
-
editor.
homeWrap
()¶ Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.
See Scintilla documentation for SCI_HOMEWRAP
-
editor.
homeWrapExtend
()¶ Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.
See Scintilla documentation for SCI_HOMEWRAPEXTEND
-
editor.
lineEndWrap
()¶ Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.
See Scintilla documentation for SCI_LINEENDWRAP
-
editor.
lineEndWrapExtend
()¶ Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.
See Scintilla documentation for SCI_LINEENDWRAPEXTEND
-
editor.
vCHomeWrap
()¶ Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome.
See Scintilla documentation for SCI_VCHOMEWRAP
-
editor.
vCHomeWrapExtend
()¶ Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend.
See Scintilla documentation for SCI_VCHOMEWRAPEXTEND
-
editor.
lineCopy
()¶ Copy the line containing the caret.
See Scintilla documentation for SCI_LINECOPY
-
editor.
moveCaretInsideView
()¶ Move the caret inside current view if it’s not there already.
See Scintilla documentation for SCI_MOVECARETINSIDEVIEW
-
editor.
lineLength
(line) → int¶ How many characters are on a line, including end of line characters?
See Scintilla documentation for SCI_LINELENGTH
-
editor.
braceHighlight
(posA, posB)¶ Highlight the characters at two positions.
See Scintilla documentation for SCI_BRACEHIGHLIGHT
-
editor.
braceHighlightIndicator
(useSetting, indicator)¶ Use specified indicator to highlight matching braces instead of changing their style.
See Scintilla documentation for SCI_BRACEHIGHLIGHTINDICATOR
-
editor.
braceBadLight
(pos)¶ Highlight the character at a position indicating there is no matching brace.
See Scintilla documentation for SCI_BRACEBADLIGHT
-
editor.
braceBadLightIndicator
(useSetting, indicator)¶ Use specified indicator to highlight non matching brace instead of changing its style.
See Scintilla documentation for SCI_BRACEBADLIGHTINDICATOR
-
editor.
braceMatch
(pos, maxReStyle) → int¶ Find the position of a matching brace or INVALID_POSITION if no match. The maxReStyle must be 0 for now. It may be defined in a future release.
See Scintilla documentation for SCI_BRACEMATCH
-
editor.
getViewEOL
() → bool¶ Are the end of line characters visible?
See Scintilla documentation for SCI_GETVIEWEOL
-
editor.
setViewEOL
(visible)¶ Make the end of line characters visible or invisible.
See Scintilla documentation for SCI_SETVIEWEOL
-
editor.
getDocPointer
() → int¶ Retrieve a pointer to the document object.
See Scintilla documentation for SCI_GETDOCPOINTER
-
editor.
setDocPointer
(pointer)¶ Change the document object used.
See Scintilla documentation for SCI_SETDOCPOINTER
-
editor.
setModEventMask
(eventMask)¶ Set which document modification events are sent to the container.
See Scintilla documentation for SCI_SETMODEVENTMASK
-
editor.
getEdgeColumn
() → int¶ Retrieve the column number which text should be kept within.
See Scintilla documentation for SCI_GETEDGECOLUMN
-
editor.
setEdgeColumn
(column)¶ Set the column number of the edge. If text goes past the edge then it is highlighted.
See Scintilla documentation for SCI_SETEDGECOLUMN
-
editor.
getEdgeMode
() → int¶ Retrieve the edge highlight mode.
See Scintilla documentation for SCI_GETEDGEMODE
-
editor.
setEdgeMode
(edgeMode)¶ The edge may be displayed by a line (EDGE_LINE/EDGE_MULTILINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
See Scintilla documentation for SCI_SETEDGEMODE
-
editor.
getEdgeColour
() → tuple¶ Retrieve the colour used in edge indication.
See Scintilla documentation for SCI_GETEDGECOLOUR
-
editor.
setEdgeColour
(edgeColour)¶ Change the colour used in edge indication.
See Scintilla documentation for SCI_SETEDGECOLOUR
-
editor.
multiEdgeAddLine
(column, edgeColour)¶ Add a new vertical edge to the view.
See Scintilla documentation for SCI_MULTIEDGEADDLINE
-
editor.
multiEdgeClearAll
()¶ Clear all vertical edges.
See Scintilla documentation for SCI_MULTIEDGECLEARALL
-
editor.
searchAnchor
()¶ Sets the current caret position to be the search anchor.
See Scintilla documentation for SCI_SEARCHANCHOR
-
editor.
searchNext
(searchFlags, text) → int¶ Find some text starting at the search anchor. Does not ensure the selection is visible.
See Scintilla documentation for SCI_SEARCHNEXT
-
editor.
searchPrev
(searchFlags, text) → int¶ Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible.
See Scintilla documentation for SCI_SEARCHPREV
-
editor.
linesOnScreen
() → int¶ Retrieves the number of lines completely visible.
See Scintilla documentation for SCI_LINESONSCREEN
-
editor.
usePopUp
(popUpMode)¶ Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas.
See Scintilla documentation for SCI_USEPOPUP
-
editor.
selectionIsRectangle
() → bool¶ Is the selection rectangular? The alternative is the more common stream selection.
See Scintilla documentation for SCI_SELECTIONISRECTANGLE
-
editor.
setZoom
(zoomInPoints)¶ Set the zoom level. This number of points is added to the size of all fonts. It may be positive to magnify or negative to reduce.
See Scintilla documentation for SCI_SETZOOM
-
editor.
getZoom
() → int¶ Retrieve the zoom level.
See Scintilla documentation for SCI_GETZOOM
-
editor.
createDocument
(bytes, documentOptions) → int¶ Create a new document object. Starts with reference count of 1 and not selected into editor.
See Scintilla documentation for SCI_CREATEDOCUMENT
-
editor.
addRefDocument
(doc)¶ Extend life of document.
See Scintilla documentation for SCI_ADDREFDOCUMENT
-
editor.
releaseDocument
(doc)¶ Release a reference to the document, deleting document if it fades to black.
See Scintilla documentation for SCI_RELEASEDOCUMENT
-
editor.
getDocumentOptions
() → int¶ Get which document options are set.
See Scintilla documentation for SCI_GETDOCUMENTOPTIONS
-
editor.
getModEventMask
() → int¶ Get which document modification events are sent to the container.
See Scintilla documentation for SCI_GETMODEVENTMASK
-
editor.
setCommandEvents
(commandEvents)¶ Set whether command events are sent to the container.
See Scintilla documentation for SCI_SETCOMMANDEVENTS
-
editor.
getCommandEvents
() → bool¶ Get whether command events are sent to the container.
See Scintilla documentation for SCI_GETCOMMANDEVENTS
-
editor.
setFocus
(focus)¶ Change internal focus flag.
See Scintilla documentation for SCI_SETFOCUS
-
editor.
getFocus
() → bool¶ Get internal focus flag.
See Scintilla documentation for SCI_GETFOCUS
-
editor.
setStatus
(status)¶ Change error status - 0 = OK.
See Scintilla documentation for SCI_SETSTATUS
-
editor.
getStatus
() → int¶ Get error status.
See Scintilla documentation for SCI_GETSTATUS
-
editor.
setMouseDownCaptures
(captures)¶ Set whether the mouse is captured when its button is pressed.
See Scintilla documentation for SCI_SETMOUSEDOWNCAPTURES
-
editor.
getMouseDownCaptures
() → bool¶ Get whether mouse gets captured.
See Scintilla documentation for SCI_GETMOUSEDOWNCAPTURES
-
editor.
setMouseWheelCaptures
(captures)¶ Set whether the mouse wheel can be active outside the window.
See Scintilla documentation for SCI_SETMOUSEWHEELCAPTURES
-
editor.
getMouseWheelCaptures
() → bool¶ Get whether mouse wheel can be active outside the window.
See Scintilla documentation for SCI_GETMOUSEWHEELCAPTURES
-
editor.
setCursor
(cursorType)¶ Sets the cursor to one of the SC_CURSOR* values.
See Scintilla documentation for SCI_SETCURSOR
-
editor.
getCursor
() → int¶ Get cursor type.
See Scintilla documentation for SCI_GETCURSOR
-
editor.
setControlCharSymbol
(symbol)¶ Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
See Scintilla documentation for SCI_SETCONTROLCHARSYMBOL
-
editor.
getControlCharSymbol
() → int¶ Get the way control characters are displayed.
See Scintilla documentation for SCI_GETCONTROLCHARSYMBOL
-
editor.
wordPartLeft
()¶ Move to the previous change in capitalisation.
See Scintilla documentation for SCI_WORDPARTLEFT
-
editor.
wordPartLeftExtend
()¶ Move to the previous change in capitalisation extending selection to new caret position.
See Scintilla documentation for SCI_WORDPARTLEFTEXTEND
-
editor.
wordPartRight
()¶ Move to the change next in capitalisation.
See Scintilla documentation for SCI_WORDPARTRIGHT
-
editor.
wordPartRightExtend
()¶ Move to the next change in capitalisation extending selection to new caret position.
See Scintilla documentation for SCI_WORDPARTRIGHTEXTEND
-
editor.
setVisiblePolicy
(visiblePolicy, visibleSlop)¶ Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
See Scintilla documentation for SCI_SETVISIBLEPOLICY
-
editor.
delLineLeft
()¶ Delete back from the current position to the start of the line.
See Scintilla documentation for SCI_DELLINELEFT
-
editor.
delLineRight
()¶ Delete forwards from the current position to the end of the line.
See Scintilla documentation for SCI_DELLINERIGHT
-
editor.
setXOffset
(xOffset)¶ Set the xOffset (ie, horizontal scroll position).
See Scintilla documentation for SCI_SETXOFFSET
-
editor.
getXOffset
() → int¶ Get the xOffset (ie, horizontal scroll position).
See Scintilla documentation for SCI_GETXOFFSET
-
editor.
chooseCaretX
()¶ Set the last x chosen value to be the caret x position.
See Scintilla documentation for SCI_CHOOSECARETX
-
editor.
grabFocus
()¶ Set the focus to this Scintilla widget.
See Scintilla documentation for SCI_GRABFOCUS
-
editor.
setXCaretPolicy
(caretPolicy, caretSlop)¶ Set the way the caret is kept visible when going sideways. The exclusion zone is given in pixels.
See Scintilla documentation for SCI_SETXCARETPOLICY
-
editor.
setYCaretPolicy
(caretPolicy, caretSlop)¶ Set the way the line the caret is on is kept visible. The exclusion zone is given in lines.
See Scintilla documentation for SCI_SETYCARETPOLICY
-
editor.
setPrintWrapMode
(wrapMode)¶ Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
See Scintilla documentation for SCI_SETPRINTWRAPMODE
-
editor.
getPrintWrapMode
() → int¶ Is printing line wrapped?
See Scintilla documentation for SCI_GETPRINTWRAPMODE
-
editor.
setHotspotActiveFore
(useSetting, fore)¶ Set a fore colour for active hotspots.
See Scintilla documentation for SCI_SETHOTSPOTACTIVEFORE
-
editor.
getHotspotActiveFore
() → tuple¶ Get the fore colour for active hotspots.
See Scintilla documentation for SCI_GETHOTSPOTACTIVEFORE
-
editor.
setHotspotActiveBack
(useSetting, back)¶ Set a back colour for active hotspots.
See Scintilla documentation for SCI_SETHOTSPOTACTIVEBACK
-
editor.
getHotspotActiveBack
() → tuple¶ Get the back colour for active hotspots.
See Scintilla documentation for SCI_GETHOTSPOTACTIVEBACK
-
editor.
setHotspotActiveUnderline
(underline)¶ Enable / Disable underlining active hotspots.
See Scintilla documentation for SCI_SETHOTSPOTACTIVEUNDERLINE
-
editor.
getHotspotActiveUnderline
() → bool¶ Get whether underlining for active hotspots.
See Scintilla documentation for SCI_GETHOTSPOTACTIVEUNDERLINE
-
editor.
setHotspotSingleLine
(singleLine)¶ Limit hotspots to single line so hotspots on two lines don’t merge.
See Scintilla documentation for SCI_SETHOTSPOTSINGLELINE
-
editor.
getHotspotSingleLine
() → bool¶ Get the HotspotSingleLine property
See Scintilla documentation for SCI_GETHOTSPOTSINGLELINE
-
editor.
paraDown
()¶ Move caret down one paragraph (delimited by empty lines).
See Scintilla documentation for SCI_PARADOWN
-
editor.
paraDownExtend
()¶ Extend selection down one paragraph (delimited by empty lines).
See Scintilla documentation for SCI_PARADOWNEXTEND
-
editor.
paraUp
()¶ Move caret up one paragraph (delimited by empty lines).
See Scintilla documentation for SCI_PARAUP
-
editor.
paraUpExtend
()¶ Extend selection up one paragraph (delimited by empty lines).
See Scintilla documentation for SCI_PARAUPEXTEND
-
editor.
positionBefore
(pos) → int¶ Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0.
See Scintilla documentation for SCI_POSITIONBEFORE
-
editor.
positionAfter
(pos) → int¶ Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document.
See Scintilla documentation for SCI_POSITIONAFTER
-
editor.
positionRelative
(pos, relative) → int¶ Given a valid document position, return a position that differs in a number of characters. Returned value is always between 0 and last position in document.
See Scintilla documentation for SCI_POSITIONRELATIVE
-
editor.
positionRelativeCodeUnits
(pos, relative) → int¶ Given a valid document position, return a position that differs in a number of UTF-16 code units. Returned value is always between 0 and last position in document. The result may point half way (2 bytes) inside a non-BMP character.
See Scintilla documentation for SCI_POSITIONRELATIVECODEUNITS
-
editor.
copyRange
(start, end)¶ Copy a range of text to the clipboard. Positions are clipped into the document.
See Scintilla documentation for SCI_COPYRANGE
-
editor.
copyText
(text) → int¶ Copy argument text to the clipboard.
See Scintilla documentation for SCI_COPYTEXT
-
editor.
setSelectionMode
(selectionMode)¶ Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES).
See Scintilla documentation for SCI_SETSELECTIONMODE
-
editor.
getSelectionMode
() → int¶ Get the mode of the current selection.
See Scintilla documentation for SCI_GETSELECTIONMODE
-
editor.
getMoveExtendsSelection
() → bool¶ Get whether or not regular caret moves will extend or reduce the selection.
See Scintilla documentation for SCI_GETMOVEEXTENDSSELECTION
-
editor.
getLineSelStartPosition
(line) → int¶ Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
See Scintilla documentation for SCI_GETLINESELSTARTPOSITION
-
editor.
getLineSelEndPosition
(line) → int¶ Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
See Scintilla documentation for SCI_GETLINESELENDPOSITION
-
editor.
lineDownRectExtend
()¶ Move caret down one line, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_LINEDOWNRECTEXTEND
-
editor.
lineUpRectExtend
()¶ Move caret up one line, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_LINEUPRECTEXTEND
-
editor.
charLeftRectExtend
()¶ Move caret left one character, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_CHARLEFTRECTEXTEND
-
editor.
charRightRectExtend
()¶ Move caret right one character, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_CHARRIGHTRECTEXTEND
-
editor.
homeRectExtend
()¶ Move caret to first position on line, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_HOMERECTEXTEND
-
editor.
vCHomeRectExtend
()¶ Move caret to before first visible character on line. If already there move to first character on line. In either case, extend rectangular selection to new caret position.
See Scintilla documentation for SCI_VCHOMERECTEXTEND
-
editor.
lineEndRectExtend
()¶ Move caret to last position on line, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_LINEENDRECTEXTEND
-
editor.
pageUpRectExtend
()¶ Move caret one page up, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_PAGEUPRECTEXTEND
-
editor.
pageDownRectExtend
()¶ Move caret one page down, extending rectangular selection to new caret position.
See Scintilla documentation for SCI_PAGEDOWNRECTEXTEND
-
editor.
stutteredPageUp
()¶ Move caret to top of page, or one page up if already at top of page.
See Scintilla documentation for SCI_STUTTEREDPAGEUP
-
editor.
stutteredPageUpExtend
()¶ Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
See Scintilla documentation for SCI_STUTTEREDPAGEUPEXTEND
-
editor.
stutteredPageDown
()¶ Move caret to bottom of page, or one page down if already at bottom of page.
See Scintilla documentation for SCI_STUTTEREDPAGEDOWN
-
editor.
stutteredPageDownExtend
()¶ Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
See Scintilla documentation for SCI_STUTTEREDPAGEDOWNEXTEND
-
editor.
wordLeftEnd
()¶ Move caret left one word, position cursor at end of word.
See Scintilla documentation for SCI_WORDLEFTEND
-
editor.
wordLeftEndExtend
()¶ Move caret left one word, position cursor at end of word, extending selection to new caret position.
See Scintilla documentation for SCI_WORDLEFTENDEXTEND
-
editor.
wordRightEnd
()¶ Move caret right one word, position cursor at end of word.
See Scintilla documentation for SCI_WORDRIGHTEND
-
editor.
wordRightEndExtend
()¶ Move caret right one word, position cursor at end of word, extending selection to new caret position.
See Scintilla documentation for SCI_WORDRIGHTENDEXTEND
-
editor.
setWhitespaceChars
(characters)¶ Set the set of characters making up whitespace for when moving or selecting by word. Should be called after SetWordChars.
See Scintilla documentation for SCI_SETWHITESPACECHARS
-
editor.
getWhitespaceChars
() → str¶ Get the set of characters making up whitespace for when moving or selecting by word.
See Scintilla documentation for SCI_GETWHITESPACECHARS
-
editor.
setPunctuationChars
(characters)¶ Set the set of characters making up punctuation characters Should be called after SetWordChars.
See Scintilla documentation for SCI_SETPUNCTUATIONCHARS
-
editor.
getPunctuationChars
() → str¶ Get the set of characters making up punctuation characters
See Scintilla documentation for SCI_GETPUNCTUATIONCHARS
-
editor.
setCharsDefault
()¶ Reset the set of characters for whitespace and word characters to the defaults.
See Scintilla documentation for SCI_SETCHARSDEFAULT
-
editor.
autoCGetCurrent
() → int¶ Get currently selected item position in the auto-completion list
See Scintilla documentation for SCI_AUTOCGETCURRENT
-
editor.
autoCGetCurrentText
() → str¶ Get currently selected item text in the auto-completion list Returns the length of the item text Result is NUL-terminated.
See Scintilla documentation for SCI_AUTOCGETCURRENTTEXT
-
editor.
autoCSetCaseInsensitiveBehaviour
(behaviour)¶ Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
See Scintilla documentation for SCI_AUTOCSETCASEINSENSITIVEBEHAVIOUR
-
editor.
autoCGetCaseInsensitiveBehaviour
() → int¶ Get auto-completion case insensitive behaviour.
See Scintilla documentation for SCI_AUTOCGETCASEINSENSITIVEBEHAVIOUR
-
editor.
autoCSetMulti
(multi)¶ Change the effect of autocompleting when there are multiple selections.
See Scintilla documentation for SCI_AUTOCSETMULTI
-
editor.
autoCGetMulti
() → int¶ Retrieve the effect of autocompleting when there are multiple selections.
See Scintilla documentation for SCI_AUTOCGETMULTI
-
editor.
autoCSetOrder
(order)¶ Set the way autocompletion lists are ordered.
See Scintilla documentation for SCI_AUTOCSETORDER
-
editor.
autoCGetOrder
() → int¶ Get the way autocompletion lists are ordered.
See Scintilla documentation for SCI_AUTOCGETORDER
-
editor.
allocate
(bytes)¶ Enlarge the document to a particular size of text bytes.
See Scintilla documentation for SCI_ALLOCATE
-
editor.
targetAsUTF8
() → str¶ Returns the target converted to UTF8. Return the length in bytes.
See Scintilla documentation for SCI_TARGETASUTF8
-
editor.
setLengthForEncode
(bytes)¶ Set the length of the utf8 argument for calling EncodedFromUTF8. Set to -1 and the string will be measured to the first nul.
See Scintilla documentation for SCI_SETLENGTHFORENCODE
-
editor.
encodedFromUTF8
(utf8) → str¶ Translates a UTF8 string into the document encoding. Return the length of the result in bytes. On error return 0.
See Scintilla documentation for SCI_ENCODEDFROMUTF8
-
editor.
findColumn
(line, column) → int¶ Find the position of a column on a line taking into account tabs and multi-byte characters. If beyond end of line, return line end position.
See Scintilla documentation for SCI_FINDCOLUMN
-
editor.
getCaretSticky
() → int¶ Can the caret preferred x position only be changed by explicit movement commands?
See Scintilla documentation for SCI_GETCARETSTICKY
-
editor.
setCaretSticky
(useCaretStickyBehaviour)¶ Stop the caret preferred x position changing when the user types.
See Scintilla documentation for SCI_SETCARETSTICKY
-
editor.
toggleCaretSticky
()¶ Switch between sticky and non-sticky: meant to be bound to a key.
See Scintilla documentation for SCI_TOGGLECARETSTICKY
-
editor.
setPasteConvertEndings
(convert)¶ Enable/Disable convert-on-paste for line endings
See Scintilla documentation for SCI_SETPASTECONVERTENDINGS
-
editor.
getPasteConvertEndings
() → bool¶ Get convert-on-paste setting
See Scintilla documentation for SCI_GETPASTECONVERTENDINGS
-
editor.
selectionDuplicate
()¶ Duplicate the selection. If selection empty duplicate the line containing the caret.
See Scintilla documentation for SCI_SELECTIONDUPLICATE
-
editor.
setCaretLineBackAlpha
(alpha)¶ Set background alpha of the caret line.
See Scintilla documentation for SCI_SETCARETLINEBACKALPHA
-
editor.
getCaretLineBackAlpha
() → int¶ Get the background alpha of the caret line.
See Scintilla documentation for SCI_GETCARETLINEBACKALPHA
-
editor.
setCaretStyle
(caretStyle)¶ Set the style of the caret to be drawn.
See Scintilla documentation for SCI_SETCARETSTYLE
-
editor.
getCaretStyle
() → int¶ Returns the current style of the caret.
See Scintilla documentation for SCI_GETCARETSTYLE
-
editor.
setIndicatorCurrent
(indicator)¶ Set the indicator used for IndicatorFillRange and IndicatorClearRange
See Scintilla documentation for SCI_SETINDICATORCURRENT
-
editor.
getIndicatorCurrent
() → int¶ Get the current indicator
See Scintilla documentation for SCI_GETINDICATORCURRENT
-
editor.
setIndicatorValue
(value)¶ Set the value used for IndicatorFillRange
See Scintilla documentation for SCI_SETINDICATORVALUE
-
editor.
getIndicatorValue
() → int¶ Get the current indicator value
See Scintilla documentation for SCI_GETINDICATORVALUE
-
editor.
indicatorFillRange
(start, lengthFill)¶ Turn a indicator on over a range.
See Scintilla documentation for SCI_INDICATORFILLRANGE
-
editor.
indicatorClearRange
(start, lengthClear)¶ Turn a indicator off over a range.
See Scintilla documentation for SCI_INDICATORCLEARRANGE
-
editor.
indicatorAllOnFor
(pos) → int¶ Are any indicators present at pos?
See Scintilla documentation for SCI_INDICATORALLONFOR
-
editor.
indicatorValueAt
(indicator, pos) → int¶ What value does a particular indicator have at a position?
See Scintilla documentation for SCI_INDICATORVALUEAT
-
editor.
indicatorStart
(indicator, pos) → int¶ Where does a particular indicator start?
See Scintilla documentation for SCI_INDICATORSTART
-
editor.
indicatorEnd
(indicator, pos) → int¶ Where does a particular indicator end?
See Scintilla documentation for SCI_INDICATOREND
-
editor.
setPositionCache
(size)¶ Set number of entries in position cache
See Scintilla documentation for SCI_SETPOSITIONCACHE
-
editor.
getPositionCache
() → int¶ How many entries are allocated to the position cache?
See Scintilla documentation for SCI_GETPOSITIONCACHE
-
editor.
copyAllowLine
()¶ Copy the selection, if selection empty copy the line with the caret
See Scintilla documentation for SCI_COPYALLOWLINE
-
editor.
getCharacterPointer
() → str Compact the document buffer and return a read-only pointer to the characters in the document.
See Scintilla documentation for SCI_GETCHARACTERPOINTER
-
editor.
getRangePointer
(position, rangeLength) → str¶ Return a read-only pointer to a range of characters in the document. May move the gap so that the range is contiguous, but will only move up to lengthRange bytes.
See Scintilla documentation for SCI_GETRANGEPOINTER
-
editor.
getGapPosition
() → int¶ Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.
See Scintilla documentation for SCI_GETGAPPOSITION
-
editor.
indicSetAlpha
(indicator, alpha)¶ Set the alpha fill colour of the given indicator.
See Scintilla documentation for SCI_INDICSETALPHA
-
editor.
indicGetAlpha
(indicator) → int¶ Get the alpha fill colour of the given indicator.
See Scintilla documentation for SCI_INDICGETALPHA
-
editor.
indicSetOutlineAlpha
(indicator, alpha)¶ Set the alpha outline colour of the given indicator.
See Scintilla documentation for SCI_INDICSETOUTLINEALPHA
-
editor.
indicGetOutlineAlpha
(indicator) → int¶ Get the alpha outline colour of the given indicator.
See Scintilla documentation for SCI_INDICGETOUTLINEALPHA
-
editor.
setExtraAscent
(extraAscent)¶ Set extra ascent for each line
See Scintilla documentation for SCI_SETEXTRAASCENT
-
editor.
getExtraAscent
() → int¶ Get extra ascent for each line
See Scintilla documentation for SCI_GETEXTRAASCENT
-
editor.
setExtraDescent
(extraDescent)¶ Set extra descent for each line
See Scintilla documentation for SCI_SETEXTRADESCENT
-
editor.
getExtraDescent
() → int¶ Get extra descent for each line
See Scintilla documentation for SCI_GETEXTRADESCENT
-
editor.
markerSymbolDefined
(markerNumber) → int¶ Which symbol was defined for markerNumber with MarkerDefine
See Scintilla documentation for SCI_MARKERSYMBOLDEFINED
-
editor.
marginSetText
(line, text)¶ Set the text in the text margin for a line
See Scintilla documentation for SCI_MARGINSETTEXT
-
editor.
marginGetText
(line) → str¶ Get the text in the text margin for a line
See Scintilla documentation for SCI_MARGINGETTEXT
-
editor.
marginSetStyle
(line, style)¶ Set the style number for the text margin for a line
See Scintilla documentation for SCI_MARGINSETSTYLE
-
editor.
marginGetStyle
(line) → int¶ Get the style number for the text margin for a line
See Scintilla documentation for SCI_MARGINGETSTYLE
-
editor.
marginSetStyles
(line, styles)¶ Set the style in the text margin for a line
See Scintilla documentation for SCI_MARGINSETSTYLES
-
editor.
marginGetStyles
(line) → str¶ Get the styles in the text margin for a line
See Scintilla documentation for SCI_MARGINGETSTYLES
-
editor.
marginTextClearAll
()¶ Clear the margin text on all lines
See Scintilla documentation for SCI_MARGINTEXTCLEARALL
-
editor.
marginSetStyleOffset
(style)¶ Get the start of the range of style numbers used for margin text
See Scintilla documentation for SCI_MARGINSETSTYLEOFFSET
-
editor.
marginGetStyleOffset
() → int¶ Get the start of the range of style numbers used for margin text
See Scintilla documentation for SCI_MARGINGETSTYLEOFFSET
-
editor.
setMarginOptions
(marginOptions)¶ Set the margin options.
See Scintilla documentation for SCI_SETMARGINOPTIONS
-
editor.
getMarginOptions
() → int¶ Get the margin options.
See Scintilla documentation for SCI_GETMARGINOPTIONS
-
editor.
annotationSetText
(line, text)¶ Set the annotation text for a line
See Scintilla documentation for SCI_ANNOTATIONSETTEXT
-
editor.
annotationGetText
(line) → str¶ Get the annotation text for a line
See Scintilla documentation for SCI_ANNOTATIONGETTEXT
-
editor.
annotationSetStyle
(line, style)¶ Set the style number for the annotations for a line
See Scintilla documentation for SCI_ANNOTATIONSETSTYLE
-
editor.
annotationGetStyle
(line) → int¶ Get the style number for the annotations for a line
See Scintilla documentation for SCI_ANNOTATIONGETSTYLE
-
editor.
annotationSetStyles
(line, styles)¶ Set the annotation styles for a line
See Scintilla documentation for SCI_ANNOTATIONSETSTYLES
-
editor.
annotationGetStyles
(line) → str¶ Get the annotation styles for a line
See Scintilla documentation for SCI_ANNOTATIONGETSTYLES
-
editor.
annotationGetLines
(line) → int¶ Get the number of annotation lines for a line
See Scintilla documentation for SCI_ANNOTATIONGETLINES
-
editor.
annotationClearAll
()¶ Clear the annotations from all lines
See Scintilla documentation for SCI_ANNOTATIONCLEARALL
-
editor.
annotationSetVisible
(visible)¶ Set the visibility for the annotations for a view
See Scintilla documentation for SCI_ANNOTATIONSETVISIBLE
-
editor.
annotationGetVisible
() → int¶ Get the visibility for the annotations for a view
See Scintilla documentation for SCI_ANNOTATIONGETVISIBLE
-
editor.
annotationSetStyleOffset
(style)¶ Get the start of the range of style numbers used for annotations
See Scintilla documentation for SCI_ANNOTATIONSETSTYLEOFFSET
-
editor.
annotationGetStyleOffset
() → int¶ Get the start of the range of style numbers used for annotations
See Scintilla documentation for SCI_ANNOTATIONGETSTYLEOFFSET
-
editor.
releaseAllExtendedStyles
()¶ Release all extended (>255) style numbers
See Scintilla documentation for SCI_RELEASEALLEXTENDEDSTYLES
-
editor.
allocateExtendedStyles
(numberStyles) → int¶ Allocate some extended (>255) style numbers and return the start of the range
See Scintilla documentation for SCI_ALLOCATEEXTENDEDSTYLES
-
editor.
addUndoAction
(token, flags)¶ Add a container action to the undo stack
See Scintilla documentation for SCI_ADDUNDOACTION
-
editor.
charPositionFromPoint
(x, y) → int¶ Find the position of a character from a point within the window.
See Scintilla documentation for SCI_CHARPOSITIONFROMPOINT
-
editor.
charPositionFromPointClose
(x, y) → int¶ Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text.
See Scintilla documentation for SCI_CHARPOSITIONFROMPOINTCLOSE
-
editor.
setMouseSelectionRectangularSwitch
(mouseSelectionRectangularSwitch)¶ Set whether switching to rectangular mode while selecting with the mouse is allowed.
See Scintilla documentation for SCI_SETMOUSESELECTIONRECTANGULARSWITCH
-
editor.
getMouseSelectionRectangularSwitch
() → bool¶ Whether switching to rectangular mode while selecting with the mouse is allowed.
See Scintilla documentation for SCI_GETMOUSESELECTIONRECTANGULARSWITCH
-
editor.
setMultipleSelection
(multipleSelection)¶ Set whether multiple selections can be made
See Scintilla documentation for SCI_SETMULTIPLESELECTION
-
editor.
getMultipleSelection
() → bool¶ Whether multiple selections can be made
See Scintilla documentation for SCI_GETMULTIPLESELECTION
-
editor.
setAdditionalSelectionTyping
(additionalSelectionTyping)¶ Set whether typing can be performed into multiple selections
See Scintilla documentation for SCI_SETADDITIONALSELECTIONTYPING
-
editor.
getAdditionalSelectionTyping
() → bool¶ Whether typing can be performed into multiple selections
See Scintilla documentation for SCI_GETADDITIONALSELECTIONTYPING
-
editor.
setAdditionalCaretsBlink
(additionalCaretsBlink)¶ Set whether additional carets will blink
See Scintilla documentation for SCI_SETADDITIONALCARETSBLINK
-
editor.
getAdditionalCaretsBlink
() → bool¶ Whether additional carets will blink
See Scintilla documentation for SCI_GETADDITIONALCARETSBLINK
-
editor.
setAdditionalCaretsVisible
(additionalCaretsVisible)¶ Set whether additional carets are visible
See Scintilla documentation for SCI_SETADDITIONALCARETSVISIBLE
-
editor.
getAdditionalCaretsVisible
() → bool¶ Whether additional carets are visible
See Scintilla documentation for SCI_GETADDITIONALCARETSVISIBLE
-
editor.
getSelections
() → int¶ How many selections are there?
See Scintilla documentation for SCI_GETSELECTIONS
-
editor.
getSelectionEmpty
() → bool¶ Is every selected range empty?
See Scintilla documentation for SCI_GETSELECTIONEMPTY
-
editor.
clearSelections
()¶ Clear selections to a single empty stream selection
See Scintilla documentation for SCI_CLEARSELECTIONS
-
editor.
setSelection
(caret, anchor)¶ Set a simple selection
See Scintilla documentation for SCI_SETSELECTION
-
editor.
addSelection
(caret, anchor)¶ Add a selection
See Scintilla documentation for SCI_ADDSELECTION
-
editor.
dropSelectionN
(selection)¶ Drop one selection
See Scintilla documentation for SCI_DROPSELECTIONN
-
editor.
setMainSelection
(selection)¶ Set the main selection
See Scintilla documentation for SCI_SETMAINSELECTION
-
editor.
getMainSelection
() → int¶ Which selection is the main selection
See Scintilla documentation for SCI_GETMAINSELECTION
-
editor.
setSelectionNCaret
(selection, caret)¶ Set the caret position of the nth selection.
See Scintilla documentation for SCI_SETSELECTIONNCARET
-
editor.
getSelectionNCaret
(selection) → int¶ Return the caret position of the nth selection.
See Scintilla documentation for SCI_GETSELECTIONNCARET
-
editor.
setSelectionNAnchor
(selection, anchor)¶ Set the anchor position of the nth selection.
See Scintilla documentation for SCI_SETSELECTIONNANCHOR
-
editor.
getSelectionNAnchor
(selection) → int¶ Return the anchor position of the nth selection.
See Scintilla documentation for SCI_GETSELECTIONNANCHOR
-
editor.
setSelectionNCaretVirtualSpace
(selection, space)¶ Set the virtual space of the caret of the nth selection.
See Scintilla documentation for SCI_SETSELECTIONNCARETVIRTUALSPACE
-
editor.
getSelectionNCaretVirtualSpace
(selection) → int¶ Return the virtual space of the caret of the nth selection.
See Scintilla documentation for SCI_GETSELECTIONNCARETVIRTUALSPACE
-
editor.
setSelectionNAnchorVirtualSpace
(selection, space)¶ Set the virtual space of the anchor of the nth selection.
See Scintilla documentation for SCI_SETSELECTIONNANCHORVIRTUALSPACE
-
editor.
getSelectionNAnchorVirtualSpace
(selection) → int¶ Return the virtual space of the anchor of the nth selection.
See Scintilla documentation for SCI_GETSELECTIONNANCHORVIRTUALSPACE
-
editor.
setSelectionNStart
(selection, anchor)¶ Sets the position that starts the selection - this becomes the anchor.
See Scintilla documentation for SCI_SETSELECTIONNSTART
-
editor.
getSelectionNStart
(selection) → int¶ Returns the position at the start of the selection.
See Scintilla documentation for SCI_GETSELECTIONNSTART
-
editor.
setSelectionNEnd
(selection, caret)¶ Sets the position that ends the selection - this becomes the currentPosition.
See Scintilla documentation for SCI_SETSELECTIONNEND
-
editor.
getSelectionNEnd
(selection) → int¶ Returns the position at the end of the selection.
See Scintilla documentation for SCI_GETSELECTIONNEND
-
editor.
setRectangularSelectionCaret
(caret)¶ Set the caret position of the rectangular selection.
See Scintilla documentation for SCI_SETRECTANGULARSELECTIONCARET
-
editor.
getRectangularSelectionCaret
() → int¶ Return the caret position of the rectangular selection.
See Scintilla documentation for SCI_GETRECTANGULARSELECTIONCARET
-
editor.
setRectangularSelectionAnchor
(anchor)¶ Set the anchor position of the rectangular selection.
See Scintilla documentation for SCI_SETRECTANGULARSELECTIONANCHOR
-
editor.
getRectangularSelectionAnchor
() → int¶ Return the anchor position of the rectangular selection.
See Scintilla documentation for SCI_GETRECTANGULARSELECTIONANCHOR
-
editor.
setRectangularSelectionCaretVirtualSpace
(space)¶ Set the virtual space of the caret of the rectangular selection.
See Scintilla documentation for SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE
-
editor.
getRectangularSelectionCaretVirtualSpace
() → int¶ Return the virtual space of the caret of the rectangular selection.
See Scintilla documentation for SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE
-
editor.
setRectangularSelectionAnchorVirtualSpace
(space)¶ Set the virtual space of the anchor of the rectangular selection.
See Scintilla documentation for SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE
-
editor.
getRectangularSelectionAnchorVirtualSpace
() → int¶ Return the virtual space of the anchor of the rectangular selection.
See Scintilla documentation for SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE
-
editor.
setVirtualSpaceOptions
(virtualSpaceOptions)¶ Set options for virtual space behaviour.
See Scintilla documentation for SCI_SETVIRTUALSPACEOPTIONS
-
editor.
getVirtualSpaceOptions
() → int¶ Return options for virtual space behaviour.
See Scintilla documentation for SCI_GETVIRTUALSPACEOPTIONS
-
editor.
setRectangularSelectionModifier
(modifier)¶ On GTK, allow selecting the modifier key to use for mouse-based rectangular selection. Often the window manager requires Alt+Mouse Drag for moving windows. Valid values are SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.
See Scintilla documentation for SCI_SETRECTANGULARSELECTIONMODIFIER
-
editor.
getRectangularSelectionModifier
() → int¶ Get the modifier key used for rectangular selection.
See Scintilla documentation for SCI_GETRECTANGULARSELECTIONMODIFIER
-
editor.
setAdditionalSelFore
(fore)¶ Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect.
See Scintilla documentation for SCI_SETADDITIONALSELFORE
-
editor.
setAdditionalSelBack
(back)¶ Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect.
See Scintilla documentation for SCI_SETADDITIONALSELBACK
-
editor.
setAdditionalSelAlpha
(alpha)¶ Set the alpha of the selection.
See Scintilla documentation for SCI_SETADDITIONALSELALPHA
-
editor.
getAdditionalSelAlpha
() → int¶ Get the alpha of the selection.
See Scintilla documentation for SCI_GETADDITIONALSELALPHA
-
editor.
setAdditionalCaretFore
(fore)¶ Set the foreground colour of additional carets.
See Scintilla documentation for SCI_SETADDITIONALCARETFORE
-
editor.
getAdditionalCaretFore
() → tuple¶ Get the foreground colour of additional carets.
See Scintilla documentation for SCI_GETADDITIONALCARETFORE
-
editor.
rotateSelection
()¶ Set the main selection to the next selection.
See Scintilla documentation for SCI_ROTATESELECTION
-
editor.
swapMainAnchorCaret
()¶ Swap that caret and anchor of the main selection.
See Scintilla documentation for SCI_SWAPMAINANCHORCARET
-
editor.
multipleSelectAddNext
()¶ Add the next occurrence of the main selection to the set of selections as main. If the current selection is empty then select word around caret.
See Scintilla documentation for SCI_MULTIPLESELECTADDNEXT
-
editor.
multipleSelectAddEach
()¶ Add each occurrence of the main selection in the target to the set of selections. If the current selection is empty then select word around caret.
See Scintilla documentation for SCI_MULTIPLESELECTADDEACH
-
editor.
changeLexerState
(start, end) → int¶ Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.
See Scintilla documentation for SCI_CHANGELEXERSTATE
-
editor.
contractedFoldNext
(lineStart) → int¶ Find the next line at or after lineStart that is a contracted fold header line. Return -1 when no more lines.
See Scintilla documentation for SCI_CONTRACTEDFOLDNEXT
-
editor.
verticalCentreCaret
()¶ Centre current line in window.
See Scintilla documentation for SCI_VERTICALCENTRECARET
-
editor.
moveSelectedLinesUp
()¶ Move the selected lines up one line, shifting the line above after the selection
See Scintilla documentation for SCI_MOVESELECTEDLINESUP
-
editor.
moveSelectedLinesDown
()¶ Move the selected lines down one line, shifting the line below before the selection
See Scintilla documentation for SCI_MOVESELECTEDLINESDOWN
-
editor.
setIdentifier
(identifier)¶ Set the identifier reported as idFrom in notification messages.
See Scintilla documentation for SCI_SETIDENTIFIER
-
editor.
getIdentifier
() → int¶ Get the identifier.
See Scintilla documentation for SCI_GETIDENTIFIER
-
editor.
rGBAImageSetWidth
(width)¶ Set the width for future RGBA image data.
See Scintilla documentation for SCI_RGBAIMAGESETWIDTH
-
editor.
rGBAImageSetHeight
(height)¶ Set the height for future RGBA image data.
See Scintilla documentation for SCI_RGBAIMAGESETHEIGHT
-
editor.
rGBAImageSetScale
(scalePercent)¶ Set the scale factor in percent for future RGBA image data.
See Scintilla documentation for SCI_RGBAIMAGESETSCALE
-
editor.
markerDefineRGBAImage
(markerNumber, pixels)¶ Define a marker from RGBA data. It has the width and height from RGBAImageSetWidth/Height
See Scintilla documentation for SCI_MARKERDEFINERGBAIMAGE
-
editor.
registerRGBAImage
(type, pixels)¶ Register an RGBA image for use in autocompletion lists. It has the width and height from RGBAImageSetWidth/Height
See Scintilla documentation for SCI_REGISTERRGBAIMAGE
-
editor.
scrollToStart
()¶ Scroll to start of document.
See Scintilla documentation for SCI_SCROLLTOSTART
-
editor.
scrollToEnd
()¶ Scroll to end of document.
See Scintilla documentation for SCI_SCROLLTOEND
-
editor.
setTechnology
(technology)¶ Set the technology used.
See Scintilla documentation for SCI_SETTECHNOLOGY
-
editor.
getTechnology
() → int¶ Get the tech.
See Scintilla documentation for SCI_GETTECHNOLOGY
-
editor.
createLoader
(bytes, documentOptions) → int¶ Create an ILoader*.
See Scintilla documentation for SCI_CREATELOADER
-
editor.
findIndicatorShow
(start, end)¶ On OS X, show a find indicator.
See Scintilla documentation for SCI_FINDINDICATORSHOW
-
editor.
findIndicatorFlash
(start, end)¶ On OS X, flash a find indicator, then fade out.
See Scintilla documentation for SCI_FINDINDICATORFLASH
-
editor.
findIndicatorHide
()¶ On OS X, hide the find indicator.
See Scintilla documentation for SCI_FINDINDICATORHIDE
-
editor.
vCHomeDisplay
()¶ Move caret to before first visible character on display line. If already there move to first character on display line.
See Scintilla documentation for SCI_VCHOMEDISPLAY
-
editor.
vCHomeDisplayExtend
()¶ Like VCHomeDisplay but extending selection to new caret position.
See Scintilla documentation for SCI_VCHOMEDISPLAYEXTEND
-
editor.
getCaretLineVisibleAlways
() → bool¶ Is the caret line always visible?
See Scintilla documentation for SCI_GETCARETLINEVISIBLEALWAYS
-
editor.
setCaretLineVisibleAlways
(alwaysVisible)¶ Sets the caret line to always visible.
See Scintilla documentation for SCI_SETCARETLINEVISIBLEALWAYS
-
editor.
setLineEndTypesAllowed
(lineEndBitSet)¶ Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding.
See Scintilla documentation for SCI_SETLINEENDTYPESALLOWED
-
editor.
getLineEndTypesAllowed
() → int¶ Get the line end types currently allowed.
See Scintilla documentation for SCI_GETLINEENDTYPESALLOWED
-
editor.
getLineEndTypesActive
() → int¶ Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation.
See Scintilla documentation for SCI_GETLINEENDTYPESACTIVE
-
editor.
setRepresentation
(encodedCharacter, representation)¶ Set the way a character is drawn.
See Scintilla documentation for SCI_SETREPRESENTATION
-
editor.
getRepresentation
(encodedCharacter) → str¶ Set the way a character is drawn. Result is NUL-terminated.
See Scintilla documentation for SCI_GETREPRESENTATION
-
editor.
clearRepresentation
(encodedCharacter)¶ Remove a character representation.
See Scintilla documentation for SCI_CLEARREPRESENTATION
-
editor.
startRecord
()¶ Start notifying the container of all key presses and commands.
See Scintilla documentation for SCI_STARTRECORD
-
editor.
stopRecord
()¶ Stop notifying the container of all key presses and commands.
See Scintilla documentation for SCI_STOPRECORD
-
editor.
setLexer
(lexer)¶ Set the lexing language of the document.
See Scintilla documentation for SCI_SETLEXER
-
editor.
getLexer
() → int¶ Retrieve the lexing language of the document.
See Scintilla documentation for SCI_GETLEXER
-
editor.
colourise
(start, end)¶ Colourise a segment of the document using the current lexing language.
See Scintilla documentation for SCI_COLOURISE
-
editor.
setProperty
(key, value)¶ Set up a value that may be used by a lexer for some optional feature.
See Scintilla documentation for SCI_SETPROPERTY
-
editor.
setKeyWords
(keyWordSet, keyWords)¶ Set up the key words used by the lexer.
See Scintilla documentation for SCI_SETKEYWORDS
-
editor.
setLexerLanguage
(language)¶ Set the lexing language of the document based on string name.
See Scintilla documentation for SCI_SETLEXERLANGUAGE
-
editor.
loadLexerLibrary
(path)¶ Load a lexer library (dll / so).
See Scintilla documentation for SCI_LOADLEXERLIBRARY
-
editor.
getProperty
(key) → str¶ Retrieve a “property” value previously set with SetProperty. Result is NUL-terminated.
See Scintilla documentation for SCI_GETPROPERTY
-
editor.
getPropertyExpanded
(key) → str¶ Retrieve a “property” value previously set with SetProperty, with “$()” variable replacement on returned buffer. Result is NUL-terminated.
See Scintilla documentation for SCI_GETPROPERTYEXPANDED
-
editor.
getPropertyInt
(key, defaultValue) → int¶ Retrieve a “property” value previously set with SetProperty, interpreted as an int AFTER any “$()” variable replacement.
See Scintilla documentation for SCI_GETPROPERTYINT
-
editor.
getLexerLanguage
() → str¶ Retrieve the name of the lexer. Return the length of the text. Result is NUL-terminated.
See Scintilla documentation for SCI_GETLEXERLANGUAGE
-
editor.
privateLexerCall
(operation, pointer) → int¶ For private communication between an application and a known lexer.
See Scintilla documentation for SCI_PRIVATELEXERCALL
-
editor.
propertyNames
() → str¶ Retrieve a ‘\n’ separated list of properties understood by the current lexer. Result is NUL-terminated.
See Scintilla documentation for SCI_PROPERTYNAMES
-
editor.
propertyType
(name) → int¶ Retrieve the type of a property.
See Scintilla documentation for SCI_PROPERTYTYPE
-
editor.
describeProperty
(name) → str¶ Describe a property. Result is NUL-terminated.
See Scintilla documentation for SCI_DESCRIBEPROPERTY
-
editor.
describeKeyWordSets
() → str¶ Retrieve a ‘\n’ separated list of descriptions of the keyword sets understood by the current lexer. Result is NUL-terminated.
See Scintilla documentation for SCI_DESCRIBEKEYWORDSETS
-
editor.
getLineEndTypesSupported
() → int¶ Bit set of LineEndType enumeration for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer.
See Scintilla documentation for SCI_GETLINEENDTYPESSUPPORTED
-
editor.
allocateSubStyles
(styleBase, numberStyles) → int¶ Allocate a set of sub styles for a particular base style, returning start of range
See Scintilla documentation for SCI_ALLOCATESUBSTYLES
-
editor.
getSubStylesStart
(styleBase) → int¶ The starting style number for the sub styles associated with a base style
See Scintilla documentation for SCI_GETSUBSTYLESSTART
-
editor.
getSubStylesLength
(styleBase) → int¶ The number of sub styles associated with a base style
See Scintilla documentation for SCI_GETSUBSTYLESLENGTH
-
editor.
getStyleFromSubStyle
(subStyle) → int¶ For a sub style, return the base style, else return the argument.
See Scintilla documentation for SCI_GETSTYLEFROMSUBSTYLE
-
editor.
getPrimaryStyleFromStyle
(style) → int¶ For a secondary style, return the primary style, else return the argument.
See Scintilla documentation for SCI_GETPRIMARYSTYLEFROMSTYLE
-
editor.
freeSubStyles
()¶ Free allocated sub styles
See Scintilla documentation for SCI_FREESUBSTYLES
-
editor.
setIdentifiers
(style, identifiers)¶ Set the identifiers that are shown in a particular style
See Scintilla documentation for SCI_SETIDENTIFIERS
-
editor.
distanceToSecondaryStyles
() → int¶ Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.
See Scintilla documentation for SCI_DISTANCETOSECONDARYSTYLES
-
editor.
getSubStyleBases
() → str¶ Get the set of base styles that can be extended with sub styles Result is NUL-terminated.
See Scintilla documentation for SCI_GETSUBSTYLEBASES
-
editor.
getNamedStyles
() → int¶ Retrieve the number of named styles for the lexer.
See Scintilla documentation for SCI_GETNAMEDSTYLES
-
editor.
nameOfStyle
(style) → str¶ Retrieve the name of a style. Result is NUL-terminated.
See Scintilla documentation for SCI_NAMEOFSTYLE
Retrieve a ‘ ‘ separated list of style tags like “literal quoted string”. Result is NUL-terminated.
See Scintilla documentation for SCI_TAGSOFSTYLE
-
editor.
descriptionOfStyle
(style) → str¶ Retrieve a description of a style. Result is NUL-terminated.
See Scintilla documentation for SCI_DESCRIPTIONOFSTYLE
-
editor.
getBidirectional
() → int¶ Retrieve bidirectional text display state.
See Scintilla documentation for SCI_GETBIDIRECTIONAL
-
editor.
setBidirectional
(bidirectional)¶ Set bidirectional text display state.
See Scintilla documentation for SCI_SETBIDIRECTIONAL
-
editor.
getLineCharacterIndex
() → int¶ Retrieve line character index state.
See Scintilla documentation for SCI_GETLINECHARACTERINDEX
-
editor.
allocateLineCharacterIndex
(lineCharacterIndex)¶ Request line character index be created or its use count increased.
See Scintilla documentation for SCI_ALLOCATELINECHARACTERINDEX
-
editor.
releaseLineCharacterIndex
(lineCharacterIndex)¶ Decrease use count of line character index and remove if 0.
See Scintilla documentation for SCI_RELEASELINECHARACTERINDEX
-
editor.
lineFromIndexPosition
(pos, lineCharacterIndex) → int¶ Retrieve the document line containing a position measured in index units.
See Scintilla documentation for SCI_LINEFROMINDEXPOSITION
-
editor.
indexPositionFromLine
(line, lineCharacterIndex) → int¶ Retrieve the position measured in index units at the start of a document line.
See Scintilla documentation for SCI_INDEXPOSITIONFROMLINE
Helper Methods¶
-
editor.
flash
(milliseconds)¶ Flashes the current document by slightly modifying the current background color for the given time.
-
editor.
forEachLine
(function)¶ Runs the function passed for each line in the current document. The function gets passed 3 arguments, the contents of the line, the line number (starting from zero), and the total number of lines. If the function returns a number, that number is added to the current line number for the next iteration.
That way, if you delete the current line, you should return 0, so as to stay on the current physical line.
Under normal circumstances, you do not need to return anything from the function (i.e. None)
e.g.:
def testContents(contents, lineNumber, totalLines): if contents.strip() == "rubbish": editor.deleteLine(lineNumber) # As we've deleted the line, the "next" line to process # is actually the current line, so we return 0 to advance zero lines # and hence stay on the same line return 0 elif contents.strip() == "something old": editor.replaceLine(lineNumber, "something new") elif contents.strip() == "little something": editor.replaceLine(lineNumber, "BIG\nSOMETHING" # Here we return 2, as we've inserted a newline, # and we don't want to test the "SOMETHING" line again return 2 # if you wanted, you could optionally return 1 here, to move the next line # but that's the default, so you don't need to bother. editor.forEachLine(testContents)
-
editor.
deleteLine
(line)¶ Deletes the given (zero indexed) line number.
-
editor.
replaceLine
(line, newContents)¶ Replaces the given (zero indexed) line number with the given contents. e.g.:
editor.replaceLine(3, "New contents")
-
editor.
replaceWholeLine
(line, newContents)¶ Replaces the given (zero indexed) line number with the given contents, including the line break (ie. the line break from the old line is removed, no line break on the replacement will result in joining lines).
e.g.:
editor.replaceWholeLine(3, "New contents")
-
editor.
setTarget
(start, end)¶ Sets the target start and end in one call. See
editor.setTargetStart()
andeditor.setTargetEnd()
-
editor.
getUserLineSelection
() -> (startLine, endLine)¶ Gets the start and end (zero indexed) line numbers of the user selection, or the whole document if nothing is selected.
Useful if you want to run your script over a number of lines - using this allows the user to select nothing, and have the script run for the whole document, or select just the section they want to run the script over.
-
editor.
getUserCharSelection
() -> (startByte, endByte)¶ Gets the start and end (zero indexed) byte numbers of the user selection, or the whole document if nothing is selected.
-
editor.
clearCallbacks
()¶ Clears all callbacks
-
editor.
clearCallbacks
(function) Clears all callbacks for a given function
-
editor.
clearCallbacks
(eventsList) Clears all callbacks for the given list of events
-
editor.
clearCallbacks
(function, eventsList) Clears the callback for the given callback function for the list of events
-
editor.
callback
(function, eventsList)¶ Adds a handler for an
Editor
(Scintilla) event. The events list is a list of events to respond to, from theSCINTILLANOTIFICATION
enum. Documentation on notifications from Scintilla can be found here: https://www.scintilla.org/ScintillaDoc.html#NotificationsFor a simple example, here’s a script that automatically saves the document as soon as a change is made:
def saveCurrentDoc(args): notepad.save() editor.callback(saveCurrentDoc, [SCINTILLANOTIFICATION.SAVEPOINTLEFT])
This script is not really sensible in real life, as for large files, it will take some time to save the file, and it will be saved after every key press.
Note that
Editor
callbacks are processed asynchronously by default. What this means in practice is that your event handler function (saveCurrentDoc in the previous example) is called just after the event has fired. If the callback handler is slow, and the callbacks occur quickly, you could get “behind”. Callbacks are placed in a queue and processed in the order they arrived. If you need to do something before letting the user continue, you can useeditor.callbackSync()
, which adds a synchronous callback.
-
editor.
callbackSync
(function, eventsList)¶ Adds a synchronous handler for an
Editor
(Scintilla) event. The events list is a list of events to respond to, from theSCINTILLANOTIFICATION
enum.What this means is that the handler function is called, and must complete, before control is returned to the user. If you perform a slow operation in your handler function, this will have an effect on the speed of Notepad++ for the user (i.e. Notepad++ may appear to have “locked up”, whilst your event processes).
Synchronous callbacks are mostly used for calling
editor.autoCCancel()
in response toSCINTILLANOTIFICATION.AUTOCSELECTION
, but could be used for anything where the timing of the handler function is critical.
-
editor.
replace
(search, replace[, flags[, startPosition[, endPosition[, maxCount]]]])¶ See
editor.rereplace()
, as this method is identical, with the exception that the search string is treated literally, and not as a regular expression.If you use a function as the replace argument, the function will still receive a
re.MatchObject
like object as the parameter,group(0)
will therefore always contain the string searched for (possibly in a different case ifre.IGNORECASE
was passed in the flags)For example:
counter = 0 def get_counter(m): global counter counter += 1 return 'C' + str(counter) editor.replace('(x)', get_counter, re.IGNORECASE) # Replacing: # # This (x) is some (X) text. The bracketed X's will (x) get numerical replacements # # results in # # This C1 is some C2 text. The bracketed X's will C3 get numerical replacements
-
editor.
rereplace
(search, replace[, flags[, startPosition[, endPosition[, maxCount]]]])¶ The main search and replace method, using regular expressions. The regular expression syntax in use is that from Notepad++, which is actually the Boost::Regex implementation (specifically the Perl regular expression syntax).
flags
are from the re module (e.g.re.IGNORECASE
), soimport re
if you use the flags.The
re.MULTILINE
flag is automatically set, so^
matches the start of each line of the document, and$
the end of each line. If you want to^
and$
to match the start and end of the whole document, you can override the behaviour by adding in theeditor.WHOLEDOC
flag.Note that line endings are now handled automatically.
search
can be a string, a unicode string, or an object. An object will be converted to a string using it’s__str__
method. For a unicode string, the current document encoding is checked, and an attempt is made at a conversion. If the conversion cannot be successfully performed, an error occurs. When a standard Python string is used, no conversion takes place. If you need to replace strings in documents in both UTF-8 and ANSI (or other single byte encodings), then it’s best to pass unicode strings.replace
follows the same conversion rules assearch
. However, you can also pass a function or lambda expression as thereplace
parameter. This function receives a single parameter, which is an object resembling a re.MatchObject instance. It only resembles an re.MatchObject because it doesn’t support all the methods. Specifically,groupdict()
,pos
,endpos
,re
andstring
methods and properties are not supported.expand()
,group()
andgroups()
(for example) all work identically. The function should return the string to use as the replacement.A simple function replacement:
def add_1(m): return 'Y' + str(int(m.group(1)) + 1) # replace X followed by numbers by an incremented number # e.g. X56 X39 X999 # becomes # Y57 Y40 Y1000 editor.rereplace('X([0-9]+)', add_1);
startPosition
is the binary position to start the search. Useeditor.positionFromLine()
to get the binary position from the (zero indexed) line number.endPosition
is the binary position to end the search. Useeditor.positionFromLine()
to get the binary position from the (zero indexed) line number.A maximum of
count
replacements are made, if zero or None, then all replacements are made.An small point to note, is that the replacements are first searched, and then all replacements are made. This is done for performance and reliability reasons. Generally this will have no side effects, however there may be cases where it makes a difference. (Author’s note: If you have such a case, please post a note on the forums such that it can be added to the documentation, or corrected).
-
editor.
research
(search, matchFunction[, flags[, startPosition[, endPosition[, maxCount]]]])¶ The main search method, using regular expressions. The regular expression syntax in use is that from Notepad++, which is actually the Boost::Regex implementation (specifically the Perl regular expression syntax).
flags
are from the re module (e.g.re.IGNORECASE
), soimport re
if you use the flags.The
re.MULTILINE
flag is automatically set, so^
matches the start of each line of the document, and$
the end of each line. If you want to^
and$
to match the start and end of the whole document, you can override the behaviour by adding in theeditor.WHOLEDOC
flag.Note that line endings are now handled automatically.
search
can be a string, a unicode string, or an object. An object will be converted to a string using it’s__str__
method. For a unicode string, the current document encoding is checked, and an attempt is made at a conversion. If the conversion cannot be successfully performed, an error occurs. When a standard Python string is used, no conversion takes place. If you need to replace strings in documents in both UTF-8 and ANSI (or other single byte encodings), then it’s best to pass unicode strings.matchFunction
is a function that gets callled with each match. This function receives a single parameter, which is an object resembling a re.MatchObject instance. It only resembles an re.MatchObject because it doesn’t support all the methods. Specifically,groupdict()
,pos
,endpos
,re
andstring
methods and properties are not supported.expand()
,group()
andgroups()
(for example) all work identically. The function should return the string to use as the replacement.A simple function replacement:
matches = [] def match_found(m): # append the match (start, end) positions to the matches array matches.append(m.span(0)) # find X followed by numbers # e.g. X56 X39 X999 editor.research('X([0-9]+)', match_found)
You can do the same thing with a lambda expression:
matches = [] editor.research('X([0-9]+)', lambda m: matches.append(m.span(0)))
startPosition
is the binary position to start the search. Useeditor.positionFromLine()
to get the binary position from the (zero indexed) line number.endPosition
is the binary position to end the search. Useeditor.positionFromLine()
to get the binary position from the (zero indexed) line number.If
maxCount
is not zero or None, then the search stops as soon asmaxCount
matches have been found.
-
editor.
getCurrentWord
()¶ Alias for getWord(), that gets the current word at the cursor.
-
editor.
getWord
(position, useOnlyWordChars)¶ Gets the word at position. If position is not given or None, the current caret position is used. useOnlyWordChars is a bool that is passed to Scintilla - see Scintilla rules on what is match. If not given or None, it is assumed to be true.
-
editor.
search
(search, handlerFunction)¶ Searches the document for given search text, and calls the handlerFunction with each match. The handler function receives a single match parameter, which is similar to a re.MatchObject object
-
editor.
search
(search, handlerFunction, flags) Searches the document for given search text, and calls the handlerFunction with each match. The handler function receives a single match parameter, which is similar to a re.MatchObject object. Flags are the flags from the re module, specifically only re.IGNORECASE has an effect here.
-
editor.
search
(search, handlerFunction, flags, startPosition) Searches the document from the given startPosition for given search text, and calls the handlerFunction with each match. The handler function receives a single match parameter, which is similar to a re.MatchObject object. Flags are the flags from the re module, specifically only re.IGNORECASE has an effect here.
-
editor.
search
(search, handlerFunction, flags, startPosition, endPosition) Searches the document from the given startPosition to the given endPosition for given search text, and calls the handlerFunction with each match. The handler function receives a single match parameter, which is similar to a re.MatchObject object. Flags are the flags from the re module, specifically only re.IGNORECASE has an effect here.
-
editor.
search
(search, handlerFunction, flags, startPosition, endPosition, maxCount) Searches the document from the given startPosition to the given endPosition for given search text, and calls the handlerFunction with each match. The search ends when maxCount matches have been located. The handler function receives a single match parameter, which is similar to a re.MatchObject object. Flags are the flags from the re module, specifically only re.IGNORECASE has an effect here.
-
editor.
write
()¶ Add text to the document at current position (alias for addText).