## First line may be used for shbang

## This file defines the interface to Scintilla

## Copyright 2000-2003 by Neil Hodgson <neilh@scintilla.org>

## The License.txt file describes the conditions under which this software may be distributed.

## A line starting with ## is a pure comment and should be stripped by readers.

## A line starting with #! is for future shbang use

## A line starting with # followed by a space is a documentation comment and refers

## to the next feature definition.

## Each feature is defined by a line starting with fun, get, set, val, evt, enu, lex, or ali.

## cat -> start a category

## fun -> a function

## get -> a property get function

## set -> a property set function

## val -> definition of a constant

## evt -> an event

## enu -> associate an enumeration with a set of vals with a prefix

## lex -> associate a lexer with the lexical classes it produces

## ali -> add an alias for a val, commonly adding '_' to separate words

##

## All other feature names should be ignored. They may be defined in the future.

## A property may have a set function, a get function or both. Each will have

## "Get" or "Set" in their names and the corresponding name will have the obvious switch.

## A property may be subscripted, in which case the first parameter is the subscript.

## fun, get, and set features have a strict syntax:

## <featureType><ws><returnType><ws><name>[=<number](<param>,<param>)

## where <ws> stands for white space.

## param may be empty (null value) or is <paramType><ws><paramName>[=<value>]

## Additional white space is allowed between elements.

## The syntax for evt is <featureType><ws><returnType><ws><name>[=<number]([<param>[,<param>]*])

## Feature names that contain an underscore are defined by Windows, so in these

## cases, using the Windows definition is preferred where available.

## The feature numbers are stable so features will not be renumbered.

## Features may be removed but they will go through a period of deprecation

## before removal which is signalled by moving them into the Deprecated category.

##

## enu has the syntax enu<ws><enumeration>=<prefix>[<ws><prefix>]* where all the val

## features in this file starting with a given <prefix> are considered part of the

## enumeration.

##

## lex has the syntax lex<ws><name>=<lexerVal><ws><prefix>[<ws><prefix>]*

## where name is a reasonably capitalised (Python, XML) identifier or UI name,

## lexerVal is the val used to specify the lexer, and the list of prefixes is similar

## to enu. The name may not be the same as that used within the lexer so the lexerVal

## should be used to tie these entities together.

## Types: Never start with a capital letter

## void

## int

## bool -> integer, 1=true, 0=false

## position -> intptr_t position in a document

## line -> intptr_t line in a document

## colour -> colour integer containing red, green and blue bytes.

## string -> pointer to const character

## stringresult -> pointer to character, NULL-> return size of result

## cells -> pointer to array of cells, each cell containing a style byte and character byte

## pointer -> void* pointer that may point to a document, loader, internal text storage or similar

## textrange -> range of a min and a max position with an output string

## findtext -> searchrange, text -> foundposition

## keymod -> integer containing key in low half and modifiers in high half

## formatrange

## Enumeration types always start with a capital letter

## Types no longer used:

## findtextex -> searchrange

## charrange -> range of a min and a max position

## charrangeresult -> like charrange, but output param

## countedstring

## point -> x,y

## pointresult -> like point, but output param

## rectangle -> left,top,right,bottom

## Client code should ignore definitions containing types it does not understand, except

## for possibly #defining the constants

## Line numbers and positions start at 0.

## String arguments may contain NUL ('\0') characters where the calls provide a length

## argument and retrieve NUL characters. APIs marked as NUL-terminated also have a

## NUL appended but client code should calculate the size that will be returned rather

## than relying upon the NUL whenever possible. Allow for the extra NUL character when

## allocating buffers. The size to allocate for a stringresult (not including NUL) can be

## determined by calling with a NULL (0) pointer.

cat Basics

################################################

## For Scintilla.h

val INVALID_POSITION=-1

# 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.

val SCI_START=2000

val SCI_OPTIONAL_START=3000

val SCI_LEXER_START=4000

# Add text to the document at current position.

fun void AddText=2001(position length, string text)

# Add array of cells to document.

fun void AddStyledText=2002(position length, cells c)

# Insert string at a position.

fun void InsertText=2003(position pos, string text)

# Change the text that is being inserted in response to SC_MOD_INSERTCHECK

fun void ChangeInsertion=2672(position length, string text)

# Delete all text in the document.

fun void ClearAll=2004(,)

# Delete a range of text in the document.

fun void DeleteRange=2645(position start, position lengthDelete)

# Set all style bytes to 0, remove all folding information.

fun void ClearDocumentStyle=2005(,)

# Returns the number of bytes in the document.

get position GetLength=2006(,)

# Returns the character byte at the position.

get int GetCharAt=2007(position pos,)

# Returns the position of the caret.

get position GetCurrentPos=2008(,)

# Returns the position of the opposite end of the selection to the caret.

get position GetAnchor=2009(,)

# Returns the style byte at the position.

get int GetStyleAt=2010(position pos,)

# Redoes the next action on the undo history.

fun void Redo=2011(,)

# Choose between collecting actions into the undo

# history and discarding them.

set void SetUndoCollection=2012(bool collectUndo,)

# Select all the text in the document.

fun void SelectAll=2013(,)

# Remember the current position in the undo history as the position

# at which the document was saved.

fun void SetSavePoint=2014(,)

# Retrieve a buffer of cells.

# Returns the number of bytes in the buffer not including terminating NULs.

fun position GetStyledText=2015(, textrange tr)

# Are there any redoable actions in the undo history?

fun bool CanRedo=2016(,)

# Retrieve the line number at which a particular marker is located.

fun line MarkerLineFromHandle=2017(int markerHandle,)

# Delete a marker.

fun void MarkerDeleteHandle=2018(int markerHandle,)

# Retrieve marker handles of a line

fun int MarkerHandleFromLine=2732(line line, int which)

# Retrieve marker number of a marker handle

fun int MarkerNumberFromLine=2733(line line, int which)

# Is undo history being collected?

get bool GetUndoCollection=2019(,)

enu WhiteSpace=SCWS_

val SCWS_INVISIBLE=0

val SCWS_VISIBLEALWAYS=1

val SCWS_VISIBLEAFTERINDENT=2

val SCWS_VISIBLEONLYININDENT=3

ali SCWS_VISIBLEALWAYS=VISIBLE_ALWAYS

ali SCWS_VISIBLEAFTERINDENT=VISIBLE_AFTER_INDENT

ali SCWS_VISIBLEONLYININDENT=VISIBLE_ONLY_IN_INDENT

# Are white space characters currently visible?

# Returns one of SCWS_* constants.

get WhiteSpace GetViewWS=2020(,)

# Make white space characters invisible, always visible or visible outside indentation.

set void SetViewWS=2021(WhiteSpace viewWS,)

enu TabDrawMode=SCTD_

val SCTD_LONGARROW=0

val SCTD_STRIKEOUT=1

ali SCTD_LONGARROW=LONG_ARROW

ali SCTD_STRIKEOUT=STRIKE_OUT

# Retrieve the current tab draw mode.

# Returns one of SCTD_* constants.

get TabDrawMode GetTabDrawMode=2698(,)

# Set how tabs are drawn when visible.

set void SetTabDrawMode=2699(TabDrawMode tabDrawMode,)

# Find the position from a point within the window.

fun position PositionFromPoint=2022(int x, int y)

# Find the position from a point within the window but return

# INVALID_POSITION if not close to text.

fun position PositionFromPointClose=2023(int x, int y)

# Set caret to start of a line and ensure it is visible.

fun void GotoLine=2024(line line,)

# Set caret to a position and ensure it is visible.

fun void GotoPos=2025(position caret,)

# Set the selection anchor to a position. The anchor is the opposite

# end of the selection from the caret.

set void SetAnchor=2026(position anchor,)

# Retrieve the text of the line containing the caret.

# Returns the index of the caret on the line.

# Result is NUL-terminated.

fun position GetCurLine=2027(position length, stringresult text)

# Retrieve the position of the last correctly styled character.

get position GetEndStyled=2028(,)

enu EndOfLine=SC_EOL_

val SC_EOL_CRLF=0

val SC_EOL_CR=1

val SC_EOL_LF=2

ali SC_EOL_CRLF=CR_LF

# Convert all line endings in the document to one mode.

fun void ConvertEOLs=2029(EndOfLine eolMode,)

# Retrieve the current end of line mode - one of CRLF, CR, or LF.

get EndOfLine GetEOLMode=2030(,)

# Set the current end of line mode.

set void SetEOLMode=2031(EndOfLine eolMode,)

# Set the current styling position to start.

# The unused parameter is no longer used and should be set to 0.

fun void StartStyling=2032(position start, int unused)

# Change style from current styling position for length characters to a style

# and move the current styling position to after this newly styled segment.

fun void SetStyling=2033(position length, int style)

# Is drawing done first into a buffer or direct to the screen?

get bool GetBufferedDraw=2034(,)

# If drawing is buffered then each line of text is drawn into a bitmap buffer

# before drawing it to the screen to avoid flicker.

set void SetBufferedDraw=2035(bool buffered,)

# Change the visible size of a tab to be a multiple of the width of a space character.

set void SetTabWidth=2036(int tabWidth,)

# Retrieve the visible size of a tab.

get int GetTabWidth=2121(,)

# Set the minimum visual width of a tab.

set void SetTabMinimumWidth=2724(int pixels,)

# Get the minimum visual width of a tab.

get int GetTabMinimumWidth=2725(,)

# Clear explicit tabstops on a line.

fun void ClearTabStops=2675(line line,)

# Add an explicit tab stop for a line.

fun void AddTabStop=2676(line line, int x)

# Find the next explicit tab stop position on a line after a position.

fun int GetNextTabStop=2677(line line, int x)

# The SC_CP_UTF8 value can be used to enter Unicode mode.

# This is the same value as CP_UTF8 in Windows

val SC_CP_UTF8=65001

# 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.

set void SetCodePage=2037(int codePage,)

enu IMEInteraction=SC_IME_

val SC_IME_WINDOWED=0

val SC_IME_INLINE=1

# Is the IME displayed in a window or inline?

get IMEInteraction GetIMEInteraction=2678(,)

# Choose to display the IME in a window or inline.

set void SetIMEInteraction=2679(IMEInteraction imeInteraction,)

enu Alpha=SC_ALPHA_

val SC_ALPHA_TRANSPARENT=0

val SC_ALPHA_OPAQUE=255

val SC_ALPHA_NOALPHA=256

ali SC_ALPHA_NOALPHA=NO_ALPHA

enu CursorShape=SC_CURSOR

val SC_CURSORNORMAL=-1

val SC_CURSORARROW=2

val SC_CURSORWAIT=4

val SC_CURSORREVERSEARROW=7

ali SC_CURSORREVERSEARROW=REVERSE_ARROW

enu MarkerSymbol=SC_MARK_

val MARKER_MAX=31

val SC_MARK_CIRCLE=0

val SC_MARK_ROUNDRECT=1

val SC_MARK_ARROW=2

val SC_MARK_SMALLRECT=3

val SC_MARK_SHORTARROW=4

val SC_MARK_EMPTY=5

val SC_MARK_ARROWDOWN=6

val SC_MARK_MINUS=7

val SC_MARK_PLUS=8

# Shapes used for outlining column.

val SC_MARK_VLINE=9

val SC_MARK_LCORNER=10

val SC_MARK_TCORNER=11

val SC_MARK_BOXPLUS=12

val SC_MARK_BOXPLUSCONNECTED=13

val SC_MARK_BOXMINUS=14

val SC_MARK_BOXMINUSCONNECTED=15

val SC_MARK_LCORNERCURVE=16

val SC_MARK_TCORNERCURVE=17

val SC_MARK_CIRCLEPLUS=18

val SC_MARK_CIRCLEPLUSCONNECTED=19

val SC_MARK_CIRCLEMINUS=20

val SC_MARK_CIRCLEMINUSCONNECTED=21

# Invisible mark that only sets the line background colour.

val SC_MARK_BACKGROUND=22

val SC_MARK_DOTDOTDOT=23

val SC_MARK_ARROWS=24

val SC_MARK_PIXMAP=25

val SC_MARK_FULLRECT=26

val SC_MARK_LEFTRECT=27

val SC_MARK_AVAILABLE=28

val SC_MARK_UNDERLINE=29

val SC_MARK_RGBAIMAGE=30

val SC_MARK_BOOKMARK=31

val SC_MARK_VERTICALBOOKMARK=32

val SC_MARK_CHARACTER=10000

ali SC_MARK_ROUNDRECT=ROUND_RECT

ali SC_MARK_SMALLRECT=SMALL_RECT

ali SC_MARK_SHORTARROW=SHORT_ARROW

ali SC_MARK_ARROWDOWN=ARROW_DOWN

ali SC_MARK_VLINE=V_LINE

ali SC_MARK_LCORNER=L_CORNER

ali SC_MARK_TCORNER=T_CORNER

ali SC_MARK_BOXPLUS=BOX_PLUS

ali SC_MARK_BOXPLUSCONNECTED=BOX_PLUS_CONNECTED

ali SC_MARK_BOXMINUS=BOX_MINUS

ali SC_MARK_BOXMINUSCONNECTED=BOX_MINUS_CONNECTED

ali SC_MARK_LCORNERCURVE=L_CORNER_CURVE

ali SC_MARK_TCORNERCURVE=T_CORNER_CURVE

ali SC_MARK_CIRCLEPLUS=CIRCLE_PLUS

ali SC_MARK_CIRCLEPLUSCONNECTED=CIRCLE_PLUS_CONNECTED

ali SC_MARK_CIRCLEMINUS=CIRCLE_MINUS

ali SC_MARK_CIRCLEMINUSCONNECTED=CIRCLE_MINUS_CONNECTED

ali SC_MARK_DOTDOTDOT=DOT_DOT_DOT

ali SC_MARK_FULLRECT=FULL_RECT

ali SC_MARK_LEFTRECT=LEFT_RECT

ali SC_MARK_RGBAIMAGE=RGBA_IMAGE

ali SC_MARK_VERTICALBOOKMARK=VERTICAL_BOOKMARK

enu MarkerOutline=SC_MARKNUM_

# Markers used for outlining column.

val SC_MARKNUM_FOLDEREND=25

val SC_MARKNUM_FOLDEROPENMID=26

val SC_MARKNUM_FOLDERMIDTAIL=27

val SC_MARKNUM_FOLDERTAIL=28

val SC_MARKNUM_FOLDERSUB=29

val SC_MARKNUM_FOLDER=30

val SC_MARKNUM_FOLDEROPEN=31

ali SC_MARKNUM_FOLDEREND=FOLDER_END

ali SC_MARKNUM_FOLDEROPENMID=FOLDER_OPEN_MID

ali SC_MARKNUM_FOLDERMIDTAIL=FOLDER_MID_TAIL

ali SC_MARKNUM_FOLDERTAIL=FOLDER_TAIL

ali SC_MARKNUM_FOLDERSUB=FOLDER_SUB

ali SC_MARKNUM_FOLDEROPEN=FOLDER_OPEN

# SC_MASK_FOLDERS doesn't go in an enumeration as larger than max 32-bit positive integer

val SC_MASK_FOLDERS=0xFE000000

# Set the symbol used for a particular marker number.

fun void MarkerDefine=2040(int markerNumber, MarkerSymbol markerSymbol)

# Set the foreground colour used for a particular marker number.

set void MarkerSetFore=2041(int markerNumber, colour fore)

# Set the background colour used for a particular marker number.

set void MarkerSetBack=2042(int markerNumber, colour back)

# Set the background colour used for a particular marker number when its folding block is selected.

set void MarkerSetBackSelected=2292(int markerNumber, colour back)

# Enable/disable highlight for current folding block (smallest one that contains the caret)

fun void MarkerEnableHighlight=2293(bool enabled,)

# Add a marker to a line, returning an ID which can be used to find or delete the marker.

fun int MarkerAdd=2043(line line, int markerNumber)

# Delete a marker from a line.

fun void MarkerDelete=2044(line line, int markerNumber)

# Delete all markers with a particular number from all lines.

fun void MarkerDeleteAll=2045(int markerNumber,)

# Get a bit mask of all the markers set on a line.

fun int MarkerGet=2046(line line,)

# Find the next line at or after lineStart that includes a marker in mask.

# Return -1 when no more lines.

fun line MarkerNext=2047(line lineStart, int markerMask)

# Find the previous line before lineStart that includes a marker in mask.

fun line MarkerPrevious=2048(line lineStart, int markerMask)

# Define a marker from a pixmap.

fun void MarkerDefinePixmap=2049(int markerNumber, string pixmap)

# Add a set of markers to a line.

fun void MarkerAddSet=2466(line line, int markerSet)

# Set the alpha used for a marker that is drawn in the text area, not the margin.

set void MarkerSetAlpha=2476(int markerNumber, Alpha alpha)

val SC_MAX_MARGIN=4

enu MarginType=SC_MARGIN_

val SC_MARGIN_SYMBOL=0

val SC_MARGIN_NUMBER=1

val SC_MARGIN_BACK=2

val SC_MARGIN_FORE=3

val SC_MARGIN_TEXT=4

val SC_MARGIN_RTEXT=5

val SC_MARGIN_COLOUR=6

ali SC_MARGIN_RTEXT=R_TEXT

# Set a margin to be either numeric or symbolic.

set void SetMarginTypeN=2240(int margin, MarginType marginType)

# Retrieve the type of a margin.

get MarginType GetMarginTypeN=2241(int margin,)

# Set the width of a margin to a width expressed in pixels.

set void SetMarginWidthN=2242(int margin, int pixelWidth)

# Retrieve the width of a margin in pixels.

get int GetMarginWidthN=2243(int margin,)

# Set a mask that determines which markers are displayed in a margin.

set void SetMarginMaskN=2244(int margin, int mask)

# Retrieve the marker mask of a margin.

get int GetMarginMaskN=2245(int margin,)

# Make a margin sensitive or insensitive to mouse clicks.

set void SetMarginSensitiveN=2246(int margin, bool sensitive)

# Retrieve the mouse click sensitivity of a margin.

get bool GetMarginSensitiveN=2247(int margin,)

# Set the cursor shown when the mouse is inside a margin.

set void SetMarginCursorN=2248(int margin, CursorShape cursor)

# Retrieve the cursor shown in a margin.

get CursorShape GetMarginCursorN=2249(int margin,)

# Set the background colour of a margin. Only visible for SC_MARGIN_COLOUR.

set void SetMarginBackN=2250(int margin, colour back)

# Retrieve the background colour of a margin

get colour GetMarginBackN=2251(int margin,)

# Allocate a non-standard number of margins.

set void SetMargins=2252(int margins,)

# How many margins are there?.

get int GetMargins=2253(,)

# Styles in range 32..39 are predefined for parts of the UI and are not used as normal styles.

enu StylesCommon=STYLE_

val STYLE_DEFAULT=32

val STYLE_LINENUMBER=33

val STYLE_BRACELIGHT=34

val STYLE_BRACEBAD=35

val STYLE_CONTROLCHAR=36

val STYLE_INDENTGUIDE=37

val STYLE_CALLTIP=38

val STYLE_FOLDDISPLAYTEXT=39

val STYLE_LASTPREDEFINED=39

val STYLE_MAX=255

ali STYLE_LINENUMBER=LINE_NUMBER

ali STYLE_BRACELIGHT=BRACE_LIGHT

ali STYLE_BRACEBAD=BRACE_BAD

ali STYLE_CONTROLCHAR=CONTROL_CHAR

ali STYLE_INDENTGUIDE=INDENT_GUIDE

ali STYLE_CALLTIP=CALL_TIP

ali STYLE_FOLDDISPLAYTEXT=FOLD_DISPLAY_TEXT

ali STYLE_LASTPREDEFINED=LAST_PREDEFINED

# Character set identifiers are used in StyleSetCharacterSet.

# The values are the same as the Windows *_CHARSET values.

enu CharacterSet=SC_CHARSET_

val SC_CHARSET_ANSI=0

val SC_CHARSET_DEFAULT=1

val SC_CHARSET_BALTIC=186

val SC_CHARSET_CHINESEBIG5=136

val SC_CHARSET_EASTEUROPE=238

val SC_CHARSET_GB2312=134

val SC_CHARSET_GREEK=161

val SC_CHARSET_HANGUL=129

val SC_CHARSET_MAC=77

val SC_CHARSET_OEM=255

val SC_CHARSET_RUSSIAN=204

val SC_CHARSET_OEM866=866

val SC_CHARSET_CYRILLIC=1251

val SC_CHARSET_SHIFTJIS=128

val SC_CHARSET_SYMBOL=2

val SC_CHARSET_TURKISH=162

val SC_CHARSET_JOHAB=130

val SC_CHARSET_HEBREW=177

val SC_CHARSET_ARABIC=178

val SC_CHARSET_VIETNAMESE=163

val SC_CHARSET_THAI=222

val SC_CHARSET_8859_15=1000

ali SC_CHARSET_CHINESEBIG5=CHINESE_BIG5

ali SC_CHARSET_EASTEUROPE=EAST_EUROPE

ali SC_CHARSET_GB2312=G_B_2312

ali SC_CHARSET_OEM866=OEM_866

ali SC_CHARSET_SHIFTJIS=SHIFT_JIS

ali SC_CHARSET_8859_15=ISO_8859_15

# Clear all the styles and make equivalent to the global default style.

fun void StyleClearAll=2050(,)

# Set the foreground colour of a style.

set void StyleSetFore=2051(int style, colour fore)

# Set the background colour of a style.

set void StyleSetBack=2052(int style, colour back)

# Set a style to be bold or not.

set void StyleSetBold=2053(int style, bool bold)

# Set a style to be italic or not.

set void StyleSetItalic=2054(int style, bool italic)

# Set the size of characters of a style.

set void StyleSetSize=2055(int style, int sizePoints)

# Set the font of a style.

set void StyleSetFont=2056(int style, string fontName)

# Set a style to have its end of line filled or not.

set void StyleSetEOLFilled=2057(int style, bool eolFilled)

# Reset the default style to its state at startup

fun void StyleResetDefault=2058(,)

# Set a style to be underlined or not.

set void StyleSetUnderline=2059(int style, bool underline)

enu CaseVisible=SC_CASE_

val SC_CASE_MIXED=0

val SC_CASE_UPPER=1

val SC_CASE_LOWER=2

val SC_CASE_CAMEL=3

# Get the foreground colour of a style.

get colour StyleGetFore=2481(int style,)

# Get the background colour of a style.

get colour StyleGetBack=2482(int style,)

# Get is a style bold or not.

get bool StyleGetBold=2483(int style,)

# Get is a style italic or not.

get bool StyleGetItalic=2484(int style,)

# Get the size of characters of a style.

get int StyleGetSize=2485(int style,)

# Get the font of a style.

# Returns the length of the fontName

# Result is NUL-terminated.

get int StyleGetFont=2486(int style, stringresult fontName)

# Get is a style to have its end of line filled or not.

get bool StyleGetEOLFilled=2487(int style,)

# Get is a style underlined or not.

get bool StyleGetUnderline=2488(int style,)

# Get is a style mixed case, or to force upper or lower case.

get CaseVisible StyleGetCase=2489(int style,)

# Get the character get of the font in a style.

get CharacterSet StyleGetCharacterSet=2490(int style,)

# Get is a style visible or not.

get bool StyleGetVisible=2491(int style,)

# Get is a style changeable or not (read only).

# Experimental feature, currently buggy.

get bool StyleGetChangeable=2492(int style,)

# Get is a style a hotspot or not.

get bool StyleGetHotSpot=2493(int style,)

# Set a style to be mixed case, or to force upper or lower case.

set void StyleSetCase=2060(int style, CaseVisible caseVisible)

val SC_FONT_SIZE_MULTIPLIER=100

# Set the size of characters of a style. Size is in points multiplied by 100.

set void StyleSetSizeFractional=2061(int style, int sizeHundredthPoints)

# Get the size of characters of a style in points multiplied by 100

get int StyleGetSizeFractional=2062(int style,)

enu FontWeight=SC_WEIGHT_

val SC_WEIGHT_NORMAL=400

val SC_WEIGHT_SEMIBOLD=600

val SC_WEIGHT_BOLD=700

ali SC_WEIGHT_SEMIBOLD=SEMI_BOLD

# Set the weight of characters of a style.

set void StyleSetWeight=2063(int style, FontWeight weight)

# Get the weight of characters of a style.

get FontWeight StyleGetWeight=2064(int style,)

# Set the character set of the font in a style.

set void StyleSetCharacterSet=2066(int style, CharacterSet characterSet)

# Set a style to be a hotspot or not.

set void StyleSetHotSpot=2409(int style, bool hotspot)

# Set the foreground colour of the main and additional selections and whether to use this setting.

fun void SetSelFore=2067(bool useSetting, colour fore)

# Set the background colour of the main and additional selections and whether to use this setting.

fun void SetSelBack=2068(bool useSetting, colour back)

# Get the alpha of the selection.

get Alpha GetSelAlpha=2477(,)

# Set the alpha of the selection.

set void SetSelAlpha=2478(Alpha alpha,)

# Is the selection end of line filled?

get bool GetSelEOLFilled=2479(,)

# Set the selection to have its end of line filled or not.

set void SetSelEOLFilled=2480(bool filled,)

# Set the foreground colour of the caret.

set void SetCaretFore=2069(colour fore,)

# When key+modifier combination keyDefinition is pressed perform sciCommand.

fun void AssignCmdKey=2070(keymod keyDefinition, int sciCommand)

# When key+modifier combination keyDefinition is pressed do nothing.

fun void ClearCmdKey=2071(keymod keyDefinition,)

# Drop all key mappings.

fun void ClearAllCmdKeys=2072(,)

# Set the styles for a segment of the document.

fun void SetStylingEx=2073(position length, string styles)

# Set a style to be visible or not.

set void StyleSetVisible=2074(int style, bool visible)

# Get the time in milliseconds that the caret is on and off.

get int GetCaretPeriod=2075(,)

# Get the time in milliseconds that the caret is on and off. 0 = steady on.

set void SetCaretPeriod=2076(int periodMilliseconds,)

# Set the set of characters making up words for when moving or selecting by word.

# First sets defaults like SetCharsDefault.

set void SetWordChars=2077(, string characters)

# Get the set of characters making up words for when moving or selecting by word.

# Returns the number of characters

get int GetWordChars=2646(, stringresult characters)

# Set the number of characters to have directly indexed categories

set void SetCharacterCategoryOptimization=2720(int countCharacters,)

# Get the number of characters to have directly indexed categories

get int GetCharacterCategoryOptimization=2721(,)

# Start a sequence of actions that is undone and redone as a unit.

# May be nested.

fun void BeginUndoAction=2078(,)

# End a sequence of actions that is undone and redone as a unit.

fun void EndUndoAction=2079(,)

# Indicator style enumeration and some constants

enu IndicatorStyle=INDIC_

val INDIC_PLAIN=0

val INDIC_SQUIGGLE=1

val INDIC_TT=2

val INDIC_DIAGONAL=3

val INDIC_STRIKE=4

val INDIC_HIDDEN=5

val INDIC_BOX=6

val INDIC_ROUNDBOX=7

val INDIC_STRAIGHTBOX=8

val INDIC_DASH=9

val INDIC_DOTS=10

val INDIC_SQUIGGLELOW=11

val INDIC_DOTBOX=12

val INDIC_SQUIGGLEPIXMAP=13

val INDIC_COMPOSITIONTHICK=14

val INDIC_COMPOSITIONTHIN=15

val INDIC_FULLBOX=16

val INDIC_TEXTFORE=17

val INDIC_POINT=18

val INDIC_POINTCHARACTER=19

val INDIC_GRADIENT=20

val INDIC_GRADIENTCENTRE=21

# INDIC_CONTAINER, INDIC_IME, INDIC_IME_MAX, and INDIC_MAX are indicator numbers,

# not IndicatorStyles so should not really be in the INDIC_ enumeration.

# They are redeclared in IndicatorNumbers INDICATOR_.

val INDIC_CONTAINER=8

val INDIC_IME=32

val INDIC_IME_MAX=35

val INDIC_MAX=35

enu IndicatorNumbers=INDICATOR_

val INDICATOR_CONTAINER=8

val INDICATOR_IME=32

val INDICATOR_IME_MAX=35

val INDICATOR_MAX=35

ali INDIC_TT=T_T

ali INDIC_ROUNDBOX=ROUND_BOX

ali INDIC_STRAIGHTBOX=STRAIGHT_BOX

ali INDIC_SQUIGGLELOW=SQUIGGLE_LOW

ali INDIC_DOTBOX=DOT_BOX

ali INDIC_SQUIGGLEPIXMAP=SQUIGGLE_PIXMAP

ali INDIC_COMPOSITIONTHICK=COMPOSITION_THICK

ali INDIC_COMPOSITIONTHIN=COMPOSITION_THIN

ali INDIC_FULLBOX=FULL_BOX

ali INDIC_TEXTFORE=TEXT_FORE

ali INDIC_POINTCHARACTER=POINT_CHARACTER

ali INDIC_GRADIENTCENTRE=GRADIENT_CENTRE

# Set an indicator to plain, squiggle or TT.

set void IndicSetStyle=2080(int indicator, IndicatorStyle indicatorStyle)

# Retrieve the style of an indicator.

get IndicatorStyle IndicGetStyle=2081(int indicator,)

# Set the foreground colour of an indicator.

set void IndicSetFore=2082(int indicator, colour fore)

# Retrieve the foreground colour of an indicator.

get colour IndicGetFore=2083(int indicator,)

# Set an indicator to draw under text or over(default).

set void IndicSetUnder=2510(int indicator, bool under)

# Retrieve whether indicator drawn under or over text.

get bool IndicGetUnder=2511(int indicator,)

# Set a hover indicator to plain, squiggle or TT.

set void IndicSetHoverStyle=2680(int indicator, IndicatorStyle indicatorStyle)

# Retrieve the hover style of an indicator.

get IndicatorStyle IndicGetHoverStyle=2681(int indicator,)

# Set the foreground hover colour of an indicator.

set void IndicSetHoverFore=2682(int indicator, colour fore)

# Retrieve the foreground hover colour of an indicator.

get colour IndicGetHoverFore=2683(int indicator,)

enu IndicValue=SC_INDICVALUE

val SC_INDICVALUEBIT=0x1000000

val SC_INDICVALUEMASK=0xFFFFFF

enu IndicFlag=SC_INDICFLAG_

val SC_INDICFLAG_VALUEFORE=1

ali SC_INDICFLAG_VALUEFORE=VALUE_FORE

# Set the attributes of an indicator.

set void IndicSetFlags=2684(int indicator, IndicFlag flags)

# Retrieve the attributes of an indicator.

get IndicFlag IndicGetFlags=2685(int indicator,)

# Set the foreground colour of all whitespace and whether to use this setting.

fun void SetWhitespaceFore=2084(bool useSetting, colour fore)

# Set the background colour of all whitespace and whether to use this setting.

fun void SetWhitespaceBack=2085(bool useSetting, colour back)

# Set the size of the dots used to mark space characters.

set void SetWhitespaceSize=2086(int size,)

# Get the size of the dots used to mark space characters.

get int GetWhitespaceSize=2087(,)

# Used to hold extra styling information for each line.

set void SetLineState=2092(line line, int state)

# Retrieve the extra styling information for a line.

get int GetLineState=2093(line line,)

# Retrieve the last line number that has line state.

get int GetMaxLineState=2094(,)

# Is the background of the line containing the caret in a different colour?

get bool GetCaretLineVisible=2095(,)

# Display the background of the line containing the caret in a different colour.

set void SetCaretLineVisible=2096(bool show,)

# Get the colour of the background of the line containing the caret.

get colour GetCaretLineBack=2097(,)

# Set the colour of the background of the line containing the caret.

set void SetCaretLineBack=2098(colour back,)

# Retrieve the caret line frame width.

# Width = 0 means this option is disabled.

get int GetCaretLineFrame=2704(,)

# Display the caret line framed.

# Set width != 0 to enable this option and width = 0 to disable it.

set void SetCaretLineFrame=2705(int width,)

# Set a style to be changeable or not (read only).

# Experimental feature, currently buggy.

set void StyleSetChangeable=2099(int style, bool changeable)

# Display a auto-completion list.

# The lengthEntered parameter indicates how many characters before

# the caret should be used to provide context.

fun void AutoCShow=2100(position lengthEntered, string itemList)

# Remove the auto-completion list from the screen.

fun void AutoCCancel=2101(,)

# Is there an auto-completion list visible?

fun bool AutoCActive=2102(,)

# Retrieve the position of the caret when the auto-completion list was displayed.

fun position AutoCPosStart=2103(,)

# User has selected an item so remove the list and insert the selection.

fun void AutoCComplete=2104(,)

# Define a set of character that when typed cancel the auto-completion list.

fun void AutoCStops=2105(, string characterSet)

# Change the separator character in the string setting up an auto-completion list.

# Default is space but can be changed if items contain space.

set void AutoCSetSeparator=2106(int separatorCharacter,)

# Retrieve the auto-completion list separator character.

get int AutoCGetSeparator=2107(,)

# Select the item in the auto-completion list that starts with a string.

fun void AutoCSelect=2108(, string select)

# Should the auto-completion list be cancelled if the user backspaces to a

# position before where the box was created.

set void AutoCSetCancelAtStart=2110(bool cancel,)

# Retrieve whether auto-completion cancelled by backspacing before start.

get bool AutoCGetCancelAtStart=2111(,)

# Define a set of characters that when typed will cause the autocompletion to

# choose the selected item.

set void AutoCSetFillUps=2112(, string characterSet)

# Should a single item auto-completion list automatically choose the item.

set void AutoCSetChooseSingle=2113(bool chooseSingle,)

# Retrieve whether a single item auto-completion list automatically choose the item.

get bool AutoCGetChooseSingle=2114(,)

# Set whether case is significant when performing auto-completion searches.

set void AutoCSetIgnoreCase=2115(bool ignoreCase,)

# Retrieve state of ignore case flag.

get bool AutoCGetIgnoreCase=2116(,)

# Display a list of strings and send notification when user chooses one.

fun void UserListShow=2117(int listType, string itemList)

# Set whether or not autocompletion is hidden automatically when nothing matches.

set void AutoCSetAutoHide=2118(bool autoHide,)

# Retrieve whether or not autocompletion is hidden automatically when nothing matches.

get bool AutoCGetAutoHide=2119(,)

# Set whether or not autocompletion deletes any word characters

# after the inserted text upon completion.

set void AutoCSetDropRestOfWord=2270(bool dropRestOfWord,)

# Retrieve whether or not autocompletion deletes any word characters

# after the inserted text upon completion.

get bool AutoCGetDropRestOfWord=2271(,)

# Register an XPM image for use in autocompletion lists.

fun void RegisterImage=2405(int type, string xpmData)

# Clear all the registered XPM images.

fun void ClearRegisteredImages=2408(,)

# Retrieve the auto-completion list type-separator character.

get int AutoCGetTypeSeparator=2285(,)

# Change the type-separator character in the string setting up an auto-completion list.

# Default is '?' but can be changed if items contain '?'.

set void AutoCSetTypeSeparator=2286(int separatorCharacter,)

# 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.

set void AutoCSetMaxWidth=2208(int characterCount,)

# Get the maximum width, in characters, of auto-completion and user lists.

get int AutoCGetMaxWidth=2209(,)

# Set the maximum height, in rows, of auto-completion and user lists.

# The default is 5 rows.

set void AutoCSetMaxHeight=2210(int rowCount,)

# Set the maximum height, in rows, of auto-completion and user lists.

get int AutoCGetMaxHeight=2211(,)

# Set the number of spaces used for one level of indentation.

set void SetIndent=2122(int indentSize,)

# Retrieve indentation size.

get int GetIndent=2123(,)

# Indentation will only use space characters if useTabs is false, otherwise

# it will use a combination of tabs and spaces.

set void SetUseTabs=2124(bool useTabs,)

# Retrieve whether tabs will be used in indentation.

get bool GetUseTabs=2125(,)

# Change the indentation of a line to a number of columns.

set void SetLineIndentation=2126(line line, int indentation)

# Retrieve the number of columns that a line is indented.

get int GetLineIndentation=2127(line line,)

# Retrieve the position before the first non indentation character on a line.

get position GetLineIndentPosition=2128(line line,)

# Retrieve the column number of a position, taking tab width into account.

get position GetColumn=2129(position pos,)

# Count characters between two positions.

fun position CountCharacters=2633(position start, position end)

# Count code units between two positions.

fun position CountCodeUnits=2715(position start, position end)

# Show or hide the horizontal scroll bar.

set void SetHScrollBar=2130(bool visible,)

# Is the horizontal scroll bar visible?

get bool GetHScrollBar=2131(,)

enu IndentView=SC_IV_

val SC_IV_NONE=0

val SC_IV_REAL=1

val SC_IV_LOOKFORWARD=2

val SC_IV_LOOKBOTH=3

ali SC_IV_LOOKFORWARD=LOOK_FORWARD

ali SC_IV_LOOKBOTH=LOOK_BOTH