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