SciTE/Scintilla functions for Lua

Those reddish are constants. They are global.

Those bluish are methods of the objects 'editor' and 'output'. They are called like 'editor:AddText("_")'

Those greenish are properties of 'editor' and 'output'; either 'R' (readable) or 'W' (writable) or both. They are accessed like 'editor.TabWidth = 20'

Basics

INVALID_POSITION = -1
SCI_START = 2000
Define start of Scintilla messages to be greater than all Windows edit (EM_*) messages as many EM_ messages can be used although that use is deprecated.
SCI_OPTIONAL_START = 3000
SCI_LEXER_START = 4000
AddText(string text)
Add text to the document at current position.
AddStyledText(cells c)
Add array of cells to document.
InsertText(position pos, string text)
Insert string at a position.
ClearAll()
Delete all text in the document.
ClearDocumentStyle()
Set all style bytes to 0, remove all folding information.
Length [R] : int
Returns the number of bytes in the document.
GetCharAt(position pos) : int
Returns the character byte at the position.
CurrentPos [RW] : position pos
R: Returns the position of the caret.
W: Sets the position of the caret.
Anchor [RW] : position posAnchor
R: Returns the position of the opposite end of the selection to the caret.
W: Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret.
GetStyleAt(position pos) : int
Returns the style byte at the position.
Redo()
Redoes the next action on the undo history.
UndoCollection [RW] : bool collectUndo
R: Is undo history being collected?
W: Choose between collecting actions into the undo history and discarding them.
SelectAll()
Select all the text in the document.
SetSavePoint()
Remember the current position in the undo history as the position at which the document was saved.
GetStyledText(textrange tr) : int
Retrieve a buffer of cells. Returns the number of bytes in the buffer not including terminating NULs.
CanRedo() : bool
Are there any redoable actions in the undo history?
MarkerLineFromHandle(int handle) : int
Retrieve the line number at which a particular marker is located.
MarkerDeleteHandle(int handle)
Delete a marker.
WhiteSpace
ViewWS [RW] : int viewWS
R: Are white space characters currently visible? Returns one of SCWS_* constants.
W: Make white space characters invisible, always visible or visible outside indentation.
PositionFromPoint(int x, int y) : position
Find the position from a point within the window.
PositionFromPointClose(int x, int y) : position
Find the position from a point within the window but return INVALID_POSITION if not close to text.
GotoLine(int line)
Set caret to start of a line and ensure it is visible.
GotoPos(position pos)
Set caret to a position and ensure it is visible.
GetCurLine() : string, int
Retrieve the text of the line containing the caret. Returns the index of the caret on the line.
EndStyled [R] : position
Retrieve the position of the last correctly styled character.
EndOfLine
ConvertEOLs(int eolMode)
Convert all line endings in the document to one mode.
EOLMode [RW] : int eolMode
R: Retrieve the current end of line mode - one of CRLF, CR, or LF.
W: Set the current end of line mode.
StartStyling(position pos, int mask)
Set the current styling position to pos and the styling mask to mask. The styling mask can be used to protect some bits in each styling byte from modification.
SetStyling(int 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.
BufferedDraw [RW] : bool buffered
R: Is drawing done first into a buffer or direct to the screen?
W: If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
TabWidth [RW] : int tabWidth
R: Retrieve the visible size of a tab.
W: Change the visible size of a tab to be a multiple of the width of a space character.
SC_CP_UTF8 = 65001
The SC_CP_UTF8 value can be used to enter Unicode mode. This is the same value as CP_UTF8 in Windows
CodePage [RW] : int codePage
R: Get the code page used to interpret the bytes of the document as characters.
W: 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.
MarkerSymbol
MARKER_MAX = 31
MarkerOutline
SC_MASK_FOLDERS = 0xFE000000
MarkerDefine(int markerNumber, int markerSymbol)
Set the symbol used for a particular marker number.
MarkerSetFore(int markerNumber, colour fore)
Set the foreground colour used for a particular marker number.
MarkerSetBack(int markerNumber, colour back)
Set the background colour used for a particular marker number.
MarkerSetBackSelected(int markerNumber, colour back)
Set the background colour used for a particular marker number when its folding block is selected.
MarkerEnableHighlight(bool enabled)
Enable/disable highlight for current folding bloc (smallest one that contains the caret)
MarkerAdd(int line, int markerNumber) : int
Add a marker to a line, returning an ID which can be used to find or delete the marker.
MarkerDelete(int line, int markerNumber)
Delete a marker from a line.
MarkerDeleteAll(int markerNumber)
Delete all markers with a particular number from all lines.
MarkerGet(int line) : int
Get a bit mask of all the markers set on a line.
MarkerNext(int lineStart, int markerMask) : int
Find the next line at or after lineStart that includes a marker in mask. Return -1 when no more lines.
MarkerPrevious(int lineStart, int markerMask) : int
Find the previous line before lineStart that includes a marker in mask.
MarkerDefinePixmap(int markerNumber, string pixmap)
Define a marker from a pixmap.
MarkerAddSet(int line, int set)
Add a set of markers to a line.
MarkerSetAlpha(int markerNumber, int alpha)
Set the alpha used for a marker that is drawn in the text area, not the margin.
MarginType
SetMarginTypeN(int margin, int marginType)
Set a margin to be either numeric or symbolic.
GetMarginTypeN(int margin) : int
Retrieve the type of a margin.
SetMarginWidthN(int margin, int pixelWidth)
Set the width of a margin to a width expressed in pixels.
GetMarginWidthN(int margin) : int
Retrieve the width of a margin in pixels.
SetMarginMaskN(int margin, int mask)
Set a mask that determines which markers are displayed in a margin.
GetMarginMaskN(int margin) : int
Retrieve the marker mask of a margin.
SetMarginSensitiveN(int margin, bool sensitive)
Make a margin sensitive or insensitive to mouse clicks.
GetMarginSensitiveN(int margin) : bool
Retrieve the mouse click sensitivity of a margin.
SetMarginCursorN(int margin, int cursor)
Set the cursor shown when the mouse is inside a margin.
GetMarginCursorN(int margin) : int
Retrieve the cursor shown in a margin.
StylesCommon
Styles in range 32..38 are predefined for parts of the UI and are not used as normal styles. Style 39 is for future use.
CharacterSet
Character set identifiers are used in StyleSetCharacterSet. The values are the same as the Windows *_CHARSET values.
StyleClearAll()
Clear all the styles and make equivalent to the global default style.
StyleSetFore(int style, colour fore)
Set the foreground colour of a style.
StyleSetBack(int style, colour back)
Set the background colour of a style.
StyleSetBold(int style, bool bold)
Set a style to be bold or not.
StyleSetItalic(int style, bool italic)
Set a style to be italic or not.
StyleSetSize(int style, int sizePoints)
Set the size of characters of a style.
StyleSetFont(int style, string fontName)
Set the font of a style.
StyleSetEOLFilled(int style, bool filled)
Set a style to have its end of line filled or not.
StyleResetDefault()
Reset the default style to its state at startup
StyleSetUnderline(int style, bool underline)
Set a style to be underlined or not.
CaseVisible
StyleGetFore(int style) : colour
Get the foreground colour of a style.
StyleGetBack(int style) : colour
Get the background colour of a style.
StyleGetBold(int style) : bool
Get is a style bold or not.
StyleGetItalic(int style) : bool
Get is a style italic or not.
StyleGetSize(int style) : int
Get the size of characters of a style.
StyleGetFont(int style) : string, int
Get the font of a style. Returns the length of the fontName
StyleGetEOLFilled(int style) : bool
Get is a style to have its end of line filled or not.
StyleGetUnderline(int style) : bool
Get is a style underlined or not.
StyleGetCase(int style) : int
Get is a style mixed case, or to force upper or lower case.
StyleGetCharacterSet(int style) : int
Get the character get of the font in a style.
StyleGetVisible(int style) : bool
Get is a style visible or not.
StyleGetChangeable(int style) : bool
Get is a style changeable or not (read only). Experimental feature, currently buggy.
StyleGetHotSpot(int style) : bool
Get is a style a hotspot or not.
StyleSetCase(int style, int caseForce)
Set a style to be mixed case, or to force upper or lower case.
SC_FONT_SIZE_MULTIPLIER = 100
StyleSetSizeFractional(int style, int caseForce)
Set the size of characters of a style. Size is in points multiplied by 100.
StyleGetSizeFractional(int style) : int
Get the size of characters of a style in points multiplied by 100
FontWeight
StyleSetWeight(int style, int weight)
Set the weight of characters of a style.
StyleGetWeight(int style) : int
Get the weight of characters of a style.
StyleSetCharacterSet(int style, int characterSet)
Set the character set of the font in a style.
StyleSetHotSpot(int style, bool hotspot)
Set a style to be a hotspot or not.
SetSelFore(bool useSetting, colour fore)
Set the foreground colour of the main and additional selections and whether to use this setting.
SetSelBack(bool useSetting, colour back)
Set the background colour of the main and additional selections and whether to use this setting.
SelAlpha [RW] : int alpha
R: Get the alpha of the selection.
W: Set the alpha of the selection.
SelEOLFilled [RW] : bool filled
R: Is the selection end of line filled?
W: Set the selection to have its end of line filled or not.
CaretFore [RW] : colour fore
R: Get the foreground colour of the caret.
W: Set the foreground colour of the caret.
AssignCmdKey(keymod km, int msg)
When key+modifier combination km is pressed perform msg.
ClearCmdKey(keymod km)
When key+modifier combination km is pressed do nothing.
ClearAllCmdKeys()
Drop all key mappings.
SetStylingEx(string styles)
Set the styles for a segment of the document.
StyleSetVisible(int style, bool visible)
Set a style to be visible or not.
CaretPeriod [RW] : int periodMilliseconds
R: Get the time in milliseconds that the caret is on and off.
W: Get the time in milliseconds that the caret is on and off. 0 = steady on.
WordChars [W] : string characters
Set the set of characters making up words for when moving or selecting by word. First sets defaults like SetCharsDefault.
BeginUndoAction()
Start a sequence of actions that is undone and redone as a unit. May be nested.
EndUndoAction()
End a sequence of actions that is undone and redone as a unit.
IndicatorStyle
Indicator style enumeration and some constants
INDIC0_MASK = 0x20
INDIC1_MASK = 0x40
INDIC2_MASK = 0x80
INDICS_MASK = 0xE0
IndicSetStyle(int indic, int style)
Set an indicator to plain, squiggle or TT.
IndicGetStyle(int indic) : int
Retrieve the style of an indicator.
IndicSetFore(int indic, colour fore)
Set the foreground colour of an indicator.
IndicGetFore(int indic) : colour
Retrieve the foreground colour of an indicator.
IndicSetUnder(int indic, bool under)
Set an indicator to draw under text or over(default).
IndicGetUnder(int indic) : bool
Retrieve whether indicator drawn under or over text.
SetWhitespaceFore(bool useSetting, colour fore)
Set the foreground colour of all whitespace and whether to use this setting.
SetWhitespaceBack(bool useSetting, colour back)
Set the background colour of all whitespace and whether to use this setting.
WhitespaceSize [RW] : int size
R: Get the size of the dots used to mark space characters.
W: Set the size of the dots used to mark space characters.
StyleBits [RW] : int bits
R: Retrieve number of bits in style bytes used to hold the lexical state.
W: Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3). If a lexer requires more than 32 lexical states, then this is used to expand the possible states.
SetLineState(int line, int state)
Used to hold extra styling information for each line.
GetLineState(int line) : int
Retrieve the extra styling information for a line.
MaxLineState [R] : int
Retrieve the last line number that has line state.
CaretLineVisible [RW] : bool show
R: Is the background of the line containing the caret in a different colour?
W: Display the background of the line containing the caret in a different colour.
CaretLineBack [RW] : colour back
R: Get the colour of the background of the line containing the caret.
W: Set the colour of the background of the line containing the caret.
StyleSetChangeable(int style, bool changeable)
Set a style to be changeable or not (read only). Experimental feature, currently buggy.
AutoCShow(int lenEntered, string itemList)
Display a auto-completion list. The lenEntered parameter indicates how many characters before the caret should be used to provide context.
AutoCCancel()
Remove the auto-completion list from the screen.
AutoCActive() : bool
Is there an auto-completion list visible?
AutoCPosStart() : position
Retrieve the position of the caret when the auto-completion list was displayed.
AutoCComplete()
User has selected an item so remove the list and insert the selection.
AutoCStops(string characterSet)
Define a set of character that when typed cancel the auto-completion list.
AutoCSeparator [RW] : int separatorCharacter
R: Retrieve the auto-completion list separator character.
W: Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space.
AutoCSelect(string text)
Select the item in the auto-completion list that starts with a string.
AutoCCancelAtStart [RW] : bool cancel
R: Retrieve whether auto-completion cancelled by backspacing before start.
W: Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
AutoCFillUps [W] : string characterSet
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
AutoCChooseSingle [RW] : bool chooseSingle
R: Retrieve whether a single item auto-completion list automatically choose the item.
W: Should a single item auto-completion list automatically choose the item.
AutoCIgnoreCase [RW] : bool ignoreCase
R: Retrieve state of ignore case flag.
W: Set whether case is significant when performing auto-completion searches.
UserListShow(int listType, string itemList)
Display a list of strings and send notification when user chooses one.
AutoCAutoHide [RW] : bool autoHide
R: Retrieve whether or not autocompletion is hidden automatically when nothing matches.
W: Set whether or not autocompletion is hidden automatically when nothing matches.
AutoCDropRestOfWord [RW] : bool dropRestOfWord
R: Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
W: Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
RegisterImage(int type, string xpmData)
Register an XPM image for use in autocompletion lists.
ClearRegisteredImages()
Clear all the registered XPM images.
AutoCTypeSeparator [RW] : int separatorCharacter
R: Retrieve the auto-completion list type-separator character.
W: Change the type-separator character in the string setting up an auto-completion list. Default is '?' but can be changed if items contain '?'.
AutoCMaxWidth [RW] : int characterCount
R: Get the maximum width, in characters, of auto-completion and user lists.
W: 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.
AutoCMaxHeight [RW] : int rowCount
R: Set the maximum height, in rows, of auto-completion and user lists.
W: Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows.
Indent [RW] : int indentSize
R: Retrieve indentation size.
W: Set the number of spaces used for one level of indentation.
UseTabs [RW] : bool useTabs
R: Retrieve whether tabs will be used in indentation.
W: Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
SetLineIndentation(int line, int indentSize)
Change the indentation of a line to a number of columns.
GetLineIndentation(int line) : int
Retrieve the number of columns that a line is indented.
GetLineIndentPosition(int line) : position
Retrieve the position before the first non indentation character on a line.
GetColumn(position pos) : int
Retrieve the column number of a position, taking tab width into account.
CountCharacters(int startPos, int endPos) : int
Count characters between two positions.
HScrollBar [RW] : bool show
R: Is the horizontal scroll bar visible?
W: Show or hide the horizontal scroll bar.
IndentView
IndentationGuides [RW] : int indentView
R: Are the indentation guides visible?
W: Show or hide indentation guides.
HighlightGuide [RW] : int column
R: Get the highlighted indentation guide column.
W: Set the highlighted indentation guide column. 0 = no highlighted guide.
GetLineEndPosition(int line) : int
Get the position after the last visible characters on a line.
ReadOnly [RW] : bool readOnly
R: In read-only mode?
W: Set to read only or read write.
SelectionStart [RW] : position pos
R: Returns the position at the start of the selection.
W: Sets the position that starts the selection - this becomes the anchor.
SelectionEnd [RW] : position pos
R: Returns the position at the end of the selection.
W: Sets the position that ends the selection - this becomes the currentPosition.
SetEmptySelection(position pos)
Set caret to a position, while removing any existing selection.
PrintMagnification [RW] : int magnification
R: Returns the print magnification.
W: Sets the print magnification added to the point size of each style for printing.
PrintOption
PrintColourMode [RW] : int mode
R: Returns the print colour mode.
W: Modify colours when printing for clearer printed text.
FindOption
FindText(int flags, findtext ft) : position
Find some text in the document.
FormatRange(bool draw, formatrange fr) : position
On Windows, will draw the document into a display context such as a printer.
FirstVisibleLine [RW] : int lineDisplay
R: Retrieve the display line at the top of the display.
W: Scroll so that a display line is at the top of the display.
GetLine(int line) : string, int
Retrieve the contents of a line. Returns the length of the line.
LineCount [R] : int
Returns the number of lines in the document. There is always at least one.
MarginLeft [RW] : int pixelWidth
R: Returns the size in pixels of the left margin.
W: Sets the size in pixels of the left margin.
MarginRight [RW] : int pixelWidth
R: Returns the size in pixels of the right margin.
W: Sets the size in pixels of the right margin.
Modify [R] : bool
Is the document different from when it was last saved?
SetSel(position start, position end)
Select a range of text.
GetSelText() : string, int
Retrieve the selected text. Return the length of the text.
GetTextRange(textrange tr) : int
Retrieve a range of text. Return the length of the text.
HideSelection(bool normal)
Draw the selection in normal style or with selection highlighted.
PointXFromPosition(position pos) : int
Retrieve the x value of the point in the window where a position is displayed.
PointYFromPosition(position pos) : int
Retrieve the y value of the point in the window where a position is displayed.
LineFromPosition(position pos) : int
Retrieve the line containing a position.
PositionFromLine(int line) : position
Retrieve the position at the start of a line.
LineScroll(int columns, int lines)
Scroll horizontally and vertically.
ScrollCaret()
Ensure the caret is visible.
ReplaceSel(string text)
Replace the selected text with the argument text.
Null()
Null operation.
CanPaste() : bool
Will a paste succeed?
CanUndo() : bool
Are there any undoable actions in the undo history?
EmptyUndoBuffer()
Delete the undo history.
Undo()
Undo one action in the undo history.
Cut()
Cut the selection to the clipboard.
Copy()
Copy the selection to the clipboard.
Paste()
Paste the contents of the clipboard into the document replacing the selection.
Clear()
Clear the selection.
SetText(string text)
Replace the contents of the document with the argument text.
GetText() : string, int
Retrieve all the text in the document. Returns number of characters retrieved.
TextLength [R] : int
Retrieve the number of characters in the document.
DirectFunction [R] : int
Retrieve a pointer to a function that processes messages for this Scintilla.
DirectPointer [R] : int
Retrieve a pointer value to use as the first argument when calling the function returned by GetDirectFunction.
Overtype [RW] : bool overtype
R: Returns true if overtype mode is active otherwise false is returned.
W: Set to overtype (true) or insert mode.
CaretWidth [RW] : int pixelWidth
R: Returns the width of the insert mode caret.
W: Set the width of the insert mode caret.
TargetStart [RW] : position pos
R: Get the position that starts the target.
W: Sets the position that starts the target which is used for updating the document without affecting the scroll position.
TargetEnd [RW] : position pos
R: Get the position that ends the target.
W: Sets the position that ends the target which is used for updating the document without affecting the scroll position.
ReplaceTarget(string 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.
ReplaceTargetRE(string 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.
SearchInTarget(string 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 length of range or -1 for failure in which case target is not moved.
SearchFlags [RW] : int flags
R: Get the search flags used by SearchInTarget.
W: Set the search flags used by SearchInTarget.
CallTipShow(position pos, string definition)
Show a call tip containing a definition near position pos.
CallTipCancel()
Remove the call tip from the screen.
CallTipActive() : bool
Is there an active call tip?
CallTipPosStart() : position
Retrieve the position where the caret was before displaying the call tip.
CallTipSetHlt(int start, int end)
Highlight a segment of the definition.
CallTipBack [W] : colour back
Set the background colour for the call tip.
CallTipFore [W] : colour fore
Set the foreground colour for the call tip.
CallTipForeHlt [W] : colour fore
Set the foreground colour for the highlighted part of the call tip.
CallTipUseStyle [W] : int tabSize
Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
CallTipPosition [W] : bool above
Set position of calltip, above or below text.
VisibleFromDocLine(int line) : int
Find the display line of a document line taking hidden lines into account.
DocLineFromVisible(int lineDisplay) : int
Find the document line of a display line taking hidden lines into account.
WrapCount(int line) : int
The number of display lines needed to wrap a document line
FoldLevel
SetFoldLevel(int line, int 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.
GetFoldLevel(int line) : int
Retrieve the fold level of a line.
GetLastChild(int line, int level) : int
Find the last child line of a header line.
GetFoldParent(int line) : int
Find the parent line of a child line.
ShowLines(int lineStart, int lineEnd)
Make a range of lines visible.
HideLines(int lineStart, int lineEnd)
Make a range of lines invisible.
GetLineVisible(int line) : bool
Is a line visible?
AllLinesVisible [R] : bool
Are all lines visible?
SetFoldExpanded(int line, bool expanded)
Show the children of a header line.
GetFoldExpanded(int line) : bool
Is a header line expanded?
ToggleFold(int line)
Switch a header line between expanded and contracted.
EnsureVisible(int line)
Ensure a particular line is visible by expanding any header line hiding it.
FoldFlag
SetFoldFlags(int flags)
Set some style options for folding.
EnsureVisibleEnforcePolicy(int 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.
TabIndents [RW] : bool tabIndents
R: Does a tab pressed when caret is within indentation indent?
W: Sets whether a tab pressed when caret is within indentation indents.
BackSpaceUnIndents [RW] : bool bsUnIndents
R: Does a backspace pressed when caret is within indentation unindent?
W: Sets whether a backspace pressed when caret is within indentation unindents.
SC_TIME_FOREVER = 10000000
MouseDwellTime [RW] : int periodMilliseconds
R: Retrieve the time the mouse must sit still to generate a mouse dwell event.
W: Sets the time the mouse must sit still to generate a mouse dwell event.
WordStartPosition(position pos, bool onlyWordCharacters) : int
Get position of start of word.
WordEndPosition(position pos, bool onlyWordCharacters) : int
Get position of end of word.
Wrap
WrapMode [RW] : int mode
R: Retrieve whether text is word wrapped.
W: Sets whether text is word wrapped.
WrapVisualFlag
WrapVisualFlags [RW] : int wrapVisualFlags
R: Retrive the display mode of visual flags for wrapped lines.
W: Set the display mode of visual flags for wrapped lines.
WrapVisualLocation
WrapVisualFlagsLocation [RW] : int wrapVisualFlagsLocation
R: Retrive the location of visual flags for wrapped lines.
W: Set the location of visual flags for wrapped lines.
WrapStartIndent [RW] : int indent
R: Retrive the start indent for wrapped lines.
W: Set the start indent for wrapped lines.
WrapIndentMode
WrapIndentMode [RW] : int mode
R: Retrieve how wrapped sublines are placed. Default is fixed.
W: Sets how wrapped sublines are placed. Default is fixed.
LineCache
LayoutCache [RW] : int mode
R: Retrieve the degree of caching of layout information.
W: Sets the degree of caching of layout information.
ScrollWidth [RW] : int pixelWidth
R: Retrieve the document width assumed for scrolling.
W: Sets the document width assumed for scrolling.
ScrollWidthTracking [RW] : bool tracking
R: Retrieve whether the scroll width tracks wide lines.
W: Sets whether the maximum width line displayed is used to set scroll width.
TextWidth(int style, string text) : int
Measure the pixel width of some text in a particular style. NUL terminated text argument. Does not handle tab or control characters.
EndAtLastLine [RW] : bool endAtLastLine
R: Retrieve whether the maximum scroll position has the last line at the bottom of the view.
W: 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.
TextHeight(int line) : int
Retrieve the height of a particular line of text in pixels.
VScrollBar [RW] : bool show
R: Is the vertical scroll bar visible?
W: Show or hide the vertical scroll bar.
AppendText(string text)
Append a string to the end of the document without changing the selection.
TwoPhaseDraw [RW] : bool twoPhase
R: Is drawing done in two phases with backgrounds drawn before faoregrounds?
W: In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground. This avoids chopping off characters that overlap the next run.

Control font anti-aliasing.

FontQuality
FontQuality [RW] : int fontQuality
R: Retrieve the quality level for text.
W: Choose the quality level for text from the FontQuality enumeration.
MultiPaste
MultiPaste [RW] : int multiPaste
R: Retrieve the effect of pasting when there are multiple selections..
W: Change the effect of pasting when there are multiple selections.
GetTag(int tagNumber) : string, int
Retrieve the value of a tag from a regular expression search.
TargetFromSelection()
Make the target range start and end be the same as the selection range start and end.
LinesJoin()
Join the lines in the target.
LinesSplit(int pixelWidth)
Split the lines in the target into lines that are less wide than pixelWidth where possible.
SetFoldMarginColour(bool useSetting, colour back)
Set the colours used as a chequerboard pattern in the fold margin
SetFoldMarginHiColour(bool useSetting, colour fore)
LineDown()
Move caret down one line.
LineDownExtend()
Move caret down one line extending selection to new caret position.
LineUp()
Move caret up one line.
LineUpExtend()
Move caret up one line extending selection to new caret position.
CharLeft()
Move caret left one character.
CharLeftExtend()
Move caret left one character extending selection to new caret position.
CharRight()
Move caret right one character.
CharRightExtend()
Move caret right one character extending selection to new caret position.
WordLeft()
Move caret left one word.
WordLeftExtend()
Move caret left one word extending selection to new caret position.
WordRight()
Move caret right one word.
WordRightExtend()
Move caret right one word extending selection to new caret position.
Home()
Move caret to first position on line.
HomeExtend()
Move caret to first position on line extending selection to new caret position.
LineEnd()
Move caret to last position on line.
LineEndExtend()
Move caret to last position on line extending selection to new caret position.
DocumentStart()
Move caret to first position in document.
DocumentStartExtend()
Move caret to first position in document extending selection to new caret position.
DocumentEnd()
Move caret to last position in document.
DocumentEndExtend()
Move caret to last position in document extending selection to new caret position.
PageUp()
Move caret one page up.
PageUpExtend()
Move caret one page up extending selection to new caret position.
PageDown()
Move caret one page down.
PageDownExtend()
Move caret one page down extending selection to new caret position.
EditToggleOvertype()
Switch from insert to overtype mode or the reverse.
Cancel()
Cancel any modes such as call tip or auto-completion list display.
DeleteBack()
Delete the selection or if no selection, the character before the caret.
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.
BackTab()
Dedent the selected lines.
NewLine()
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
FormFeed()
Insert a Form Feed character.
VCHome()
Move caret to before first visible character on line. If already there move to first character on line.
VCHomeExtend()
Like VCHome but extending selection to new caret position.
ZoomIn()
Magnify the displayed text by increasing the sizes by 1 point.
ZoomOut()
Make the displayed text smaller by decreasing the sizes by 1 point.
DelWordLeft()
Delete the word to the left of the caret.
DelWordRight()
Delete the word to the right of the caret.
DelWordRightEnd()
Delete the word to the right of the caret, but not the trailing non-word characters.
LineCut()
Cut the line containing the caret.
LineDelete()
Delete the line containing the caret.
LineTranspose()
Switch the current line with the previous.
LineDuplicate()
Duplicate the current line.
LowerCase()
Transform the selection to lower case.
UpperCase()
Transform the selection to upper case.
LineScrollDown()
Scroll the document down, keeping the caret visible.
LineScrollUp()
Scroll the document up, keeping the caret visible.
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.
HomeDisplay()
Move caret to first position on display line.
HomeDisplayExtend()
Move caret to first position on display line extending selection to new caret position.
LineEndDisplay()
Move caret to last position on display line.
LineEndDisplayExtend()
Move caret to last position on display line extending selection to new caret position.

These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.

HomeWrap()
HomeWrapExtend()
LineEndWrap()
LineEndWrapExtend()
VCHomeWrap()
VCHomeWrapExtend()
LineCopy()
Copy the line containing the caret.
MoveCaretInsideView()
Move the caret inside current view if it's not there already.
LineLength(int line) : int
How many characters are on a line, including end of line characters?
BraceHighlight(position pos1, position pos2)
Highlight the characters at two positions.
BraceHighlightIndicator(bool useBraceHighlightIndicator, int indicator)
Use specified indicator to highlight matching braces instead of changing their style.
BraceBadLight(position pos)
Highlight the character at a position indicating there is no matching brace.
BraceBadLightIndicator(bool useBraceBadLightIndicator, int indicator)
Use specified indicator to highlight non matching brace instead of changing its style.
BraceMatch(position pos) : position
Find the position of a matching brace or INVALID_POSITION if no match.
ViewEOL [RW] : bool visible
R: Are the end of line characters visible?
W: Make the end of line characters visible or invisible.
DocPointer [RW] : int pointer
R: Retrieve a pointer to the document object.
W: Change the document object used.
ModEventMask [RW] : int mask
R: Get which document modification events are sent to the container.
W: Set which document modification events are sent to the container.
EdgeVisualStyle
EdgeColumn [RW] : int column
R: Retrieve the column number which text should be kept within.
W: Set the column number of the edge. If text goes past the edge then it is highlighted.
EdgeMode [RW] : int mode
R: Retrieve the edge highlight mode.
W: The edge may be displayed by a line (EDGE_LINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
EdgeColour [RW] : colour edgeColour
R: Retrieve the colour used in edge indication.
W: Change the colour used in edge indication.
SearchAnchor()
Sets the current caret position to be the search anchor.
SearchNext(int flags, string text) : int
Find some text starting at the search anchor. Does not ensure the selection is visible.
SearchPrev(int flags, string text) : int
Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible.
LinesOnScreen [R] : int
Retrieves the number of lines completely visible.
UsePopUp(bool allowPopUp)
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button.
SelectionIsRectangle [R] : bool
Is the selection rectangular? The alternative is the more common stream selection.
Zoom [RW] : int zoom
R: Retrieve the zoom level.
W: 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.
CreateDocument() : int
Create a new document object. Starts with reference count of 1 and not selected into editor.
AddRefDocument(int doc)
Extend life of document.
ReleaseDocument(int doc)
Release a reference to the document, deleting document if it fades to black.
Focus [RW] : bool focus
R: Get internal focus flag.
W: Change internal focus flag.
Status
Status [RW] : int statusCode
R: Get error status.
W: Change error status - 0 = OK.
MouseDownCaptures [RW] : bool captures
R: Get whether mouse gets captured.
W: Set whether the mouse is captured when its button is pressed.
CursorShape
Cursor [RW] : int cursorType
R: Get cursor type.
W: Sets the cursor to one of the SC_CURSOR* values.
ControlCharSymbol [RW] : int symbol
R: Get the way control characters are displayed.
W: Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
WordPartLeft()
Move to the previous change in capitalisation.
WordPartLeftExtend()
Move to the previous change in capitalisation extending selection to new caret position.
WordPartRight()
Move to the change next in capitalisation.
WordPartRightExtend()
Move to the next change in capitalisation extending selection to new caret position.
VISIBLE_SLOP = 0x01
Constants for use with SetVisiblePolicy, similar to SetCaretPolicy.
VISIBLE_STRICT = 0x04
SetVisiblePolicy(int visiblePolicy, int visibleSlop)
Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
DelLineLeft()
Delete back from the current position to the start of the line.
DelLineRight()
Delete forwards from the current position to the end of the line.
XOffset [RW] : int newOffset
W: Get and Set the xOffset (ie, horizonal scroll position).
ChooseCaretX()
Set the last x chosen value to be the caret x position.
GrabFocus()
Set the focus to this Scintilla widget.
CaretPolicy
SetXCaretPolicy(int caretPolicy, int caretSlop)
Set the way the caret is kept visible when going sideway. The exclusion zone is given in pixels.
SetYCaretPolicy(int caretPolicy, int caretSlop)
Set the way the line the caret is on is kept visible. The exclusion zone is given in lines.
PrintWrapMode [RW] : int mode
R: Is printing line wrapped?
W: Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
SetHotspotActiveFore(bool useSetting, colour fore)
Set a fore colour for active hotspots.
GetHotspotActiveFore() : colour
Get the fore colour for active hotspots.
SetHotspotActiveBack(bool useSetting, colour back)
Set a back colour for active hotspots.
GetHotspotActiveBack() : colour
Get the back colour for active hotspots.
HotspotActiveUnderline [RW] : bool underline
R: Get whether underlining for active hotspots.
W: Enable / Disable underlining active hotspots.
HotspotSingleLine [RW] : bool singleLine
R: Get the HotspotSingleLine property
W: Limit hotspots to single line so hotspots on two lines don't merge.
ParaDown()
Move caret between paragraphs (delimited by empty lines).
ParaDownExtend()
ParaUp()
ParaUpExtend()
PositionBefore(position pos) : position
Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0.
PositionAfter(position pos) : position
Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document.
CopyRange(position start, position end)
Copy a range of text to the clipboard. Positions are clipped into the document.
CopyText(string text)
Copy argument text to the clipboard.
SelectionMode
SelectionMode [RW] : int mode
R: Get the mode of the current selection.
W: Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or by lines (SC_SEL_LINES).
GetLineSelStartPosition(int line) : position
Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
GetLineSelEndPosition(int line) : position
Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
LineDownRectExtend()
Move caret down one line, extending rectangular selection to new caret position.
LineUpRectExtend()
Move caret up one line, extending rectangular selection to new caret position.
CharLeftRectExtend()
Move caret left one character, extending rectangular selection to new caret position.
CharRightRectExtend()
Move caret right one character, extending rectangular selection to new caret position.
HomeRectExtend()
Move caret to first position on line, extending rectangular selection to new caret position.
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.
LineEndRectExtend()
Move caret to last position on line, extending rectangular selection to new caret position.
PageUpRectExtend()
Move caret one page up, extending rectangular selection to new caret position.
PageDownRectExtend()
Move caret one page down, extending rectangular selection to new caret position.
StutteredPageUp()
Move caret to top of page, or one page up if already at top of page.
StutteredPageUpExtend()
Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
StutteredPageDown()
Move caret to bottom of page, or one page down if already at bottom of page.
StutteredPageDownExtend()
Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
WordLeftEnd()
Move caret left one word, position cursor at end of word.
WordLeftEndExtend()
Move caret left one word, position cursor at end of word, extending selection to new caret position.
WordRightEnd()
Move caret right one word, position cursor at end of word.
WordRightEndExtend()
Move caret right one word, position cursor at end of word, extending selection to new caret position.
WhitespaceChars [W] : string characters
Set the set of characters making up whitespace for when moving or selecting by word. Should be called after SetWordChars.
SetCharsDefault()
Reset the set of characters for whitespace and word characters to the defaults.
AutoCGetCurrent() : int
Get currently selected item position in the auto-completion list
AutoCGetCurrentText() : string, int
Get currently selected item text in the auto-completion list Returns the length of the item text
Allocate(int bytes)
Enlarge the document to a particular size of text bytes.
TargetAsUTF8() : string, int
Returns the target converted to UTF8. Return the length in bytes.
SetLengthForEncode(int bytes)
Set the length of the utf8 argument for calling EncodedFromUTF8. Set to -1 and the string will be measured to the first nul.
EncodedFromUTF8(string utf8) : string, int
Translates a UTF8 string into the document encoding. Return the length of the result in bytes. On error return 0.
FindColumn(int line, int 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.
CaretSticky [RW] : int useCaretStickyBehaviour
R: Can the caret preferred x position only be changed by explicit movement commands?
W: Stop the caret preferred x position changing when the user types.
CaretSticky
ToggleCaretSticky()
Switch between sticky and non-sticky: meant to be bound to a key.
PasteConvertEndings [RW] : bool convert
R: Get convert-on-paste setting
W: Enable/Disable convert-on-paste for line endings
SelectionDuplicate()
Duplicate the selection. If selection empty duplicate the line containing the caret.
SC_ALPHA_TRANSPARENT = 0
SC_ALPHA_OPAQUE = 255
SC_ALPHA_NOALPHA = 256
CaretLineBackAlpha [RW] : int alpha
R: Get the background alpha of the caret line.
W: Set background alpha of the caret line.
CaretStyle
CaretStyle [RW] : int caretStyle
R: Returns the current style of the caret.
W: Set the style of the caret to be drawn.
IndicatorCurrent [RW] : int indicator
R: Get the current indicator
W: Set the indicator used for IndicatorFillRange and IndicatorClearRange
IndicatorValue [RW] : int value
R: Get the current indicator vaue
W: Set the value used for IndicatorFillRange
IndicatorFillRange(int position, int fillLength)
Turn a indicator on over a range.
IndicatorClearRange(int position, int clearLength)
Turn a indicator off over a range.
IndicatorAllOnFor(int position) : int
Are any indicators present at position?
IndicatorValueAt(int indicator, int position) : int
What value does a particular indicator have at at a position?
IndicatorStart(int indicator, int position) : int
Where does a particular indicator start?
IndicatorEnd(int indicator, int position) : int
Where does a particular indicator end?
PositionCache [RW] : int size
R: How many entries are allocated to the position cache?
W: Set number of entries in position cache
CopyAllowLine()
Copy the selection, if selection empty copy the line with the caret
CharacterPointer [R] : int
Compact the document buffer and return a read-only pointer to the characters in the document.
KeysUnicode [RW] : bool keysUnicode
R: Are keys always interpreted as Unicode?
W: Always interpret keyboard input as Unicode
IndicSetAlpha(int indicator, int alpha)
Set the alpha fill colour of the given indicator.
IndicGetAlpha(int indicator) : int
Get the alpha fill colour of the given indicator.
IndicSetOutlineAlpha(int indicator, int alpha)
Set the alpha outline colour of the given indicator.
IndicGetOutlineAlpha(int indicator) : int
Get the alpha outline colour of the given indicator.
ExtraAscent [RW] : int extraAscent
R: Get extra ascent for each line
W: Set extra ascent for each line
ExtraDescent [RW] : int extraDescent
R: Get extra descent for each line
W: Set extra descent for each line
MarkerSymbolDefined(int markerNumber) : int
Which symbol was defined for markerNumber with MarkerDefine
MarginSetText(int line, string text)
Set the text in the text margin for a line
MarginGetText(int line) : string, int
Get the text in the text margin for a line
MarginSetStyle(int line, int style)
Set the style number for the text margin for a line
MarginGetStyle(int line) : int
Get the style number for the text margin for a line
MarginSetStyles(int line, string styles)
Set the style in the text margin for a line
MarginGetStyles(int line) : string, int
Get the styles in the text margin for a line
MarginTextClearAll()
Clear the margin text on all lines
MarginStyleOffset [RW] : int style
R: Get the start of the range of style numbers used for margin text
W: Get the start of the range of style numbers used for margin text
MarginOption
MarginOptions [RW] : int marginOptions
R: Get the margin options.
W: Set the margin options.
AnnotationSetText(int line, string text)
Set the annotation text for a line
AnnotationGetText(int line) : string, int
Get the annotation text for a line
AnnotationSetStyle(int line, int style)
Set the style number for the annotations for a line
AnnotationGetStyle(int line) : int
Get the style number for the annotations for a line
AnnotationSetStyles(int line, string styles)
Set the annotation styles for a line
AnnotationGetStyles(int line) : string, int
Get the annotation styles for a line
AnnotationGetLines(int line) : int
Get the number of annotation lines for a line
AnnotationClearAll()
Clear the annotations from all lines
AnnotationVisible
AnnotationVisible [RW] : int visible
R: Get the visibility for the annotations for a view
W: Set the visibility for the annotations for a view
AnnotationStyleOffset [RW] : int style
R: Get the start of the range of style numbers used for annotations
W: Get the start of the range of style numbers used for annotations
UNDO_MAY_COALESCE = 1
AddUndoAction(int token, int flags)
Add a container action to the undo stack
CharPositionFromPoint(int x, int y) : position
Find the position of a character from a point within the window.
CharPositionFromPointClose(int x, int y) : position
Find the position of a character from a point within the window. Return INVALID_POSITION if not close to text.
MultipleSelection [RW] : bool multipleSelection
R: Whether multiple selections can be made
W: Set whether multiple selections can be made
AdditionalSelectionTyping [RW] : bool additionalSelectionTyping
R: Whether typing can be performed into multiple selections
W: Set whether typing can be performed into multiple selections
AdditionalCaretsBlink [RW] : bool additionalCaretsBlink
R: Whether additional carets will blink
W: Set whether additional carets will blink
AdditionalCaretsVisible [RW] : bool additionalCaretsBlink
R: Whether additional carets are visible
W: Set whether additional carets are visible
Selections [R] : int
How many selections are there?
ClearSelections()
Clear selections to a single empty stream selection
SetSelection(int caret, int anchor) : int
Set a simple selection
AddSelection(int caret, int anchor) : int
Add a selection
MainSelection [RW] : int selection
R: Which selection is the main selection
W: Set the main selection
SetSelectionNCaret(int selection, position pos)
GetSelectionNCaret(int selection) : position
SetSelectionNAnchor(int selection, position posAnchor)
GetSelectionNAnchor(int selection) : position
SetSelectionNCaretVirtualSpace(int selection, int space)
GetSelectionNCaretVirtualSpace(int selection) : int
SetSelectionNAnchorVirtualSpace(int selection, int space)
GetSelectionNAnchorVirtualSpace(int selection) : int
SetSelectionNStart(int selection, position pos)
Sets the position that starts the selection - this becomes the anchor.
GetSelectionNStart(int selection) : position
Returns the position at the start of the selection.
SetSelectionNEnd(int selection, position pos)
Sets the position that ends the selection - this becomes the currentPosition.
GetSelectionNEnd(int selection) : position
Returns the position at the end of the selection.
RectangularSelectionCaret [RW] : position pos
RectangularSelectionAnchor [RW] : position posAnchor
RectangularSelectionCaretVirtualSpace [RW] : int space
RectangularSelectionAnchorVirtualSpace [RW] : int space
VirtualSpace
VirtualSpaceOptions [RW] : int virtualSpaceOptions

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.

RectangularSelectionModifier [RW] : int modifier
R: Get the modifier key used for rectangular selection.
AdditionalSelFore [W] : colour fore
Set the foreground colour of additional selections. Must have previously called SetSelFore with non-zero first argument for this to have an effect.
AdditionalSelBack [W] : colour back
Set the background colour of additional selections. Must have previously called SetSelBack with non-zero first argument for this to have an effect.
AdditionalSelAlpha [RW] : int alpha
R: Get the alpha of the selection.
W: Set the alpha of the selection.
AdditionalCaretFore [RW] : colour fore
R: Get the foreground colour of additional carets.
W: Set the foreground colour of additional carets.
RotateSelection()
Set the main selection to the next selection.
SwapMainAnchorCaret()
Swap that caret and anchor of the main selection.
ChangeLexerState(position start, position end) : int
Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.
ContractedFoldNext(int lineStart) : int
Find the next line at or after lineStart that is a contracted fold header line. Return -1 when no more lines.
VerticalCentreCaret()
Centre current line in window.
MoveSelectedLinesUp()
Move the selected lines up one line, shifting the line above after the selection
MoveSelectedLinesDown()
Move the selected lines down one line, shifting the line below before the selection
Identifier [RW] : int identifier
R: Get the identifier.
W: Set the identifier reported as idFrom in notification messages.
RGBAImageWidth [W] : int width
Set the width for future RGBA image data.
RGBAImageHeight [W] : int height
Set the height for future RGBA image data.
MarkerDefineRGBAImage(int markerNumber, string pixels)
Define a marker from RGBA data. It has the width and height from RGBAImageSetWidth/Height
RegisterRGBAImage(int type, string pixels)
Register an RGBA image for use in autocompletion lists. It has the width and height from RGBAImageSetWidth/Height
ScrollToStart()
Scroll to start of document.
ScrollToEnd()
Scroll to end of document.
SC_TECHNOLOGY_DEFAULT = 0
SC_TECHNOLOGY_DIRECTWRITE = 1
Technology [RW] : int technology
R: Get the tech.
W: Set the technolgy used.
CreateLoader(int bytes) : int
Create an ILoader*.
StartRecord()
Start notifying the container of all key presses and commands.
StopRecord()
Stop notifying the container of all key presses and commands.
Lexer [RW] : int lexer
R: Retrieve the lexing language of the document.
W: Set the lexing language of the document.
Colourise(position start, position end)
Colourise a segment of the document using the current lexing language.
SetProperty(string key, string value)
Set up a value that may be used by a lexer for some optional feature.
KEYWORDSET_MAX = 8
Maximum value of keywordSet parameter of SetKeyWords.
SetKeyWords(int keywordSet, string keyWords)
Set up the key words used by the lexer.
SetLexerLanguage(string language)
Set the lexing language of the document based on string name.
LoadLexerLibrary(string path)
Load a lexer library (dll / so).
GetProperty(string key) : string, int
Retrieve a "property" value previously set with SetProperty.
GetPropertyExpanded(string key) : string, int
Retrieve a "property" value previously set with SetProperty, with "$()" variable replacement on returned buffer.
GetPropertyInt(string key) : int
Retrieve a "property" value previously set with SetProperty, interpreted as an int AFTER any "$()" variable replacement.
StyleBitsNeeded [R] : int
Retrieve the number of bits the current lexer needs for styling.
GetLexerLanguage() : string, int
Retrieve the name of the lexer. Return the length of the text.
PrivateLexerCall(int operation, int pointer) : int
For private communication between an application and a known lexer.
PropertyNames() : string, int
Retrieve a '\n' separated list of properties understood by the current lexer.
TypeProperty
PropertyType(string name) : int
Retrieve the type of a property.
DescribeProperty(string name) : string, int
Describe a property.
DescribeKeyWordSets() : string, int
Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
ModificationFlags
Notifications Type of modification and the action which caused the modification. These are defined as a bit mask to make it easy to specify which notifications are wanted. One bit is set from each of SC_MOD_* and SC_PERFORMED_*.
SC_MULTISTEPUNDOREDO = 0x80
SC_MULTILINEUNDOREDO = 0x1000
SC_STARTACTION = 0x2000
SC_MODEVENTMASKALL = 0xFFFFF
Update
SCEN_CHANGE = 768
For compatibility, these go through the COMMAND notification rather than NOTIFY and should have had exactly the same values as the EN_* constants. Unfortunately the SETFOCUS and KILLFOCUS are flipped over from EN_* As clients depend on these constants, this will not be changed.
SCEN_SETFOCUS = 512
SCEN_KILLFOCUS = 256

Symbolic key codes and modifier flags. ASCII and other printable characters below 256. Extended keys above 300.

Keys
KeyMod
Lexer
For SciLexer.h
SCE_GC_DEFAULT = 0
Lexical states for SCLEX_GUI4CLI
SCE_GC_COMMENTLINE = 1
SCE_GC_COMMENTBLOCK = 2
SCE_GC_GLOBAL = 3
SCE_GC_EVENT = 4
SCE_GC_ATTRIBUTE = 5
SCE_GC_CONTROL = 6
SCE_GC_COMMAND = 7
SCE_GC_STRING = 8
SCE_GC_OPERATOR = 9

Events

Deprecated

SC_CP_DBCS = 1
Deprecated in 2.21 The SC_CP_DBCS value can be used to indicate a DBCS mode for GTK+.

Deprecated in 2.30

UsePalette [RW] : bool usePalette
R: In palette mode?
W: In palette mode, Scintilla uses the environment's palette calls to display more colours. This may lead to ugly displays.

This document is a simple conversion of Scintilla's interface file, the license of which is noted in Scintilla License.

back

inserted by FC2 system