Update Russian translation (#3918)
[geany-mirror.git] / scintilla / include / Scintilla.iface
blob9f02c78d21abe66f4c8168a5e2a817371d6a76ee
1 ## First line may be used for shbang
3 ## This file defines the interface to Scintilla
5 ## Copyright 2000-2003 by Neil Hodgson <neilh@scintilla.org>
6 ## The License.txt file describes the conditions under which this software may be distributed.
8 ## A line starting with ## is a pure comment and should be stripped by readers.
9 ## A line starting with #! is for future shbang use
10 ## A line starting with # followed by a space is a documentation comment and refers
11 ## to the next feature definition.
13 ## Each feature is defined by a line starting with fun, get, set, val, evt, enu, lex, or ali.
14 ##     cat -> start a category
15 ##     fun -> a function
16 ##     get -> a property get function
17 ##     set -> a property set function
18 ##     val -> definition of a constant
19 ##     evt -> an event
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 ##     ali -> add an alias for a val, commonly adding '_' to separate words
24 ## All other feature names should be ignored. They may be defined in the future.
25 ## A property may have a set function, a get function or both. Each will have
26 ## "Get" or "Set" in their names and the corresponding name will have the obvious switch.
27 ## A property may be subscripted, in which case the first parameter is the subscript.
28 ## fun, get, and set features have a strict syntax:
29 ## <featureType><ws><returnType><ws><name>[=<number](<param>,<param>)
30 ## where <ws> stands for white space.
31 ## param may be empty (null value) or is <paramType><ws><paramName>[=<value>]
32 ## Additional white space is allowed between elements.
33 ## The syntax for evt is <featureType><ws><returnType><ws><name>[=<number]([<param>[,<param>]*])
34 ## Feature names that contain an underscore are defined by Windows, so in these
35 ## cases, using the Windows definition is preferred where available.
36 ## The feature numbers are stable so features will not be renumbered.
37 ## Features may be removed but they will go through a period of deprecation
38 ## before removal which is signalled by moving them into the Deprecated category.
40 ## enu has the syntax enu<ws><enumeration>=<prefix>[<ws><prefix>]* where all the val
41 ## features in this file starting with a given <prefix> are considered part of the
42 ## enumeration.
44 ## lex has the syntax lex<ws><name>=<lexerVal><ws><prefix>[<ws><prefix>]*
45 ## where name is a reasonably capitalised (Python, XML) identifier or UI name,
46 ## lexerVal is the val used to specify the lexer, and the list of prefixes is similar
47 ## to enu. The name may not be the same as that used within the lexer so the lexerVal
48 ## should be used to tie these entities together.
50 ## Types: Never start with a capital letter
51 ##     void
52 ##     int
53 ##     bool -> integer, 1=true, 0=false
54 ##     position -> intptr_t position in a document
55 ##     line -> intptr_t line in a document
56 ##     colour -> colour integer containing red, green, and blue bytes with red as least-significant and blue as most.
57 ##     colouralpha -> colour integer containing red, green, blue, and alpha bytes with red as least-significant and alpha as most.
58 ##     string -> pointer to const character
59 ##     stringresult -> pointer to character, NULL-> return size of result
60 ##     cells -> pointer to array of cells, each cell containing a style byte and character byte
61 ##     pointer -> void* pointer that may point to a document, loader, internal text storage or similar
62 ##     textrange -> range of a min and a max position with an output string
63 ##     textrangefull -> range of a min and a max position with an output string - supports 64-bit
64 ##     findtext -> searchrange, text -> foundposition
65 ##     findtextfull -> searchrange, text -> foundposition
66 ##     keymod -> integer containing key in low half and modifiers in high half
67 ##     formatrange
68 ##     formatrangefull
69 ## Enumeration types always start with a capital letter
70 ## Types no longer used:
71 ##     findtextex -> searchrange
72 ##     charrange -> range of a min and a max position
73 ##     charrangeresult -> like charrange, but output param
74 ##     countedstring
75 ##     point -> x,y
76 ##     pointresult  -> like point, but output param
77 ##     rectangle -> left,top,right,bottom
78 ## Client code should ignore definitions containing types it does not understand, except
79 ## for possibly #defining the constants
81 ## Line numbers and positions start at 0.
82 ## String arguments may contain NUL ('\0') characters where the calls provide a length
83 ## argument and retrieve NUL characters. APIs marked as NUL-terminated also have a
84 ## NUL appended but client code should calculate the size that will be returned rather
85 ## than relying upon the NUL whenever possible. Allow for the extra NUL character when
86 ## allocating buffers. The size to allocate for a stringresult (not including NUL) can be
87 ## determined by calling with a NULL (0) pointer.
89 cat Basics
91 ################################################
92 ## For Scintilla.h
93 val INVALID_POSITION=-1
94 # Define start of Scintilla messages to be greater than all Windows edit (EM_*) messages
95 # as many EM_ messages can be used although that use is deprecated.
96 val SCI_START=2000
97 val SCI_OPTIONAL_START=3000
98 val SCI_LEXER_START=4000
100 # Add text to the document at current position.
101 fun void AddText=2001(position length, string text)
103 # Add array of cells to document.
104 fun void AddStyledText=2002(position length, cells c)
106 # Insert string at a position.
107 fun void InsertText=2003(position pos, string text)
109 # Change the text that is being inserted in response to SC_MOD_INSERTCHECK
110 fun void ChangeInsertion=2672(position length, string text)
112 # Delete all text in the document.
113 fun void ClearAll=2004(,)
115 # Delete a range of text in the document.
116 fun void DeleteRange=2645(position start, position lengthDelete)
118 # Set all style bytes to 0, remove all folding information.
119 fun void ClearDocumentStyle=2005(,)
121 # Returns the number of bytes in the document.
122 get position GetLength=2006(,)
124 # Returns the character byte at the position.
125 get int GetCharAt=2007(position pos,)
127 # Returns the position of the caret.
128 get position GetCurrentPos=2008(,)
130 # Returns the position of the opposite end of the selection to the caret.
131 get position GetAnchor=2009(,)
133 # Returns the style byte at the position.
134 get int GetStyleAt=2010(position pos,)
136 # Returns the unsigned style byte at the position.
137 get int GetStyleIndexAt=2038(position pos,)
139 # Redoes the next action on the undo history.
140 fun void Redo=2011(,)
142 # Choose between collecting actions into the undo
143 # history and discarding them.
144 set void SetUndoCollection=2012(bool collectUndo,)
146 # Select all the text in the document.
147 fun void SelectAll=2013(,)
149 # Remember the current position in the undo history as the position
150 # at which the document was saved.
151 fun void SetSavePoint=2014(,)
153 # Retrieve a buffer of cells.
154 # Returns the number of bytes in the buffer not including terminating NULs.
155 fun position GetStyledText=2015(, textrange tr)
157 # Retrieve a buffer of cells that can be past 2GB.
158 # Returns the number of bytes in the buffer not including terminating NULs.
159 fun position GetStyledTextFull=2778(, textrangefull tr)
161 # Are there any redoable actions in the undo history?
162 fun bool CanRedo=2016(,)
164 # Retrieve the line number at which a particular marker is located.
165 fun line MarkerLineFromHandle=2017(int markerHandle,)
167 # Delete a marker.
168 fun void MarkerDeleteHandle=2018(int markerHandle,)
170 # Retrieve marker handles of a line
171 fun int MarkerHandleFromLine=2732(line line, int which)
173 # Retrieve marker number of a marker handle
174 fun int MarkerNumberFromLine=2733(line line, int which)
176 # Is undo history being collected?
177 get bool GetUndoCollection=2019(,)
179 enu WhiteSpace=SCWS_
180 val SCWS_INVISIBLE=0
181 val SCWS_VISIBLEALWAYS=1
182 val SCWS_VISIBLEAFTERINDENT=2
183 val SCWS_VISIBLEONLYININDENT=3
185 ali SCWS_VISIBLEALWAYS=VISIBLE_ALWAYS
186 ali SCWS_VISIBLEAFTERINDENT=VISIBLE_AFTER_INDENT
187 ali SCWS_VISIBLEONLYININDENT=VISIBLE_ONLY_IN_INDENT
189 # Are white space characters currently visible?
190 # Returns one of SCWS_* constants.
191 get WhiteSpace GetViewWS=2020(,)
193 # Make white space characters invisible, always visible or visible outside indentation.
194 set void SetViewWS=2021(WhiteSpace viewWS,)
196 enu TabDrawMode=SCTD_
197 val SCTD_LONGARROW=0
198 val SCTD_STRIKEOUT=1
200 ali SCTD_LONGARROW=LONG_ARROW
201 ali SCTD_STRIKEOUT=STRIKE_OUT
203 # Retrieve the current tab draw mode.
204 # Returns one of SCTD_* constants.
205 get TabDrawMode GetTabDrawMode=2698(,)
207 # Set how tabs are drawn when visible.
208 set void SetTabDrawMode=2699(TabDrawMode tabDrawMode,)
210 # Find the position from a point within the window.
211 fun position PositionFromPoint=2022(int x, int y)
213 # Find the position from a point within the window but return
214 # INVALID_POSITION if not close to text.
215 fun position PositionFromPointClose=2023(int x, int y)
217 # Set caret to start of a line and ensure it is visible.
218 fun void GotoLine=2024(line line,)
220 # Set caret to a position and ensure it is visible.
221 fun void GotoPos=2025(position caret,)
223 # Set the selection anchor to a position. The anchor is the opposite
224 # end of the selection from the caret.
225 set void SetAnchor=2026(position anchor,)
227 # Retrieve the text of the line containing the caret.
228 # Returns the index of the caret on the line.
229 # Result is NUL-terminated.
230 fun position GetCurLine=2027(position length, stringresult text)
232 # Retrieve the position of the last correctly styled character.
233 get position GetEndStyled=2028(,)
235 enu EndOfLine=SC_EOL_
236 val SC_EOL_CRLF=0
237 val SC_EOL_CR=1
238 val SC_EOL_LF=2
240 ali SC_EOL_CRLF=CR_LF
242 # Convert all line endings in the document to one mode.
243 fun void ConvertEOLs=2029(EndOfLine eolMode,)
245 # Retrieve the current end of line mode - one of CRLF, CR, or LF.
246 get EndOfLine GetEOLMode=2030(,)
248 # Set the current end of line mode.
249 set void SetEOLMode=2031(EndOfLine eolMode,)
251 # Set the current styling position to start.
252 # The unused parameter is no longer used and should be set to 0.
253 fun void StartStyling=2032(position start, int unused)
255 # Change style from current styling position for length characters to a style
256 # and move the current styling position to after this newly styled segment.
257 fun void SetStyling=2033(position length, int style)
259 # Is drawing done first into a buffer or direct to the screen?
260 get bool GetBufferedDraw=2034(,)
262 # If drawing is buffered then each line of text is drawn into a bitmap buffer
263 # before drawing it to the screen to avoid flicker.
264 set void SetBufferedDraw=2035(bool buffered,)
266 # Change the visible size of a tab to be a multiple of the width of a space character.
267 set void SetTabWidth=2036(int tabWidth,)
269 # Retrieve the visible size of a tab.
270 get int GetTabWidth=2121(,)
272 # Set the minimum visual width of a tab.
273 set void SetTabMinimumWidth=2724(int pixels,)
275 # Get the minimum visual width of a tab.
276 get int GetTabMinimumWidth=2725(,)
278 # Clear explicit tabstops on a line.
279 fun void ClearTabStops=2675(line line,)
281 # Add an explicit tab stop for a line.
282 fun void AddTabStop=2676(line line, int x)
284 # Find the next explicit tab stop position on a line after a position.
285 fun int GetNextTabStop=2677(line line, int x)
287 # The SC_CP_UTF8 value can be used to enter Unicode mode.
288 # This is the same value as CP_UTF8 in Windows
289 val SC_CP_UTF8=65001
291 # Set the code page used to interpret the bytes of the document as characters.
292 # The SC_CP_UTF8 value can be used to enter Unicode mode.
293 set void SetCodePage=2037(int codePage,)
295 # Set the locale for displaying text.
296 set void SetFontLocale=2760(, string localeName)
298 # Get the locale for displaying text.
299 get int GetFontLocale=2761(, stringresult localeName)
301 enu IMEInteraction=SC_IME_
302 val SC_IME_WINDOWED=0
303 val SC_IME_INLINE=1
305 # Is the IME displayed in a window or inline?
306 get IMEInteraction GetIMEInteraction=2678(,)
308 # Choose to display the IME in a window or inline.
309 set void SetIMEInteraction=2679(IMEInteraction imeInteraction,)
311 enu Alpha=SC_ALPHA_
312 val SC_ALPHA_TRANSPARENT=0
313 val SC_ALPHA_OPAQUE=255
314 val SC_ALPHA_NOALPHA=256
316 ali SC_ALPHA_NOALPHA=NO_ALPHA
318 enu CursorShape=SC_CURSOR
319 val SC_CURSORNORMAL=-1
320 val SC_CURSORARROW=2
321 val SC_CURSORWAIT=4
322 val SC_CURSORREVERSEARROW=7
324 ali SC_CURSORREVERSEARROW=REVERSE_ARROW
326 enu MarkerSymbol=SC_MARK_
327 val MARKER_MAX=31
328 val SC_MARK_CIRCLE=0
329 val SC_MARK_ROUNDRECT=1
330 val SC_MARK_ARROW=2
331 val SC_MARK_SMALLRECT=3
332 val SC_MARK_SHORTARROW=4
333 val SC_MARK_EMPTY=5
334 val SC_MARK_ARROWDOWN=6
335 val SC_MARK_MINUS=7
336 val SC_MARK_PLUS=8
338 # Shapes used for outlining column.
339 val SC_MARK_VLINE=9
340 val SC_MARK_LCORNER=10
341 val SC_MARK_TCORNER=11
342 val SC_MARK_BOXPLUS=12
343 val SC_MARK_BOXPLUSCONNECTED=13
344 val SC_MARK_BOXMINUS=14
345 val SC_MARK_BOXMINUSCONNECTED=15
346 val SC_MARK_LCORNERCURVE=16
347 val SC_MARK_TCORNERCURVE=17
348 val SC_MARK_CIRCLEPLUS=18
349 val SC_MARK_CIRCLEPLUSCONNECTED=19
350 val SC_MARK_CIRCLEMINUS=20
351 val SC_MARK_CIRCLEMINUSCONNECTED=21
353 # Invisible mark that only sets the line background colour.
354 val SC_MARK_BACKGROUND=22
355 val SC_MARK_DOTDOTDOT=23
356 val SC_MARK_ARROWS=24
357 val SC_MARK_PIXMAP=25
358 val SC_MARK_FULLRECT=26
359 val SC_MARK_LEFTRECT=27
360 val SC_MARK_AVAILABLE=28
361 val SC_MARK_UNDERLINE=29
362 val SC_MARK_RGBAIMAGE=30
363 val SC_MARK_BOOKMARK=31
364 val SC_MARK_VERTICALBOOKMARK=32
365 val SC_MARK_BAR=33
367 val SC_MARK_CHARACTER=10000
369 ali SC_MARK_ROUNDRECT=ROUND_RECT
370 ali SC_MARK_SMALLRECT=SMALL_RECT
371 ali SC_MARK_SHORTARROW=SHORT_ARROW
372 ali SC_MARK_ARROWDOWN=ARROW_DOWN
373 ali SC_MARK_VLINE=V_LINE
374 ali SC_MARK_LCORNER=L_CORNER
375 ali SC_MARK_TCORNER=T_CORNER
376 ali SC_MARK_BOXPLUS=BOX_PLUS
377 ali SC_MARK_BOXPLUSCONNECTED=BOX_PLUS_CONNECTED
378 ali SC_MARK_BOXMINUS=BOX_MINUS
379 ali SC_MARK_BOXMINUSCONNECTED=BOX_MINUS_CONNECTED
380 ali SC_MARK_LCORNERCURVE=L_CORNER_CURVE
381 ali SC_MARK_TCORNERCURVE=T_CORNER_CURVE
382 ali SC_MARK_CIRCLEPLUS=CIRCLE_PLUS
383 ali SC_MARK_CIRCLEPLUSCONNECTED=CIRCLE_PLUS_CONNECTED
384 ali SC_MARK_CIRCLEMINUS=CIRCLE_MINUS
385 ali SC_MARK_CIRCLEMINUSCONNECTED=CIRCLE_MINUS_CONNECTED
386 ali SC_MARK_DOTDOTDOT=DOT_DOT_DOT
387 ali SC_MARK_FULLRECT=FULL_RECT
388 ali SC_MARK_LEFTRECT=LEFT_RECT
389 ali SC_MARK_RGBAIMAGE=RGBA_IMAGE
390 ali SC_MARK_VERTICALBOOKMARK=VERTICAL_BOOKMARK
392 enu MarkerOutline=SC_MARKNUM_
393 # Markers used for outlining and change history columns.
394 val SC_MARKNUM_HISTORY_REVERTED_TO_ORIGIN=21
395 val SC_MARKNUM_HISTORY_SAVED=22
396 val SC_MARKNUM_HISTORY_MODIFIED=23
397 val SC_MARKNUM_HISTORY_REVERTED_TO_MODIFIED=24
398 val SC_MARKNUM_FOLDEREND=25
399 val SC_MARKNUM_FOLDEROPENMID=26
400 val SC_MARKNUM_FOLDERMIDTAIL=27
401 val SC_MARKNUM_FOLDERTAIL=28
402 val SC_MARKNUM_FOLDERSUB=29
403 val SC_MARKNUM_FOLDER=30
404 val SC_MARKNUM_FOLDEROPEN=31
406 ali SC_MARKNUM_FOLDEREND=FOLDER_END
407 ali SC_MARKNUM_FOLDEROPENMID=FOLDER_OPEN_MID
408 ali SC_MARKNUM_FOLDERMIDTAIL=FOLDER_MID_TAIL
409 ali SC_MARKNUM_FOLDERTAIL=FOLDER_TAIL
410 ali SC_MARKNUM_FOLDERSUB=FOLDER_SUB
411 ali SC_MARKNUM_FOLDEROPEN=FOLDER_OPEN
413 # SC_MASK_FOLDERS doesn't go in an enumeration as larger than max 32-bit positive integer
414 val SC_MASK_FOLDERS=0xFE000000
416 # Set the symbol used for a particular marker number.
417 fun void MarkerDefine=2040(int markerNumber, MarkerSymbol markerSymbol)
419 # Set the foreground colour used for a particular marker number.
420 set void MarkerSetFore=2041(int markerNumber, colour fore)
422 # Set the background colour used for a particular marker number.
423 set void MarkerSetBack=2042(int markerNumber, colour back)
425 # Set the background colour used for a particular marker number when its folding block is selected.
426 set void MarkerSetBackSelected=2292(int markerNumber, colour back)
428 # Set the foreground colour used for a particular marker number.
429 set void MarkerSetForeTranslucent=2294(int markerNumber, colouralpha fore)
431 # Set the background colour used for a particular marker number.
432 set void MarkerSetBackTranslucent=2295(int markerNumber, colouralpha back)
434 # Set the background colour used for a particular marker number when its folding block is selected.
435 set void MarkerSetBackSelectedTranslucent=2296(int markerNumber, colouralpha back)
437 # Set the width of strokes used in .01 pixels so 50  = 1/2 pixel width.
438 set void MarkerSetStrokeWidth=2297(int markerNumber, int hundredths)
440 # Enable/disable highlight for current folding block (smallest one that contains the caret)
441 fun void MarkerEnableHighlight=2293(bool enabled,)
443 # Add a marker to a line, returning an ID which can be used to find or delete the marker.
444 fun int MarkerAdd=2043(line line, int markerNumber)
446 # Delete a marker from a line.
447 fun void MarkerDelete=2044(line line, int markerNumber)
449 # Delete all markers with a particular number from all lines.
450 fun void MarkerDeleteAll=2045(int markerNumber,)
452 # Get a bit mask of all the markers set on a line.
453 fun int MarkerGet=2046(line line,)
455 # Find the next line at or after lineStart that includes a marker in mask.
456 # Return -1 when no more lines.
457 fun line MarkerNext=2047(line lineStart, int markerMask)
459 # Find the previous line before lineStart that includes a marker in mask.
460 fun line MarkerPrevious=2048(line lineStart, int markerMask)
462 # Define a marker from a pixmap.
463 fun void MarkerDefinePixmap=2049(int markerNumber, string pixmap)
465 # Add a set of markers to a line.
466 fun void MarkerAddSet=2466(line line, int markerSet)
468 # Set the alpha used for a marker that is drawn in the text area, not the margin.
469 set void MarkerSetAlpha=2476(int markerNumber, Alpha alpha)
471 # Get the layer used for a marker that is drawn in the text area, not the margin.
472 get Layer MarkerGetLayer=2734(int markerNumber,)
474 # Set the layer used for a marker that is drawn in the text area, not the margin.
475 set void MarkerSetLayer=2735(int markerNumber, Layer layer)
477 val SC_MAX_MARGIN=4
479 enu MarginType=SC_MARGIN_
480 val SC_MARGIN_SYMBOL=0
481 val SC_MARGIN_NUMBER=1
482 val SC_MARGIN_BACK=2
483 val SC_MARGIN_FORE=3
484 val SC_MARGIN_TEXT=4
485 val SC_MARGIN_RTEXT=5
486 val SC_MARGIN_COLOUR=6
488 ali SC_MARGIN_RTEXT=R_TEXT
490 # Set a margin to be either numeric or symbolic.
491 set void SetMarginTypeN=2240(int margin, MarginType marginType)
493 # Retrieve the type of a margin.
494 get MarginType GetMarginTypeN=2241(int margin,)
496 # Set the width of a margin to a width expressed in pixels.
497 set void SetMarginWidthN=2242(int margin, int pixelWidth)
499 # Retrieve the width of a margin in pixels.
500 get int GetMarginWidthN=2243(int margin,)
502 # Set a mask that determines which markers are displayed in a margin.
503 set void SetMarginMaskN=2244(int margin, int mask)
505 # Retrieve the marker mask of a margin.
506 get int GetMarginMaskN=2245(int margin,)
508 # Make a margin sensitive or insensitive to mouse clicks.
509 set void SetMarginSensitiveN=2246(int margin, bool sensitive)
511 # Retrieve the mouse click sensitivity of a margin.
512 get bool GetMarginSensitiveN=2247(int margin,)
514 # Set the cursor shown when the mouse is inside a margin.
515 set void SetMarginCursorN=2248(int margin, CursorShape cursor)
517 # Retrieve the cursor shown in a margin.
518 get CursorShape GetMarginCursorN=2249(int margin,)
520 # Set the background colour of a margin. Only visible for SC_MARGIN_COLOUR.
521 set void SetMarginBackN=2250(int margin, colour back)
523 # Retrieve the background colour of a margin
524 get colour GetMarginBackN=2251(int margin,)
526 # Allocate a non-standard number of margins.
527 set void SetMargins=2252(int margins,)
529 # How many margins are there?.
530 get int GetMargins=2253(,)
532 # Styles in range 32..39 are predefined for parts of the UI and are not used as normal styles.
533 enu StylesCommon=STYLE_
534 val STYLE_DEFAULT=32
535 val STYLE_LINENUMBER=33
536 val STYLE_BRACELIGHT=34
537 val STYLE_BRACEBAD=35
538 val STYLE_CONTROLCHAR=36
539 val STYLE_INDENTGUIDE=37
540 val STYLE_CALLTIP=38
541 val STYLE_FOLDDISPLAYTEXT=39
542 val STYLE_LASTPREDEFINED=39
543 val STYLE_MAX=255
545 ali STYLE_LINENUMBER=LINE_NUMBER
546 ali STYLE_BRACELIGHT=BRACE_LIGHT
547 ali STYLE_BRACEBAD=BRACE_BAD
548 ali STYLE_CONTROLCHAR=CONTROL_CHAR
549 ali STYLE_INDENTGUIDE=INDENT_GUIDE
550 ali STYLE_CALLTIP=CALL_TIP
551 ali STYLE_FOLDDISPLAYTEXT=FOLD_DISPLAY_TEXT
552 ali STYLE_LASTPREDEFINED=LAST_PREDEFINED
554 # Character set identifiers are used in StyleSetCharacterSet.
555 # The values are the same as the Windows *_CHARSET values.
556 enu CharacterSet=SC_CHARSET_
557 val SC_CHARSET_ANSI=0
558 val SC_CHARSET_DEFAULT=1
559 val SC_CHARSET_BALTIC=186
560 val SC_CHARSET_CHINESEBIG5=136
561 val SC_CHARSET_EASTEUROPE=238
562 val SC_CHARSET_GB2312=134
563 val SC_CHARSET_GREEK=161
564 val SC_CHARSET_HANGUL=129
565 val SC_CHARSET_MAC=77
566 val SC_CHARSET_OEM=255
567 val SC_CHARSET_RUSSIAN=204
568 val SC_CHARSET_OEM866=866
569 val SC_CHARSET_CYRILLIC=1251
570 val SC_CHARSET_SHIFTJIS=128
571 val SC_CHARSET_SYMBOL=2
572 val SC_CHARSET_TURKISH=162
573 val SC_CHARSET_JOHAB=130
574 val SC_CHARSET_HEBREW=177
575 val SC_CHARSET_ARABIC=178
576 val SC_CHARSET_VIETNAMESE=163
577 val SC_CHARSET_THAI=222
578 val SC_CHARSET_8859_15=1000
580 ali SC_CHARSET_CHINESEBIG5=CHINESE_BIG5
581 ali SC_CHARSET_EASTEUROPE=EAST_EUROPE
582 ali SC_CHARSET_GB2312=G_B_2312
583 ali SC_CHARSET_OEM866=OEM_866
584 ali SC_CHARSET_SHIFTJIS=SHIFT_JIS
585 ali SC_CHARSET_8859_15=ISO_8859_15
587 # Clear all the styles and make equivalent to the global default style.
588 fun void StyleClearAll=2050(,)
590 # Set the foreground colour of a style.
591 set void StyleSetFore=2051(int style, colour fore)
593 # Set the background colour of a style.
594 set void StyleSetBack=2052(int style, colour back)
596 # Set a style to be bold or not.
597 set void StyleSetBold=2053(int style, bool bold)
599 # Set a style to be italic or not.
600 set void StyleSetItalic=2054(int style, bool italic)
602 # Set the size of characters of a style.
603 set void StyleSetSize=2055(int style, int sizePoints)
605 # Set the font of a style.
606 set void StyleSetFont=2056(int style, string fontName)
608 # Set a style to have its end of line filled or not.
609 set void StyleSetEOLFilled=2057(int style, bool eolFilled)
611 # Reset the default style to its state at startup
612 fun void StyleResetDefault=2058(,)
614 # Set a style to be underlined or not.
615 set void StyleSetUnderline=2059(int style, bool underline)
617 enu CaseVisible=SC_CASE_
618 val SC_CASE_MIXED=0
619 val SC_CASE_UPPER=1
620 val SC_CASE_LOWER=2
621 val SC_CASE_CAMEL=3
623 # Get the foreground colour of a style.
624 get colour StyleGetFore=2481(int style,)
626 # Get the background colour of a style.
627 get colour StyleGetBack=2482(int style,)
629 # Get is a style bold or not.
630 get bool StyleGetBold=2483(int style,)
632 # Get is a style italic or not.
633 get bool StyleGetItalic=2484(int style,)
635 # Get the size of characters of a style.
636 get int StyleGetSize=2485(int style,)
638 # Get the font of a style.
639 # Returns the length of the fontName
640 # Result is NUL-terminated.
641 get int StyleGetFont=2486(int style, stringresult fontName)
643 # Get is a style to have its end of line filled or not.
644 get bool StyleGetEOLFilled=2487(int style,)
646 # Get is a style underlined or not.
647 get bool StyleGetUnderline=2488(int style,)
649 # Get is a style mixed case, or to force upper or lower case.
650 get CaseVisible StyleGetCase=2489(int style,)
652 # Get the character get of the font in a style.
653 get CharacterSet StyleGetCharacterSet=2490(int style,)
655 # Get is a style visible or not.
656 get bool StyleGetVisible=2491(int style,)
658 # Get is a style changeable or not (read only).
659 # Experimental feature, currently buggy.
660 get bool StyleGetChangeable=2492(int style,)
662 # Get is a style a hotspot or not.
663 get bool StyleGetHotSpot=2493(int style,)
665 # Set a style to be mixed case, or to force upper or lower case.
666 set void StyleSetCase=2060(int style, CaseVisible caseVisible)
668 val SC_FONT_SIZE_MULTIPLIER=100
670 # Set the size of characters of a style. Size is in points multiplied by 100.
671 set void StyleSetSizeFractional=2061(int style, int sizeHundredthPoints)
673 # Get the size of characters of a style in points multiplied by 100
674 get int StyleGetSizeFractional=2062(int style,)
676 enu FontWeight=SC_WEIGHT_
677 val SC_WEIGHT_NORMAL=400
678 val SC_WEIGHT_SEMIBOLD=600
679 val SC_WEIGHT_BOLD=700
681 ali SC_WEIGHT_SEMIBOLD=SEMI_BOLD
683 # Set the weight of characters of a style.
684 set void StyleSetWeight=2063(int style, FontWeight weight)
686 # Get the weight of characters of a style.
687 get FontWeight StyleGetWeight=2064(int style,)
689 # Set the character set of the font in a style.
690 set void StyleSetCharacterSet=2066(int style, CharacterSet characterSet)
692 # Set a style to be a hotspot or not.
693 set void StyleSetHotSpot=2409(int style, bool hotspot)
695 # Indicate that a style may be monospaced over ASCII graphics characters which enables optimizations.
696 set void StyleSetCheckMonospaced=2254(int style, bool checkMonospaced)
698 # Get whether a style may be monospaced.
699 get bool StyleGetCheckMonospaced=2255(int style,)
701 # Set the invisible representation for a style.
702 set void StyleSetInvisibleRepresentation=2256(int style, string representation)
704 # Get the invisible representation for a style.
705 get int StyleGetInvisibleRepresentation=2257(int style, stringresult representation)
707 enu Element=SC_ELEMENT_
708 val SC_ELEMENT_LIST=0
709 val SC_ELEMENT_LIST_BACK=1
710 val SC_ELEMENT_LIST_SELECTED=2
711 val SC_ELEMENT_LIST_SELECTED_BACK=3
712 val SC_ELEMENT_SELECTION_TEXT=10
713 val SC_ELEMENT_SELECTION_BACK=11
714 val SC_ELEMENT_SELECTION_ADDITIONAL_TEXT=12
715 val SC_ELEMENT_SELECTION_ADDITIONAL_BACK=13
716 val SC_ELEMENT_SELECTION_SECONDARY_TEXT=14
717 val SC_ELEMENT_SELECTION_SECONDARY_BACK=15
718 val SC_ELEMENT_SELECTION_INACTIVE_TEXT=16
719 val SC_ELEMENT_SELECTION_INACTIVE_BACK=17
720 val SC_ELEMENT_CARET=40
721 val SC_ELEMENT_CARET_ADDITIONAL=41
722 val SC_ELEMENT_CARET_LINE_BACK=50
723 val SC_ELEMENT_WHITE_SPACE=60
724 val SC_ELEMENT_WHITE_SPACE_BACK=61
725 val SC_ELEMENT_HOT_SPOT_ACTIVE=70
726 val SC_ELEMENT_HOT_SPOT_ACTIVE_BACK=71
727 val SC_ELEMENT_FOLD_LINE=80
728 val SC_ELEMENT_HIDDEN_LINE=81
730 # Set the colour of an element. Translucency (alpha) may or may not be significant
731 # and this may depend on the platform. The alpha byte should commonly be 0xff for opaque.
732 set void SetElementColour=2753(Element element, colouralpha colourElement)
734 # Get the colour of an element.
735 get colouralpha GetElementColour=2754(Element element,)
737 # Use the default or platform-defined colour for an element.
738 fun void ResetElementColour=2755(Element element,)
740 # Get whether an element has been set by SetElementColour.
741 # When false, a platform-defined or default colour is used.
742 get bool GetElementIsSet=2756(Element element,)
744 # Get whether an element supports translucency.
745 get bool GetElementAllowsTranslucent=2757(Element element,)
747 # Get the colour of an element.
748 get colouralpha GetElementBaseColour=2758(Element element,)
750 # Set the foreground colour of the main and additional selections and whether to use this setting.
751 fun void SetSelFore=2067(bool useSetting, colour fore)
753 # Set the background colour of the main and additional selections and whether to use this setting.
754 fun void SetSelBack=2068(bool useSetting, colour back)
756 # Get the alpha of the selection.
757 get Alpha GetSelAlpha=2477(,)
759 # Set the alpha of the selection.
760 set void SetSelAlpha=2478(Alpha alpha,)
762 # Is the selection end of line filled?
763 get bool GetSelEOLFilled=2479(,)
765 # Set the selection to have its end of line filled or not.
766 set void SetSelEOLFilled=2480(bool filled,)
768 enu Layer=SC_LAYER_
769 val SC_LAYER_BASE=0
770 val SC_LAYER_UNDER_TEXT=1
771 val SC_LAYER_OVER_TEXT=2
773 # Get the layer for drawing selections
774 get Layer GetSelectionLayer=2762(,)
776 # Set the layer for drawing selections: either opaquely on base layer or translucently over text
777 set void SetSelectionLayer=2763(Layer layer,)
779 # Get the layer of the background of the line containing the caret.
780 get Layer GetCaretLineLayer=2764(,)
782 # Set the layer of the background of the line containing the caret.
783 set void SetCaretLineLayer=2765(Layer layer,)
785 # Get only highlighting subline instead of whole line.
786 get bool GetCaretLineHighlightSubLine=2773(,)
788 # Set only highlighting subline instead of whole line.
789 set void SetCaretLineHighlightSubLine=2774(bool subLine,)
791 # Set the foreground colour of the caret.
792 set void SetCaretFore=2069(colour fore,)
794 # When key+modifier combination keyDefinition is pressed perform sciCommand.
795 fun void AssignCmdKey=2070(keymod keyDefinition, int sciCommand)
797 # When key+modifier combination keyDefinition is pressed do nothing.
798 fun void ClearCmdKey=2071(keymod keyDefinition,)
800 # Drop all key mappings.
801 fun void ClearAllCmdKeys=2072(,)
803 # Set the styles for a segment of the document.
804 fun void SetStylingEx=2073(position length, string styles)
806 # Set a style to be visible or not.
807 set void StyleSetVisible=2074(int style, bool visible)
809 # Get the time in milliseconds that the caret is on and off.
810 get int GetCaretPeriod=2075(,)
812 # Get the time in milliseconds that the caret is on and off. 0 = steady on.
813 set void SetCaretPeriod=2076(int periodMilliseconds,)
815 # Set the set of characters making up words for when moving or selecting by word.
816 # First sets defaults like SetCharsDefault.
817 set void SetWordChars=2077(, string characters)
819 # Get the set of characters making up words for when moving or selecting by word.
820 # Returns the number of characters
821 get int GetWordChars=2646(, stringresult characters)
823 # Set the number of characters to have directly indexed categories
824 set void SetCharacterCategoryOptimization=2720(int countCharacters,)
826 # Get the number of characters to have directly indexed categories
827 get int GetCharacterCategoryOptimization=2721(,)
829 # Start a sequence of actions that is undone and redone as a unit.
830 # May be nested.
831 fun void BeginUndoAction=2078(,)
833 # End a sequence of actions that is undone and redone as a unit.
834 fun void EndUndoAction=2079(,)
836 # Indicator style enumeration and some constants
837 enu IndicatorStyle=INDIC_
838 val INDIC_PLAIN=0
839 val INDIC_SQUIGGLE=1
840 val INDIC_TT=2
841 val INDIC_DIAGONAL=3
842 val INDIC_STRIKE=4
843 val INDIC_HIDDEN=5
844 val INDIC_BOX=6
845 val INDIC_ROUNDBOX=7
846 val INDIC_STRAIGHTBOX=8
847 val INDIC_DASH=9
848 val INDIC_DOTS=10
849 val INDIC_SQUIGGLELOW=11
850 val INDIC_DOTBOX=12
851 val INDIC_SQUIGGLEPIXMAP=13
852 val INDIC_COMPOSITIONTHICK=14
853 val INDIC_COMPOSITIONTHIN=15
854 val INDIC_FULLBOX=16
855 val INDIC_TEXTFORE=17
856 val INDIC_POINT=18
857 val INDIC_POINTCHARACTER=19
858 val INDIC_GRADIENT=20
859 val INDIC_GRADIENTCENTRE=21
860 val INDIC_POINT_TOP=22
862 # INDIC_CONTAINER, INDIC_IME, INDIC_IME_MAX, and INDIC_MAX are indicator numbers,
863 # not IndicatorStyles so should not really be in the INDIC_ enumeration.
864 # They are redeclared in IndicatorNumbers INDICATOR_.
865 val INDIC_CONTAINER=8
866 val INDIC_IME=32
867 val INDIC_IME_MAX=35
868 val INDIC_MAX=35
870 enu IndicatorNumbers=INDICATOR_
871 val INDICATOR_CONTAINER=8
872 val INDICATOR_IME=32
873 val INDICATOR_IME_MAX=35
874 val INDICATOR_HISTORY_REVERTED_TO_ORIGIN_INSERTION=36
875 val INDICATOR_HISTORY_REVERTED_TO_ORIGIN_DELETION=37
876 val INDICATOR_HISTORY_SAVED_INSERTION=38
877 val INDICATOR_HISTORY_SAVED_DELETION=39
878 val INDICATOR_HISTORY_MODIFIED_INSERTION=40
879 val INDICATOR_HISTORY_MODIFIED_DELETION=41
880 val INDICATOR_HISTORY_REVERTED_TO_MODIFIED_INSERTION=42
881 val INDICATOR_HISTORY_REVERTED_TO_MODIFIED_DELETION=43
882 val INDICATOR_MAX=43
884 ali INDIC_TT=T_T
885 ali INDIC_ROUNDBOX=ROUND_BOX
886 ali INDIC_STRAIGHTBOX=STRAIGHT_BOX
887 ali INDIC_SQUIGGLELOW=SQUIGGLE_LOW
888 ali INDIC_DOTBOX=DOT_BOX
889 ali INDIC_SQUIGGLEPIXMAP=SQUIGGLE_PIXMAP
890 ali INDIC_COMPOSITIONTHICK=COMPOSITION_THICK
891 ali INDIC_COMPOSITIONTHIN=COMPOSITION_THIN
892 ali INDIC_FULLBOX=FULL_BOX
893 ali INDIC_TEXTFORE=TEXT_FORE
894 ali INDIC_POINTCHARACTER=POINT_CHARACTER
895 ali INDIC_GRADIENTCENTRE=GRADIENT_CENTRE
897 # Set an indicator to plain, squiggle or TT.
898 set void IndicSetStyle=2080(int indicator, IndicatorStyle indicatorStyle)
900 # Retrieve the style of an indicator.
901 get IndicatorStyle IndicGetStyle=2081(int indicator,)
903 # Set the foreground colour of an indicator.
904 set void IndicSetFore=2082(int indicator, colour fore)
906 # Retrieve the foreground colour of an indicator.
907 get colour IndicGetFore=2083(int indicator,)
909 # Set an indicator to draw under text or over(default).
910 set void IndicSetUnder=2510(int indicator, bool under)
912 # Retrieve whether indicator drawn under or over text.
913 get bool IndicGetUnder=2511(int indicator,)
915 # Set a hover indicator to plain, squiggle or TT.
916 set void IndicSetHoverStyle=2680(int indicator, IndicatorStyle indicatorStyle)
918 # Retrieve the hover style of an indicator.
919 get IndicatorStyle IndicGetHoverStyle=2681(int indicator,)
921 # Set the foreground hover colour of an indicator.
922 set void IndicSetHoverFore=2682(int indicator, colour fore)
924 # Retrieve the foreground hover colour of an indicator.
925 get colour IndicGetHoverFore=2683(int indicator,)
927 enu IndicValue=SC_INDICVALUE
928 val SC_INDICVALUEBIT=0x1000000
929 val SC_INDICVALUEMASK=0xFFFFFF
931 enu IndicFlag=SC_INDICFLAG_
932 val SC_INDICFLAG_NONE=0
933 val SC_INDICFLAG_VALUEFORE=1
935 ali SC_INDICFLAG_VALUEFORE=VALUE_FORE
937 # Set the attributes of an indicator.
938 set void IndicSetFlags=2684(int indicator, IndicFlag flags)
940 # Retrieve the attributes of an indicator.
941 get IndicFlag IndicGetFlags=2685(int indicator,)
943 # Set the stroke width of an indicator in hundredths of a pixel.
944 set void IndicSetStrokeWidth=2751(int indicator, int hundredths)
946 # Retrieve the stroke width of an indicator.
947 get int IndicGetStrokeWidth=2752(int indicator,)
949 # Set the foreground colour of all whitespace and whether to use this setting.
950 fun void SetWhitespaceFore=2084(bool useSetting, colour fore)
952 # Set the background colour of all whitespace and whether to use this setting.
953 fun void SetWhitespaceBack=2085(bool useSetting, colour back)
955 # Set the size of the dots used to mark space characters.
956 set void SetWhitespaceSize=2086(int size,)
958 # Get the size of the dots used to mark space characters.
959 get int GetWhitespaceSize=2087(,)
961 # Used to hold extra styling information for each line.
962 set void SetLineState=2092(line line, int state)
964 # Retrieve the extra styling information for a line.
965 get int GetLineState=2093(line line,)
967 # Retrieve the last line number that has line state.
968 get int GetMaxLineState=2094(,)
970 # Is the background of the line containing the caret in a different colour?
971 get bool GetCaretLineVisible=2095(,)
973 # Display the background of the line containing the caret in a different colour.
974 set void SetCaretLineVisible=2096(bool show,)
976 # Get the colour of the background of the line containing the caret.
977 get colour GetCaretLineBack=2097(,)
979 # Set the colour of the background of the line containing the caret.
980 set void SetCaretLineBack=2098(colour back,)
982 # Retrieve the caret line frame width.
983 # Width = 0 means this option is disabled.
984 get int GetCaretLineFrame=2704(,)
986 # Display the caret line framed.
987 # Set width != 0 to enable this option and width = 0 to disable it.
988 set void SetCaretLineFrame=2705(int width,)
990 # Set a style to be changeable or not (read only).
991 # Experimental feature, currently buggy.
992 set void StyleSetChangeable=2099(int style, bool changeable)
994 # Display a auto-completion list.
995 # The lengthEntered parameter indicates how many characters before
996 # the caret should be used to provide context.
997 fun void AutoCShow=2100(position lengthEntered, string itemList)
999 # Remove the auto-completion list from the screen.
1000 fun void AutoCCancel=2101(,)
1002 # Is there an auto-completion list visible?
1003 fun bool AutoCActive=2102(,)
1005 # Retrieve the position of the caret when the auto-completion list was displayed.
1006 fun position AutoCPosStart=2103(,)
1008 # User has selected an item so remove the list and insert the selection.
1009 fun void AutoCComplete=2104(,)
1011 # Define a set of character that when typed cancel the auto-completion list.
1012 fun void AutoCStops=2105(, string characterSet)
1014 # Change the separator character in the string setting up an auto-completion list.
1015 # Default is space but can be changed if items contain space.
1016 set void AutoCSetSeparator=2106(int separatorCharacter,)
1018 # Retrieve the auto-completion list separator character.
1019 get int AutoCGetSeparator=2107(,)
1021 # Select the item in the auto-completion list that starts with a string.
1022 fun void AutoCSelect=2108(, string select)
1024 # Should the auto-completion list be cancelled if the user backspaces to a
1025 # position before where the box was created.
1026 set void AutoCSetCancelAtStart=2110(bool cancel,)
1028 # Retrieve whether auto-completion cancelled by backspacing before start.
1029 get bool AutoCGetCancelAtStart=2111(,)
1031 # Define a set of characters that when typed will cause the autocompletion to
1032 # choose the selected item.
1033 set void AutoCSetFillUps=2112(, string characterSet)
1035 # Should a single item auto-completion list automatically choose the item.
1036 set void AutoCSetChooseSingle=2113(bool chooseSingle,)
1038 # Retrieve whether a single item auto-completion list automatically choose the item.
1039 get bool AutoCGetChooseSingle=2114(,)
1041 # Set whether case is significant when performing auto-completion searches.
1042 set void AutoCSetIgnoreCase=2115(bool ignoreCase,)
1044 # Retrieve state of ignore case flag.
1045 get bool AutoCGetIgnoreCase=2116(,)
1047 # Display a list of strings and send notification when user chooses one.
1048 fun void UserListShow=2117(int listType, string itemList)
1050 # Set whether or not autocompletion is hidden automatically when nothing matches.
1051 set void AutoCSetAutoHide=2118(bool autoHide,)
1053 # Retrieve whether or not autocompletion is hidden automatically when nothing matches.
1054 get bool AutoCGetAutoHide=2119(,)
1056 # Define option flags for autocompletion lists
1057 enu AutoCompleteOption=SC_AUTOCOMPLETE_
1058 val SC_AUTOCOMPLETE_NORMAL=0
1059 # Win32 specific:
1060 val SC_AUTOCOMPLETE_FIXED_SIZE=1
1062 # Set autocompletion options.
1063 set void AutoCSetOptions=2638(AutoCompleteOption options,)
1065 # Retrieve autocompletion options.
1066 get AutoCompleteOption AutoCGetOptions=2639(,)
1068 # Set whether or not autocompletion deletes any word characters
1069 # after the inserted text upon completion.
1070 set void AutoCSetDropRestOfWord=2270(bool dropRestOfWord,)
1072 # Retrieve whether or not autocompletion deletes any word characters
1073 # after the inserted text upon completion.
1074 get bool AutoCGetDropRestOfWord=2271(,)
1076 # Register an XPM image for use in autocompletion lists.
1077 fun void RegisterImage=2405(int type, string xpmData)
1079 # Clear all the registered XPM images.
1080 fun void ClearRegisteredImages=2408(,)
1082 # Retrieve the auto-completion list type-separator character.
1083 get int AutoCGetTypeSeparator=2285(,)
1085 # Change the type-separator character in the string setting up an auto-completion list.
1086 # Default is '?' but can be changed if items contain '?'.
1087 set void AutoCSetTypeSeparator=2286(int separatorCharacter,)
1089 # Set the maximum width, in characters, of auto-completion and user lists.
1090 # Set to 0 to autosize to fit longest item, which is the default.
1091 set void AutoCSetMaxWidth=2208(int characterCount,)
1093 # Get the maximum width, in characters, of auto-completion and user lists.
1094 get int AutoCGetMaxWidth=2209(,)
1096 # Set the maximum height, in rows, of auto-completion and user lists.
1097 # The default is 5 rows.
1098 set void AutoCSetMaxHeight=2210(int rowCount,)
1100 # Set the maximum height, in rows, of auto-completion and user lists.
1101 get int AutoCGetMaxHeight=2211(,)
1103 # Set the number of spaces used for one level of indentation.
1104 set void SetIndent=2122(int indentSize,)
1106 # Retrieve indentation size.
1107 get int GetIndent=2123(,)
1109 # Indentation will only use space characters if useTabs is false, otherwise
1110 # it will use a combination of tabs and spaces.
1111 set void SetUseTabs=2124(bool useTabs,)
1113 # Retrieve whether tabs will be used in indentation.
1114 get bool GetUseTabs=2125(,)
1116 # Change the indentation of a line to a number of columns.
1117 set void SetLineIndentation=2126(line line, int indentation)
1119 # Retrieve the number of columns that a line is indented.
1120 get int GetLineIndentation=2127(line line,)
1122 # Retrieve the position before the first non indentation character on a line.
1123 get position GetLineIndentPosition=2128(line line,)
1125 # Retrieve the column number of a position, taking tab width into account.
1126 get position GetColumn=2129(position pos,)
1128 # Count characters between two positions.
1129 fun position CountCharacters=2633(position start, position end)
1131 # Count code units between two positions.
1132 fun position CountCodeUnits=2715(position start, position end)
1134 # Show or hide the horizontal scroll bar.
1135 set void SetHScrollBar=2130(bool visible,)
1136 # Is the horizontal scroll bar visible?
1137 get bool GetHScrollBar=2131(,)
1139 enu IndentView=SC_IV_
1140 val SC_IV_NONE=0
1141 val SC_IV_REAL=1
1142 val SC_IV_LOOKFORWARD=2
1143 val SC_IV_LOOKBOTH=3
1145 ali SC_IV_LOOKFORWARD=LOOK_FORWARD
1146 ali SC_IV_LOOKBOTH=LOOK_BOTH
1148 # Show or hide indentation guides.
1149 set void SetIndentationGuides=2132(IndentView indentView,)
1151 # Are the indentation guides visible?
1152 get IndentView GetIndentationGuides=2133(,)
1154 # Set the highlighted indentation guide column.
1155 # 0 = no highlighted guide.
1156 set void SetHighlightGuide=2134(position column,)
1158 # Get the highlighted indentation guide column.
1159 get position GetHighlightGuide=2135(,)
1161 # Get the position after the last visible characters on a line.
1162 get position GetLineEndPosition=2136(line line,)
1164 # Get the code page used to interpret the bytes of the document as characters.
1165 get int GetCodePage=2137(,)
1167 # Get the foreground colour of the caret.
1168 get colour GetCaretFore=2138(,)
1170 # In read-only mode?
1171 get bool GetReadOnly=2140(,)
1173 # Sets the position of the caret.
1174 set void SetCurrentPos=2141(position caret,)
1176 # Sets the position that starts the selection - this becomes the anchor.
1177 set void SetSelectionStart=2142(position anchor,)
1179 # Returns the position at the start of the selection.
1180 get position GetSelectionStart=2143(,)
1182 # Sets the position that ends the selection - this becomes the caret.
1183 set void SetSelectionEnd=2144(position caret,)
1185 # Returns the position at the end of the selection.
1186 get position GetSelectionEnd=2145(,)
1188 # Set caret to a position, while removing any existing selection.
1189 fun void SetEmptySelection=2556(position caret,)
1191 # Sets the print magnification added to the point size of each style for printing.
1192 set void SetPrintMagnification=2146(int magnification,)
1194 # Returns the print magnification.
1195 get int GetPrintMagnification=2147(,)
1197 enu PrintOption=SC_PRINT_
1198 # PrintColourMode - use same colours as screen.
1199 # with the exception of line number margins, which use a white background
1200 val SC_PRINT_NORMAL=0
1201 # PrintColourMode - invert the light value of each style for printing.
1202 val SC_PRINT_INVERTLIGHT=1
1203 # PrintColourMode - force black text on white background for printing.
1204 val SC_PRINT_BLACKONWHITE=2
1205 # PrintColourMode - text stays coloured, but all background is forced to be white for printing.
1206 val SC_PRINT_COLOURONWHITE=3
1207 # PrintColourMode - only the default-background is forced to be white for printing.
1208 val SC_PRINT_COLOURONWHITEDEFAULTBG=4
1209 # PrintColourMode - use same colours as screen, including line number margins.
1210 val SC_PRINT_SCREENCOLOURS=5
1212 ali SC_PRINT_INVERTLIGHT=INVERT_LIGHT
1213 ali SC_PRINT_BLACKONWHITE=BLACK_ON_WHITE
1214 ali SC_PRINT_COLOURONWHITE=COLOUR_ON_WHITE
1215 ali SC_PRINT_COLOURONWHITEDEFAULTBG=COLOUR_ON_WHITE_DEFAULT_B_G
1216 ali SC_PRINT_SCREENCOLOURS=SCREEN_COLOURS
1218 # Modify colours when printing for clearer printed text.
1219 set void SetPrintColourMode=2148(PrintOption mode,)
1221 # Returns the print colour mode.
1222 get PrintOption GetPrintColourMode=2149(,)
1224 enu FindOption=SCFIND_
1225 val SCFIND_NONE=0x0
1226 val SCFIND_WHOLEWORD=0x2
1227 val SCFIND_MATCHCASE=0x4
1228 val SCFIND_WORDSTART=0x00100000
1229 val SCFIND_REGEXP=0x00200000
1230 val SCFIND_POSIX=0x00400000
1231 val SCFIND_CXX11REGEX=0x00800000
1233 ali SCFIND_WHOLEWORD=WHOLE_WORD
1234 ali SCFIND_MATCHCASE=MATCH_CASE
1235 ali SCFIND_WORDSTART=WORD_START
1236 ali SCFIND_REGEXP=REG_EXP
1237 ali SCFIND_CXX11REGEX=CXX11_REG_EX
1239 # Find some text in the document.
1240 fun position FindText=2150(FindOption searchFlags, findtext ft)
1242 # Find some text in the document.
1243 fun position FindTextFull=2196(FindOption searchFlags, findtextfull ft)
1245 # Draw the document into a display context such as a printer.
1246 fun position FormatRange=2151(bool draw, formatrange fr)
1248 # Draw the document into a display context such as a printer.
1249 fun position FormatRangeFull=2777(bool draw, formatrangefull fr)
1251 enu ChangeHistoryOption=SC_CHANGE_HISTORY_
1252 val SC_CHANGE_HISTORY_DISABLED=0
1253 val SC_CHANGE_HISTORY_ENABLED=1
1254 val SC_CHANGE_HISTORY_MARKERS=2
1255 val SC_CHANGE_HISTORY_INDICATORS=4
1257 # Enable or disable change history.
1258 set void SetChangeHistory=2780(ChangeHistoryOption changeHistory,)
1260 # Report change history status.
1261 get ChangeHistoryOption GetChangeHistory=2781(,)
1263 # Retrieve the display line at the top of the display.
1264 get line GetFirstVisibleLine=2152(,)
1266 # Retrieve the contents of a line.
1267 # Returns the length of the line.
1268 fun position GetLine=2153(line line, stringresult text)
1270 # Returns the number of lines in the document. There is always at least one.
1271 get line GetLineCount=2154(,)
1273 # Enlarge the number of lines allocated.
1274 set void AllocateLines=2089(line lines,)
1276 # Sets the size in pixels of the left margin.
1277 set void SetMarginLeft=2155(, int pixelWidth)
1279 # Returns the size in pixels of the left margin.
1280 get int GetMarginLeft=2156(,)
1282 # Sets the size in pixels of the right margin.
1283 set void SetMarginRight=2157(, int pixelWidth)
1285 # Returns the size in pixels of the right margin.
1286 get int GetMarginRight=2158(,)
1288 # Is the document different from when it was last saved?
1289 get bool GetModify=2159(,)
1291 # Select a range of text.
1292 fun void SetSel=2160(position anchor, position caret)
1294 # Retrieve the selected text.
1295 # Return the length of the text.
1296 # Result is NUL-terminated.
1297 fun position GetSelText=2161(, stringresult text)
1299 # Retrieve a range of text.
1300 # Return the length of the text.
1301 fun position GetTextRange=2162(, textrange tr)
1303 # Retrieve a range of text that can be past 2GB.
1304 # Return the length of the text.
1305 fun position GetTextRangeFull=2039(, textrangefull tr)
1307 # Draw the selection either highlighted or in normal (non-highlighted) style.
1308 fun void HideSelection=2163(bool hide,)
1310 #Is the selection visible or hidden?
1311 get bool GetSelectionHidden=2088(,)
1313 # Retrieve the x value of the point in the window where a position is displayed.
1314 fun int PointXFromPosition=2164(, position pos)
1316 # Retrieve the y value of the point in the window where a position is displayed.
1317 fun int PointYFromPosition=2165(, position pos)
1319 # Retrieve the line containing a position.
1320 fun line LineFromPosition=2166(position pos,)
1322 # Retrieve the position at the start of a line.
1323 fun position PositionFromLine=2167(line line,)
1325 # Scroll horizontally and vertically.
1326 fun void LineScroll=2168(position columns, line lines)
1328 # Ensure the caret is visible.
1329 fun void ScrollCaret=2169(,)
1331 # Scroll the argument positions and the range between them into view giving
1332 # priority to the primary position then the secondary position.
1333 # This may be used to make a search match visible.
1334 fun void ScrollRange=2569(position secondary, position primary)
1336 # Replace the selected text with the argument text.
1337 fun void ReplaceSel=2170(, string text)
1339 # Set to read only or read write.
1340 set void SetReadOnly=2171(bool readOnly,)
1342 # Null operation.
1343 fun void Null=2172(,)
1345 # Will a paste succeed?
1346 fun bool CanPaste=2173(,)
1348 # Are there any undoable actions in the undo history?
1349 fun bool CanUndo=2174(,)
1351 # Delete the undo history.
1352 fun void EmptyUndoBuffer=2175(,)
1354 # Undo one action in the undo history.
1355 fun void Undo=2176(,)
1357 # Cut the selection to the clipboard.
1358 fun void Cut=2177(,)
1360 # Copy the selection to the clipboard.
1361 fun void Copy=2178(,)
1363 # Paste the contents of the clipboard into the document replacing the selection.
1364 fun void Paste=2179(,)
1366 # Clear the selection.
1367 fun void Clear=2180(,)
1369 # Replace the contents of the document with the argument text.
1370 fun void SetText=2181(, string text)
1372 # Retrieve all the text in the document.
1373 # Returns number of characters retrieved.
1374 # Result is NUL-terminated.
1375 fun position GetText=2182(position length, stringresult text)
1377 # Retrieve the number of characters in the document.
1378 get position GetTextLength=2183(,)
1380 # Retrieve a pointer to a function that processes messages for this Scintilla.
1381 get pointer GetDirectFunction=2184(,)
1383 # Retrieve a pointer to a function that processes messages for this Scintilla and returns status.
1384 get pointer GetDirectStatusFunction=2772(,)
1386 # Retrieve a pointer value to use as the first argument when calling
1387 # the function returned by GetDirectFunction.
1388 get pointer GetDirectPointer=2185(,)
1390 # Set to overtype (true) or insert mode.
1391 set void SetOvertype=2186(bool overType,)
1393 # Returns true if overtype mode is active otherwise false is returned.
1394 get bool GetOvertype=2187(,)
1396 # Set the width of the insert mode caret.
1397 set void SetCaretWidth=2188(int pixelWidth,)
1399 # Returns the width of the insert mode caret.
1400 get int GetCaretWidth=2189(,)
1402 # Sets the position that starts the target which is used for updating the
1403 # document without affecting the scroll position.
1404 set void SetTargetStart=2190(position start,)
1406 # Get the position that starts the target.
1407 get position GetTargetStart=2191(,)
1409 # Sets the virtual space of the target start
1410 set void SetTargetStartVirtualSpace=2728(position space,)
1412 # Get the virtual space of the target start
1413 get position GetTargetStartVirtualSpace=2729(,)
1415 # Sets the position that ends the target which is used for updating the
1416 # document without affecting the scroll position.
1417 set void SetTargetEnd=2192(position end,)
1419 # Get the position that ends the target.
1420 get position GetTargetEnd=2193(,)
1422 # Sets the virtual space of the target end
1423 set void SetTargetEndVirtualSpace=2730(position space,)
1425 # Get the virtual space of the target end
1426 get position GetTargetEndVirtualSpace=2731(,)
1428 # Sets both the start and end of the target in one call.
1429 fun void SetTargetRange=2686(position start, position end)
1431 # Retrieve the text in the target.
1432 get position GetTargetText=2687(, stringresult text)
1434 # Make the target range start and end be the same as the selection range start and end.
1435 fun void TargetFromSelection=2287(,)
1437 # Sets the target to the whole document.
1438 fun void TargetWholeDocument=2690(,)
1440 # Replace the target text with the argument text.
1441 # Text is counted so it can contain NULs.
1442 # Returns the length of the replacement text.
1443 fun position ReplaceTarget=2194(position length, string text)
1445 # Replace the target text with the argument text after \d processing.
1446 # Text is counted so it can contain NULs.
1447 # Looks for \d where d is between 1 and 9 and replaces these with the strings
1448 # matched in the last search operation which were surrounded by \( and \).
1449 # Returns the length of the replacement text including any change
1450 # caused by processing the \d patterns.
1451 fun position ReplaceTargetRE=2195(position length, string text)
1453 # Replace the target text with the argument text but ignore prefix and suffix that
1454 # are the same as current.
1455 fun position ReplaceTargetMinimal=2779(position length, string text)
1457 # Search for a counted string in the target and set the target to the found
1458 # range. Text is counted so it can contain NULs.
1459 # Returns start of found range or -1 for failure in which case target is not moved.
1460 fun position SearchInTarget=2197(position length, string text)
1462 # Set the search flags used by SearchInTarget.
1463 set void SetSearchFlags=2198(FindOption searchFlags,)
1465 # Get the search flags used by SearchInTarget.
1466 get FindOption GetSearchFlags=2199(,)
1468 # Show a call tip containing a definition near position pos.
1469 fun void CallTipShow=2200(position pos, string definition)
1471 # Remove the call tip from the screen.
1472 fun void CallTipCancel=2201(,)
1474 # Is there an active call tip?
1475 fun bool CallTipActive=2202(,)
1477 # Retrieve the position where the caret was before displaying the call tip.
1478 fun position CallTipPosStart=2203(,)
1480 # Set the start position in order to change when backspacing removes the calltip.
1481 set void CallTipSetPosStart=2214(position posStart,)
1483 # Highlight a segment of the definition.
1484 fun void CallTipSetHlt=2204(position highlightStart, position highlightEnd)
1486 # Set the background colour for the call tip.
1487 set void CallTipSetBack=2205(colour back,)
1489 # Set the foreground colour for the call tip.
1490 set void CallTipSetFore=2206(colour fore,)
1492 # Set the foreground colour for the highlighted part of the call tip.
1493 set void CallTipSetForeHlt=2207(colour fore,)
1495 # Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
1496 set void CallTipUseStyle=2212(int tabSize,)
1498 # Set position of calltip, above or below text.
1499 set void CallTipSetPosition=2213(bool above,)
1501 # Find the display line of a document line taking hidden lines into account.
1502 fun line VisibleFromDocLine=2220(line docLine,)
1504 # Find the document line of a display line taking hidden lines into account.
1505 fun line DocLineFromVisible=2221(line displayLine,)
1507 # The number of display lines needed to wrap a document line
1508 fun line WrapCount=2235(line docLine,)
1510 enu FoldLevel=SC_FOLDLEVEL
1511 val SC_FOLDLEVELNONE=0x0
1512 val SC_FOLDLEVELBASE=0x400
1513 val SC_FOLDLEVELWHITEFLAG=0x1000
1514 val SC_FOLDLEVELHEADERFLAG=0x2000
1515 val SC_FOLDLEVELNUMBERMASK=0x0FFF
1517 ali SC_FOLDLEVELWHITEFLAG=WHITE_FLAG
1518 ali SC_FOLDLEVELHEADERFLAG=HEADER_FLAG
1519 ali SC_FOLDLEVELNUMBERMASK=NUMBER_MASK
1521 # Set the fold level of a line.
1522 # This encodes an integer level along with flags indicating whether the
1523 # line is a header and whether it is effectively white space.
1524 set void SetFoldLevel=2222(line line, FoldLevel level)
1526 # Retrieve the fold level of a line.
1527 get FoldLevel GetFoldLevel=2223(line line,)
1529 # Find the last child line of a header line.
1530 get line GetLastChild=2224(line line, FoldLevel level)
1532 # Find the parent line of a child line.
1533 get line GetFoldParent=2225(line line,)
1535 # Make a range of lines visible.
1536 fun void ShowLines=2226(line lineStart, line lineEnd)
1538 # Make a range of lines invisible.
1539 fun void HideLines=2227(line lineStart, line lineEnd)
1541 # Is a line visible?
1542 get bool GetLineVisible=2228(line line,)
1544 # Are all lines visible?
1545 get bool GetAllLinesVisible=2236(,)
1547 # Show the children of a header line.
1548 set void SetFoldExpanded=2229(line line, bool expanded)
1550 # Is a header line expanded?
1551 get bool GetFoldExpanded=2230(line line,)
1553 # Switch a header line between expanded and contracted.
1554 fun void ToggleFold=2231(line line,)
1556 # Switch a header line between expanded and contracted and show some text after the line.
1557 fun void ToggleFoldShowText=2700(line line, string text)
1559 enu FoldDisplayTextStyle=SC_FOLDDISPLAYTEXT_
1560 val SC_FOLDDISPLAYTEXT_HIDDEN=0
1561 val SC_FOLDDISPLAYTEXT_STANDARD=1
1562 val SC_FOLDDISPLAYTEXT_BOXED=2
1564 # Set the style of fold display text.
1565 set void FoldDisplayTextSetStyle=2701(FoldDisplayTextStyle style,)
1567 # Get the style of fold display text.
1568 get FoldDisplayTextStyle FoldDisplayTextGetStyle=2707(,)
1570 # Set the default fold display text.
1571 fun void SetDefaultFoldDisplayText=2722(, string text)
1573 # Get the default fold display text.
1574 fun int GetDefaultFoldDisplayText=2723(, stringresult text)
1576 enu FoldAction=SC_FOLDACTION_
1577 val SC_FOLDACTION_CONTRACT=0
1578 val SC_FOLDACTION_EXPAND=1
1579 val SC_FOLDACTION_TOGGLE=2
1580 val SC_FOLDACTION_CONTRACT_EVERY_LEVEL=4
1582 # Expand or contract a fold header.
1583 fun void FoldLine=2237(line line, FoldAction action)
1585 # Expand or contract a fold header and its children.
1586 fun void FoldChildren=2238(line line, FoldAction action)
1588 # Expand a fold header and all children. Use the level argument instead of the line's current level.
1589 fun void ExpandChildren=2239(line line, FoldLevel level)
1591 # Expand or contract all fold headers.
1592 fun void FoldAll=2662(FoldAction action,)
1594 # Ensure a particular line is visible by expanding any header line hiding it.
1595 fun void EnsureVisible=2232(line line,)
1597 enu AutomaticFold=SC_AUTOMATICFOLD_
1598 val SC_AUTOMATICFOLD_NONE=0x0000
1599 val SC_AUTOMATICFOLD_SHOW=0x0001
1600 val SC_AUTOMATICFOLD_CLICK=0x0002
1601 val SC_AUTOMATICFOLD_CHANGE=0x0004
1603 # Set automatic folding behaviours.
1604 set void SetAutomaticFold=2663(AutomaticFold automaticFold,)
1606 # Get automatic folding behaviours.
1607 get AutomaticFold GetAutomaticFold=2664(,)
1609 enu FoldFlag=SC_FOLDFLAG_
1610 val SC_FOLDFLAG_NONE=0x0000
1611 val SC_FOLDFLAG_LINEBEFORE_EXPANDED=0x0002
1612 val SC_FOLDFLAG_LINEBEFORE_CONTRACTED=0x0004
1613 val SC_FOLDFLAG_LINEAFTER_EXPANDED=0x0008
1614 val SC_FOLDFLAG_LINEAFTER_CONTRACTED=0x0010
1615 val SC_FOLDFLAG_LEVELNUMBERS=0x0040
1616 val SC_FOLDFLAG_LINESTATE=0x0080
1618 ali SC_FOLDFLAG_LINEBEFORE_EXPANDED=LINE_BEFORE_EXPANDED
1619 ali SC_FOLDFLAG_LINEBEFORE_CONTRACTED=LINE_BEFORE_CONTRACTED
1620 ali SC_FOLDFLAG_LINEAFTER_EXPANDED=LINE_AFTER_EXPANDED
1621 ali SC_FOLDFLAG_LINEAFTER_CONTRACTED=LINE_AFTER_CONTRACTED
1622 ali SC_FOLDFLAG_LEVELNUMBERS=LEVEL_NUMBERS
1623 ali SC_FOLDFLAG_LINESTATE=LINE_STATE
1625 # Set some style options for folding.
1626 set void SetFoldFlags=2233(FoldFlag flags,)
1628 # Ensure a particular line is visible by expanding any header line hiding it.
1629 # Use the currently set visibility policy to determine which range to display.
1630 fun void EnsureVisibleEnforcePolicy=2234(line line,)
1632 # Sets whether a tab pressed when caret is within indentation indents.
1633 set void SetTabIndents=2260(bool tabIndents,)
1635 # Does a tab pressed when caret is within indentation indent?
1636 get bool GetTabIndents=2261(,)
1638 # Sets whether a backspace pressed when caret is within indentation unindents.
1639 set void SetBackSpaceUnIndents=2262(bool bsUnIndents,)
1641 # Does a backspace pressed when caret is within indentation unindent?
1642 get bool GetBackSpaceUnIndents=2263(,)
1644 val SC_TIME_FOREVER=10000000
1646 # Sets the time the mouse must sit still to generate a mouse dwell event.
1647 set void SetMouseDwellTime=2264(int periodMilliseconds,)
1649 # Retrieve the time the mouse must sit still to generate a mouse dwell event.
1650 get int GetMouseDwellTime=2265(,)
1652 # Get position of start of word.
1653 fun position WordStartPosition=2266(position pos, bool onlyWordCharacters)
1655 # Get position of end of word.
1656 fun position WordEndPosition=2267(position pos, bool onlyWordCharacters)
1658 # Is the range start..end considered a word?
1659 fun bool IsRangeWord=2691(position start, position end)
1661 enu IdleStyling=SC_IDLESTYLING_
1662 val SC_IDLESTYLING_NONE=0
1663 val SC_IDLESTYLING_TOVISIBLE=1
1664 val SC_IDLESTYLING_AFTERVISIBLE=2
1665 val SC_IDLESTYLING_ALL=3
1667 ali SC_IDLESTYLING_TOVISIBLE=TO_VISIBLE
1668 ali SC_IDLESTYLING_AFTERVISIBLE=AFTER_VISIBLE
1670 # Sets limits to idle styling.
1671 set void SetIdleStyling=2692(IdleStyling idleStyling,)
1673 # Retrieve the limits to idle styling.
1674 get IdleStyling GetIdleStyling=2693(,)
1676 enu Wrap=SC_WRAP_
1677 val SC_WRAP_NONE=0
1678 val SC_WRAP_WORD=1
1679 val SC_WRAP_CHAR=2
1680 val SC_WRAP_WHITESPACE=3
1682 ali SC_WRAP_WHITESPACE=WHITE_SPACE
1684 # Sets whether text is word wrapped.
1685 set void SetWrapMode=2268(Wrap wrapMode,)
1687 # Retrieve whether text is word wrapped.
1688 get Wrap GetWrapMode=2269(,)
1690 enu WrapVisualFlag=SC_WRAPVISUALFLAG_
1691 val SC_WRAPVISUALFLAG_NONE=0x0000
1692 val SC_WRAPVISUALFLAG_END=0x0001
1693 val SC_WRAPVISUALFLAG_START=0x0002
1694 val SC_WRAPVISUALFLAG_MARGIN=0x0004
1696 # Set the display mode of visual flags for wrapped lines.
1697 set void SetWrapVisualFlags=2460(WrapVisualFlag wrapVisualFlags,)
1699 # Retrive the display mode of visual flags for wrapped lines.
1700 get WrapVisualFlag GetWrapVisualFlags=2461(,)
1702 enu WrapVisualLocation=SC_WRAPVISUALFLAGLOC_
1703 val SC_WRAPVISUALFLAGLOC_DEFAULT=0x0000
1704 val SC_WRAPVISUALFLAGLOC_END_BY_TEXT=0x0001
1705 val SC_WRAPVISUALFLAGLOC_START_BY_TEXT=0x0002
1707 # Set the location of visual flags for wrapped lines.
1708 set void SetWrapVisualFlagsLocation=2462(WrapVisualLocation wrapVisualFlagsLocation,)
1710 # Retrive the location of visual flags for wrapped lines.
1711 get WrapVisualLocation GetWrapVisualFlagsLocation=2463(,)
1713 # Set the start indent for wrapped lines.
1714 set void SetWrapStartIndent=2464(int indent,)
1716 # Retrive the start indent for wrapped lines.
1717 get int GetWrapStartIndent=2465(,)
1719 enu WrapIndentMode=SC_WRAPINDENT_
1720 val SC_WRAPINDENT_FIXED=0
1721 val SC_WRAPINDENT_SAME=1
1722 val SC_WRAPINDENT_INDENT=2
1723 val SC_WRAPINDENT_DEEPINDENT=3
1725 ali SC_WRAPINDENT_DEEPINDENT=DEEP_INDENT
1727 # Sets how wrapped sublines are placed. Default is fixed.
1728 set void SetWrapIndentMode=2472(WrapIndentMode wrapIndentMode,)
1730 # Retrieve how wrapped sublines are placed. Default is fixed.
1731 get WrapIndentMode GetWrapIndentMode=2473(,)
1733 enu LineCache=SC_CACHE_
1734 val SC_CACHE_NONE=0
1735 val SC_CACHE_CARET=1
1736 val SC_CACHE_PAGE=2
1737 val SC_CACHE_DOCUMENT=3
1739 # Sets the degree of caching of layout information.
1740 set void SetLayoutCache=2272(LineCache cacheMode,)
1742 # Retrieve the degree of caching of layout information.
1743 get LineCache GetLayoutCache=2273(,)
1745 # Sets the document width assumed for scrolling.
1746 set void SetScrollWidth=2274(int pixelWidth,)
1748 # Retrieve the document width assumed for scrolling.
1749 get int GetScrollWidth=2275(,)
1751 # Sets whether the maximum width line displayed is used to set scroll width.
1752 set void SetScrollWidthTracking=2516(bool tracking,)
1754 # Retrieve whether the scroll width tracks wide lines.
1755 get bool GetScrollWidthTracking=2517(,)
1757 # Measure the pixel width of some text in a particular style.
1758 # NUL terminated text argument.
1759 # Does not handle tab or control characters.
1760 fun int TextWidth=2276(int style, string text)
1762 # Sets the scroll range so that maximum scroll position has
1763 # the last line at the bottom of the view (default).
1764 # Setting this to false allows scrolling one page below the last line.
1765 set void SetEndAtLastLine=2277(bool endAtLastLine,)
1767 # Retrieve whether the maximum scroll position has the last
1768 # line at the bottom of the view.
1769 get bool GetEndAtLastLine=2278(,)
1771 # Retrieve the height of a particular line of text in pixels.
1772 fun int TextHeight=2279(line line,)
1774 # Show or hide the vertical scroll bar.
1775 set void SetVScrollBar=2280(bool visible,)
1777 # Is the vertical scroll bar visible?
1778 get bool GetVScrollBar=2281(,)
1780 # Append a string to the end of the document without changing the selection.
1781 fun void AppendText=2282(position length, string text)
1783 enu PhasesDraw=SC_PHASES_
1784 val SC_PHASES_ONE=0
1785 val SC_PHASES_TWO=1
1786 val SC_PHASES_MULTIPLE=2
1788 # How many phases is drawing done in?
1789 get PhasesDraw GetPhasesDraw=2673(,)
1791 # In one phase draw, text is drawn in a series of rectangular blocks with no overlap.
1792 # In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally.
1793 # In multiple phase draw, each element is drawn over the whole drawing area, allowing text
1794 # to overlap from one line to the next.
1795 set void SetPhasesDraw=2674(PhasesDraw phases,)
1797 # Control font anti-aliasing.
1799 enu FontQuality=SC_EFF_
1800 val SC_EFF_QUALITY_MASK=0xF
1801 val SC_EFF_QUALITY_DEFAULT=0
1802 val SC_EFF_QUALITY_NON_ANTIALIASED=1
1803 val SC_EFF_QUALITY_ANTIALIASED=2
1804 val SC_EFF_QUALITY_LCD_OPTIMIZED=3
1806 # Choose the quality level for text from the FontQuality enumeration.
1807 set void SetFontQuality=2611(FontQuality fontQuality,)
1809 # Retrieve the quality level for text.
1810 get FontQuality GetFontQuality=2612(,)
1812 # Scroll so that a display line is at the top of the display.
1813 set void SetFirstVisibleLine=2613(line displayLine,)
1815 enu MultiPaste=SC_MULTIPASTE_
1816 val SC_MULTIPASTE_ONCE=0
1817 val SC_MULTIPASTE_EACH=1
1819 # Change the effect of pasting when there are multiple selections.
1820 set void SetMultiPaste=2614(MultiPaste multiPaste,)
1822 # Retrieve the effect of pasting when there are multiple selections.
1823 get MultiPaste GetMultiPaste=2615(,)
1825 # Retrieve the value of a tag from a regular expression search.
1826 # Result is NUL-terminated.
1827 get int GetTag=2616(int tagNumber, stringresult tagValue)
1829 # Join the lines in the target.
1830 fun void LinesJoin=2288(,)
1832 # Split the lines in the target into lines that are less wide than pixelWidth
1833 # where possible.
1834 fun void LinesSplit=2289(int pixelWidth,)
1836 # Set one of the colours used as a chequerboard pattern in the fold margin
1837 fun void SetFoldMarginColour=2290(bool useSetting, colour back)
1838 # Set the other colour used as a chequerboard pattern in the fold margin
1839 fun void SetFoldMarginHiColour=2291(bool useSetting, colour fore)
1841 enu Accessibility=SC_ACCESSIBILITY_
1842 val SC_ACCESSIBILITY_DISABLED=0
1843 val SC_ACCESSIBILITY_ENABLED=1
1845 # Enable or disable accessibility.
1846 set void SetAccessibility=2702(Accessibility accessibility,)
1848 # Report accessibility status.
1849 get Accessibility GetAccessibility=2703(,)
1851 ## New messages go here
1853 ## Start of key messages
1854 # Move caret down one line.
1855 fun void LineDown=2300(,)
1857 # Move caret down one line extending selection to new caret position.
1858 fun void LineDownExtend=2301(,)
1860 # Move caret up one line.
1861 fun void LineUp=2302(,)
1863 # Move caret up one line extending selection to new caret position.
1864 fun void LineUpExtend=2303(,)
1866 # Move caret left one character.
1867 fun void CharLeft=2304(,)
1869 # Move caret left one character extending selection to new caret position.
1870 fun void CharLeftExtend=2305(,)
1872 # Move caret right one character.
1873 fun void CharRight=2306(,)
1875 # Move caret right one character extending selection to new caret position.
1876 fun void CharRightExtend=2307(,)
1878 # Move caret left one word.
1879 fun void WordLeft=2308(,)
1881 # Move caret left one word extending selection to new caret position.
1882 fun void WordLeftExtend=2309(,)
1884 # Move caret right one word.
1885 fun void WordRight=2310(,)
1887 # Move caret right one word extending selection to new caret position.
1888 fun void WordRightExtend=2311(,)
1890 # Move caret to first position on line.
1891 fun void Home=2312(,)
1893 # Move caret to first position on line extending selection to new caret position.
1894 fun void HomeExtend=2313(,)
1896 # Move caret to last position on line.
1897 fun void LineEnd=2314(,)
1899 # Move caret to last position on line extending selection to new caret position.
1900 fun void LineEndExtend=2315(,)
1902 # Move caret to first position in document.
1903 fun void DocumentStart=2316(,)
1905 # Move caret to first position in document extending selection to new caret position.
1906 fun void DocumentStartExtend=2317(,)
1908 # Move caret to last position in document.
1909 fun void DocumentEnd=2318(,)
1911 # Move caret to last position in document extending selection to new caret position.
1912 fun void DocumentEndExtend=2319(,)
1914 # Move caret one page up.
1915 fun void PageUp=2320(,)
1917 # Move caret one page up extending selection to new caret position.
1918 fun void PageUpExtend=2321(,)
1920 # Move caret one page down.
1921 fun void PageDown=2322(,)
1923 # Move caret one page down extending selection to new caret position.
1924 fun void PageDownExtend=2323(,)
1926 # Switch from insert to overtype mode or the reverse.
1927 fun void EditToggleOvertype=2324(,)
1929 # Cancel any modes such as call tip or auto-completion list display.
1930 fun void Cancel=2325(,)
1932 # Delete the selection or if no selection, the character before the caret.
1933 fun void DeleteBack=2326(,)
1935 # If selection is empty or all on one line replace the selection with a tab character.
1936 # If more than one line selected, indent the lines.
1937 fun void Tab=2327(,)
1939 # Dedent the selected lines.
1940 fun void BackTab=2328(,)
1942 # Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
1943 fun void NewLine=2329(,)
1945 # Insert a Form Feed character.
1946 fun void FormFeed=2330(,)
1948 # Move caret to before first visible character on line.
1949 # If already there move to first character on line.
1950 fun void VCHome=2331(,)
1952 # Like VCHome but extending selection to new caret position.
1953 fun void VCHomeExtend=2332(,)
1955 # Magnify the displayed text by increasing the sizes by 1 point.
1956 fun void ZoomIn=2333(,)
1958 # Make the displayed text smaller by decreasing the sizes by 1 point.
1959 fun void ZoomOut=2334(,)
1961 # Delete the word to the left of the caret.
1962 fun void DelWordLeft=2335(,)
1964 # Delete the word to the right of the caret.
1965 fun void DelWordRight=2336(,)
1967 # Delete the word to the right of the caret, but not the trailing non-word characters.
1968 fun void DelWordRightEnd=2518(,)
1970 # Cut the line containing the caret.
1971 fun void LineCut=2337(,)
1973 # Delete the line containing the caret.
1974 fun void LineDelete=2338(,)
1976 # Switch the current line with the previous.
1977 fun void LineTranspose=2339(,)
1979 # Reverse order of selected lines.
1980 fun void LineReverse=2354(,)
1982 # Duplicate the current line.
1983 fun void LineDuplicate=2404(,)
1985 # Transform the selection to lower case.
1986 fun void LowerCase=2340(,)
1988 # Transform the selection to upper case.
1989 fun void UpperCase=2341(,)
1991 # Scroll the document down, keeping the caret visible.
1992 fun void LineScrollDown=2342(,)
1994 # Scroll the document up, keeping the caret visible.
1995 fun void LineScrollUp=2343(,)
1997 # Delete the selection or if no selection, the character before the caret.
1998 # Will not delete the character before at the start of a line.
1999 fun void DeleteBackNotLine=2344(,)
2001 # Move caret to first position on display line.
2002 fun void HomeDisplay=2345(,)
2004 # Move caret to first position on display line extending selection to
2005 # new caret position.
2006 fun void HomeDisplayExtend=2346(,)
2008 # Move caret to last position on display line.
2009 fun void LineEndDisplay=2347(,)
2011 # Move caret to last position on display line extending selection to new
2012 # caret position.
2013 fun void LineEndDisplayExtend=2348(,)
2015 # Like Home but when word-wrap is enabled goes first to start of display line
2016 # HomeDisplay, then to start of document line Home.
2017 fun void HomeWrap=2349(,)
2019 # Like HomeExtend but when word-wrap is enabled extends first to start of display line
2020 # HomeDisplayExtend, then to start of document line HomeExtend.
2021 fun void HomeWrapExtend=2450(,)
2023 # Like LineEnd but when word-wrap is enabled goes first to end of display line
2024 # LineEndDisplay, then to start of document line LineEnd.
2025 fun void LineEndWrap=2451(,)
2027 # Like LineEndExtend but when word-wrap is enabled extends first to end of display line
2028 # LineEndDisplayExtend, then to start of document line LineEndExtend.
2029 fun void LineEndWrapExtend=2452(,)
2031 # Like VCHome but when word-wrap is enabled goes first to start of display line
2032 # VCHomeDisplay, then behaves like VCHome.
2033 fun void VCHomeWrap=2453(,)
2035 # Like VCHomeExtend but when word-wrap is enabled extends first to start of display line
2036 # VCHomeDisplayExtend, then behaves like VCHomeExtend.
2037 fun void VCHomeWrapExtend=2454(,)
2039 # Copy the line containing the caret.
2040 fun void LineCopy=2455(,)
2042 # Move the caret inside current view if it's not there already.
2043 fun void MoveCaretInsideView=2401(,)
2045 # How many characters are on a line, including end of line characters?
2046 fun position LineLength=2350(line line,)
2048 # Highlight the characters at two positions.
2049 fun void BraceHighlight=2351(position posA, position posB)
2051 # Use specified indicator to highlight matching braces instead of changing their style.
2052 fun void BraceHighlightIndicator=2498(bool useSetting, int indicator)
2054 # Highlight the character at a position indicating there is no matching brace.
2055 fun void BraceBadLight=2352(position pos,)
2057 # Use specified indicator to highlight non matching brace instead of changing its style.
2058 fun void BraceBadLightIndicator=2499(bool useSetting, int indicator)
2060 # Find the position of a matching brace or INVALID_POSITION if no match.
2061 # The maxReStyle must be 0 for now. It may be defined in a future release.
2062 fun position BraceMatch=2353(position pos, int maxReStyle)
2064 # Similar to BraceMatch, but matching starts at the explicit start position.
2065 fun position BraceMatchNext=2369(position pos, position startPos)
2067 # Are the end of line characters visible?
2068 get bool GetViewEOL=2355(,)
2070 # Make the end of line characters visible or invisible.
2071 set void SetViewEOL=2356(bool visible,)
2073 # Retrieve a pointer to the document object.
2074 get pointer GetDocPointer=2357(,)
2076 # Change the document object used.
2077 set void SetDocPointer=2358(, pointer doc)
2079 # Set which document modification events are sent to the container.
2080 set void SetModEventMask=2359(ModificationFlags eventMask,)
2082 enu EdgeVisualStyle=EDGE_
2083 val EDGE_NONE=0
2084 val EDGE_LINE=1
2085 val EDGE_BACKGROUND=2
2086 val EDGE_MULTILINE=3
2088 ali EDGE_MULTILINE=MULTI_LINE
2090 # Retrieve the column number which text should be kept within.
2091 get position GetEdgeColumn=2360(,)
2093 # Set the column number of the edge.
2094 # If text goes past the edge then it is highlighted.
2095 set void SetEdgeColumn=2361(position column,)
2097 # Retrieve the edge highlight mode.
2098 get EdgeVisualStyle GetEdgeMode=2362(,)
2100 # The edge may be displayed by a line (EDGE_LINE/EDGE_MULTILINE) or by highlighting text that
2101 # goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
2102 set void SetEdgeMode=2363(EdgeVisualStyle edgeMode,)
2104 # Retrieve the colour used in edge indication.
2105 get colour GetEdgeColour=2364(,)
2107 # Change the colour used in edge indication.
2108 set void SetEdgeColour=2365(colour edgeColour,)
2110 # Add a new vertical edge to the view.
2111 fun void MultiEdgeAddLine=2694(position column, colour edgeColour)
2113 # Clear all vertical edges.
2114 fun void MultiEdgeClearAll=2695(,)
2116 # Get multi edge positions.
2117 get position GetMultiEdgeColumn=2749(int which,)
2119 # Sets the current caret position to be the search anchor.
2120 fun void SearchAnchor=2366(,)
2122 # Find some text starting at the search anchor.
2123 # Does not ensure the selection is visible.
2124 fun position SearchNext=2367(FindOption searchFlags, string text)
2126 # Find some text starting at the search anchor and moving backwards.
2127 # Does not ensure the selection is visible.
2128 fun position SearchPrev=2368(FindOption searchFlags, string text)
2130 # Retrieves the number of lines completely visible.
2131 get line LinesOnScreen=2370(,)
2133 enu PopUp=SC_POPUP_
2134 val SC_POPUP_NEVER=0
2135 val SC_POPUP_ALL=1
2136 val SC_POPUP_TEXT=2
2138 # Set whether a pop up menu is displayed automatically when the user presses
2139 # the wrong mouse button on certain areas.
2140 fun void UsePopUp=2371(PopUp popUpMode,)
2142 # Is the selection rectangular? The alternative is the more common stream selection.
2143 get bool SelectionIsRectangle=2372(,)
2145 # Set the zoom level. This number of points is added to the size of all fonts.
2146 # It may be positive to magnify or negative to reduce.
2147 set void SetZoom=2373(int zoomInPoints,)
2148 # Retrieve the zoom level.
2149 get int GetZoom=2374(,)
2151 enu DocumentOption=SC_DOCUMENTOPTION_
2152 val SC_DOCUMENTOPTION_DEFAULT=0
2153 val SC_DOCUMENTOPTION_STYLES_NONE=0x1
2154 val SC_DOCUMENTOPTION_TEXT_LARGE=0x100
2156 # Create a new document object.
2157 # Starts with reference count of 1 and not selected into editor.
2158 fun pointer CreateDocument=2375(position bytes, DocumentOption documentOptions)
2159 # Extend life of document.
2160 fun void AddRefDocument=2376(, pointer doc)
2161 # Release a reference to the document, deleting document if it fades to black.
2162 fun void ReleaseDocument=2377(, pointer doc)
2164 # Get which document options are set.
2165 get DocumentOption GetDocumentOptions=2379(,)
2167 # Get which document modification events are sent to the container.
2168 get ModificationFlags GetModEventMask=2378(,)
2170 # Set whether command events are sent to the container.
2171 set void SetCommandEvents=2717(bool commandEvents,)
2173 # Get whether command events are sent to the container.
2174 get bool GetCommandEvents=2718(,)
2176 # Change internal focus flag.
2177 set void SetFocus=2380(bool focus,)
2178 # Get internal focus flag.
2179 get bool GetFocus=2381(,)
2181 enu Status=SC_STATUS_
2182 val SC_STATUS_OK=0
2183 val SC_STATUS_FAILURE=1
2184 val SC_STATUS_BADALLOC=2
2185 val SC_STATUS_WARN_START=1000
2186 val SC_STATUS_WARN_REGEX=1001
2188 ali SC_STATUS_BADALLOC=BAD_ALLOC
2189 ali SC_STATUS_WARN_REGEX=REG_EX
2191 # Change error status - 0 = OK.
2192 set void SetStatus=2382(Status status,)
2193 # Get error status.
2194 get Status GetStatus=2383(,)
2196 # Set whether the mouse is captured when its button is pressed.
2197 set void SetMouseDownCaptures=2384(bool captures,)
2198 # Get whether mouse gets captured.
2199 get bool GetMouseDownCaptures=2385(,)
2201 # Set whether the mouse wheel can be active outside the window.
2202 set void SetMouseWheelCaptures=2696(bool captures,)
2203 # Get whether mouse wheel can be active outside the window.
2204 get bool GetMouseWheelCaptures=2697(,)
2206 # Sets the cursor to one of the SC_CURSOR* values.
2207 set void SetCursor=2386(CursorShape cursorType,)
2208 # Get cursor type.
2209 get CursorShape GetCursor=2387(,)
2211 # Change the way control characters are displayed:
2212 # If symbol is < 32, keep the drawn way, else, use the given character.
2213 set void SetControlCharSymbol=2388(int symbol,)
2214 # Get the way control characters are displayed.
2215 get int GetControlCharSymbol=2389(,)
2217 # Move to the previous change in capitalisation.
2218 fun void WordPartLeft=2390(,)
2219 # Move to the previous change in capitalisation extending selection
2220 # to new caret position.
2221 fun void WordPartLeftExtend=2391(,)
2222 # Move to the change next in capitalisation.
2223 fun void WordPartRight=2392(,)
2224 # Move to the next change in capitalisation extending selection
2225 # to new caret position.
2226 fun void WordPartRightExtend=2393(,)
2228 # Constants for use with SetVisiblePolicy, similar to SetCaretPolicy.
2229 enu VisiblePolicy=VISIBLE_
2230 val VISIBLE_SLOP=0x01
2231 val VISIBLE_STRICT=0x04
2233 # Set the way the display area is determined when a particular line
2234 # is to be moved to by Find, FindNext, GotoLine, etc.
2235 fun void SetVisiblePolicy=2394(VisiblePolicy visiblePolicy, int visibleSlop)
2237 # Delete back from the current position to the start of the line.
2238 fun void DelLineLeft=2395(,)
2240 # Delete forwards from the current position to the end of the line.
2241 fun void DelLineRight=2396(,)
2243 # Set the xOffset (ie, horizontal scroll position).
2244 set void SetXOffset=2397(int xOffset,)
2246 # Get the xOffset (ie, horizontal scroll position).
2247 get int GetXOffset=2398(,)
2249 # Set the last x chosen value to be the caret x position.
2250 fun void ChooseCaretX=2399(,)
2252 # Set the focus to this Scintilla widget.
2253 fun void GrabFocus=2400(,)
2255 enu CaretPolicy=CARET_
2256 # Caret policy, used by SetXCaretPolicy and SetYCaretPolicy.
2257 # If CARET_SLOP is set, we can define a slop value: caretSlop.
2258 # This value defines an unwanted zone (UZ) where the caret is... unwanted.
2259 # This zone is defined as a number of pixels near the vertical margins,
2260 # and as a number of lines near the horizontal margins.
2261 # By keeping the caret away from the edges, it is seen within its context,
2262 # so it is likely that the identifier that the caret is on can be completely seen,
2263 # and that the current line is seen with some of the lines following it which are
2264 # often dependent on that line.
2265 val CARET_SLOP=0x01
2266 # If CARET_STRICT is set, the policy is enforced... strictly.
2267 # The caret is centred on the display if slop is not set,
2268 # and cannot go in the UZ if slop is set.
2269 val CARET_STRICT=0x04
2270 # If CARET_JUMPS is set, the display is moved more energetically
2271 # so the caret can move in the same direction longer before the policy is applied again.
2272 val CARET_JUMPS=0x10
2273 # If CARET_EVEN is not set, instead of having symmetrical UZs,
2274 # the left and bottom UZs are extended up to right and top UZs respectively.
2275 # This way, we favour the displaying of useful information: the beginning of lines,
2276 # where most code reside, and the lines after the caret, eg. the body of a function.
2277 val CARET_EVEN=0x08
2279 # Set the way the caret is kept visible when going sideways.
2280 # The exclusion zone is given in pixels.
2281 fun void SetXCaretPolicy=2402(CaretPolicy caretPolicy, int caretSlop)
2283 # Set the way the line the caret is on is kept visible.
2284 # The exclusion zone is given in lines.
2285 fun void SetYCaretPolicy=2403(CaretPolicy caretPolicy, int caretSlop)
2287 # Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
2288 set void SetPrintWrapMode=2406(Wrap wrapMode,)
2290 # Is printing line wrapped?
2291 get Wrap GetPrintWrapMode=2407(,)
2293 # Set a fore colour for active hotspots.
2294 set void SetHotspotActiveFore=2410(bool useSetting, colour fore)
2296 # Get the fore colour for active hotspots.
2297 get colour GetHotspotActiveFore=2494(,)
2299 # Set a back colour for active hotspots.
2300 set void SetHotspotActiveBack=2411(bool useSetting, colour back)
2302 # Get the back colour for active hotspots.
2303 get colour GetHotspotActiveBack=2495(,)
2305 # Enable / Disable underlining active hotspots.
2306 set void SetHotspotActiveUnderline=2412(bool underline,)
2308 # Get whether underlining for active hotspots.
2309 get bool GetHotspotActiveUnderline=2496(,)
2311 # Limit hotspots to single line so hotspots on two lines don't merge.
2312 set void SetHotspotSingleLine=2421(bool singleLine,)
2314 # Get the HotspotSingleLine property
2315 get bool GetHotspotSingleLine=2497(,)
2317 # Move caret down one paragraph (delimited by empty lines).
2318 fun void ParaDown=2413(,)
2320 # Extend selection down one paragraph (delimited by empty lines).
2321 fun void ParaDownExtend=2414(,)
2323 # Move caret up one paragraph (delimited by empty lines).
2324 fun void ParaUp=2415(,)
2326 # Extend selection up one paragraph (delimited by empty lines).
2327 fun void ParaUpExtend=2416(,)
2329 # Given a valid document position, return the previous position taking code
2330 # page into account. Returns 0 if passed 0.
2331 fun position PositionBefore=2417(position pos,)
2333 # Given a valid document position, return the next position taking code
2334 # page into account. Maximum value returned is the last position in the document.
2335 fun position PositionAfter=2418(position pos,)
2337 # Given a valid document position, return a position that differs in a number
2338 # of characters. Returned value is always between 0 and last position in document.
2339 fun position PositionRelative=2670(position pos, position relative)
2341 # Given a valid document position, return a position that differs in a number
2342 # of UTF-16 code units. Returned value is always between 0 and last position in document.
2343 # The result may point half way (2 bytes) inside a non-BMP character.
2344 fun position PositionRelativeCodeUnits=2716(position pos, position relative)
2346 # Copy a range of text to the clipboard. Positions are clipped into the document.
2347 fun void CopyRange=2419(position start, position end)
2349 # Copy argument text to the clipboard.
2350 fun void CopyText=2420(position length, string text)
2352 enu SelectionMode=SC_SEL_
2353 val SC_SEL_STREAM=0
2354 val SC_SEL_RECTANGLE=1
2355 val SC_SEL_LINES=2
2356 val SC_SEL_THIN=3
2358 # Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or
2359 # by lines (SC_SEL_LINES).
2360 set void SetSelectionMode=2422(SelectionMode selectionMode,)
2362 # Get the mode of the current selection.
2363 get SelectionMode GetSelectionMode=2423(,)
2365 # Get whether or not regular caret moves will extend or reduce the selection.
2366 get bool GetMoveExtendsSelection=2706(,)
2368 # Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
2369 fun position GetLineSelStartPosition=2424(line line,)
2371 # Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
2372 fun position GetLineSelEndPosition=2425(line line,)
2374 ## RectExtended rectangular selection moves
2375 # Move caret down one line, extending rectangular selection to new caret position.
2376 fun void LineDownRectExtend=2426(,)
2378 # Move caret up one line, extending rectangular selection to new caret position.
2379 fun void LineUpRectExtend=2427(,)
2381 # Move caret left one character, extending rectangular selection to new caret position.
2382 fun void CharLeftRectExtend=2428(,)
2384 # Move caret right one character, extending rectangular selection to new caret position.
2385 fun void CharRightRectExtend=2429(,)
2387 # Move caret to first position on line, extending rectangular selection to new caret position.
2388 fun void HomeRectExtend=2430(,)
2390 # Move caret to before first visible character on line.
2391 # If already there move to first character on line.
2392 # In either case, extend rectangular selection to new caret position.
2393 fun void VCHomeRectExtend=2431(,)
2395 # Move caret to last position on line, extending rectangular selection to new caret position.
2396 fun void LineEndRectExtend=2432(,)
2398 # Move caret one page up, extending rectangular selection to new caret position.
2399 fun void PageUpRectExtend=2433(,)
2401 # Move caret one page down, extending rectangular selection to new caret position.
2402 fun void PageDownRectExtend=2434(,)
2405 # Move caret to top of page, or one page up if already at top of page.
2406 fun void StutteredPageUp=2435(,)
2408 # Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
2409 fun void StutteredPageUpExtend=2436(,)
2411 # Move caret to bottom of page, or one page down if already at bottom of page.
2412 fun void StutteredPageDown=2437(,)
2414 # Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
2415 fun void StutteredPageDownExtend=2438(,)
2418 # Move caret left one word, position cursor at end of word.
2419 fun void WordLeftEnd=2439(,)
2421 # Move caret left one word, position cursor at end of word, extending selection to new caret position.
2422 fun void WordLeftEndExtend=2440(,)
2424 # Move caret right one word, position cursor at end of word.
2425 fun void WordRightEnd=2441(,)
2427 # Move caret right one word, position cursor at end of word, extending selection to new caret position.
2428 fun void WordRightEndExtend=2442(,)
2430 # Set the set of characters making up whitespace for when moving or selecting by word.
2431 # Should be called after SetWordChars.
2432 set void SetWhitespaceChars=2443(, string characters)
2434 # Get the set of characters making up whitespace for when moving or selecting by word.
2435 get int GetWhitespaceChars=2647(, stringresult characters)
2437 # Set the set of characters making up punctuation characters
2438 # Should be called after SetWordChars.
2439 set void SetPunctuationChars=2648(, string characters)
2441 # Get the set of characters making up punctuation characters
2442 get int GetPunctuationChars=2649(, stringresult characters)
2444 # Reset the set of characters for whitespace and word characters to the defaults.
2445 fun void SetCharsDefault=2444(,)
2447 # Get currently selected item position in the auto-completion list
2448 get int AutoCGetCurrent=2445(,)
2450 # Get currently selected item text in the auto-completion list
2451 # Returns the length of the item text
2452 # Result is NUL-terminated.
2453 get int AutoCGetCurrentText=2610(, stringresult text)
2455 enu CaseInsensitiveBehaviour=SC_CASEINSENSITIVEBEHAVIOUR_
2456 val SC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE=0
2457 val SC_CASEINSENSITIVEBEHAVIOUR_IGNORECASE=1
2459 ali SC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE=RESPECT_CASE
2460 ali SC_CASEINSENSITIVEBEHAVIOUR_IGNORECASE=IGNORE_CASE
2462 # Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
2463 set void AutoCSetCaseInsensitiveBehaviour=2634(CaseInsensitiveBehaviour behaviour,)
2465 # Get auto-completion case insensitive behaviour.
2466 get CaseInsensitiveBehaviour AutoCGetCaseInsensitiveBehaviour=2635(,)
2468 enu MultiAutoComplete=SC_MULTIAUTOC_
2469 val SC_MULTIAUTOC_ONCE=0
2470 val SC_MULTIAUTOC_EACH=1
2472 # Change the effect of autocompleting when there are multiple selections.
2473 set void AutoCSetMulti=2636(MultiAutoComplete multi,)
2475 # Retrieve the effect of autocompleting when there are multiple selections.
2476 get MultiAutoComplete AutoCGetMulti=2637(,)
2478 enu Ordering=SC_ORDER_
2479 val SC_ORDER_PRESORTED=0
2480 val SC_ORDER_PERFORMSORT=1
2481 val SC_ORDER_CUSTOM=2
2483 ali SC_ORDER_PRESORTED=PRE_SORTED
2484 ali SC_ORDER_PERFORMSORT=PERFORM_SORT
2486 # Set the way autocompletion lists are ordered.
2487 set void AutoCSetOrder=2660(Ordering order,)
2489 # Get the way autocompletion lists are ordered.
2490 get Ordering AutoCGetOrder=2661(,)
2492 # Enlarge the document to a particular size of text bytes.
2493 fun void Allocate=2446(position bytes,)
2495 # Returns the target converted to UTF8.
2496 # Return the length in bytes.
2497 fun position TargetAsUTF8=2447(, stringresult s)
2499 # Set the length of the utf8 argument for calling EncodedFromUTF8.
2500 # Set to -1 and the string will be measured to the first nul.
2501 fun void SetLengthForEncode=2448(position bytes,)
2503 # Translates a UTF8 string into the document encoding.
2504 # Return the length of the result in bytes.
2505 # On error return 0.
2506 fun position EncodedFromUTF8=2449(string utf8, stringresult encoded)
2508 # Find the position of a column on a line taking into account tabs and
2509 # multi-byte characters. If beyond end of line, return line end position.
2510 fun position FindColumn=2456(line line, position column)
2512 enu CaretSticky=SC_CARETSTICKY_
2513 val SC_CARETSTICKY_OFF=0
2514 val SC_CARETSTICKY_ON=1
2515 val SC_CARETSTICKY_WHITESPACE=2
2517 ali SC_CARETSTICKY_WHITESPACE=WHITE_SPACE
2519 # Can the caret preferred x position only be changed by explicit movement commands?
2520 get CaretSticky GetCaretSticky=2457(,)
2522 # Stop the caret preferred x position changing when the user types.
2523 set void SetCaretSticky=2458(CaretSticky useCaretStickyBehaviour,)
2525 # Switch between sticky and non-sticky: meant to be bound to a key.
2526 fun void ToggleCaretSticky=2459(,)
2528 # Enable/Disable convert-on-paste for line endings
2529 set void SetPasteConvertEndings=2467(bool convert,)
2531 # Get convert-on-paste setting
2532 get bool GetPasteConvertEndings=2468(,)
2534 # Replace the selection with text like a rectangular paste.
2535 fun void ReplaceRectangular=2771(position length, string text)
2537 # Duplicate the selection. If selection empty duplicate the line containing the caret.
2538 fun void SelectionDuplicate=2469(,)
2540 # Set background alpha of the caret line.
2541 set void SetCaretLineBackAlpha=2470(Alpha alpha,)
2543 # Get the background alpha of the caret line.
2544 get Alpha GetCaretLineBackAlpha=2471(,)
2546 enu CaretStyle=CARETSTYLE_
2547 val CARETSTYLE_INVISIBLE=0
2548 val CARETSTYLE_LINE=1
2549 val CARETSTYLE_BLOCK=2
2550 val CARETSTYLE_OVERSTRIKE_BAR=0
2551 val CARETSTYLE_OVERSTRIKE_BLOCK=0x10
2552 val CARETSTYLE_CURSES=0x20
2553 val CARETSTYLE_INS_MASK=0xF
2554 val CARETSTYLE_BLOCK_AFTER=0x100
2556 # Set the style of the caret to be drawn.
2557 set void SetCaretStyle=2512(CaretStyle caretStyle,)
2559 # Returns the current style of the caret.
2560 get CaretStyle GetCaretStyle=2513(,)
2562 # Set the indicator used for IndicatorFillRange and IndicatorClearRange
2563 set void SetIndicatorCurrent=2500(int indicator,)
2565 # Get the current indicator
2566 get int GetIndicatorCurrent=2501(,)
2568 # Set the value used for IndicatorFillRange
2569 set void SetIndicatorValue=2502(int value,)
2571 # Get the current indicator value
2572 get int GetIndicatorValue=2503(,)
2574 # Turn a indicator on over a range.
2575 fun void IndicatorFillRange=2504(position start, position lengthFill)
2577 # Turn a indicator off over a range.
2578 fun void IndicatorClearRange=2505(position start, position lengthClear)
2580 # Are any indicators present at pos?
2581 fun int IndicatorAllOnFor=2506(position pos,)
2583 # What value does a particular indicator have at a position?
2584 fun int IndicatorValueAt=2507(int indicator, position pos)
2586 # Where does a particular indicator start?
2587 fun position IndicatorStart=2508(int indicator, position pos)
2589 # Where does a particular indicator end?
2590 fun position IndicatorEnd=2509(int indicator, position pos)
2592 # Set number of entries in position cache
2593 set void SetPositionCache=2514(int size,)
2595 # How many entries are allocated to the position cache?
2596 get int GetPositionCache=2515(,)
2598 # Set maximum number of threads used for layout
2599 set void SetLayoutThreads=2775(int threads,)
2601 # Get maximum number of threads used for layout
2602 get int GetLayoutThreads=2776(,)
2604 # Copy the selection, if selection empty copy the line with the caret
2605 fun void CopyAllowLine=2519(,)
2607 # Compact the document buffer and return a read-only pointer to the
2608 # characters in the document.
2609 get pointer GetCharacterPointer=2520(,)
2611 # Return a read-only pointer to a range of characters in the document.
2612 # May move the gap so that the range is contiguous, but will only move up
2613 # to lengthRange bytes.
2614 get pointer GetRangePointer=2643(position start, position lengthRange)
2616 # Return a position which, to avoid performance costs, should not be within
2617 # the range of a call to GetRangePointer.
2618 get position GetGapPosition=2644(,)
2620 # Set the alpha fill colour of the given indicator.
2621 set void IndicSetAlpha=2523(int indicator, Alpha alpha)
2623 # Get the alpha fill colour of the given indicator.
2624 get Alpha IndicGetAlpha=2524(int indicator,)
2626 # Set the alpha outline colour of the given indicator.
2627 set void IndicSetOutlineAlpha=2558(int indicator, Alpha alpha)
2629 # Get the alpha outline colour of the given indicator.
2630 get Alpha IndicGetOutlineAlpha=2559(int indicator,)
2632 # Set extra ascent for each line
2633 set void SetExtraAscent=2525(int extraAscent,)
2635 # Get extra ascent for each line
2636 get int GetExtraAscent=2526(,)
2638 # Set extra descent for each line
2639 set void SetExtraDescent=2527(int extraDescent,)
2641 # Get extra descent for each line
2642 get int GetExtraDescent=2528(,)
2644 # Which symbol was defined for markerNumber with MarkerDefine
2645 fun int MarkerSymbolDefined=2529(int markerNumber,)
2647 # Set the text in the text margin for a line
2648 set void MarginSetText=2530(line line, string text)
2650 # Get the text in the text margin for a line
2651 get int MarginGetText=2531(line line, stringresult text)
2653 # Set the style number for the text margin for a line
2654 set void MarginSetStyle=2532(line line, int style)
2656 # Get the style number for the text margin for a line
2657 get int MarginGetStyle=2533(line line,)
2659 # Set the style in the text margin for a line
2660 set void MarginSetStyles=2534(line line, string styles)
2662 # Get the styles in the text margin for a line
2663 get int MarginGetStyles=2535(line line, stringresult styles)
2665 # Clear the margin text on all lines
2666 fun void MarginTextClearAll=2536(,)
2668 # Get the start of the range of style numbers used for margin text
2669 set void MarginSetStyleOffset=2537(int style,)
2671 # Get the start of the range of style numbers used for margin text
2672 get int MarginGetStyleOffset=2538(,)
2674 enu MarginOption=SC_MARGINOPTION_
2675 val SC_MARGINOPTION_NONE=0
2676 val SC_MARGINOPTION_SUBLINESELECT=1
2678 ali SC_MARGINOPTION_SUBLINESELECT=SUB_LINE_SELECT
2680 # Set the margin options.
2681 set void SetMarginOptions=2539(MarginOption marginOptions,)
2683 # Get the margin options.
2684 get MarginOption GetMarginOptions=2557(,)
2686 # Set the annotation text for a line
2687 set void AnnotationSetText=2540(line line, string text)
2689 # Get the annotation text for a line
2690 get int AnnotationGetText=2541(line line, stringresult text)
2692 # Set the style number for the annotations for a line
2693 set void AnnotationSetStyle=2542(line line, int style)
2695 # Get the style number for the annotations for a line
2696 get int AnnotationGetStyle=2543(line line,)
2698 # Set the annotation styles for a line
2699 set void AnnotationSetStyles=2544(line line, string styles)
2701 # Get the annotation styles for a line
2702 get int AnnotationGetStyles=2545(line line, stringresult styles)
2704 # Get the number of annotation lines for a line
2705 get int AnnotationGetLines=2546(line line,)
2707 # Clear the annotations from all lines
2708 fun void AnnotationClearAll=2547(,)
2710 enu AnnotationVisible=ANNOTATION_
2711 val ANNOTATION_HIDDEN=0
2712 val ANNOTATION_STANDARD=1
2713 val ANNOTATION_BOXED=2
2714 val ANNOTATION_INDENTED=3
2716 # Set the visibility for the annotations for a view
2717 set void AnnotationSetVisible=2548(AnnotationVisible visible,)
2719 # Get the visibility for the annotations for a view
2720 get AnnotationVisible AnnotationGetVisible=2549(,)
2722 # Get the start of the range of style numbers used for annotations
2723 set void AnnotationSetStyleOffset=2550(int style,)
2725 # Get the start of the range of style numbers used for annotations
2726 get int AnnotationGetStyleOffset=2551(,)
2728 # Release all extended (>255) style numbers
2729 fun void ReleaseAllExtendedStyles=2552(,)
2731 # Allocate some extended (>255) style numbers and return the start of the range
2732 fun int AllocateExtendedStyles=2553(int numberStyles,)
2734 enu UndoFlags=UNDO_
2735 val UNDO_NONE=0
2736 val UNDO_MAY_COALESCE=1
2738 # Add a container action to the undo stack
2739 fun void AddUndoAction=2560(int token, UndoFlags flags)
2741 # Find the position of a character from a point within the window.
2742 fun position CharPositionFromPoint=2561(int x, int y)
2744 # Find the position of a character from a point within the window.
2745 # Return INVALID_POSITION if not close to text.
2746 fun position CharPositionFromPointClose=2562(int x, int y)
2748 # Set whether switching to rectangular mode while selecting with the mouse is allowed.
2749 set void SetMouseSelectionRectangularSwitch=2668(bool mouseSelectionRectangularSwitch,)
2751 # Whether switching to rectangular mode while selecting with the mouse is allowed.
2752 get bool GetMouseSelectionRectangularSwitch=2669(,)
2754 # Set whether multiple selections can be made
2755 set void SetMultipleSelection=2563(bool multipleSelection,)
2757 # Whether multiple selections can be made
2758 get bool GetMultipleSelection=2564(,)
2760 # Set whether typing can be performed into multiple selections
2761 set void SetAdditionalSelectionTyping=2565(bool additionalSelectionTyping,)
2763 # Whether typing can be performed into multiple selections
2764 get bool GetAdditionalSelectionTyping=2566(,)
2766 # Set whether additional carets will blink
2767 set void SetAdditionalCaretsBlink=2567(bool additionalCaretsBlink,)
2769 # Whether additional carets will blink
2770 get bool GetAdditionalCaretsBlink=2568(,)
2772 # Set whether additional carets are visible
2773 set void SetAdditionalCaretsVisible=2608(bool additionalCaretsVisible,)
2775 # Whether additional carets are visible
2776 get bool GetAdditionalCaretsVisible=2609(,)
2778 # How many selections are there?
2779 get int GetSelections=2570(,)
2781 # Is every selected range empty?
2782 get bool GetSelectionEmpty=2650(,)
2784 # Clear selections to a single empty stream selection
2785 fun void ClearSelections=2571(,)
2787 # Set a simple selection
2788 fun void SetSelection=2572(position caret, position anchor)
2790 # Add a selection
2791 fun void AddSelection=2573(position caret, position anchor)
2793 # Drop one selection
2794 fun void DropSelectionN=2671(int selection,)
2796 # Set the main selection
2797 set void SetMainSelection=2574(int selection,)
2799 # Which selection is the main selection
2800 get int GetMainSelection=2575(,)
2802 # Set the caret position of the nth selection.
2803 set void SetSelectionNCaret=2576(int selection, position caret)
2805 # Return the caret position of the nth selection.
2806 get position GetSelectionNCaret=2577(int selection,)
2808 # Set the anchor position of the nth selection.
2809 set void SetSelectionNAnchor=2578(int selection, position anchor)
2811 # Return the anchor position of the nth selection.
2812 get position GetSelectionNAnchor=2579(int selection,)
2814 # Set the virtual space of the caret of the nth selection.
2815 set void SetSelectionNCaretVirtualSpace=2580(int selection, position space)
2817 # Return the virtual space of the caret of the nth selection.
2818 get position GetSelectionNCaretVirtualSpace=2581(int selection,)
2820 # Set the virtual space of the anchor of the nth selection.
2821 set void SetSelectionNAnchorVirtualSpace=2582(int selection, position space)
2823 # Return the virtual space of the anchor of the nth selection.
2824 get position GetSelectionNAnchorVirtualSpace=2583(int selection,)
2826 # Sets the position that starts the selection - this becomes the anchor.
2827 set void SetSelectionNStart=2584(int selection, position anchor)
2829 # Returns the position at the start of the selection.
2830 get position GetSelectionNStart=2585(int selection,)
2832 # Returns the virtual space at the start of the selection.
2833 get position GetSelectionNStartVirtualSpace=2726(int selection,)
2835 # Sets the position that ends the selection - this becomes the currentPosition.
2836 set void SetSelectionNEnd=2586(int selection, position caret)
2838 # Returns the virtual space at the end of the selection.
2839 get position GetSelectionNEndVirtualSpace=2727(int selection,)
2841 # Returns the position at the end of the selection.
2842 get position GetSelectionNEnd=2587(int selection,)
2844 # Set the caret position of the rectangular selection.
2845 set void SetRectangularSelectionCaret=2588(position caret,)
2847 # Return the caret position of the rectangular selection.
2848 get position GetRectangularSelectionCaret=2589(,)
2850 # Set the anchor position of the rectangular selection.
2851 set void SetRectangularSelectionAnchor=2590(position anchor,)
2853 # Return the anchor position of the rectangular selection.
2854 get position GetRectangularSelectionAnchor=2591(,)
2856 # Set the virtual space of the caret of the rectangular selection.
2857 set void SetRectangularSelectionCaretVirtualSpace=2592(position space,)
2859 # Return the virtual space of the caret of the rectangular selection.
2860 get position GetRectangularSelectionCaretVirtualSpace=2593(,)
2862 # Set the virtual space of the anchor of the rectangular selection.
2863 set void SetRectangularSelectionAnchorVirtualSpace=2594(position space,)
2865 # Return the virtual space of the anchor of the rectangular selection.
2866 get position GetRectangularSelectionAnchorVirtualSpace=2595(,)
2868 enu VirtualSpace=SCVS_
2869 val SCVS_NONE=0
2870 val SCVS_RECTANGULARSELECTION=1
2871 val SCVS_USERACCESSIBLE=2
2872 val SCVS_NOWRAPLINESTART=4
2874 ali SCVS_RECTANGULARSELECTION=RECTANGULAR_SELECTION
2875 ali SCVS_USERACCESSIBLE=USER_ACCESSIBLE
2876 ali SCVS_NOWRAPLINESTART=NO_WRAP_LINE_START
2878 # Set options for virtual space behaviour.
2879 set void SetVirtualSpaceOptions=2596(VirtualSpace virtualSpaceOptions,)
2881 # Return options for virtual space behaviour.
2882 get VirtualSpace GetVirtualSpaceOptions=2597(,)
2884 # On GTK, allow selecting the modifier key to use for mouse-based
2885 # rectangular selection. Often the window manager requires Alt+Mouse Drag
2886 # for moving windows.
2887 # Valid values are SCMOD_CTRL(default), SCMOD_ALT, or SCMOD_SUPER.
2889 set void SetRectangularSelectionModifier=2598(int modifier,)
2891 # Get the modifier key used for rectangular selection.
2892 get int GetRectangularSelectionModifier=2599(,)
2894 # Set the foreground colour of additional selections.
2895 # Must have previously called SetSelFore with non-zero first argument for this to have an effect.
2896 set void SetAdditionalSelFore=2600(colour fore,)
2898 # Set the background colour of additional selections.
2899 # Must have previously called SetSelBack with non-zero first argument for this to have an effect.
2900 set void SetAdditionalSelBack=2601(colour back,)
2902 # Set the alpha of the selection.
2903 set void SetAdditionalSelAlpha=2602(Alpha alpha,)
2905 # Get the alpha of the selection.
2906 get Alpha GetAdditionalSelAlpha=2603(,)
2908 # Set the foreground colour of additional carets.
2909 set void SetAdditionalCaretFore=2604(colour fore,)
2911 # Get the foreground colour of additional carets.
2912 get colour GetAdditionalCaretFore=2605(,)
2914 # Set the main selection to the next selection.
2915 fun void RotateSelection=2606(,)
2917 # Swap that caret and anchor of the main selection.
2918 fun void SwapMainAnchorCaret=2607(,)
2920 # Add the next occurrence of the main selection to the set of selections as main.
2921 # If the current selection is empty then select word around caret.
2922 fun void MultipleSelectAddNext=2688(,)
2924 # Add each occurrence of the main selection in the target to the set of selections.
2925 # If the current selection is empty then select word around caret.
2926 fun void MultipleSelectAddEach=2689(,)
2928 # Indicate that the internal state of a lexer has changed over a range and therefore
2929 # there may be a need to redraw.
2930 fun int ChangeLexerState=2617(position start, position end)
2932 # Find the next line at or after lineStart that is a contracted fold header line.
2933 # Return -1 when no more lines.
2934 fun line ContractedFoldNext=2618(line lineStart,)
2936 # Centre current line in window.
2937 fun void VerticalCentreCaret=2619(,)
2939 # Move the selected lines up one line, shifting the line above after the selection
2940 fun void MoveSelectedLinesUp=2620(,)
2942 # Move the selected lines down one line, shifting the line below before the selection
2943 fun void MoveSelectedLinesDown=2621(,)
2945 # Set the identifier reported as idFrom in notification messages.
2946 set void SetIdentifier=2622(int identifier,)
2948 # Get the identifier.
2949 get int GetIdentifier=2623(,)
2951 # Set the width for future RGBA image data.
2952 set void RGBAImageSetWidth=2624(int width,)
2954 # Set the height for future RGBA image data.
2955 set void RGBAImageSetHeight=2625(int height,)
2957 # Set the scale factor in percent for future RGBA image data.
2958 set void RGBAImageSetScale=2651(int scalePercent,)
2960 # Define a marker from RGBA data.
2961 # It has the width and height from RGBAImageSetWidth/Height
2962 fun void MarkerDefineRGBAImage=2626(int markerNumber, string pixels)
2964 # Register an RGBA image for use in autocompletion lists.
2965 # It has the width and height from RGBAImageSetWidth/Height
2966 fun void RegisterRGBAImage=2627(int type, string pixels)
2968 # Scroll to start of document.
2969 fun void ScrollToStart=2628(,)
2971 # Scroll to end of document.
2972 fun void ScrollToEnd=2629(,)
2974 enu Technology=SC_TECHNOLOGY_
2975 val SC_TECHNOLOGY_DEFAULT=0
2976 val SC_TECHNOLOGY_DIRECTWRITE=1
2977 val SC_TECHNOLOGY_DIRECTWRITERETAIN=2
2978 val SC_TECHNOLOGY_DIRECTWRITEDC=3
2980 ali SC_TECHNOLOGY_DIRECTWRITE=DIRECT_WRITE
2981 ali SC_TECHNOLOGY_DIRECTWRITERETAIN=DIRECT_WRITE_RETAIN
2982 ali SC_TECHNOLOGY_DIRECTWRITEDC=DIRECT_WRITE_D_C
2984 # Set the technology used.
2985 set void SetTechnology=2630(Technology technology,)
2987 # Get the tech.
2988 get Technology GetTechnology=2631(,)
2990 # Create an ILoader*.
2991 fun pointer CreateLoader=2632(position bytes, DocumentOption documentOptions)
2993 # On macOS, show a find indicator.
2994 fun void FindIndicatorShow=2640(position start, position end)
2996 # On macOS, flash a find indicator, then fade out.
2997 fun void FindIndicatorFlash=2641(position start, position end)
2999 # On macOS, hide the find indicator.
3000 fun void FindIndicatorHide=2642(,)
3002 # Move caret to before first visible character on display line.
3003 # If already there move to first character on display line.
3004 fun void VCHomeDisplay=2652(,)
3006 # Like VCHomeDisplay but extending selection to new caret position.
3007 fun void VCHomeDisplayExtend=2653(,)
3009 # Is the caret line always visible?
3010 get bool GetCaretLineVisibleAlways=2654(,)
3012 # Sets the caret line to always visible.
3013 set void SetCaretLineVisibleAlways=2655(bool alwaysVisible,)
3015 # Line end types which may be used in addition to LF, CR, and CRLF
3016 # SC_LINE_END_TYPE_UNICODE includes U+2028 Line Separator,
3017 # U+2029 Paragraph Separator, and U+0085 Next Line
3018 enu LineEndType=SC_LINE_END_TYPE_
3019 val SC_LINE_END_TYPE_DEFAULT=0
3020 val SC_LINE_END_TYPE_UNICODE=1
3022 # Set the line end types that the application wants to use. May not be used if incompatible with lexer or encoding.
3023 set void SetLineEndTypesAllowed=2656(LineEndType lineEndBitSet,)
3025 # Get the line end types currently allowed.
3026 get LineEndType GetLineEndTypesAllowed=2657(,)
3028 # Get the line end types currently recognised. May be a subset of the allowed types due to lexer limitation.
3029 get LineEndType GetLineEndTypesActive=2658(,)
3031 # Set the way a character is drawn.
3032 set void SetRepresentation=2665(string encodedCharacter, string representation)
3034 # Get the way a character is drawn.
3035 # Result is NUL-terminated.
3036 get int GetRepresentation=2666(string encodedCharacter, stringresult representation)
3038 # Remove a character representation.
3039 fun void ClearRepresentation=2667(string encodedCharacter,)
3041 # Clear representations to default.
3042 fun void ClearAllRepresentations=2770(,)
3044 # Can draw representations in various ways
3045 enu RepresentationAppearance=SC_REPRESENTATION
3046 val SC_REPRESENTATION_PLAIN=0
3047 val SC_REPRESENTATION_BLOB=1
3048 val SC_REPRESENTATION_COLOUR=0x10
3050 # Set the appearance of a representation.
3051 set void SetRepresentationAppearance=2766(string encodedCharacter, RepresentationAppearance appearance)
3053 # Get the appearance of a representation.
3054 get RepresentationAppearance GetRepresentationAppearance=2767(string encodedCharacter,)
3056 # Set the colour of a representation.
3057 set void SetRepresentationColour=2768(string encodedCharacter, colouralpha colour)
3059 # Get the colour of a representation.
3060 get colouralpha GetRepresentationColour=2769(string encodedCharacter,)
3062 # Set the end of line annotation text for a line
3063 set void EOLAnnotationSetText=2740(line line, string text)
3065 # Get the end of line annotation text for a line
3066 get int EOLAnnotationGetText=2741(line line, stringresult text)
3068 # Set the style number for the end of line annotations for a line
3069 set void EOLAnnotationSetStyle=2742(line line, int style)
3071 # Get the style number for the end of line annotations for a line
3072 get int EOLAnnotationGetStyle=2743(line line,)
3074 # Clear the end of annotations from all lines
3075 fun void EOLAnnotationClearAll=2744(,)
3077 enu EOLAnnotationVisible=EOLANNOTATION_
3078 val EOLANNOTATION_HIDDEN=0x0
3079 val EOLANNOTATION_STANDARD=0x1
3080 val EOLANNOTATION_BOXED=0x2
3081 val EOLANNOTATION_STADIUM=0x100
3082 val EOLANNOTATION_FLAT_CIRCLE=0x101
3083 val EOLANNOTATION_ANGLE_CIRCLE=0x102
3084 val EOLANNOTATION_CIRCLE_FLAT=0x110
3085 val EOLANNOTATION_FLATS=0x111
3086 val EOLANNOTATION_ANGLE_FLAT=0x112
3087 val EOLANNOTATION_CIRCLE_ANGLE=0x120
3088 val EOLANNOTATION_FLAT_ANGLE=0x121
3089 val EOLANNOTATION_ANGLES=0x122
3091 # Set the visibility for the end of line annotations for a view
3092 set void EOLAnnotationSetVisible=2745(EOLAnnotationVisible visible,)
3094 # Get the visibility for the end of line annotations for a view
3095 get EOLAnnotationVisible EOLAnnotationGetVisible=2746(,)
3097 # Get the start of the range of style numbers used for end of line annotations
3098 set void EOLAnnotationSetStyleOffset=2747(int style,)
3100 # Get the start of the range of style numbers used for end of line annotations
3101 get int EOLAnnotationGetStyleOffset=2748(,)
3103 enu Supports=SC_SUPPORTS_
3104 val SC_SUPPORTS_LINE_DRAWS_FINAL=0
3105 val SC_SUPPORTS_PIXEL_DIVISIONS=1
3106 val SC_SUPPORTS_FRACTIONAL_STROKE_WIDTH=2
3107 val SC_SUPPORTS_TRANSLUCENT_STROKE=3
3108 val SC_SUPPORTS_PIXEL_MODIFICATION=4
3109 val SC_SUPPORTS_THREAD_SAFE_MEASURE_WIDTHS=5
3111 # Get whether a feature is supported
3112 get bool SupportsFeature=2750(Supports feature,)
3114 enu LineCharacterIndexType=SC_LINECHARACTERINDEX_
3115 val SC_LINECHARACTERINDEX_NONE=0
3116 val SC_LINECHARACTERINDEX_UTF32=1
3117 val SC_LINECHARACTERINDEX_UTF16=2
3119 # Retrieve line character index state.
3120 get LineCharacterIndexType GetLineCharacterIndex=2710(,)
3122 # Request line character index be created or its use count increased.
3123 fun void AllocateLineCharacterIndex=2711(LineCharacterIndexType lineCharacterIndex,)
3125 # Decrease use count of line character index and remove if 0.
3126 fun void ReleaseLineCharacterIndex=2712(LineCharacterIndexType lineCharacterIndex,)
3128 # Retrieve the document line containing a position measured in index units.
3129 fun line LineFromIndexPosition=2713(position pos, LineCharacterIndexType lineCharacterIndex)
3131 # Retrieve the position measured in index units at the start of a document line.
3132 fun position IndexPositionFromLine=2714(line line, LineCharacterIndexType lineCharacterIndex)
3134 # Start notifying the container of all key presses and commands.
3135 fun void StartRecord=3001(,)
3137 # Stop notifying the container of all key presses and commands.
3138 fun void StopRecord=3002(,)
3140 # Retrieve the lexing language of the document.
3141 get int GetLexer=4002(,)
3143 # Colourise a segment of the document using the current lexing language.
3144 fun void Colourise=4003(position start, position end)
3146 # Set up a value that may be used by a lexer for some optional feature.
3147 set void SetProperty=4004(string key, string value)
3149 # Maximum value of keywordSet parameter of SetKeyWords.
3150 val KEYWORDSET_MAX=8
3152 # Set up the key words used by the lexer.
3153 set void SetKeyWords=4005(int keyWordSet, string keyWords)
3155 # Retrieve a "property" value previously set with SetProperty.
3156 # Result is NUL-terminated.
3157 get int GetProperty=4008(string key, stringresult value)
3159 # Retrieve a "property" value previously set with SetProperty,
3160 # with "$()" variable replacement on returned buffer.
3161 # Result is NUL-terminated.
3162 get int GetPropertyExpanded=4009(string key, stringresult value)
3164 # Retrieve a "property" value previously set with SetProperty,
3165 # interpreted as an int AFTER any "$()" variable replacement.
3166 get int GetPropertyInt=4010(string key, int defaultValue)
3168 # Retrieve the name of the lexer.
3169 # Return the length of the text.
3170 # Result is NUL-terminated.
3171 get int GetLexerLanguage=4012(, stringresult language)
3173 # For private communication between an application and a known lexer.
3174 fun pointer PrivateLexerCall=4013(int operation, pointer pointer)
3176 # Retrieve a '\n' separated list of properties understood by the current lexer.
3177 # Result is NUL-terminated.
3178 fun int PropertyNames=4014(, stringresult names)
3180 enu TypeProperty=SC_TYPE_
3181 val SC_TYPE_BOOLEAN=0
3182 val SC_TYPE_INTEGER=1
3183 val SC_TYPE_STRING=2
3185 # Retrieve the type of a property.
3186 fun TypeProperty PropertyType=4015(string name,)
3188 # Describe a property.
3189 # Result is NUL-terminated.
3190 fun int DescribeProperty=4016(string name, stringresult description)
3192 # Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
3193 # Result is NUL-terminated.
3194 fun int DescribeKeyWordSets=4017(, stringresult descriptions)
3196 # Bit set of LineEndType enumertion for which line ends beyond the standard
3197 # LF, CR, and CRLF are supported by the lexer.
3198 get LineEndType GetLineEndTypesSupported=4018(,)
3200 # Allocate a set of sub styles for a particular base style, returning start of range
3201 fun int AllocateSubStyles=4020(int styleBase, int numberStyles)
3203 # The starting style number for the sub styles associated with a base style
3204 get int GetSubStylesStart=4021(int styleBase,)
3206 # The number of sub styles associated with a base style
3207 get int GetSubStylesLength=4022(int styleBase,)
3209 # For a sub style, return the base style, else return the argument.
3210 get int GetStyleFromSubStyle=4027(int subStyle,)
3212 # For a secondary style, return the primary style, else return the argument.
3213 get int GetPrimaryStyleFromStyle=4028(int style,)
3215 # Free allocated sub styles
3216 fun void FreeSubStyles=4023(,)
3218 # Set the identifiers that are shown in a particular style
3219 set void SetIdentifiers=4024(int style, string identifiers)
3221 # Where styles are duplicated by a feature such as active/inactive code
3222 # return the distance between the two types.
3223 get int DistanceToSecondaryStyles=4025(,)
3225 # Get the set of base styles that can be extended with sub styles
3226 # Result is NUL-terminated.
3227 get int GetSubStyleBases=4026(, stringresult styles)
3229 # Retrieve the number of named styles for the lexer.
3230 get int GetNamedStyles=4029(,)
3232 # Retrieve the name of a style.
3233 # Result is NUL-terminated.
3234 fun int NameOfStyle=4030(int style, stringresult name)
3236 # Retrieve a ' ' separated list of style tags like "literal quoted string".
3237 # Result is NUL-terminated.
3238 fun int TagsOfStyle=4031(int style, stringresult tags)
3240 # Retrieve a description of a style.
3241 # Result is NUL-terminated.
3242 fun int DescriptionOfStyle=4032(int style, stringresult description)
3244 # Set the lexer from an ILexer*.
3245 set void SetILexer=4033(, pointer ilexer)
3247 # Notifications
3248 # Type of modification and the action which caused the modification.
3249 # These are defined as a bit mask to make it easy to specify which notifications are wanted.
3250 # One bit is set from each of SC_MOD_* and SC_PERFORMED_*.
3251 enu ModificationFlags=SC_MOD_ SC_PERFORMED_ SC_MULTISTEPUNDOREDO SC_LASTSTEPINUNDOREDO SC_MULTILINEUNDOREDO SC_STARTACTION SC_MODEVENTMASKALL
3252 val SC_MOD_NONE=0x0
3253 val SC_MOD_INSERTTEXT=0x1
3254 val SC_MOD_DELETETEXT=0x2
3255 val SC_MOD_CHANGESTYLE=0x4
3256 val SC_MOD_CHANGEFOLD=0x8
3257 val SC_PERFORMED_USER=0x10
3258 val SC_PERFORMED_UNDO=0x20
3259 val SC_PERFORMED_REDO=0x40
3260 val SC_MULTISTEPUNDOREDO=0x80
3261 val SC_LASTSTEPINUNDOREDO=0x100
3262 val SC_MOD_CHANGEMARKER=0x200
3263 val SC_MOD_BEFOREINSERT=0x400
3264 val SC_MOD_BEFOREDELETE=0x800
3265 val SC_MULTILINEUNDOREDO=0x1000
3266 val SC_STARTACTION=0x2000
3267 val SC_MOD_CHANGEINDICATOR=0x4000
3268 val SC_MOD_CHANGELINESTATE=0x8000
3269 val SC_MOD_CHANGEMARGIN=0x10000
3270 val SC_MOD_CHANGEANNOTATION=0x20000
3271 val SC_MOD_CONTAINER=0x40000
3272 val SC_MOD_LEXERSTATE=0x80000
3273 val SC_MOD_INSERTCHECK=0x100000
3274 val SC_MOD_CHANGETABSTOPS=0x200000
3275 val SC_MOD_CHANGEEOLANNOTATION=0x400000
3276 val SC_MODEVENTMASKALL=0x7FFFFF
3278 ali SC_MOD_INSERTTEXT=INSERT_TEXT
3279 ali SC_MOD_DELETETEXT=DELETE_TEXT
3280 ali SC_MOD_CHANGESTYLE=CHANGE_STYLE
3281 ali SC_MOD_CHANGEFOLD=CHANGE_FOLD
3282 ali SC_MULTISTEPUNDOREDO=MULTI_STEP_UNDO_REDO
3283 ali SC_LASTSTEPINUNDOREDO=LAST_STEP_IN_UNDO_REDO
3284 ali SC_MOD_CHANGEMARKER=CHANGE_MARKER
3285 ali SC_MOD_BEFOREINSERT=BEFORE_INSERT
3286 ali SC_MOD_BEFOREDELETE=BEFORE_DELETE
3287 ali SC_MULTILINEUNDOREDO=MULTILINE_UNDO_REDO
3288 ali SC_STARTACTION=START_ACTION
3289 ali SC_MOD_CHANGEINDICATOR=CHANGE_INDICATOR
3290 ali SC_MOD_CHANGELINESTATE=CHANGE_LINE_STATE
3291 ali SC_MOD_CHANGEMARGIN=CHANGE_MARGIN
3292 ali SC_MOD_CHANGEANNOTATION=CHANGE_ANNOTATION
3293 ali SC_MOD_LEXERSTATE=LEXER_STATE
3294 ali SC_MOD_INSERTCHECK=INSERT_CHECK
3295 ali SC_MOD_CHANGETABSTOPS=CHANGE_TAB_STOPS
3296 ali SC_MOD_CHANGEEOLANNOTATION=CHANGE_E_O_L_ANNOTATION
3297 ali SC_MODEVENTMASKALL=EVENT_MASK_ALL
3299 enu Update=SC_UPDATE_
3300 val SC_UPDATE_NONE=0x0
3301 val SC_UPDATE_CONTENT=0x1
3302 val SC_UPDATE_SELECTION=0x2
3303 val SC_UPDATE_V_SCROLL=0x4
3304 val SC_UPDATE_H_SCROLL=0x8
3306 # For compatibility, these go through the COMMAND notification rather than NOTIFY
3307 # and should have had exactly the same values as the EN_* constants.
3308 # Unfortunately the SETFOCUS and KILLFOCUS are flipped over from EN_*
3309 # As clients depend on these constants, this will not be changed.
3310 enu FocusChange=SCEN_
3311 val SCEN_CHANGE=768
3312 val SCEN_SETFOCUS=512
3313 val SCEN_KILLFOCUS=256
3315 # Symbolic key codes and modifier flags.
3316 # ASCII and other printable characters below 256.
3317 # Extended keys above 300.
3319 enu Keys=SCK_
3320 val SCK_DOWN=300
3321 val SCK_UP=301
3322 val SCK_LEFT=302
3323 val SCK_RIGHT=303
3324 val SCK_HOME=304
3325 val SCK_END=305
3326 val SCK_PRIOR=306
3327 val SCK_NEXT=307
3328 val SCK_DELETE=308
3329 val SCK_INSERT=309
3330 val SCK_ESCAPE=7
3331 val SCK_BACK=8
3332 val SCK_TAB=9
3333 val SCK_RETURN=13
3334 val SCK_ADD=310
3335 val SCK_SUBTRACT=311
3336 val SCK_DIVIDE=312
3337 val SCK_WIN=313
3338 val SCK_RWIN=314
3339 val SCK_MENU=315
3341 ali SCK_RWIN=R_WIN
3343 enu KeyMod=SCMOD_
3344 val SCMOD_NORM=0
3345 val SCMOD_SHIFT=1
3346 val SCMOD_CTRL=2
3347 val SCMOD_ALT=4
3348 val SCMOD_SUPER=8
3349 val SCMOD_META=16
3351 enu CompletionMethods=SC_AC_
3352 val SC_AC_FILLUP=1
3353 val SC_AC_DOUBLECLICK=2
3354 val SC_AC_TAB=3
3355 val SC_AC_NEWLINE=4
3356 val SC_AC_COMMAND=5
3357 val SC_AC_SINGLE_CHOICE=6
3359 ali SC_AC_FILLUP=FILL_UP
3360 ali SC_AC_DOUBLECLICK=DOUBLE_CLICK
3362 # characterSource for SCN_CHARADDED
3363 enu CharacterSource=SC_CHARACTERSOURCE_
3364 # Direct input characters.
3365 val SC_CHARACTERSOURCE_DIRECT_INPUT=0
3366 # IME (inline mode) or dead key tentative input characters.
3367 val SC_CHARACTERSOURCE_TENTATIVE_INPUT=1
3368 # IME (either inline or windowed mode) full composited string.
3369 val SC_CHARACTERSOURCE_IME_RESULT=2
3371 # Events
3373 evt void StyleNeeded=2000(int position)
3374 evt void CharAdded=2001(int ch, int characterSource)
3375 evt void SavePointReached=2002(void)
3376 evt void SavePointLeft=2003(void)
3377 evt void ModifyAttemptRO=2004(void)
3378 # GTK Specific to work around focus and accelerator problems:
3379 evt void Key=2005(int ch, int modifiers)
3380 evt void DoubleClick=2006(int modifiers, int position, int line)
3381 evt void UpdateUI=2007(int updated)
3382 evt void Modified=2008(int position, int modificationType, string text, int length, int linesAdded, int line, int foldLevelNow, int foldLevelPrev, int token, int annotationLinesAdded)
3383 evt void MacroRecord=2009(int message, int wParam, int lParam)
3384 evt void MarginClick=2010(int modifiers, int position, int margin)
3385 evt void NeedShown=2011(int position, int length)
3386 evt void Painted=2013(void)
3387 evt void UserListSelection=2014(int listType, string text, int position, int ch, CompletionMethods listCompletionMethod)
3388 evt void URIDropped=2015(string text)
3389 evt void DwellStart=2016(int position, int x, int y)
3390 evt void DwellEnd=2017(int position, int x, int y)
3391 evt void Zoom=2018(void)
3392 evt void HotSpotClick=2019(int modifiers, int position)
3393 evt void HotSpotDoubleClick=2020(int modifiers, int position)
3394 evt void CallTipClick=2021(int position)
3395 evt void AutoCSelection=2022(string text, int position, int ch, CompletionMethods listCompletionMethod)
3396 evt void IndicatorClick=2023(int modifiers, int position)
3397 evt void IndicatorRelease=2024(int modifiers, int position)
3398 evt void AutoCCancelled=2025(void)
3399 evt void AutoCCharDeleted=2026(void)
3400 evt void HotSpotReleaseClick=2027(int modifiers, int position)
3401 evt void FocusIn=2028(void)
3402 evt void FocusOut=2029(void)
3403 evt void AutoCCompleted=2030(string text, int position, int ch, CompletionMethods listCompletionMethod)
3404 evt void MarginRightClick=2031(int modifiers, int position, int margin)
3405 evt void AutoCSelectionChange=2032(int listType, string text, int position)
3407 cat Provisional
3409 enu Bidirectional=SC_BIDIRECTIONAL_
3410 val SC_BIDIRECTIONAL_DISABLED=0
3411 val SC_BIDIRECTIONAL_L2R=1
3412 val SC_BIDIRECTIONAL_R2L=2
3414 # Retrieve bidirectional text display state.
3415 get Bidirectional GetBidirectional=2708(,)
3417 # Set bidirectional text display state.
3418 set void SetBidirectional=2709(Bidirectional bidirectional,)
3420 cat Deprecated
3422 # Divide each styling byte into lexical class bits (default: 5) and indicator
3423 # bits (default: 3). If a lexer requires more than 32 lexical states, then this
3424 # is used to expand the possible states.
3425 set void SetStyleBits=2090(int bits,)
3427 # Retrieve number of bits in style bytes used to hold the lexical state.
3428 get int GetStyleBits=2091(,)
3430 # Retrieve the number of bits the current lexer needs for styling.
3431 get int GetStyleBitsNeeded=4011(,)
3433 # Deprecated in 3.5.5
3435 # Always interpret keyboard input as Unicode
3436 set void SetKeysUnicode=2521(bool keysUnicode,)
3438 # Are keys always interpreted as Unicode?
3439 get bool GetKeysUnicode=2522(,)
3441 # Is drawing done in two phases with backgrounds drawn before foregrounds?
3442 get bool GetTwoPhaseDraw=2283(,)
3444 # In twoPhaseDraw mode, drawing is performed in two phases, first the background
3445 # and then the foreground. This avoids chopping off characters that overlap the next run.
3446 set void SetTwoPhaseDraw=2284(bool twoPhase,)
3448 val INDIC0_MASK=0x20
3449 val INDIC1_MASK=0x40
3450 val INDIC2_MASK=0x80
3451 val INDICS_MASK=0xE0