]> git.saurik.com Git - wxWidgets.git/blame - src/stc/scintilla/include/Scintilla.iface
Windows and Unicode compilation fixes
[wxWidgets.git] / src / stc / scintilla / include / Scintilla.iface
CommitLineData
bfabd11a
RD
1## First line may be used for shbang
2
3## This file defines the interface to Scintilla
4
1a2fb4cd
RD
5## Copyright 2000-2002 by Neil Hodgson <neilh@scintilla.org>
6## The License.txt file describes the conditions under which this software may be distributed.
7
bfabd11a 8## A line starting with ## is a pure comment and should be stripped by readers.
d134f170 9## A line starting with #! is for future shbang use
d25f5fbb 10## A line starting with # followed by a space is a documentation comment and refers
bfabd11a
RD
11## to the next feature definition.
12
d134f170 13## Each feature is defined by a line starting with fun, get, set, val or evt.
bfabd11a
RD
14## cat -> start a category
15## fun -> a function
16## get -> a property get function
d134f170 17## set -> a property set function
bfabd11a 18## val -> definition of a constant
d134f170 19## evt -> an event
a834585d
RD
20## enu -> associate an enumeration with a set of vals with a prefix
21## lex -> associate a lexer with the lexical classes it produces
22##
bfabd11a
RD
23## All other feature names should be ignored. They may be defined in the future.
24## A property may have a set function, a get function or both. Each will have
25## "Get" or "Set" in their names and the corresponding name will have the obvious switch.
26## A property may be subscripted, in which case the first parameter is the subscript.
27## fun, get, and set features have a strict syntax:
28## <featureType><ws><returnType><ws><name>[=<number](<param>,<param>)
29## param is <paramType><ws><paramName>[=<value>]
30## Additional white space is allowed between elements.
d134f170 31## The syntax for evt is <featureType><ws><returnType><ws><name>[=<number]([<param>[,<param>]*])
bfabd11a
RD
32## Feature names that contain an underscore are defined by Windows, so in these
33## cases, using the Windows definition is preferred where available.
1a2fb4cd
RD
34## The feature numbers are stable so features will not be renumbered.
35## Features may be removed but they will go through a period of deprecation
36## before removal which is signalled by moving them into the Deprecated category.
a834585d
RD
37##
38## enu has the syntax enu<ws><enumeration>=<prefix>[<ws><prefix>]* where all the val
39## features in this file starting with a given <prefix> are considered part of the
40## enumeration.
41##
42## lex has the syntax lex<ws><name>=<lexerVal><ws><prefix>[<ws><prefix>]*
43## where name is a reasonably capitalised (Python, XML) identifier or UI name,
44## lexerVal is the val used to specify the lexer, and the list of prefixes is similar
45## to enu. The name may not be the same as that used within the lexer so the lexerVal
46## should be used to tie these entities together.
bfabd11a
RD
47
48## Types:
49## void
50## int
51## bool -> integer, 1=true, 0=false
52## position -> integer position in a document
53## colour -> colour integer containing red, green and blue bytes.
54## string -> pointer to const character
55## stringresult -> pointer to character
56## cells -> pointer to array of cells, each cell containing a style byte and character byte
1a2fb4cd 57## textrange -> range of a min and a max position with an output string
bfabd11a
RD
58## findtext -> searchrange, text -> foundposition
59## keymod -> integer containing key in low half and modifiers in high half
bfabd11a 60## formatrange
1a2fb4cd
RD
61## Types no longer used:
62## findtextex -> searchrange
63## charrange -> range of a min and a max position
64## charrangeresult -> like charrange, but output param
65## countedstring
bfabd11a 66## point -> x,y
d134f170
RD
67## pointresult -> like point, but output param
68## rectangle -> left,top,right,bottom
d25f5fbb 69## Client code should ignore definitions containing types it does not understand, except
bfabd11a
RD
70## for possibly #defining the constants
71
1a2fb4cd
RD
72## String arguments may contain NUL ('\0') characters where the calls provide a length
73## argument and retrieve NUL characters. All retrieved strings except for those retrieved
74## by GetLine also have a NUL appended but client code should calculate the size that
75## will be returned rather than relying upon the NUL whenever possible. Allow for the
76## extra NUL character when allocating buffers.
77
d25f5fbb 78cat Basics
bfabd11a
RD
79
80################################################
d134f170 81## For Scintilla.h
bfabd11a 82val INVALID_POSITION=-1
d134f170
RD
83# Define start of Scintilla messages to be greater than all edit (EM_*) messages
84# as many EM_ messages can be used although that use is deprecated.
bfabd11a
RD
85val SCI_START=2000
86val SCI_OPTIONAL_START=3000
87val SCI_LEXER_START=4000
88
a834585d 89# Add text to the document.
bfabd11a
RD
90fun void AddText=2001(int length, string text)
91
a834585d 92# Add array of cells to document.
bfabd11a
RD
93fun void AddStyledText=2002(int length, cells c)
94
a834585d 95# Insert string at a position.
bfabd11a
RD
96fun void InsertText=2003(position pos, string text)
97
a834585d 98# Delete all text in the document.
bfabd11a
RD
99fun void ClearAll=2004(,)
100
a834585d 101# Set all style bytes to 0, remove all folding information.
d134f170
RD
102fun void ClearDocumentStyle=2005(,)
103
a834585d 104# The number of characters in the document.
bfabd11a
RD
105get int GetLength=2006(,)
106
a834585d 107# Returns the character byte at the position.
bfabd11a
RD
108get int GetCharAt=2007(position pos,)
109
a834585d 110# Returns the position of the caret.
bfabd11a
RD
111get position GetCurrentPos=2008(,)
112
a834585d 113# Returns the position of the opposite end of the selection to the caret.
bfabd11a
RD
114get position GetAnchor=2009(,)
115
a834585d 116# Returns the style byte at the position.
bfabd11a
RD
117get int GetStyleAt=2010(position pos,)
118
a834585d 119# Redoes the next action on the undo history.
bfabd11a
RD
120fun void Redo=2011(,)
121
d25f5fbb 122# Choose between collecting actions into the undo
bfabd11a 123# history and discarding them.
d134f170 124set void SetUndoCollection=2012(bool collectUndo,)
bfabd11a
RD
125
126# Select all the text in the document.
127fun void SelectAll=2013(,)
128
d25f5fbb 129# Remember the current position in the undo history as the position
bfabd11a
RD
130# at which the document was saved.
131fun void SetSavePoint=2014(,)
132
133# Retrieve a buffer of cells.
134# Returns the number of bytes in the buffer not including terminating nulls.
135fun int GetStyledText=2015(, textrange tr)
136
a834585d 137# Are there any redoable actions in the undo history?
bfabd11a
RD
138fun bool CanRedo=2016(,)
139
a834585d 140# Retrieve the line number at which a particular marker is located.
bfabd11a
RD
141fun int MarkerLineFromHandle=2017(int handle,)
142
143# Delete a marker.
144fun void MarkerDeleteHandle=2018(int handle,)
145
d134f170
RD
146# Is undo history being collected?
147get bool GetUndoCollection=2019(,)
148
a834585d 149enu WhiteSpace=SCWS_
d134f170
RD
150val SCWS_INVISIBLE=0
151val SCWS_VISIBLEALWAYS=1
152val SCWS_VISIBLEAFTERINDENT=2
153
bfabd11a 154# Are white space characters currently visible?
d134f170
RD
155# Returns one of SCWS_* constants.
156get int GetViewWS=2020(,)
bfabd11a 157
d134f170
RD
158# Make white space characters invisible, always visible or visible outside indentation.
159set void SetViewWS=2021(int viewWS,)
160
161# Find the position from a point within the window.
162fun int PositionFromPoint=2022(int x, int y)
bfabd11a 163
65ec6247
RD
164# Find the position from a point within the window but return
165# INVALID_POSITION if not close to text.
166fun int PositionFromPointClose=2023(int x, int y)
167
bfabd11a
RD
168# Set caret to start of a line and ensure it is visible.
169fun void GotoLine=2024(int line,)
170
171# Set caret to a position and ensure it is visible.
172fun void GotoPos=2025(position pos,)
173
174# Set the selection anchor to a position. The anchor is the opposite
175# end of the selection from the caret.
176set void SetAnchor=2026(position posAnchor,)
177
178# Retrieve the text of the line containing the caret.
179# Returns the index of the caret on the line.
180fun int GetCurLine=2027(int length, stringresult text)
181
182# Retrieve the position of the last correctly styled character.
183get position GetEndStyled=2028(,)
184
a834585d 185enu EndOfLine=SC_EOL_
bfabd11a
RD
186val SC_EOL_CRLF=0
187val SC_EOL_CR=1
188val SC_EOL_LF=2
189
65ec6247
RD
190# Convert all line endings in the document to one mode.
191fun void ConvertEOLs=2029(int eolMode,)
192
bfabd11a
RD
193# Retrieve the current end of line mode - one of CRLF, CR, or LF.
194get int GetEOLMode=2030(,)
195
196# Set the current end of line mode.
197set void SetEOLMode=2031(int eolMode,)
198
199# Set the current styling position to pos and the styling mask to mask.
a834585d 200# The styling mask can be used to protect some bits in each styling byte from modification.
bfabd11a
RD
201fun void StartStyling=2032(position pos, int mask)
202
203# Change style from current styling position for length characters to a style
204# and move the current styling position to after this newly styled segment.
205fun void SetStyling=2033(int length, int style)
206
a834585d 207# Is drawing done first into a buffer or direct to the screen?
d134f170
RD
208get bool GetBufferedDraw=2034(,)
209
bfabd11a
RD
210# If drawing is buffered then each line of text is drawn into a bitmap buffer
211# before drawing it to the screen to avoid flicker.
212set void SetBufferedDraw=2035(bool buffered,)
213
a834585d 214# Change the visible size of a tab to be a multiple of the width of a space character.
bfabd11a
RD
215set void SetTabWidth=2036(int tabWidth,)
216
d25f5fbb 217# Retrieve the visible size of a tab.
bfabd11a
RD
218get int GetTabWidth=2121(,)
219
d134f170
RD
220# The SC_CP_UTF8 value can be used to enter Unicode mode.
221# This is the same value as CP_UTF8 in Windows
bfabd11a
RD
222val SC_CP_UTF8=65001
223
224# Set the code page used to interpret the bytes of the document as characters.
225# The SC_CP_UTF8 value can be used to enter Unicode mode.
226set void SetCodePage=2037(int codePage,)
227
a834585d 228# In palette mode, Scintilla uses the environment's palette calls to display
bfabd11a
RD
229# more colours. This may lead to ugly displays.
230set void SetUsePalette=2039(bool usePalette,)
231
a834585d 232enu MarkerSymbol=SC_MARK_
bfabd11a
RD
233val MARKER_MAX=31
234val SC_MARK_CIRCLE=0
235val SC_MARK_ROUNDRECT=1
236val SC_MARK_ARROW=2
237val SC_MARK_SMALLRECT=3
238val SC_MARK_SHORTARROW=4
239val SC_MARK_EMPTY=5
240val SC_MARK_ARROWDOWN=6
241val SC_MARK_MINUS=7
242val SC_MARK_PLUS=8
243
a834585d 244# Shapes used for outlining column.
65ec6247
RD
245val SC_MARK_VLINE=9
246val SC_MARK_LCORNER=10
247val SC_MARK_TCORNER=11
248val SC_MARK_BOXPLUS=12
249val SC_MARK_BOXPLUSCONNECTED=13
250val SC_MARK_BOXMINUS=14
251val SC_MARK_BOXMINUSCONNECTED=15
252val SC_MARK_LCORNERCURVE=16
253val SC_MARK_TCORNERCURVE=17
254val SC_MARK_CIRCLEPLUS=18
255val SC_MARK_CIRCLEPLUSCONNECTED=19
256val SC_MARK_CIRCLEMINUS=20
257val SC_MARK_CIRCLEMINUSCONNECTED=21
258
a834585d 259# Invisible mark that only sets the line background color.
1a2fb4cd
RD
260val SC_MARK_BACKGROUND=22
261
b8b0e402
RD
262val SC_MARK_CHARACTER=10000
263
a834585d
RD
264enu MarkerOutline=SC_MARKNUM_
265# Markers used for outlining column.
65ec6247
RD
266val SC_MARKNUM_FOLDEREND=25
267val SC_MARKNUM_FOLDEROPENMID=26
268val SC_MARKNUM_FOLDERMIDTAIL=27
269val SC_MARKNUM_FOLDERTAIL=28
270val SC_MARKNUM_FOLDERSUB=29
bfabd11a
RD
271val SC_MARKNUM_FOLDER=30
272val SC_MARKNUM_FOLDEROPEN=31
bfabd11a 273
1a2fb4cd
RD
274val SC_MASK_FOLDERS=0xFE000000
275
bfabd11a
RD
276# Set the symbol used for a particular marker number.
277fun void MarkerDefine=2040(int markerNumber, int markerSymbol)
278
279# Set the foreground colour used for a particular marker number.
280fun void MarkerSetFore=2041(int markerNumber, colour fore)
281
282# Set the background colour used for a particular marker number.
283fun void MarkerSetBack=2042(int markerNumber, colour back)
284
1a2fb4cd
RD
285# Add a marker to a line, returning an ID which can be used to find or delete the marker.
286fun int MarkerAdd=2043(int line, int markerNumber)
bfabd11a 287
a834585d 288# Delete a marker from a line.
bfabd11a
RD
289fun void MarkerDelete=2044(int line, int markerNumber)
290
a834585d 291# Delete all markers with a particular number from all lines.
bfabd11a
RD
292fun void MarkerDeleteAll=2045(int markerNumber,)
293
294# Get a bit mask of all the markers set on a line.
295fun int MarkerGet=2046(int line,)
296
297# Find the next line after lineStart that includes a marker in mask.
298fun int MarkerNext=2047(int lineStart, int markerMask)
299
300# Find the previous line before lineStart that includes a marker in mask.
301fun int MarkerPrevious=2048(int lineStart, int markerMask)
302
a834585d 303enu MarginType=SC_MARGIN_
bfabd11a
RD
304val SC_MARGIN_SYMBOL=0
305val SC_MARGIN_NUMBER=1
306
307# Set a margin to be either numeric or symbolic.
308set void SetMarginTypeN=2240(int margin, int marginType)
309
310# Retrieve the type of a margin.
311get int GetMarginTypeN=2241(int margin,)
312
313# Set the width of a margin to a width expressed in pixels.
314set void SetMarginWidthN=2242(int margin, int pixelWidth)
315
316# Retrieve the width of a margin in pixels.
317get int GetMarginWidthN=2243(int margin,)
318
319# Set a mask that determines which markers are displayed in a margin.
320set void SetMarginMaskN=2244(int margin, int mask)
321
322# Retrieve the marker mask of a margin.
323get int GetMarginMaskN=2245(int margin,)
324
325# Make a margin sensitive or insensitive to mouse clicks.
326set void SetMarginSensitiveN=2246(int margin, bool sensitive)
327
328# Retrieve the mouse click sensitivity of a margin.
329get bool GetMarginSensitiveN=2247(int margin,)
330
b8b0e402
RD
331# Styles in range 32..37 are predefined for parts of the UI and are not used as normal styles.
332# Styles 38 and 39 are for future use.
a834585d 333enu StylesCommon=STYLE_
bfabd11a
RD
334val STYLE_DEFAULT=32
335val STYLE_LINENUMBER=33
336val STYLE_BRACELIGHT=34
337val STYLE_BRACEBAD=35
338val STYLE_CONTROLCHAR=36
d134f170 339val STYLE_INDENTGUIDE=37
b8b0e402 340val STYLE_LASTPREDEFINED=39
bfabd11a
RD
341val STYLE_MAX=127
342
d134f170
RD
343# Character set identifiers are used in StyleSetCharacterSet.
344# The values are the same as the Windows *_CHARSET values.
a834585d 345enu CharacterSet=SC_CHARSET_
d134f170
RD
346val SC_CHARSET_ANSI=0
347val SC_CHARSET_DEFAULT=1
348val SC_CHARSET_BALTIC=186
349val SC_CHARSET_CHINESEBIG5=136
350val SC_CHARSET_EASTEUROPE=238
351val SC_CHARSET_GB2312=134
352val SC_CHARSET_GREEK=161
353val SC_CHARSET_HANGUL=129
354val SC_CHARSET_MAC=77
355val SC_CHARSET_OEM=255
356val SC_CHARSET_RUSSIAN=204
357val SC_CHARSET_SHIFTJIS=128
358val SC_CHARSET_SYMBOL=2
359val SC_CHARSET_TURKISH=162
360val SC_CHARSET_JOHAB=130
361val SC_CHARSET_HEBREW=177
362val SC_CHARSET_ARABIC=178
363val SC_CHARSET_VIETNAMESE=163
364val SC_CHARSET_THAI=222
365
bfabd11a
RD
366# Clear all the styles and make equivalent to the global default style.
367set void StyleClearAll=2050(,)
368
369# Set the foreground colour of a style.
370set void StyleSetFore=2051(int style, colour fore)
371
372# Set the background colour of a style.
373set void StyleSetBack=2052(int style, colour back)
374
375# Set a style to be bold or not.
376set void StyleSetBold=2053(int style, bool bold)
377
378# Set a style to be italic or not.
379set void StyleSetItalic=2054(int style, bool italic)
380
381# Set the size of characters of a style.
382set void StyleSetSize=2055(int style, int sizePoints)
383
384# Set the font of a style.
385set void StyleSetFont=2056(int style, string fontName)
386
387# Set a style to have its end of line filled or not.
388set void StyleSetEOLFilled=2057(int style, bool filled)
389
390# Reset the default style to its state at startup
391fun void StyleResetDefault=2058(,)
392
393# Set a style to be underlined or not.
394set void StyleSetUnderline=2059(int style, bool underline)
395
a834585d 396enu CaseVisible=SC_CASE_
65ec6247
RD
397val SC_CASE_MIXED=0
398val SC_CASE_UPPER=1
399val SC_CASE_LOWER=2
400# Set a style to be mixed case, or to force upper or lower case.
401set void StyleSetCase=2060(int style, int caseForce)
402
bfabd11a
RD
403# Set the character set of the font in a style.
404set void StyleSetCharacterSet=2066(int style, int characterSet)
405
406# Set the foreground colour of the selection and whether to use this setting.
407fun void SetSelFore=2067(bool useSetting, colour fore)
408
409# Set the background colour of the selection and whether to use this setting.
410fun void SetSelBack=2068(bool useSetting, colour back)
411
412# Set the foreground colour of the caret.
d134f170 413set void SetCaretFore=2069(colour fore,)
bfabd11a
RD
414
415# When key+modifier combination km is pressed perform msg.
416fun void AssignCmdKey=2070(keymod km, int msg)
417
418# When key+modifier combination km do nothing.
419fun void ClearCmdKey=2071(keymod km,)
420
421# Drop all key mappings.
422fun void ClearAllCmdKeys=2072(,)
423
424# Set the styles for a segment of the document.
425fun void SetStylingEx=2073(int length, string styles)
426
d134f170
RD
427# Set a style to be visible or not.
428set void StyleSetVisible=2074(int style, bool visible)
429
d25f5fbb 430# Get the time in milliseconds that the caret is on and off.
bfabd11a
RD
431get int GetCaretPeriod=2075(,)
432
433# Get the time in milliseconds that the caret is on and off. 0 = steady on.
434set void SetCaretPeriod=2076(int periodMilliseconds,)
435
a834585d 436# Set the set of characters making up words for when moving or selecting by word.
bfabd11a
RD
437set void SetWordChars=2077(, string characters)
438
439# Start a sequence of actions that is undone and redone as a unit.
440# May be nested.
441fun void BeginUndoAction=2078(,)
442
443# End a sequence of actions that is undone and redone as a unit.
444fun void EndUndoAction=2079(,)
445
a834585d 446enu IndicatorStyle=INDIC_
bfabd11a
RD
447val INDIC_MAX=7
448val INDIC_PLAIN=0
449val INDIC_SQUIGGLE=1
450val INDIC_TT=2
451val INDIC_DIAGONAL=3
452val INDIC_STRIKE=4
1a2fb4cd
RD
453val INDIC0_MASK=0x20
454val INDIC1_MASK=0x40
455val INDIC2_MASK=0x80
456val INDICS_MASK=0xE0
bfabd11a
RD
457
458# Set an indicator to plain, squiggle or TT.
459set void IndicSetStyle=2080(int indic, int style)
460
461# Retrieve the style of an indicator.
462get int IndicGetStyle=2081(int indic,)
463
464# Set the foreground colour of an indicator.
465set void IndicSetFore=2082(int indic, colour fore)
466
467# Retrieve the foreground colour of an indicator.
468get colour IndicGetFore=2083(int indic,)
469
a834585d
RD
470# Divide each styling byte into lexical class bits (default: 5) and indicator
471# bits (default: 3). If a lexer requires more than 32 lexical states, then this
bfabd11a
RD
472# is used to expand the possible states.
473set void SetStyleBits=2090(int bits,)
474
475# Retrieve number of bits in style bytes used to hold the lexical state.
476get int GetStyleBits=2091(,)
477
478# Used to hold extra styling information for each line.
479set void SetLineState=2092(int line, int state)
480
481# Retrieve the extra styling information for a line.
482get int GetLineState=2093(int line,)
483
d25f5fbb 484# Retrieve the last line number that has line state.
bfabd11a
RD
485get int GetMaxLineState=2094(,)
486
65ec6247
RD
487# Is the background of the line containing the caret in a different colour?
488get bool GetCaretLineVisible=2095(,)
489
a834585d 490# Display the background of the line containing the caret in a different colour.
65ec6247
RD
491set void SetCaretLineVisible=2096(bool show,)
492
493# Get the colour of the background of the line containing the caret.
494get colour GetCaretLineBack=2097(,)
495
496# Set the colour of the background of the line containing the caret.
497set void SetCaretLineBack=2098(colour back,)
498
1a2fb4cd
RD
499# Set a style to be changeable or not (read only).
500# Experimental feature, currently buggy.
501set void StyleSetChangeable=2099(int style, bool changeable)
502
bfabd11a
RD
503# Display a auto-completion list.
504# The lenEntered parameter indicates how many characters before
505# the caret should be used to provide context.
506fun void AutoCShow=2100(int lenEntered, string itemList)
507
508# Remove the auto-completion list from the screen.
509fun void AutoCCancel=2101(,)
510
511# Is there an auto-completion list visible?
512fun bool AutoCActive=2102(,)
513
a834585d 514# Retrieve the position of the caret when the auto-completion list was displayed.
bfabd11a
RD
515fun position AutoCPosStart=2103(,)
516
517# User has selected an item so remove the list and insert the selection.
518fun void AutoCComplete=2104(,)
519
520# Define a set of character that when typed cancel the auto-completion list.
521fun void AutoCStops=2105(, string characterSet)
522
a834585d
RD
523# Change the separator character in the string setting up an auto-completion list.
524# Default is space but can be changed if items contain space.
bfabd11a
RD
525set void AutoCSetSeparator=2106(int separatorCharacter,)
526
527# Retrieve the auto-completion list separator character.
528get int AutoCGetSeparator=2107(,)
529
530# Select the item in the auto-completion list that starts with a string.
531fun void AutoCSelect=2108(, string text)
532
d25f5fbb
RD
533# Should the auto-completion list be cancelled if the user backspaces to a
534# position before where the box was created.
d134f170
RD
535set void AutoCSetCancelAtStart=2110(bool cancel,)
536
537# Retrieve whether auto-completion cancelled by backspacing before start.
538get bool AutoCGetCancelAtStart=2111(,)
539
1a2fb4cd
RD
540# Define a set of characters that when typed will cause the autocompletion to
541# choose the selected item.
d134f170
RD
542set void AutoCSetFillUps=2112(, string characterSet)
543
d25f5fbb 544# Should a single item auto-completion list automatically choose the item.
d134f170
RD
545set void AutoCSetChooseSingle=2113(bool chooseSingle,)
546
d25f5fbb 547# Retrieve whether a single item auto-completion list automatically choose the item.
d134f170
RD
548get bool AutoCGetChooseSingle=2114(,)
549
550# Set whether case is significant when performing auto-completion searches.
551set void AutoCSetIgnoreCase=2115(bool ignoreCase,)
552
d25f5fbb 553# Retrieve state of ignore case flag.
d134f170
RD
554get bool AutoCGetIgnoreCase=2116(,)
555
65ec6247
RD
556# Display a list of strings and send notification when user chooses one.
557fun void UserListShow=2117(int listType, string itemList)
558
a834585d 559# Set whether or not autocompletion is hidden automatically when nothing matches.
65ec6247
RD
560set void AutoCSetAutoHide=2118(bool autoHide,)
561
a834585d 562# Retrieve whether or not autocompletion is hidden automatically when nothing matches.
65ec6247
RD
563get bool AutoCGetAutoHide=2119(,)
564
a834585d
RD
565# Set whether or not autocompletion deletes any word characters
566# after the inserted text upon completion.
1a2fb4cd
RD
567set void AutoCSetDropRestOfWord=2270(bool dropRestOfWord,)
568
a834585d
RD
569# Retrieve whether or not autocompletion deletes any word characters
570# after the inserted text upon completion.
1a2fb4cd
RD
571get bool AutoCGetDropRestOfWord=2271(,)
572
bfabd11a
RD
573# Set the number of spaces used for one level of indentation.
574set void SetIndent=2122(int indentSize,)
575
576# Retrieve indentation size.
577get int GetIndent=2123(,)
578
579# Indentation will only use space characters if useTabs is false, otherwise
580# it will use a combination of tabs and spaces.
581set void SetUseTabs=2124(bool useTabs,)
582
583# Retrieve whether tabs will be used in indentation.
584get bool GetUseTabs=2125(,)
585
586# Change the indentation of a line to a number of columns.
587set void SetLineIndentation=2126(int line, int indentSize)
588
589# Retrieve the number of columns that a line is indented.
590get int GetLineIndentation=2127(int line,)
591
592# Retrieve the position before the first non indentation character on a line.
593get position GetLineIndentPosition=2128(int line,)
594
d134f170
RD
595# Retrieve the column number of a position, taking tab width into account.
596get int GetColumn=2129(position pos,)
597
598# Show or hide the horizontal scroll bar.
bfabd11a
RD
599set void SetHScrollBar=2130(bool show,)
600
d134f170 601# Is the horizontal scroll bar visible?
bfabd11a
RD
602get bool GetHScrollBar=2131(,)
603
d134f170
RD
604# Show or hide indentation guides.
605set void SetIndentationGuides=2132(bool show,)
606
607# Are the indentation guides visible?
608get bool GetIndentationGuides=2133(,)
609
610# Set the highlighted indentation guide column.
611# 0 = no highlighted guide.
612set void SetHighlightGuide=2134(int column,)
613
614# Get the highlighted indentation guide column.
615get int GetHighlightGuide=2135(,)
616
617# Get the position after the last visible characters on a line.
618get int GetLineEndPosition=2136(int line,)
619
620# Get the code page used to interpret the bytes of the document as characters.
621get int GetCodePage=2137(,)
622
623# Get the foreground colour of the caret.
624get colour GetCaretFore=2138(,)
625
626# In palette mode?
627get bool GetUsePalette=2139(,)
628
629# In read-only mode?
630get bool GetReadOnly=2140(,)
631
632# Sets the position of the caret.
633set void SetCurrentPos=2141(position pos,)
634
635# Sets the position that starts the selection - this becomes the anchor.
636set void SetSelectionStart=2142(position pos,)
637
638# Returns the position at the start of the selection.
639get position GetSelectionStart=2143(,)
640
641# Sets the position that ends the selection - this becomes the currentPosition.
642set void SetSelectionEnd=2144(position pos,)
643
644# Returns the position at the end of the selection.
645get position GetSelectionEnd=2145(,)
646
647# Sets the print magnification added to the point size of each style for printing.
648set void SetPrintMagnification=2146(int magnification,)
649
650# Returns the print magnification.
651get int GetPrintMagnification=2147(,)
652
a834585d 653enu PrintOption=SC_PRINT_
d134f170
RD
654# PrintColourMode - use same colours as screen.
655val SC_PRINT_NORMAL=0
656# PrintColourMode - invert the light value of each style for printing.
657val SC_PRINT_INVERTLIGHT=1
658# PrintColourMode - force black text on white background for printing.
659val SC_PRINT_BLACKONWHITE=2
65ec6247
RD
660# PrintColourMode - text stays coloured, but all background is forced to be white for printing.
661val SC_PRINT_COLOURONWHITE=3
662# PrintColourMode - only the default-background is forced to be white for printing.
663val SC_PRINT_COLOURONWHITEDEFAULTBG=4
d134f170
RD
664
665# Modify colours when printing for clearer printed text.
666set void SetPrintColourMode=2148(int mode,)
667
668# Returns the print colour mode.
669get int GetPrintColourMode=2149(,)
670
a834585d 671enu FindOption=SCFIND_
d134f170
RD
672val SCFIND_WHOLEWORD=2
673val SCFIND_MATCHCASE=4
674val SCFIND_WORDSTART=0x00100000
d134f170
RD
675val SCFIND_REGEXP=0x00200000
676
677# Find some text in the document.
678fun position FindText=2150(int flags, findtext ft)
679
a834585d 680# On Windows, will draw the document into a display context such as a printer.
d134f170
RD
681fun void FormatRange=2151(bool draw, formatrange fr)
682
683# Retrieve the line at the top of the display.
684get int GetFirstVisibleLine=2152(,)
685
686# Retrieve the contents of a line.
687# Returns the length of the line.
688fun int GetLine=2153(int line, stringresult text)
689
690# Returns the number of lines in the document. There is always at least one.
691get int GetLineCount=2154(,)
692
693# Sets the size in pixels of the left margin.
65ec6247 694set void SetMarginLeft=2155(, int pixelWidth)
d134f170
RD
695
696# Returns the size in pixels of the left margin.
697get int GetMarginLeft=2156(,)
698
699# Sets the size in pixels of the right margin.
65ec6247 700set void SetMarginRight=2157(, int pixelWidth)
d134f170
RD
701
702# Returns the size in pixels of the right margin.
703get int GetMarginRight=2158(,)
704
705# Is the document different from when it was last saved?
706get bool GetModify=2159(,)
707
708# Select a range of text.
709fun void SetSel=2160(position start, position end)
710
711# Retrieve the selected text.
712# Return the length of the text.
713fun int GetSelText=2161(,stringresult text)
714
715# Retrieve a range of text.
716# Return the length of the text.
717fun int GetTextRange=2162(, textrange tr)
718
719# Draw the selection in normal style or with selection highlighted.
720fun void HideSelection=2163(bool normal,)
721
722# Retrieve the x value of the point in the window where a position is displayed.
723fun int PointXFromPosition=2164(, position pos)
724
725# Retrieve the y value of the point in the window where a position is displayed.
726fun int PointYFromPosition=2165(, position pos)
727
728# Retrieve the line containing a position.
729fun int LineFromPosition=2166(position pos,)
730
731# Retrieve the position at the start of a line.
732fun int PositionFromLine=2167(int line,)
733
734# Scroll horizontally and vertically.
735fun void LineScroll=2168(int columns, int lines)
736
737# Ensure the caret is visible.
738fun void ScrollCaret=2169(,)
739
740# Replace the selected text with the argument text.
741fun void ReplaceSel=2170(, string text)
742
743# Set to read only or read write.
744set void SetReadOnly=2171(bool readOnly,)
745
746# Null operation.
747fun void Null=2172(,)
748
749# Will a paste succeed?
750fun bool CanPaste=2173(,)
751
a834585d 752# Are there any undoable actions in the undo history?
d134f170
RD
753fun bool CanUndo=2174(,)
754
755# Delete the undo history.
756fun void EmptyUndoBuffer=2175(,)
757
758# Undo one action in the undo history.
759fun void Undo=2176(,)
760
761# Cut the selection to the clipboard.
762fun void Cut=2177(,)
763
764# Copy the selection to the clipboard.
765fun void Copy=2178(,)
766
767# Paste the contents of the clipboard into the document replacing the selection.
768fun void Paste=2179(,)
769
770# Clear the selection.
771fun void Clear=2180(,)
772
773# Replace the contents of the document with the argument text.
774fun void SetText=2181(, string text)
775
776# Retrieve all the text in the document.
777# Returns number of characters retrieved.
778fun int GetText=2182(int length, stringresult text)
779
780# Retrieve the number of characters in the document.
781get int GetTextLength=2183(,)
782
783# Retrieve a pointer to a function that processes messages for this Scintilla.
784get int GetDirectFunction=2184(,)
785
786# Retrieve a pointer value to use as the first argument when calling
787# the function returned by GetDirectFunction.
788get int GetDirectPointer=2185(,)
789
a834585d 790# Set to overtype (true) or insert mode.
d134f170
RD
791set void SetOvertype=2186(bool overtype,)
792
793# Returns true if overtype mode is active otherwise false is returned.
794get bool GetOvertype=2187(,)
795
a834585d 796# Set the width of the insert mode caret.
65ec6247
RD
797set void SetCaretWidth=2188(int pixelWidth,)
798
a834585d 799# Returns the width of the insert mode caret.
65ec6247
RD
800get int GetCaretWidth=2189(,)
801
802# Sets the position that starts the target which is used for updating the
803# document without affecting the scroll position.
804set void SetTargetStart=2190(position pos,)
805
806# Get the position that starts the target.
807get position GetTargetStart=2191(,)
808
809# Sets the position that ends the target which is used for updating the
810# document without affecting the scroll position.
811set void SetTargetEnd=2192(position pos,)
812
813# Get the position that ends the target.
814get position GetTargetEnd=2193(,)
815
816# Replace the target text with the argument text.
b8b0e402 817# Text is counted so it can contain nulls.
65ec6247
RD
818# Returns the length of the replacement text.
819fun int ReplaceTarget=2194(int length, string text)
820
821# Replace the target text with the argument text after \d processing.
b8b0e402 822# Text is counted so it can contain nulls.
65ec6247
RD
823# Looks for \d where d is between 1 and 9 and replaces these with the strings
824# matched in the last search operation which were surrounded by \( and \).
825# Returns the length of the replacement text including any change
826# caused by processing the \d patterns.
827fun int ReplaceTargetRE=2195(int length, string text)
828
829# Search for a counted string in the target and set the target to the found
b8b0e402 830# range. Text is counted so it can contain nulls.
65ec6247
RD
831# Returns length of range or -1 for failure in which case target is not moved.
832fun int SearchInTarget=2197(int length, string text)
833
a834585d 834# Set the search flags used by SearchInTarget.
65ec6247
RD
835set void SetSearchFlags=2198(int flags,)
836
a834585d 837# Get the search flags used by SearchInTarget.
65ec6247
RD
838get int GetSearchFlags=2199(,)
839
bfabd11a
RD
840# Show a call tip containing a definition near position pos.
841fun void CallTipShow=2200(position pos, string definition)
842
843# Remove the call tip from the screen.
844fun void CallTipCancel=2201(,)
845
846# Is there an active call tip?
847fun bool CallTipActive=2202(,)
848
849# Retrieve the position where the caret was before displaying the call tip.
850fun position CallTipPosStart=2203(,)
851
852# Highlight a segment of the definition.
853fun void CallTipSetHlt=2204(int start, int end)
854
855# Set the background colour for the call tip.
856set void CallTipSetBack=2205(colour back,)
857
858# Find the display line of a document line taking hidden lines into account.
859fun int VisibleFromDocLine=2220(int line,)
860
861# Find the document line of a display line taking hidden lines into account.
862fun int DocLineFromVisible=2221(int lineDisplay,)
863
a834585d 864enu FoldLevel=SC_FOLDLEVEL
bfabd11a
RD
865val SC_FOLDLEVELBASE=0x400
866val SC_FOLDLEVELWHITEFLAG=0x1000
867val SC_FOLDLEVELHEADERFLAG=0x2000
868val SC_FOLDLEVELNUMBERMASK=0x0FFF
869
870# Set the fold level of a line.
871# This encodes an integer level along with flags indicating whether the
872# line is a header and whether it is effectively white space.
873set void SetFoldLevel=2222(int line, int level)
874
875# Retrieve the fold level of a line.
876get int GetFoldLevel=2223(int line,)
877
878# Find the last child line of a header line.
d134f170 879get int GetLastChild=2224(int line, int level)
bfabd11a
RD
880
881# Find the parent line of a child line.
882get int GetFoldParent=2225(int line,)
883
884# Make a range of lines visible.
885fun void ShowLines=2226(int lineStart, int lineEnd)
886
887# Make a range of lines invisible.
888fun void HideLines=2227(int lineStart, int lineEnd)
889
890# Is a line visible?
891get bool GetLineVisible=2228(int line,)
892
893# Show the children of a header line.
894set void SetFoldExpanded=2229(int line, bool expanded)
895
896# Is a header line expanded?
897get bool GetFoldExpanded=2230(int line,)
898
899# Switch a header line between expanded and contracted.
900fun void ToggleFold=2231(int line,)
901
902# Ensure a particular line is visible by expanding any header line hiding it.
903fun void EnsureVisible=2232(int line,)
904
a834585d 905# Set some debugging options for folding.
bfabd11a
RD
906fun void SetFoldFlags=2233(int flags,)
907
65ec6247
RD
908# Ensure a particular line is visible by expanding any header line hiding it.
909# Use the currently set visibility policy to determine which range to display.
910fun void EnsureVisibleEnforcePolicy=2234(int line,)
911
a834585d 912# Sets whether a tab pressed when caret is within indentation indents.
65ec6247
RD
913set void SetTabIndents=2260(bool tabIndents,)
914
915# Does a tab pressed when caret is within indentation indent?
916get bool GetTabIndents=2261(,)
917
a834585d 918# Sets whether a backspace pressed when caret is within indentation unindents.
65ec6247
RD
919set void SetBackSpaceUnIndents=2262(bool bsUnIndents,)
920
921# Does a backspace pressed when caret is within indentation unindent?
922get bool GetBackSpaceUnIndents=2263(,)
923
924val SC_TIME_FOREVER=10000000
925
a834585d 926# Sets the time the mouse must sit still to generate a mouse dwell event.
65ec6247
RD
927set void SetMouseDwellTime=2264(int periodMilliseconds,)
928
a834585d 929# Retrieve the time the mouse must sit still to generate a mouse dwell event.
65ec6247
RD
930get int GetMouseDwellTime=2265(,)
931
a834585d 932# Get position of start of word.
1a2fb4cd
RD
933fun int WordStartPosition=2266(position pos, bool onlyWordCharacters)
934
a834585d 935# Get position of end of word.
1a2fb4cd
RD
936fun int WordEndPosition=2267(position pos, bool onlyWordCharacters)
937
a834585d 938enu Wrap=SC_WRAP_
1a2fb4cd
RD
939val SC_WRAP_NONE=0
940val SC_WRAP_WORD=1
941
a834585d 942# Sets whether text is word wrapped.
1a2fb4cd
RD
943set void SetWrapMode=2268(int mode,)
944
a834585d 945# Retrieve whether text is word wrapped.
1a2fb4cd
RD
946get int GetWrapMode=2269(,)
947
a834585d 948enu LineCache=SC_CACHE_
1a2fb4cd
RD
949val SC_CACHE_NONE=0
950val SC_CACHE_CARET=1
951val SC_CACHE_PAGE=2
952val SC_CACHE_DOCUMENT=3
953
a834585d 954# Sets the degree of caching of layout information.
1a2fb4cd
RD
955set void SetLayoutCache=2272(int mode,)
956
a834585d 957# Retrieve the degree of caching of layout information.
1a2fb4cd
RD
958get int GetLayoutCache=2273(,)
959
a834585d
RD
960# Sets the document width assumed for scrolling.
961set void SetScrollWidth=2274(int pixelWidth,)
962
963# Retrieve the document width assumed for scrolling.
964get int GetScrollWidth=2275(,)
965
966# Measure the pixel width of some text in a particular style.
967# Nul terminated text argument.
968# Does not handle tab or control characters.
969fun int TextWidth=2276(int style, string text)
970
971# Sets the scroll range so that maximum scroll position has
972# the last line at the bottom of the view (default).
973# Setting this to false allows scrolling one page below the last line.
974set void SetEndAtLastLine=2277(bool endAtLastLine,)
975
976# Retrieve whether the maximum scroll position has the last
977# line at the bottom of the view.
978get int GetEndAtLastLine=2278(,)
979
980# Retrieve the height of a particular line of text in pixels.
981fun int TextHeight=2279(int line,)
982
d134f170 983## Start of key messages
bfabd11a
RD
984# Move caret down one line.
985fun void LineDown=2300(,)
986
987# Move caret down one line extending selection to new caret position.
988fun void LineDownExtend=2301(,)
989
990# Move caret up one line.
991fun void LineUp=2302(,)
992
993# Move caret up one line extending selection to new caret position.
994fun void LineUpExtend=2303(,)
995
996# Move caret left one character.
997fun void CharLeft=2304(,)
998
999# Move caret left one character extending selection to new caret position.
1000fun void CharLeftExtend=2305(,)
1001
1002# Move caret right one character.
1003fun void CharRight=2306(,)
1004
1005# Move caret right one character extending selection to new caret position.
1006fun void CharRightExtend=2307(,)
1007
1008# Move caret left one word.
1009fun void WordLeft=2308(,)
1010
1011# Move caret left one word extending selection to new caret position.
1012fun void WordLeftExtend=2309(,)
1013
1014# Move caret right one word.
1015fun void WordRight=2310(,)
1016
1017# Move caret right one word extending selection to new caret position.
1018fun void WordRightExtend=2311(,)
1019
1020# Move caret to first position on line.
1021fun void Home=2312(,)
1022
1023# Move caret to first position on line extending selection to new caret position.
1024fun void HomeExtend=2313(,)
1025
1026# Move caret to last position on line.
1027fun void LineEnd=2314(,)
1028
1029# Move caret to last position on line extending selection to new caret position.
1030fun void LineEndExtend=2315(,)
1031
1032# Move caret to first position in document.
1033fun void DocumentStart=2316(,)
1034
1035# Move caret to first position in document extending selection to new caret position.
1036fun void DocumentStartExtend=2317(,)
1037
1038# Move caret to last position in document.
1039fun void DocumentEnd=2318(,)
1040
1041# Move caret to last position in document extending selection to new caret position.
1042fun void DocumentEndExtend=2319(,)
1043
1044# Move caret one page up.
1045fun void PageUp=2320(,)
1046
1047# Move caret one page up extending selection to new caret position.
1048fun void PageUpExtend=2321(,)
1049
1050# Move caret one page down.
1051fun void PageDown=2322(,)
1052
1053# Move caret one page down extending selection to new caret position.
1054fun void PageDownExtend=2323(,)
1055
1056# Switch from insert to overtype mode or the reverse.
1057fun void EditToggleOvertype=2324(,)
1058
1059# Cancel any modes such as call tip or auto-completion list display.
1060fun void Cancel=2325(,)
1061
1062# Delete the selection or if no selection, the character before the caret.
1063fun void DeleteBack=2326(,)
1064
a834585d 1065# If selection is empty or all on one line replace the selection with a tab character.
bfabd11a
RD
1066# If more than one line selected, indent the lines.
1067fun void Tab=2327(,)
1068
1069# Dedent the selected lines.
1070fun void BackTab=2328(,)
1071
1072# Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
1073fun void NewLine=2329(,)
1074
1075# Insert a Form Feed character.
1076fun void FormFeed=2330(,)
1077
d25f5fbb 1078# Move caret to before first visible character on line.
bfabd11a
RD
1079# If already there move to first character on line.
1080fun void VCHome=2331(,)
1081
1082# Like VCHome but extending selection to new caret position.
1083fun void VCHomeExtend=2332(,)
1084
1085# Magnify the displayed text by increasing the sizes by 1 point.
1086fun void ZoomIn=2333(,)
1087
1088# Make the displayed text smaller by decreasing the sizes by 1 point.
1089fun void ZoomOut=2334(,)
1090
1091# Delete the word to the left of the caret.
1092fun void DelWordLeft=2335(,)
1093
1094# Delete the word to the right of the caret.
1095fun void DelWordRight=2336(,)
1096
1097# Cut the line containing the caret.
1098fun void LineCut=2337(,)
1099
1100# Delete the line containing the caret.
1101fun void LineDelete=2338(,)
1102
1103# Switch the current line with the previous.
1104fun void LineTranspose=2339(,)
1105
1106# Transform the selection to lower case.
1107fun void LowerCase=2340(,)
1108
1109# Transform the selection to upper case.
1110fun void UpperCase=2341(,)
1111
1112# Scroll the document down, keeping the caret visible.
1113fun void LineScrollDown=2342(,)
1114
1115# Scroll the document up, keeping the caret visible.
1116fun void LineScrollUp=2343(,)
1117
1a2fb4cd 1118# Delete the selection or if no selection, the character before the caret.
a834585d 1119# Will not delete the character before at the start of a line.
1a2fb4cd
RD
1120fun void DeleteBackNotLine=2344(,)
1121
a834585d 1122# Move the caret inside current view if it's not there already.
65ec6247
RD
1123fun void MoveCaretInsideView=2401(,)
1124
a834585d 1125# How many characters are on a line, not including end of line characters?
bfabd11a
RD
1126fun int LineLength=2350(int line,)
1127
1128# Highlight the characters at two positions.
a834585d 1129fun void BraceHighlight=2351(position pos1, position pos2)
bfabd11a
RD
1130
1131# Highlight the character at a position indicating there is no matching brace.
1132fun void BraceBadLight=2352(position pos,)
1133
1134# Find the position of a matching brace or INVALID_POSITION if no match.
1135fun position BraceMatch=2353(position pos,)
1136
a834585d 1137# Are the end of line characters visible?
bfabd11a
RD
1138get bool GetViewEOL=2355(,)
1139
a834585d 1140# Make the end of line characters visible or invisible.
bfabd11a
RD
1141set void SetViewEOL=2356(bool visible,)
1142
1143# Retrieve a pointer to the document object.
1144get int GetDocPointer=2357(,)
1145
1146# Change the document object used.
65ec6247 1147set void SetDocPointer=2358(,int pointer)
bfabd11a
RD
1148
1149# Set which document modification events are sent to the container.
1150set void SetModEventMask=2359(int mask,)
1151
a834585d 1152enu EdgeVisualStyle=EDGE_
bfabd11a
RD
1153val EDGE_NONE=0
1154val EDGE_LINE=1
1155val EDGE_BACKGROUND=2
1156
1157# Retrieve the column number which text should be kept within.
1158get int GetEdgeColumn=2360(,)
1159
d25f5fbb
RD
1160# Set the column number of the edge.
1161# If text goes past the edge then it is highlighted.
bfabd11a
RD
1162set void SetEdgeColumn=2361(int column,)
1163
1164# Retrieve the edge highlight mode.
1165get int GetEdgeMode=2362(,)
1166
1167# The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1168# goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1169set void SetEdgeMode=2363(int mode,)
1170
1171# Retrieve the colour used in edge indication.
1172get colour GetEdgeColour=2364(,)
1173
1174# Change the colour used in edge indication.
1175set void SetEdgeColour=2365(colour edgeColour,)
1176
1177# Sets the current caret position to be the search anchor.
1178fun void SearchAnchor=2366(,)
1179
1180# Find some text starting at the search anchor.
65ec6247 1181# Does not ensure the selection is visible.
bfabd11a
RD
1182fun int SearchNext=2367(int flags, string text)
1183
1184# Find some text starting at the search anchor and moving backwards.
65ec6247 1185# Does not ensure the selection is visible.
bfabd11a
RD
1186fun int SearchPrev=2368(int flags, string text)
1187
bfabd11a
RD
1188# Retrieves the number of lines completely visible.
1189get int LinesOnScreen=2370(,)
1190
1191# Set whether a pop up menu is displayed automatically when the user presses
1192# the wrong mouse button.
1193fun void UsePopUp=2371(bool allowPopUp,)
1194
a834585d 1195# Is the selection rectangular? The alternative is the more common stream selection.
bfabd11a
RD
1196get bool SelectionIsRectangle=2372(,)
1197
d25f5fbb 1198# Set the zoom level. This number of points is added to the size of all fonts.
bfabd11a
RD
1199# It may be positive to magnify or negative to reduce.
1200set void SetZoom=2373(int zoom,)
1201# Retrieve the zoom level.
1202get int GetZoom=2374(,)
1203
d25f5fbb 1204# Create a new document object.
d134f170
RD
1205# Starts with reference count of 1 and not selected into editor.
1206fun int CreateDocument=2375(,)
bfabd11a 1207# Extend life of document.
d134f170 1208fun void AddRefDocument=2376(, int doc)
bfabd11a 1209# Release a reference to the document, deleting document if it fades to black.
d134f170
RD
1210fun void ReleaseDocument=2377(, int doc)
1211
1212# Get which document modification events are sent to the container.
1213get int GetModEventMask=2378(,)
bfabd11a 1214
a834585d 1215# Change internal focus flag.
65ec6247 1216set void SetFocus=2380(bool focus,)
a834585d 1217# Get internal focus flag.
65ec6247
RD
1218get bool GetFocus=2381(,)
1219
a834585d 1220# Change error status - 0 = OK.
65ec6247 1221set void SetStatus=2382(int statusCode,)
a834585d 1222# Get error status.
65ec6247
RD
1223get int GetStatus=2383(,)
1224
a834585d 1225# Set whether the mouse is captured when its button is pressed.
65ec6247 1226set void SetMouseDownCaptures=2384(bool captures,)
a834585d 1227# Get whether mouse gets captured.
65ec6247
RD
1228get bool GetMouseDownCaptures=2385(,)
1229
a834585d 1230enu CursorShape=SC_CURSOR
65ec6247
RD
1231val SC_CURSORNORMAL=-1
1232val SC_CURSORWAIT=3
a834585d 1233# Sets the cursor to one of the SC_CURSOR* values.
65ec6247 1234set void SetCursor=2386(int cursorType,)
a834585d 1235# Get cursor type.
65ec6247
RD
1236get int GetCursor=2387(,)
1237
1a2fb4cd 1238# Change the way control characters are displayed:
a834585d 1239# If symbol is < 32, keep the drawn way, else, use the given character.
1a2fb4cd 1240set void SetControlCharSymbol=2388(int symbol,)
a834585d 1241# Get the way control characters are displayed.
1a2fb4cd
RD
1242get int GetControlCharSymbol=2389(,)
1243
a834585d 1244# Move to the previous change in capitalisation.
65ec6247 1245fun void WordPartLeft=2390(,)
a834585d
RD
1246# Move to the previous change in capitalisation extending selection
1247# to new caret position.
65ec6247 1248fun void WordPartLeftExtend=2391(,)
a834585d 1249# Move to the change next in capitalisation.
65ec6247 1250fun void WordPartRight=2392(,)
a834585d
RD
1251# Move to the next change in capitalisation extending selection
1252# to new caret position.
65ec6247
RD
1253fun void WordPartRightExtend=2393(,)
1254
a834585d 1255# Constants for use with SetVisiblePolicy, similar to SetCaretPolicy.
65ec6247
RD
1256val VISIBLE_SLOP=0x01
1257val VISIBLE_STRICT=0x04
a834585d
RD
1258# Set the way the display area is determined when a particular line
1259# is to be moved to by Find, FindNext, GotoLine, etc.
65ec6247
RD
1260fun void SetVisiblePolicy=2394(int visiblePolicy, int visibleSlop)
1261
a834585d 1262# Delete back from the current position to the start of the line.
65ec6247
RD
1263fun void DelLineLeft=2395(,)
1264
a834585d 1265# Delete forwards from the current position to the end of the line.
65ec6247
RD
1266fun void DelLineRight=2396(,)
1267
a834585d 1268# Get and Set the xOffset (ie, horizonal scroll position).
1a2fb4cd
RD
1269set void SetXOffset=2397(int newOffset,)
1270get int GetXOffset=2398(,)
1271
bfabd11a 1272# Set the focus to this Scintilla widget.
a834585d 1273# GTK+ Specific.
bfabd11a
RD
1274fun void GrabFocus=2400(,)
1275
a834585d
RD
1276enu CaretPolicy = CARET_
1277# Caret policy, used by SetXCaretPolicy and SetYCaretPolicy.
1278# If CARET_SLOP is set, we can define a slop value: caretSlop.
1279# This value defines an unwanted zone (UZ) where the caret is... unwanted.
1280# This zone is defined as a number of pixels near the vertical margins,
1281# and as a number of lines near the horizontal margins.
1282# By keeping the caret away from the edges, it is seen within its context,
1283# so it is likely that the identifier that the caret is on can be completely seen,
1284# and that the current line is seen with some of the lines following it which are
1285# often dependent on that line.
1286val CARET_SLOP=0x01
1287# If CARET_STRICT is set, the policy is enforced... strictly.
1288# The caret is centred on the display if slop is not set,
1289# and cannot go in the UZ if slop is set.
1290val CARET_STRICT=0x04
1291# If CARET_JUMPS is set, the display is moved more energetically
1292# so the caret can move in the same direction longer before the policy is applied again.
1293val CARET_JUMPS=0x10
1294# If CARET_EVEN is not set, instead of having symmetrical UZs,
1295# the left and bottom UZs are extended up to right and top UZs respectively.
1296# This way, we favour the displaying of useful information: the begining of lines,
1297# where most code reside, and the lines after the caret, eg. the body of a function.
1298val CARET_EVEN=0x08
1299
1300# Set the way the caret is kept visible when going sideway.
1301# The exclusion zone is given in pixels.
1302fun void SetXCaretPolicy=2402(int caretPolicy, int caretSlop)
1303
1304# Set the way the line the caret is on is kept visible.
1305# The exclusion zone is given in lines.
1306fun void SetYCaretPolicy=2403(int caretPolicy, int caretSlop)
1307
bfabd11a
RD
1308# Start notifying the container of all key presses and commands.
1309fun void StartRecord=3001(,)
1310
1311# Stop notifying the container of all key presses and commands.
1312fun void StopRecord=3002(,)
1313
d25f5fbb 1314# Set the lexing language of the document.
bfabd11a
RD
1315set void SetLexer=4001(int lexer,)
1316
d25f5fbb 1317# Retrieve the lexing language of the document.
bfabd11a
RD
1318get int GetLexer=4002(,)
1319
1320# Colourise a segment of the document using the current lexing language.
1321fun void Colourise=4003(position start, position end)
1322
1323# Set up a value that may be used by a lexer for some optional feature.
1324set void SetProperty=4004(string key, string value)
1325
1326# Set up the key words used by the lexer.
1327set void SetKeyWords=4005(int keywordSet, string keyWords)
1328
65ec6247
RD
1329# Set the lexing language of the document based on string name.
1330set void SetLexerLanguage=4006(, string language)
1331
d134f170 1332# Notifications
a834585d 1333# Type of modification and the action which caused the modification.
d134f170
RD
1334# These are defined as a bit mask to make it easy to specify which notifications are wanted.
1335# One bit is set from each of SC_MOD_* and SC_PERFORMED_*.
a834585d 1336enu ModificationFlags=SC_MOD_ SC_PERFORMED_ SC_LAST
bfabd11a
RD
1337val SC_MOD_INSERTTEXT=0x1
1338val SC_MOD_DELETETEXT=0x2
1339val SC_MOD_CHANGESTYLE=0x4
1340val SC_MOD_CHANGEFOLD=0x8
1341val SC_PERFORMED_USER=0x10
1342val SC_PERFORMED_UNDO=0x20
1343val SC_PERFORMED_REDO=0x40
1344val SC_LASTSTEPINUNDOREDO=0x100
1345val SC_MOD_CHANGEMARKER=0x200
1346val SC_MOD_BEFOREINSERT=0x400
1347val SC_MOD_BEFOREDELETE=0x800
1348val SC_MODEVENTMASKALL=0xF77
d134f170
RD
1349
1350# For compatibility, these go through the COMMAND notification rather than NOTIFY
a834585d
RD
1351# and should have had exactly the same values as the EN_* constants.
1352# Unfortunately the SETFOCUS and KILLFOCUS are flipped over from EN_*
1353# As clients depend on these constants, this will not be changed.
d134f170
RD
1354val SCEN_CHANGE=768
1355val SCEN_SETFOCUS=512
1356val SCEN_KILLFOCUS=256
1357
a834585d
RD
1358# Symbolic key codes and modifier flags.
1359# ASCII and other printable characters below 256.
1360# Extended keys above 300.
d134f170 1361
a834585d 1362enu Keys=SCK_
d134f170
RD
1363val SCK_DOWN=300
1364val SCK_UP=301
1365val SCK_LEFT=302
1366val SCK_RIGHT=303
1367val SCK_HOME=304
1368val SCK_END=305
1369val SCK_PRIOR=306
1370val SCK_NEXT=307
1371val SCK_DELETE=308
1372val SCK_INSERT=309
1373val SCK_ESCAPE=7
1374val SCK_BACK=8
1375val SCK_TAB=9
1376val SCK_RETURN=13
1377val SCK_ADD=310
1378val SCK_SUBTRACT=311
1379val SCK_DIVIDE=312
1380
a834585d 1381enu KeyMod=SCMOD_
d134f170
RD
1382val SCMOD_SHIFT=1
1383val SCMOD_CTRL=2
1384val SCMOD_ALT=4
bfabd11a
RD
1385
1386################################################
d134f170 1387# For SciLexer.h
a834585d 1388enu Lexer=SCLEX_
bfabd11a
RD
1389val SCLEX_CONTAINER=0
1390val SCLEX_NULL=1
1391val SCLEX_PYTHON=2
1392val SCLEX_CPP=3
1393val SCLEX_HTML=4
1394val SCLEX_XML=5
1395val SCLEX_PERL=6
1396val SCLEX_SQL=7
1397val SCLEX_VB=8
1398val SCLEX_PROPERTIES=9
1399val SCLEX_ERRORLIST=10
1400val SCLEX_MAKEFILE=11
1401val SCLEX_BATCH=12
1402val SCLEX_XCODE=13
1403val SCLEX_LATEX=14
d134f170
RD
1404val SCLEX_LUA=15
1405val SCLEX_DIFF=16
65ec6247
RD
1406val SCLEX_CONF=17
1407val SCLEX_PASCAL=18
1408val SCLEX_AVE=19
1409val SCLEX_ADA=20
1410val SCLEX_LISP=21
1411val SCLEX_RUBY=22
1412val SCLEX_EIFFEL=23
1413val SCLEX_EIFFELKW=24
1414val SCLEX_TCL=25
b8b0e402 1415val SCLEX_NNCRONTAB=26
1a2fb4cd
RD
1416val SCLEX_BULLANT=27
1417val SCLEX_VBSCRIPT=28
1418val SCLEX_ASP=29
1419val SCLEX_PHP=30
1420val SCLEX_BAAN=31
1421val SCLEX_MATLAB=32
a834585d 1422val SCLEX_SCRIPTOL=33
1a2fb4cd 1423
65ec6247
RD
1424# When a lexer specifies its language as SCLEX_AUTOMATIC it receives a
1425# value assigned in sequence from SCLEX_AUTOMATIC+1.
1426val SCLEX_AUTOMATIC=1000
d134f170 1427# Lexical states for SCLEX_PYTHON
a834585d
RD
1428lex Python=SCLEX_PYTHON SCE_P_
1429lex Ruby=SCLEX_RUBY SCE_P_
bfabd11a
RD
1430val SCE_P_DEFAULT=0
1431val SCE_P_COMMENTLINE=1
1432val SCE_P_NUMBER=2
1433val SCE_P_STRING=3
1434val SCE_P_CHARACTER=4
1435val SCE_P_WORD=5
1436val SCE_P_TRIPLE=6
1437val SCE_P_TRIPLEDOUBLE=7
1438val SCE_P_CLASSNAME=8
1439val SCE_P_DEFNAME=9
1440val SCE_P_OPERATOR=10
1441val SCE_P_IDENTIFIER=11
1442val SCE_P_COMMENTBLOCK=12
1443val SCE_P_STRINGEOL=13
1a2fb4cd 1444# Lexical states for SCLEX_CPP
a834585d
RD
1445lex Cpp=SCLEX_CPP SCE_C_
1446lex SQL=SCLEX_SQL SCE_C_
1447lex Pascal=SCLEX_PASCAL SCE_C_
1448lex TCL=SCLEX_TCL SCE_C_
1449lex BullAnt=SCLEX_BULLANT SCE_C_
bfabd11a
RD
1450val SCE_C_DEFAULT=0
1451val SCE_C_COMMENT=1
1452val SCE_C_COMMENTLINE=2
1453val SCE_C_COMMENTDOC=3
1454val SCE_C_NUMBER=4
1455val SCE_C_WORD=5
1456val SCE_C_STRING=6
1457val SCE_C_CHARACTER=7
1458val SCE_C_UUID=8
1459val SCE_C_PREPROCESSOR=9
1460val SCE_C_OPERATOR=10
1461val SCE_C_IDENTIFIER=11
1462val SCE_C_STRINGEOL=12
d134f170 1463val SCE_C_VERBATIM=13
65ec6247
RD
1464val SCE_C_REGEX=14
1465val SCE_C_COMMENTLINEDOC=15
1466val SCE_C_WORD2=16
b8b0e402
RD
1467val SCE_C_COMMENTDOCKEYWORD=17
1468val SCE_C_COMMENTDOCKEYWORDERROR=18
d134f170 1469# Lexical states for SCLEX_HTML, SCLEX_XML
a834585d
RD
1470lex HTML=SCLEX_HTML SCE_H
1471lex XML=SCLEX_XML SCE_H
1472lex ASP=SCLEX_ASP SCE_H
1473lex PHP=SCLEX_PHP SCE_H
bfabd11a
RD
1474val SCE_H_DEFAULT=0
1475val SCE_H_TAG=1
1476val SCE_H_TAGUNKNOWN=2
1477val SCE_H_ATTRIBUTE=3
1478val SCE_H_ATTRIBUTEUNKNOWN=4
1479val SCE_H_NUMBER=5
1480val SCE_H_DOUBLESTRING=6
1481val SCE_H_SINGLESTRING=7
1482val SCE_H_OTHER=8
1483val SCE_H_COMMENT=9
1484val SCE_H_ENTITY=10
d134f170 1485# XML and ASP
bfabd11a
RD
1486val SCE_H_TAGEND=11
1487val SCE_H_XMLSTART=12
1488val SCE_H_XMLEND=13
1489val SCE_H_SCRIPT=14
1490val SCE_H_ASP=15
1491val SCE_H_ASPAT=16
d134f170
RD
1492val SCE_H_CDATA=17
1493val SCE_H_QUESTION=18
1494# More HTML
1495val SCE_H_VALUE=19
65ec6247
RD
1496# X-Code
1497val SCE_H_XCCOMMENT=20
1498# SGML
b8b0e402
RD
1499val SCE_H_SGML_DEFAULT=21
1500val SCE_H_SGML_COMMAND=22
1501val SCE_H_SGML_1ST_PARAM=23
1502val SCE_H_SGML_DOUBLESTRING=24
1503val SCE_H_SGML_SIMPLESTRING=25
1504val SCE_H_SGML_ERROR=26
1505val SCE_H_SGML_SPECIAL=27
1506val SCE_H_SGML_ENTITY=28
1507val SCE_H_SGML_COMMENT=29
1508val SCE_H_SGML_1ST_PARAM_COMMENT=30
1509val SCE_H_SGML_BLOCK_DEFAULT=31
d134f170 1510# Embedded Javascript
bfabd11a
RD
1511val SCE_HJ_START=40
1512val SCE_HJ_DEFAULT=41
1513val SCE_HJ_COMMENT=42
1514val SCE_HJ_COMMENTLINE=43
1515val SCE_HJ_COMMENTDOC=44
1516val SCE_HJ_NUMBER=45
1517val SCE_HJ_WORD=46
1518val SCE_HJ_KEYWORD=47
1519val SCE_HJ_DOUBLESTRING=48
1520val SCE_HJ_SINGLESTRING=49
1521val SCE_HJ_SYMBOLS=50
1522val SCE_HJ_STRINGEOL=51
65ec6247 1523val SCE_HJ_REGEX=52
d134f170 1524# ASP Javascript
bfabd11a
RD
1525val SCE_HJA_START=55
1526val SCE_HJA_DEFAULT=56
1527val SCE_HJA_COMMENT=57
1528val SCE_HJA_COMMENTLINE=58
1529val SCE_HJA_COMMENTDOC=59
1530val SCE_HJA_NUMBER=60
1531val SCE_HJA_WORD=61
1532val SCE_HJA_KEYWORD=62
1533val SCE_HJA_DOUBLESTRING=63
1534val SCE_HJA_SINGLESTRING=64
1535val SCE_HJA_SYMBOLS=65
1536val SCE_HJA_STRINGEOL=66
65ec6247 1537val SCE_HJA_REGEX=67
d134f170 1538# Embedded VBScript
bfabd11a
RD
1539val SCE_HB_START=70
1540val SCE_HB_DEFAULT=71
1541val SCE_HB_COMMENTLINE=72
1542val SCE_HB_NUMBER=73
1543val SCE_HB_WORD=74
1544val SCE_HB_STRING=75
1545val SCE_HB_IDENTIFIER=76
1546val SCE_HB_STRINGEOL=77
d134f170 1547# ASP VBScript
bfabd11a
RD
1548val SCE_HBA_START=80
1549val SCE_HBA_DEFAULT=81
1550val SCE_HBA_COMMENTLINE=82
1551val SCE_HBA_NUMBER=83
1552val SCE_HBA_WORD=84
1553val SCE_HBA_STRING=85
1554val SCE_HBA_IDENTIFIER=86
1555val SCE_HBA_STRINGEOL=87
d134f170 1556# Embedded Python
bfabd11a
RD
1557val SCE_HP_START=90
1558val SCE_HP_DEFAULT=91
1559val SCE_HP_COMMENTLINE=92
1560val SCE_HP_NUMBER=93
1561val SCE_HP_STRING=94
1562val SCE_HP_CHARACTER=95
1563val SCE_HP_WORD=96
1564val SCE_HP_TRIPLE=97
1565val SCE_HP_TRIPLEDOUBLE=98
1566val SCE_HP_CLASSNAME=99
1567val SCE_HP_DEFNAME=100
1568val SCE_HP_OPERATOR=101
1569val SCE_HP_IDENTIFIER=102
d134f170 1570# ASP Python
bfabd11a
RD
1571val SCE_HPA_START=105
1572val SCE_HPA_DEFAULT=106
1573val SCE_HPA_COMMENTLINE=107
1574val SCE_HPA_NUMBER=108
1575val SCE_HPA_STRING=109
1576val SCE_HPA_CHARACTER=110
1577val SCE_HPA_WORD=111
1578val SCE_HPA_TRIPLE=112
1579val SCE_HPA_TRIPLEDOUBLE=113
1580val SCE_HPA_CLASSNAME=114
1581val SCE_HPA_DEFNAME=115
1582val SCE_HPA_OPERATOR=116
1583val SCE_HPA_IDENTIFIER=117
d134f170
RD
1584# PHP
1585val SCE_HPHP_DEFAULT=118
1586val SCE_HPHP_HSTRING=119
1587val SCE_HPHP_SIMPLESTRING=120
1588val SCE_HPHP_WORD=121
1589val SCE_HPHP_NUMBER=122
1590val SCE_HPHP_VARIABLE=123
1591val SCE_HPHP_COMMENT=124
1592val SCE_HPHP_COMMENTLINE=125
65ec6247
RD
1593val SCE_HPHP_HSTRING_VARIABLE=126
1594val SCE_HPHP_OPERATOR=127
d134f170 1595# Lexical states for SCLEX_PERL
a834585d 1596lex Perl=SCLEX_PERL SCE_PL_
bfabd11a 1597val SCE_PL_DEFAULT=0
65ec6247 1598val SCE_PL_ERROR=1
bfabd11a
RD
1599val SCE_PL_COMMENTLINE=2
1600val SCE_PL_POD=3
1601val SCE_PL_NUMBER=4
1602val SCE_PL_WORD=5
1603val SCE_PL_STRING=6
1604val SCE_PL_CHARACTER=7
1605val SCE_PL_PUNCTUATION=8
1606val SCE_PL_PREPROCESSOR=9
1607val SCE_PL_OPERATOR=10
1608val SCE_PL_IDENTIFIER=11
1609val SCE_PL_SCALAR=12
1610val SCE_PL_ARRAY=13
1611val SCE_PL_HASH=14
1612val SCE_PL_SYMBOLTABLE=15
bfabd11a
RD
1613val SCE_PL_REGEX=17
1614val SCE_PL_REGSUBST=18
1615val SCE_PL_LONGQUOTE=19
1616val SCE_PL_BACKTICKS=20
1617val SCE_PL_DATASECTION=21
65ec6247
RD
1618val SCE_PL_HERE_DELIM=22
1619val SCE_PL_HERE_Q=23
1620val SCE_PL_HERE_QQ=24
1621val SCE_PL_HERE_QX=25
1622val SCE_PL_STRING_Q=26
1623val SCE_PL_STRING_QQ=27
1624val SCE_PL_STRING_QX=28
1625val SCE_PL_STRING_QR=29
1626val SCE_PL_STRING_QW=30
a834585d
RD
1627# Lexical states for SCLEX_VB, SCLEX_VBSCRIPT
1628lex VB=SCLEX_VB SCE_B_
1629lex VBScript=SCLEX_VBSCRIPT SCE_B_
1630val SCE_B_DEFAULT=0
1631val SCE_B_COMMENT=1
1632val SCE_B_NUMBER=2
1633val SCE_B_KEYWORD=3
1634val SCE_B_STRING=4
1635val SCE_B_PREPROCESSOR=5
1636val SCE_B_OPERATOR=6
1637val SCE_B_IDENTIFIER=7
1638val SCE_B_DATE=8
1639# Lexical states for SCLEX_PROPERTIES
1640lex Properties=SCLEX_PROPERTIES SCE_PROPS_
1641val SCE_PROPS_DEFAULT=0
1642val SCE_PROPS_COMMENT=1
1643val SCE_PROPS_SECTION=2
1644val SCE_PROPS_ASSIGNMENT=3
1645val SCE_PROPS_DEFVAL=4
d134f170 1646# Lexical states for SCLEX_LATEX
a834585d 1647lex LaTeX=SCLEX_LATEX SCE_L_
bfabd11a
RD
1648val SCE_L_DEFAULT=0
1649val SCE_L_COMMAND=1
1650val SCE_L_TAG=2
1651val SCE_L_MATH=3
1652val SCE_L_COMMENT=4
d134f170 1653# Lexical states for SCLEX_LUA
a834585d 1654lex Lua=SCLEX_LUA SCE_LUA_
d134f170
RD
1655val SCE_LUA_DEFAULT=0
1656val SCE_LUA_COMMENT=1
1657val SCE_LUA_COMMENTLINE=2
1658val SCE_LUA_COMMENTDOC=3
1659val SCE_LUA_NUMBER=4
1660val SCE_LUA_WORD=5
1661val SCE_LUA_STRING=6
1662val SCE_LUA_CHARACTER=7
1663val SCE_LUA_LITERALSTRING=8
1664val SCE_LUA_PREPROCESSOR=9
1665val SCE_LUA_OPERATOR=10
1666val SCE_LUA_IDENTIFIER=11
1667val SCE_LUA_STRINGEOL=12
1a2fb4cd
RD
1668val SCE_LUA_WORD2=13
1669val SCE_LUA_WORD3=14
1670val SCE_LUA_WORD4=15
1671val SCE_LUA_WORD5=16
1672val SCE_LUA_WORD6=17
65ec6247 1673# Lexical states for SCLEX_ERRORLIST
a834585d 1674lex ErrorList=SCLEX_ERRORLIST SCE_ERR_
d134f170
RD
1675val SCE_ERR_DEFAULT=0
1676val SCE_ERR_PYTHON=1
1677val SCE_ERR_GCC=2
1678val SCE_ERR_MS=3
1679val SCE_ERR_CMD=4
1680val SCE_ERR_BORLAND=5
1681val SCE_ERR_PERL=6
65ec6247
RD
1682val SCE_ERR_NET=7
1683val SCE_ERR_LUA=8
a834585d 1684val SCE_ERR_CTAG=9
65ec6247
RD
1685val SCE_ERR_DIFF_CHANGED=10
1686val SCE_ERR_DIFF_ADDITION=11
1687val SCE_ERR_DIFF_DELETION=12
1688val SCE_ERR_DIFF_MESSAGE=13
1689# Lexical states for SCLEX_BATCH
a834585d 1690lex Batch=SCLEX_BATCH SCE_BAT_
65ec6247
RD
1691val SCE_BAT_DEFAULT=0
1692val SCE_BAT_COMMENT=1
1693val SCE_BAT_WORD=2
1694val SCE_BAT_LABEL=3
1695val SCE_BAT_HIDE=4
1696val SCE_BAT_COMMAND=5
1697val SCE_BAT_IDENTIFIER=6
1698val SCE_BAT_OPERATOR=7
1699# Lexical states for SCLEX_MAKEFILE
a834585d 1700lex MakeFile=SCLEX_MAKEFILE SCE_MAKE_
65ec6247
RD
1701val SCE_MAKE_DEFAULT=0
1702val SCE_MAKE_COMMENT=1
1703val SCE_MAKE_PREPROCESSOR=2
1704val SCE_MAKE_IDENTIFIER=3
1705val SCE_MAKE_OPERATOR=4
1706val SCE_MAKE_TARGET=5
1707val SCE_MAKE_IDEOL=9
a834585d
RD
1708# Lexical states for SCLEX_DIFF
1709lex Diff=SCLEX_DIFF SCE_DIFF_
1710val SCE_DIFF_DEFAULT=0
1711val SCE_DIFF_COMMENT=1
1712val SCE_DIFF_COMMAND=2
1713val SCE_DIFF_HEADER=3
1714val SCE_DIFF_POSITION=4
1715val SCE_DIFF_DELETED=5
1716val SCE_DIFF_ADDED=6
1717# Lexical states for SCLEX_CONF (Apache Configuration Files Lexer)
1718lex Conf=SCLEX_CONF SCE_CONF_
65ec6247
RD
1719val SCE_CONF_DEFAULT=0
1720val SCE_CONF_COMMENT=1
1721val SCE_CONF_NUMBER=2
1722val SCE_CONF_IDENTIFIER=3
1723val SCE_CONF_EXTENSION=4
1724val SCE_CONF_PARAMETER=5
1725val SCE_CONF_STRING=6
1726val SCE_CONF_OPERATOR=7
1727val SCE_CONF_IP=8
1728val SCE_CONF_DIRECTIVE=9
a834585d
RD
1729# Lexical states for SCLEX_AVE, Avenue
1730lex Avenue=SCLEX_AVE SCE_AVE_
65ec6247
RD
1731val SCE_AVE_DEFAULT=0
1732val SCE_AVE_COMMENT=1
1733val SCE_AVE_NUMBER=2
1734val SCE_AVE_WORD=3
1735val SCE_AVE_KEYWORD=4
1736val SCE_AVE_STATEMENT=5
1737val SCE_AVE_STRING=6
1738val SCE_AVE_ENUM=7
1739val SCE_AVE_STRINGEOL=8
1740val SCE_AVE_IDENTIFIER=9
1741val SCE_AVE_OPERATOR=10
1742# Lexical states for SCLEX_ADA
a834585d 1743lex Ada=SCLEX_ADA SCE_ADA_
65ec6247
RD
1744val SCE_ADA_DEFAULT=0
1745val SCE_ADA_COMMENT=1
1746val SCE_ADA_NUMBER=2
1747val SCE_ADA_WORD=3
1748val SCE_ADA_STRING=4
1749val SCE_ADA_CHARACTER=5
1750val SCE_ADA_OPERATOR=6
1751val SCE_ADA_IDENTIFIER=7
1752val SCE_ADA_STRINGEOL=8
1a2fb4cd 1753# Lexical states for SCLEX_BAAN
a834585d 1754lex Baan=SCLEX_BAAN SCE_BAAN_
1a2fb4cd
RD
1755val SCE_BAAN_DEFAULT=0
1756val SCE_BAAN_COMMENT=1
1757val SCE_BAAN_COMMENTDOC=2
1758val SCE_BAAN_NUMBER=3
1759val SCE_BAAN_WORD=4
1760val SCE_BAAN_STRING=5
1761val SCE_BAAN_PREPROCESSOR=6
1762val SCE_BAAN_OPERATOR=7
1763val SCE_BAAN_IDENTIFIER=8
1764val SCE_BAAN_STRINGEOL=9
1765val SCE_BAAN_WORD2=10
65ec6247 1766# Lexical states for SCLEX_LISP
a834585d 1767lex Lisp=SCLEX_LISP SCE_LISP_
65ec6247
RD
1768val SCE_LISP_DEFAULT=0
1769val SCE_LISP_COMMENT=1
1770val SCE_LISP_NUMBER=2
1771val SCE_LISP_KEYWORD=3
1772val SCE_LISP_STRING=6
1773val SCE_LISP_STRINGEOL=8
1774val SCE_LISP_IDENTIFIER=9
1775val SCE_LISP_OPERATOR=10
1776# Lexical states for SCLEX_EIFFEL and SCLEX_EIFFELKW
a834585d
RD
1777lex Eiffel=SCLEX_EIFFEL SCE_EIFFEL_
1778lex EiffelKW=SCLEX_EIFFELKW SCE_EIFFEL_
65ec6247
RD
1779val SCE_EIFFEL_DEFAULT=0
1780val SCE_EIFFEL_COMMENTLINE=1
1781val SCE_EIFFEL_NUMBER=2
1782val SCE_EIFFEL_WORD=3
1783val SCE_EIFFEL_STRING=4
1784val SCE_EIFFEL_CHARACTER=5
1785val SCE_EIFFEL_OPERATOR=6
1786val SCE_EIFFEL_IDENTIFIER=7
1787val SCE_EIFFEL_STRINGEOL=8
a834585d
RD
1788# Lexical states for SCLEX_NNCRONTAB (nnCron crontab Lexer)
1789lex NNCronTab=SCLEX_NNCRONTAB SCE_NNCRONTAB_
b8b0e402
RD
1790val SCE_NNCRONTAB_DEFAULT=0
1791val SCE_NNCRONTAB_COMMENT=1
1792val SCE_NNCRONTAB_TASK=2
1793val SCE_NNCRONTAB_SECTION=3
1794val SCE_NNCRONTAB_KEYWORD=4
1795val SCE_NNCRONTAB_MODIFIER=5
1796val SCE_NNCRONTAB_ASTERISK=6
1797val SCE_NNCRONTAB_NUMBER=7
1798val SCE_NNCRONTAB_STRING=8
1799val SCE_NNCRONTAB_ENVIRONMENT=9
1800val SCE_NNCRONTAB_IDENTIFIER=10
1a2fb4cd 1801# Lexical states for SCLEX_MATLAB
a834585d 1802lex MatLab=SCLEX_MATLAB SCE_MATLAB_
1a2fb4cd
RD
1803val SCE_MATLAB_DEFAULT=0
1804val SCE_MATLAB_COMMENT=1
1805val SCE_MATLAB_COMMAND=2
1806val SCE_MATLAB_NUMBER=3
1807val SCE_MATLAB_KEYWORD=4
1808val SCE_MATLAB_STRING=5
1809val SCE_MATLAB_OPERATOR=6
1810val SCE_MATLAB_IDENTIFIER=7
a834585d
RD
1811# Lexical states for SCLEX_SCRIPTOL
1812lex Sol=SCLEX_SCRIPTOL SCE_SCRIPTOL_
1813val SCE_SCRIPTOL_DEFAULT=0
1814val SCE_SCRIPTOL_COMMENT=1
1815val SCE_SCRIPTOL_COMMENTLINE=2
1816val SCE_SCRIPTOL_COMMENTDOC=3
1817val SCE_SCRIPTOL_NUMBER=4
1818val SCE_SCRIPTOL_WORD=5
1819val SCE_SCRIPTOL_STRING=6
1820val SCE_SCRIPTOL_CHARACTER=7
1821val SCE_SCRIPTOL_UUID=8
1822val SCE_SCRIPTOL_PREPROCESSOR=9
1823val SCE_SCRIPTOL_OPERATOR=10
1824val SCE_SCRIPTOL_IDENTIFIER=11
1825val SCE_SCRIPTOL_STRINGEOL=12
1826val SCE_SCRIPTOL_VERBATIM=13
1827val SCE_SCRIPTOL_REGEX=14
1828val SCE_SCRIPTOL_COMMENTLINEDOC=15
1829val SCE_SCRIPTOL_WORD2=16
1830val SCE_SCRIPTOL_COMMENTDOCKEYWORD=17
1831val SCE_SCRIPTOL_COMMENTDOCKEYWORDERROR=18
1832val SCE_SCRIPTOL_COMMENTBASIC=19
d134f170
RD
1833
1834# Events
1835
1836evt void StyleNeeded=2000(int position)
1837evt void CharAdded=2001(int ch)
1838evt void SavePointReached=2002(void)
1839evt void SavePointLeft=2003(void)
1840evt void ModifyAttemptRO=2004(void)
1841# GTK+ Specific to work around focus and accelerator problems:
1842evt void Key=2005(int ch, int modifiers)
1843evt void DoubleClick=2006(void)
1844evt void UpdateUI=2007(void)
d134f170 1845evt void Modified=2008(int position, int modificationType, string text, int length, int linesAdded, int line, int foldLevelNow, int foldLevelPrev)
d134f170
RD
1846evt void MacroRecord=2009(int message, int wParam, int lParam)
1847evt void MarginClick=2010(int modifiers, int position, int margin)
1848evt void NeedShown=2011(int position, int length)
65ec6247
RD
1849evt void Painted=2013(void)
1850evt void UserListSelection=2014(int listType, string text)
1851evt void URIDropped=2015(string text)
1852evt void DwellStart=2016(int position)
1853evt void DwellEnd=2017(int position)
a834585d 1854evt void Zoom=2018(void)
d134f170 1855
d25f5fbb 1856cat Deprecated
1a2fb4cd 1857
a834585d
RD
1858# CARET_POLICY changed in 1.47
1859fun void SetCaretPolicy=2369(int caretPolicy, int caretSlop)
1860val CARET_CENTER=0x02
1861val CARET_XEVEN=0x08
1862val CARET_XJUMPS=0x10
1863
1a2fb4cd
RD
1864# The old name for SCN_UPDATEUI
1865val SCN_CHECKBRACE=2007
1866evt void PosChanged=2012(int position)
a834585d 1867