1 ## First line may be used for shbang
3 ## This file defines the interface to Scintilla
5 ## A line starting with ## is a pure comment and should be stripped by readers.
6 ## A line starting with #! is for future shbang use
7 ## A line starting with # followed by a space is a documentation comment and refers
8 ## to the next feature definition.
10 ## Each feature is defined by a line starting with fun, get, set, val or evt.
11 ## cat -> start a category
13 ## get -> a property get function
14 ## set -> a property set function
15 ## val -> definition of a constant
17 ## All other feature names should be ignored. They may be defined in the future.
18 ## A property may have a set function, a get function or both. Each will have
19 ## "Get" or "Set" in their names and the corresponding name will have the obvious switch.
20 ## A property may be subscripted, in which case the first parameter is the subscript.
21 ## fun, get, and set features have a strict syntax:
22 ## <featureType><ws><returnType><ws><name>[=<number](<param>,<param>)
23 ## param is <paramType><ws><paramName>[=<value>]
24 ## Additional white space is allowed between elements.
25 ## The syntax for evt is <featureType><ws><returnType><ws><name>[=<number]([<param>[,<param>]*])
26 ## Feature names that contain an underscore are defined by Windows, so in these
27 ## cases, using the Windows definition is preferred where available.
32 ## bool -> integer, 1=true, 0=false
33 ## position -> integer position in a document
34 ## colour -> colour integer containing red, green and blue bytes.
35 ## string -> pointer to const character
36 ## stringresult -> pointer to character
37 ## cells -> pointer to array of cells, each cell containing a style byte and character byte
38 ## charrange -> range of a min and a max position
39 ## charrangeresult -> like charrange, but output param
40 ## textrange -> charrange + output string
41 ## findtext -> searchrange, text -> foundposition
42 ## findtextex -> searchrange
43 ## keymod -> integer containing key in low half and modifiers in high half
47 ## pointresult -> like point, but output param
48 ## rectangle -> left,top,right,bottom
49 ## Client code should ignore definitions containing types it does not understand, except
50 ## for possibly #defining the constants
54 ################################################
56 val INVALID_POSITION=-1
57 # Define start of Scintilla messages to be greater than all edit (EM_*) messages
58 # as many EM_ messages can be used although that use is deprecated.
60 val SCI_OPTIONAL_START=3000
61 val SCI_LEXER_START=4000
63 # Add text to the document
64 fun void AddText=2001(int length, string text)
66 # Add array of cells to document
67 fun void AddStyledText=2002(int length, cells c)
69 # Insert string at a position
70 fun void InsertText=2003(position pos, string text)
72 # Delete all text in the document
73 fun void ClearAll=2004(,)
75 # Set all style bytes to 0, remove all folding information
76 fun void ClearDocumentStyle=2005(,)
78 # The number of characters in the document
79 get int GetLength=2006(,)
81 # Returns the character byte at the position
82 get int GetCharAt=2007(position pos,)
84 # Returns the position of the caret
85 get position GetCurrentPos=2008(,)
87 # Returns the position of the opposite end of the selection to the caret
88 get position GetAnchor=2009(,)
90 # Returns the style byte at the position
91 get int GetStyleAt=2010(position pos,)
93 # Redoes the next action on the undo history
96 # Choose between collecting actions into the undo
97 # history and discarding them.
98 set void SetUndoCollection=2012(bool collectUndo,)
100 # Select all the text in the document.
101 fun void SelectAll=2013(,)
103 # Remember the current position in the undo history as the position
104 # at which the document was saved.
105 fun void SetSavePoint=2014(,)
107 # Retrieve a buffer of cells.
108 # Returns the number of bytes in the buffer not including terminating nulls.
109 fun int GetStyledText=2015(, textrange tr)
111 # Are there any redoable actions in the undo history.
112 fun bool CanRedo=2016(,)
114 # Retrieve the line number at which a particular marker is located
115 fun int MarkerLineFromHandle=2017(int handle,)
118 fun void MarkerDeleteHandle=2018(int handle,)
120 # Is undo history being collected?
121 get bool GetUndoCollection=2019(,)
124 val SCWS_VISIBLEALWAYS=1
125 val SCWS_VISIBLEAFTERINDENT=2
127 # Are white space characters currently visible?
128 # Returns one of SCWS_* constants.
129 get int GetViewWS=2020(,)
131 # Make white space characters invisible, always visible or visible outside indentation.
132 set void SetViewWS=2021(int viewWS,)
134 # Find the position from a point within the window.
135 fun int PositionFromPoint=2022(int x, int y)
137 # Find the position from a point within the window but return
138 # INVALID_POSITION if not close to text.
139 fun int PositionFromPointClose=2023(int x, int y)
141 # Set caret to start of a line and ensure it is visible.
142 fun void GotoLine=2024(int line,)
144 # Set caret to a position and ensure it is visible.
145 fun void GotoPos=2025(position pos,)
147 # Set the selection anchor to a position. The anchor is the opposite
148 # end of the selection from the caret.
149 set void SetAnchor=2026(position posAnchor,)
151 # Retrieve the text of the line containing the caret.
152 # Returns the index of the caret on the line.
153 fun int GetCurLine=2027(int length, stringresult text)
155 # Retrieve the position of the last correctly styled character.
156 get position GetEndStyled=2028(,)
162 # Convert all line endings in the document to one mode.
163 fun void ConvertEOLs=2029(int eolMode,)
165 # Retrieve the current end of line mode - one of CRLF, CR, or LF.
166 get int GetEOLMode=2030(,)
168 # Set the current end of line mode.
169 set void SetEOLMode=2031(int eolMode,)
171 # Set the current styling position to pos and the styling mask to mask.
172 # The styling mask can be used to protect some bits in each styling byte from
174 fun void StartStyling=2032(position pos, int mask)
176 # Change style from current styling position for length characters to a style
177 # and move the current styling position to after this newly styled segment.
178 fun void SetStyling=2033(int length, int style)
180 # Is drawing done first into a buffer or direct to the screen.
181 get bool GetBufferedDraw=2034(,)
183 # If drawing is buffered then each line of text is drawn into a bitmap buffer
184 # before drawing it to the screen to avoid flicker.
185 set void SetBufferedDraw=2035(bool buffered,)
187 # Change the visible size of a tab to be a multiple of the width of a space
189 set void SetTabWidth=2036(int tabWidth,)
191 # Retrieve the visible size of a tab.
192 get int GetTabWidth=2121(,)
194 # The SC_CP_UTF8 value can be used to enter Unicode mode.
195 # This is the same value as CP_UTF8 in Windows
198 # Set the code page used to interpret the bytes of the document as characters.
199 # The SC_CP_UTF8 value can be used to enter Unicode mode.
200 set void SetCodePage=2037(int codePage,)
202 # In palette mode, Scintilla uses the environments palette calls to display
203 # more colours. This may lead to ugly displays.
204 set void SetUsePalette=2039(bool usePalette,)
208 val SC_MARK_ROUNDRECT=1
210 val SC_MARK_SMALLRECT=3
211 val SC_MARK_SHORTARROW=4
213 val SC_MARK_ARROWDOWN=6
217 # Shapes used for outlining column
219 val SC_MARK_LCORNER=10
220 val SC_MARK_TCORNER=11
221 val SC_MARK_BOXPLUS=12
222 val SC_MARK_BOXPLUSCONNECTED=13
223 val SC_MARK_BOXMINUS=14
224 val SC_MARK_BOXMINUSCONNECTED=15
225 val SC_MARK_LCORNERCURVE=16
226 val SC_MARK_TCORNERCURVE=17
227 val SC_MARK_CIRCLEPLUS=18
228 val SC_MARK_CIRCLEPLUSCONNECTED=19
229 val SC_MARK_CIRCLEMINUS=20
230 val SC_MARK_CIRCLEMINUSCONNECTED=21
232 # Markers used for outlining column
233 val SC_MARKNUM_FOLDEREND=25
234 val SC_MARKNUM_FOLDEROPENMID=26
235 val SC_MARKNUM_FOLDERMIDTAIL=27
236 val SC_MARKNUM_FOLDERTAIL=28
237 val SC_MARKNUM_FOLDERSUB=29
238 val SC_MARKNUM_FOLDER=30
239 val SC_MARKNUM_FOLDEROPEN=31
241 # Set the symbol used for a particular marker number.
242 fun void MarkerDefine=2040(int markerNumber, int markerSymbol)
244 # Set the foreground colour used for a particular marker number.
245 fun void MarkerSetFore=2041(int markerNumber, colour fore)
247 # Set the background colour used for a particular marker number.
248 fun void MarkerSetBack=2042(int markerNumber, colour back)
250 # Add a marker to a line.
251 fun void MarkerAdd=2043(int line, int markerNumber)
253 # Delete a marker from a line
254 fun void MarkerDelete=2044(int line, int markerNumber)
256 # Delete all markers with a particular number from all lines
257 fun void MarkerDeleteAll=2045(int markerNumber,)
259 # Get a bit mask of all the markers set on a line.
260 fun int MarkerGet=2046(int line,)
262 # Find the next line after lineStart that includes a marker in mask.
263 fun int MarkerNext=2047(int lineStart, int markerMask)
265 # Find the previous line before lineStart that includes a marker in mask.
266 fun int MarkerPrevious=2048(int lineStart, int markerMask)
268 val SC_MARGIN_SYMBOL=0
269 val SC_MARGIN_NUMBER=1
271 # Set a margin to be either numeric or symbolic.
272 set void SetMarginTypeN=2240(int margin, int marginType)
274 # Retrieve the type of a margin.
275 get int GetMarginTypeN=2241(int margin,)
277 # Set the width of a margin to a width expressed in pixels.
278 set void SetMarginWidthN=2242(int margin, int pixelWidth)
280 # Retrieve the width of a margin in pixels.
281 get int GetMarginWidthN=2243(int margin,)
283 # Set a mask that determines which markers are displayed in a margin.
284 set void SetMarginMaskN=2244(int margin, int mask)
286 # Retrieve the marker mask of a margin.
287 get int GetMarginMaskN=2245(int margin,)
289 # Make a margin sensitive or insensitive to mouse clicks.
290 set void SetMarginSensitiveN=2246(int margin, bool sensitive)
292 # Retrieve the mouse click sensitivity of a margin.
293 get bool GetMarginSensitiveN=2247(int margin,)
296 val STYLE_LINENUMBER=33
297 val STYLE_BRACELIGHT=34
298 val STYLE_BRACEBAD=35
299 val STYLE_CONTROLCHAR=36
300 val STYLE_INDENTGUIDE=37
303 # Character set identifiers are used in StyleSetCharacterSet.
304 # The values are the same as the Windows *_CHARSET values.
305 val SC_CHARSET_ANSI=0
306 val SC_CHARSET_DEFAULT=1
307 val SC_CHARSET_BALTIC=186
308 val SC_CHARSET_CHINESEBIG5=136
309 val SC_CHARSET_EASTEUROPE=238
310 val SC_CHARSET_GB2312=134
311 val SC_CHARSET_GREEK=161
312 val SC_CHARSET_HANGUL=129
313 val SC_CHARSET_MAC=77
314 val SC_CHARSET_OEM=255
315 val SC_CHARSET_RUSSIAN=204
316 val SC_CHARSET_SHIFTJIS=128
317 val SC_CHARSET_SYMBOL=2
318 val SC_CHARSET_TURKISH=162
319 val SC_CHARSET_JOHAB=130
320 val SC_CHARSET_HEBREW=177
321 val SC_CHARSET_ARABIC=178
322 val SC_CHARSET_VIETNAMESE=163
323 val SC_CHARSET_THAI=222
325 # Clear all the styles and make equivalent to the global default style.
326 set void StyleClearAll=2050(,)
328 # Set the foreground colour of a style.
329 set void StyleSetFore=2051(int style, colour fore)
331 # Set the background colour of a style.
332 set void StyleSetBack=2052(int style, colour back)
334 # Set a style to be bold or not.
335 set void StyleSetBold=2053(int style, bool bold)
337 # Set a style to be italic or not.
338 set void StyleSetItalic=2054(int style, bool italic)
340 # Set the size of characters of a style.
341 set void StyleSetSize=2055(int style, int sizePoints)
343 # Set the font of a style.
344 set void StyleSetFont=2056(int style, string fontName)
346 # Set a style to have its end of line filled or not.
347 set void StyleSetEOLFilled=2057(int style, bool filled)
349 # Reset the default style to its state at startup
350 fun void StyleResetDefault=2058(,)
352 # Set a style to be underlined or not.
353 set void StyleSetUnderline=2059(int style, bool underline)
358 # Set a style to be mixed case, or to force upper or lower case.
359 set void StyleSetCase=2060(int style, int caseForce)
361 # Set the character set of the font in a style.
362 set void StyleSetCharacterSet=2066(int style, int characterSet)
364 # Set the foreground colour of the selection and whether to use this setting.
365 fun void SetSelFore=2067(bool useSetting, colour fore)
367 # Set the background colour of the selection and whether to use this setting.
368 fun void SetSelBack=2068(bool useSetting, colour back)
370 # Set the foreground colour of the caret.
371 set void SetCaretFore=2069(colour fore,)
373 # When key+modifier combination km is pressed perform msg.
374 fun void AssignCmdKey=2070(keymod km, int msg)
376 # When key+modifier combination km do nothing.
377 fun void ClearCmdKey=2071(keymod km,)
379 # Drop all key mappings.
380 fun void ClearAllCmdKeys=2072(,)
382 # Set the styles for a segment of the document.
383 fun void SetStylingEx=2073(int length, string styles)
385 # Set a style to be visible or not.
386 set void StyleSetVisible=2074(int style, bool visible)
388 # Get the time in milliseconds that the caret is on and off.
389 get int GetCaretPeriod=2075(,)
391 # Get the time in milliseconds that the caret is on and off. 0 = steady on.
392 set void SetCaretPeriod=2076(int periodMilliseconds,)
394 # Set the set of characters making up words for when moving or selecting
396 set void SetWordChars=2077(, string characters)
398 # Start a sequence of actions that is undone and redone as a unit.
400 fun void BeginUndoAction=2078(,)
402 # End a sequence of actions that is undone and redone as a unit.
403 fun void EndUndoAction=2079(,)
415 ##INDIC0_MASK | INDIC1_MASK | INDIC2_MASK
417 # Set an indicator to plain, squiggle or TT.
418 set void IndicSetStyle=2080(int indic, int style)
420 # Retrieve the style of an indicator.
421 get int IndicGetStyle=2081(int indic,)
423 # Set the foreground colour of an indicator.
424 set void IndicSetFore=2082(int indic, colour fore)
426 # Retrieve the foreground colour of an indicator.
427 get colour IndicGetFore=2083(int indic,)
429 # Divide each styling byte into lexical class bits (default:5) and indicator
430 # bits (default:3). If a lexer requires more than 32 lexical states, then this
431 # is used to expand the possible states.
432 set void SetStyleBits=2090(int bits,)
434 # Retrieve number of bits in style bytes used to hold the lexical state.
435 get int GetStyleBits=2091(,)
437 # Used to hold extra styling information for each line.
438 set void SetLineState=2092(int line, int state)
440 # Retrieve the extra styling information for a line.
441 get int GetLineState=2093(int line,)
443 # Retrieve the last line number that has line state.
444 get int GetMaxLineState=2094(,)
446 # Is the background of the line containing the caret in a different colour?
447 get bool GetCaretLineVisible=2095(,)
449 # Display the background of the line containing the caret in a different colour.
450 set void SetCaretLineVisible=2096(bool show,)
452 # Get the colour of the background of the line containing the caret.
453 get colour GetCaretLineBack=2097(,)
455 # Set the colour of the background of the line containing the caret.
456 set void SetCaretLineBack=2098(colour back,)
458 # Display a auto-completion list.
459 # The lenEntered parameter indicates how many characters before
460 # the caret should be used to provide context.
461 fun void AutoCShow=2100(int lenEntered, string itemList)
463 # Remove the auto-completion list from the screen.
464 fun void AutoCCancel=2101(,)
466 # Is there an auto-completion list visible?
467 fun bool AutoCActive=2102(,)
469 # Retrieve the position of the caret when the auto-completion list was
471 fun position AutoCPosStart=2103(,)
473 # User has selected an item so remove the list and insert the selection.
474 fun void AutoCComplete=2104(,)
476 # Define a set of character that when typed cancel the auto-completion list.
477 fun void AutoCStops=2105(, string characterSet)
479 # Change the separator character in the string setting up an auto-completion
480 # list. Default is space but can be changed if items contain space.
481 set void AutoCSetSeparator=2106(int separatorCharacter,)
483 # Retrieve the auto-completion list separator character.
484 get int AutoCGetSeparator=2107(,)
486 # Select the item in the auto-completion list that starts with a string.
487 fun void AutoCSelect=2108(, string text)
489 # Should the auto-completion list be cancelled if the user backspaces to a
490 # position before where the box was created.
491 set void AutoCSetCancelAtStart=2110(bool cancel,)
493 # Retrieve whether auto-completion cancelled by backspacing before start.
494 get bool AutoCGetCancelAtStart=2111(,)
496 # Define a set of character that when typed fills up the selected word.
497 set void AutoCSetFillUps=2112(, string characterSet)
499 # Should a single item auto-completion list automatically choose the item.
500 set void AutoCSetChooseSingle=2113(bool chooseSingle,)
502 # Retrieve whether a single item auto-completion list automatically choose the item.
503 get bool AutoCGetChooseSingle=2114(,)
505 # Set whether case is significant when performing auto-completion searches.
506 set void AutoCSetIgnoreCase=2115(bool ignoreCase,)
508 # Retrieve state of ignore case flag.
509 get bool AutoCGetIgnoreCase=2116(,)
511 # Display a list of strings and send notification when user chooses one.
512 fun void UserListShow=2117(int listType, string itemList)
514 # Set whether or not autocompletion is hidden automatically when nothing matches
515 set void AutoCSetAutoHide=2118(bool autoHide,)
517 # Retrieve whether or not autocompletion is hidden automatically when nothing matches
518 get bool AutoCGetAutoHide=2119(,)
520 # Set the number of spaces used for one level of indentation.
521 set void SetIndent=2122(int indentSize,)
523 # Retrieve indentation size.
524 get int GetIndent=2123(,)
526 # Indentation will only use space characters if useTabs is false, otherwise
527 # it will use a combination of tabs and spaces.
528 set void SetUseTabs=2124(bool useTabs,)
530 # Retrieve whether tabs will be used in indentation.
531 get bool GetUseTabs=2125(,)
533 # Change the indentation of a line to a number of columns.
534 set void SetLineIndentation=2126(int line, int indentSize)
536 # Retrieve the number of columns that a line is indented.
537 get int GetLineIndentation=2127(int line,)
539 # Retrieve the position before the first non indentation character on a line.
540 get position GetLineIndentPosition=2128(int line,)
542 # Retrieve the column number of a position, taking tab width into account.
543 get int GetColumn=2129(position pos,)
545 # Show or hide the horizontal scroll bar.
546 set void SetHScrollBar=2130(bool show,)
548 # Is the horizontal scroll bar visible?
549 get bool GetHScrollBar=2131(,)
551 # Show or hide indentation guides.
552 set void SetIndentationGuides=2132(bool show,)
554 # Are the indentation guides visible?
555 get bool GetIndentationGuides=2133(,)
557 # Set the highlighted indentation guide column.
558 # 0 = no highlighted guide.
559 set void SetHighlightGuide=2134(int column,)
561 # Get the highlighted indentation guide column.
562 get int GetHighlightGuide=2135(,)
564 # Get the position after the last visible characters on a line.
565 get int GetLineEndPosition=2136(int line,)
567 # Get the code page used to interpret the bytes of the document as characters.
568 get int GetCodePage=2137(,)
570 # Get the foreground colour of the caret.
571 get colour GetCaretFore=2138(,)
574 get bool GetUsePalette=2139(,)
577 get bool GetReadOnly=2140(,)
579 # Sets the position of the caret.
580 set void SetCurrentPos=2141(position pos,)
582 # Sets the position that starts the selection - this becomes the anchor.
583 set void SetSelectionStart=2142(position pos,)
585 # Returns the position at the start of the selection.
586 get position GetSelectionStart=2143(,)
588 # Sets the position that ends the selection - this becomes the currentPosition.
589 set void SetSelectionEnd=2144(position pos,)
591 # Returns the position at the end of the selection.
592 get position GetSelectionEnd=2145(,)
594 # Sets the print magnification added to the point size of each style for printing.
595 set void SetPrintMagnification=2146(int magnification,)
597 # Returns the print magnification.
598 get int GetPrintMagnification=2147(,)
600 # PrintColourMode - use same colours as screen.
601 val SC_PRINT_NORMAL=0
602 # PrintColourMode - invert the light value of each style for printing.
603 val SC_PRINT_INVERTLIGHT=1
604 # PrintColourMode - force black text on white background for printing.
605 val SC_PRINT_BLACKONWHITE=2
606 # PrintColourMode - text stays coloured, but all background is forced to be white for printing.
607 val SC_PRINT_COLOURONWHITE=3
608 # PrintColourMode - only the default-background is forced to be white for printing.
609 val SC_PRINT_COLOURONWHITEDEFAULTBG=4
611 # Modify colours when printing for clearer printed text.
612 set void SetPrintColourMode=2148(int mode,)
614 # Returns the print colour mode.
615 get int GetPrintColourMode=2149(,)
617 val SCFIND_WHOLEWORD=2
618 val SCFIND_MATCHCASE=4
619 val SCFIND_WORDSTART=0x00100000
620 val SCFIND_REGEXP=0x00200000
622 # Find some text in the document.
623 fun position FindText=2150(int flags, findtext ft)
625 # On Windows will draw the document into a display context such as a printer.
626 fun void FormatRange=2151(bool draw, formatrange fr)
628 # Retrieve the line at the top of the display.
629 get int GetFirstVisibleLine=2152(,)
631 # Retrieve the contents of a line.
632 # Returns the length of the line.
633 fun int GetLine=2153(int line, stringresult text)
635 # Returns the number of lines in the document. There is always at least one.
636 get int GetLineCount=2154(,)
638 # Sets the size in pixels of the left margin.
639 set void SetMarginLeft=2155(, int pixelWidth)
641 # Returns the size in pixels of the left margin.
642 get int GetMarginLeft=2156(,)
644 # Sets the size in pixels of the right margin.
645 set void SetMarginRight=2157(, int pixelWidth)
647 # Returns the size in pixels of the right margin.
648 get int GetMarginRight=2158(,)
650 # Is the document different from when it was last saved?
651 get bool GetModify=2159(,)
653 # Select a range of text.
654 fun void SetSel=2160(position start, position end)
656 # Retrieve the selected text.
657 # Return the length of the text.
658 fun int GetSelText=2161(,stringresult text)
660 # Retrieve a range of text.
661 # Return the length of the text.
662 fun int GetTextRange=2162(, textrange tr)
664 # Draw the selection in normal style or with selection highlighted.
665 fun void HideSelection=2163(bool normal,)
667 # Retrieve the x value of the point in the window where a position is displayed.
668 fun int PointXFromPosition=2164(, position pos)
670 # Retrieve the y value of the point in the window where a position is displayed.
671 fun int PointYFromPosition=2165(, position pos)
673 # Retrieve the line containing a position.
674 fun int LineFromPosition=2166(position pos,)
676 # Retrieve the position at the start of a line.
677 fun int PositionFromLine=2167(int line,)
679 # Scroll horizontally and vertically.
680 fun void LineScroll=2168(int columns, int lines)
682 # Ensure the caret is visible.
683 fun void ScrollCaret=2169(,)
685 # Replace the selected text with the argument text.
686 fun void ReplaceSel=2170(, string text)
688 # Set to read only or read write.
689 set void SetReadOnly=2171(bool readOnly,)
692 fun void Null=2172(,)
694 # Will a paste succeed?
695 fun bool CanPaste=2173(,)
697 # Are there any undoable actions in the undo history.
698 fun bool CanUndo=2174(,)
700 # Delete the undo history.
701 fun void EmptyUndoBuffer=2175(,)
703 # Undo one action in the undo history.
704 fun void Undo=2176(,)
706 # Cut the selection to the clipboard.
709 # Copy the selection to the clipboard.
710 fun void Copy=2178(,)
712 # Paste the contents of the clipboard into the document replacing the selection.
713 fun void Paste=2179(,)
715 # Clear the selection.
716 fun void Clear=2180(,)
718 # Replace the contents of the document with the argument text.
719 fun void SetText=2181(, string text)
721 # Retrieve all the text in the document.
722 # Returns number of characters retrieved.
723 fun int GetText=2182(int length, stringresult text)
725 # Retrieve the number of characters in the document.
726 get int GetTextLength=2183(,)
728 # Retrieve a pointer to a function that processes messages for this Scintilla.
729 get int GetDirectFunction=2184(,)
731 # Retrieve a pointer value to use as the first argument when calling
732 # the function returned by GetDirectFunction.
733 get int GetDirectPointer=2185(,)
735 # Set to overtype (true) or insert mode
736 set void SetOvertype=2186(bool overtype,)
738 # Returns true if overtype mode is active otherwise false is returned.
739 get bool GetOvertype=2187(,)
741 # Set the width of the insert mode caret
742 set void SetCaretWidth=2188(int pixelWidth,)
744 # Returns the width of the insert mode caret
745 get int GetCaretWidth=2189(,)
747 # Sets the position that starts the target which is used for updating the
748 # document without affecting the scroll position.
749 set void SetTargetStart=2190(position pos,)
751 # Get the position that starts the target.
752 get position GetTargetStart=2191(,)
754 # Sets the position that ends the target which is used for updating the
755 # document without affecting the scroll position.
756 set void SetTargetEnd=2192(position pos,)
758 # Get the position that ends the target.
759 get position GetTargetEnd=2193(,)
761 # Replace the target text with the argument text.
762 # Returns the length of the replacement text.
763 fun int ReplaceTarget=2194(int length, string text)
765 # Replace the target text with the argument text after \d processing.
766 # Looks for \d where d is between 1 and 9 and replaces these with the strings
767 # matched in the last search operation which were surrounded by \( and \).
768 # Returns the length of the replacement text including any change
769 # caused by processing the \d patterns.
770 fun int ReplaceTargetRE=2195(int length, string text)
772 # Search for a counted string in the target and set the target to the found
774 # Returns length of range or -1 for failure in which case target is not moved.
775 fun int SearchInTarget=2197(int length, string text)
777 # Set the search flags used by SearchInTarget
778 set void SetSearchFlags=2198(int flags,)
780 # Get the search flags used by SearchInTarget
781 get int GetSearchFlags=2199(,)
783 # Show a call tip containing a definition near position pos.
784 fun void CallTipShow=2200(position pos, string definition)
786 # Remove the call tip from the screen.
787 fun void CallTipCancel=2201(,)
789 # Is there an active call tip?
790 fun bool CallTipActive=2202(,)
792 # Retrieve the position where the caret was before displaying the call tip.
793 fun position CallTipPosStart=2203(,)
795 # Highlight a segment of the definition.
796 fun void CallTipSetHlt=2204(int start, int end)
798 # Set the background colour for the call tip.
799 set void CallTipSetBack=2205(colour back,)
801 # Find the display line of a document line taking hidden lines into account.
802 fun int VisibleFromDocLine=2220(int line,)
804 # Find the document line of a display line taking hidden lines into account.
805 fun int DocLineFromVisible=2221(int lineDisplay,)
807 val SC_FOLDLEVELBASE=0x400
808 val SC_FOLDLEVELWHITEFLAG=0x1000
809 val SC_FOLDLEVELHEADERFLAG=0x2000
810 val SC_FOLDLEVELNUMBERMASK=0x0FFF
812 # Set the fold level of a line.
813 # This encodes an integer level along with flags indicating whether the
814 # line is a header and whether it is effectively white space.
815 set void SetFoldLevel=2222(int line, int level)
817 # Retrieve the fold level of a line.
818 get int GetFoldLevel=2223(int line,)
820 # Find the last child line of a header line.
821 get int GetLastChild=2224(int line, int level)
823 # Find the parent line of a child line.
824 get int GetFoldParent=2225(int line,)
826 # Make a range of lines visible.
827 fun void ShowLines=2226(int lineStart, int lineEnd)
829 # Make a range of lines invisible.
830 fun void HideLines=2227(int lineStart, int lineEnd)
833 get bool GetLineVisible=2228(int line,)
835 # Show the children of a header line.
836 set void SetFoldExpanded=2229(int line, bool expanded)
838 # Is a header line expanded?
839 get bool GetFoldExpanded=2230(int line,)
841 # Switch a header line between expanded and contracted.
842 fun void ToggleFold=2231(int line,)
844 # Ensure a particular line is visible by expanding any header line hiding it.
845 fun void EnsureVisible=2232(int line,)
847 # Set some debugging options for folding
848 fun void SetFoldFlags=2233(int flags,)
850 # Ensure a particular line is visible by expanding any header line hiding it.
851 # Use the currently set visibility policy to determine which range to display.
852 fun void EnsureVisibleEnforcePolicy=2234(int line,)
854 # Sets whether a tab pressed when caret is within indentation indents
855 set void SetTabIndents=2260(bool tabIndents,)
857 # Does a tab pressed when caret is within indentation indent?
858 get bool GetTabIndents=2261(,)
860 # Sets whether a backspace pressed when caret is within indentation unindents
861 set void SetBackSpaceUnIndents=2262(bool bsUnIndents,)
863 # Does a backspace pressed when caret is within indentation unindent?
864 get bool GetBackSpaceUnIndents=2263(,)
866 val SC_TIME_FOREVER=10000000
868 # Sets the time the mouse must sit still to generate a mouse dwell event
869 set void SetMouseDwellTime=2264(int periodMilliseconds,)
871 # Retrieve the time the mouse must sit still to generate a mouse dwell event
872 get int GetMouseDwellTime=2265(,)
874 ## Start of key messages
875 # Move caret down one line.
876 fun void LineDown=2300(,)
878 # Move caret down one line extending selection to new caret position.
879 fun void LineDownExtend=2301(,)
881 # Move caret up one line.
882 fun void LineUp=2302(,)
884 # Move caret up one line extending selection to new caret position.
885 fun void LineUpExtend=2303(,)
887 # Move caret left one character.
888 fun void CharLeft=2304(,)
890 # Move caret left one character extending selection to new caret position.
891 fun void CharLeftExtend=2305(,)
893 # Move caret right one character.
894 fun void CharRight=2306(,)
896 # Move caret right one character extending selection to new caret position.
897 fun void CharRightExtend=2307(,)
899 # Move caret left one word.
900 fun void WordLeft=2308(,)
902 # Move caret left one word extending selection to new caret position.
903 fun void WordLeftExtend=2309(,)
905 # Move caret right one word.
906 fun void WordRight=2310(,)
908 # Move caret right one word extending selection to new caret position.
909 fun void WordRightExtend=2311(,)
911 # Move caret to first position on line.
912 fun void Home=2312(,)
914 # Move caret to first position on line extending selection to new caret position.
915 fun void HomeExtend=2313(,)
917 # Move caret to last position on line.
918 fun void LineEnd=2314(,)
920 # Move caret to last position on line extending selection to new caret position.
921 fun void LineEndExtend=2315(,)
923 # Move caret to first position in document.
924 fun void DocumentStart=2316(,)
926 # Move caret to first position in document extending selection to new caret position.
927 fun void DocumentStartExtend=2317(,)
929 # Move caret to last position in document.
930 fun void DocumentEnd=2318(,)
932 # Move caret to last position in document extending selection to new caret position.
933 fun void DocumentEndExtend=2319(,)
935 # Move caret one page up.
936 fun void PageUp=2320(,)
938 # Move caret one page up extending selection to new caret position.
939 fun void PageUpExtend=2321(,)
941 # Move caret one page down.
942 fun void PageDown=2322(,)
944 # Move caret one page down extending selection to new caret position.
945 fun void PageDownExtend=2323(,)
947 # Switch from insert to overtype mode or the reverse.
948 fun void EditToggleOvertype=2324(,)
950 # Cancel any modes such as call tip or auto-completion list display.
951 fun void Cancel=2325(,)
953 # Delete the selection or if no selection, the character before the caret.
954 fun void DeleteBack=2326(,)
956 # If selection is empty or all on one line replace the selection with a tab
958 # If more than one line selected, indent the lines.
961 # Dedent the selected lines.
962 fun void BackTab=2328(,)
964 # Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
965 fun void NewLine=2329(,)
967 # Insert a Form Feed character.
968 fun void FormFeed=2330(,)
970 # Move caret to before first visible character on line.
971 # If already there move to first character on line.
972 fun void VCHome=2331(,)
974 # Like VCHome but extending selection to new caret position.
975 fun void VCHomeExtend=2332(,)
977 # Magnify the displayed text by increasing the sizes by 1 point.
978 fun void ZoomIn=2333(,)
980 # Make the displayed text smaller by decreasing the sizes by 1 point.
981 fun void ZoomOut=2334(,)
983 # Delete the word to the left of the caret.
984 fun void DelWordLeft=2335(,)
986 # Delete the word to the right of the caret.
987 fun void DelWordRight=2336(,)
989 # Cut the line containing the caret.
990 fun void LineCut=2337(,)
992 # Delete the line containing the caret.
993 fun void LineDelete=2338(,)
995 # Switch the current line with the previous.
996 fun void LineTranspose=2339(,)
998 # Transform the selection to lower case.
999 fun void LowerCase=2340(,)
1001 # Transform the selection to upper case.
1002 fun void UpperCase=2341(,)
1004 # Scroll the document down, keeping the caret visible.
1005 fun void LineScrollDown=2342(,)
1007 # Scroll the document up, keeping the caret visible.
1008 fun void LineScrollUp=2343(,)
1010 # Move the caret inside current view if it's not there already
1011 fun void MoveCaretInsideView=2401(,)
1013 # How many characters are on a line, not including end of line characters.
1014 fun int LineLength=2350(int line,)
1016 # Highlight the characters at two positions.
1017 fun void BraceHighlight=2351(position pos1,position pos2)
1019 # Highlight the character at a position indicating there is no matching brace.
1020 fun void BraceBadLight=2352(position pos,)
1022 # Find the position of a matching brace or INVALID_POSITION if no match.
1023 fun position BraceMatch=2353(position pos,)
1025 # Are the end of line characters visible.
1026 get bool GetViewEOL=2355(,)
1028 # Make the end of line characters visible or invisible
1029 set void SetViewEOL=2356(bool visible,)
1031 # Retrieve a pointer to the document object.
1032 get int GetDocPointer=2357(,)
1034 # Change the document object used.
1035 set void SetDocPointer=2358(,int pointer)
1037 # Set which document modification events are sent to the container.
1038 set void SetModEventMask=2359(int mask,)
1042 val EDGE_BACKGROUND=2
1044 # Retrieve the column number which text should be kept within.
1045 get int GetEdgeColumn=2360(,)
1047 # Set the column number of the edge.
1048 # If text goes past the edge then it is highlighted.
1049 set void SetEdgeColumn=2361(int column,)
1051 # Retrieve the edge highlight mode.
1052 get int GetEdgeMode=2362(,)
1054 # The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1055 # goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1056 set void SetEdgeMode=2363(int mode,)
1058 # Retrieve the colour used in edge indication.
1059 get colour GetEdgeColour=2364(,)
1061 # Change the colour used in edge indication.
1062 set void SetEdgeColour=2365(colour edgeColour,)
1064 # Sets the current caret position to be the search anchor.
1065 fun void SearchAnchor=2366(,)
1067 # Find some text starting at the search anchor.
1068 # Does not ensure the selection is visible.
1069 fun int SearchNext=2367(int flags, string text)
1071 # Find some text starting at the search anchor and moving backwards.
1072 # Does not ensure the selection is visible.
1073 fun int SearchPrev=2368(int flags, string text)
1075 # Show caret within N lines of edge when it's scrolled to view
1076 # If CARET_SLOP not set then centre caret on screen when it's
1080 val CARET_CENTER=0x02
1081 # If CARET_SLOP also set then reposition whenever outside slop border
1082 # If CARET_SLOP not set then recentre even when visible
1083 val CARET_STRICT=0x04
1084 # If CARET_XEVEN set then both left and right margins are given equal weight
1085 # rather than favouring left following behaviour.
1086 val CARET_XEVEN=0x08
1087 # If CARET_XJUMPS set then when caret reaches the margin the display jumps
1088 # enough to leave the caret solidly within the display.
1089 val CARET_XJUMPS=0x10
1090 # Set the way the line the caret is on is kept visible.
1091 fun void SetCaretPolicy=2369(int caretPolicy, int caretSlop)
1093 # Retrieves the number of lines completely visible.
1094 get int LinesOnScreen=2370(,)
1096 # Set whether a pop up menu is displayed automatically when the user presses
1097 # the wrong mouse button.
1098 fun void UsePopUp=2371(bool allowPopUp,)
1100 # Is the selection a rectangular. The alternative is the more common stream selection.
1101 get bool SelectionIsRectangle=2372(,)
1103 # Set the zoom level. This number of points is added to the size of all fonts.
1104 # It may be positive to magnify or negative to reduce.
1105 set void SetZoom=2373(int zoom,)
1106 # Retrieve the zoom level.
1107 get int GetZoom=2374(,)
1109 # Create a new document object.
1110 # Starts with reference count of 1 and not selected into editor.
1111 fun int CreateDocument=2375(,)
1112 # Extend life of document.
1113 fun void AddRefDocument=2376(, int doc)
1114 # Release a reference to the document, deleting document if it fades to black.
1115 fun void ReleaseDocument=2377(, int doc)
1117 # Get which document modification events are sent to the container.
1118 get int GetModEventMask=2378(,)
1120 # Change internal focus flag
1121 set void SetFocus=2380(bool focus,)
1122 # Get internal focus flag
1123 get bool GetFocus=2381(,)
1125 # Change error status - 0 = OK
1126 set void SetStatus=2382(int statusCode,)
1128 get int GetStatus=2383(,)
1130 # Set whether the mouse is captured when its button is pressed
1131 set void SetMouseDownCaptures=2384(bool captures,)
1132 # Get whether mouse gets captured
1133 get bool GetMouseDownCaptures=2385(,)
1135 val SC_CURSORNORMAL=-1
1137 # Sets the cursor to one of the SC_CURSOR* values
1138 set void SetCursor=2386(int cursorType,)
1140 get int GetCursor=2387(,)
1142 # Move to the previous change in capitalistion
1143 fun void WordPartLeft=2390(,)
1144 # Move to the previous change in capitalistion extending selection to new caret position.
1145 fun void WordPartLeftExtend=2391(,)
1146 # Move to the change next in capitalistion
1147 fun void WordPartRight=2392(,)
1148 # Move to the next change in capitalistion extending selection to new caret position.
1149 fun void WordPartRightExtend=2393(,)
1151 # Constants for use with SetVisiblePolicy, similar to SetCaretPolicy
1152 val VISIBLE_SLOP=0x01
1153 val VISIBLE_STRICT=0x04
1154 # Set the way the display area is determined when a particular line is to be moved to.
1155 fun void SetVisiblePolicy=2394(int visiblePolicy, int visibleSlop)
1157 # Delete back from the current position to the start of the line
1158 fun void DelLineLeft=2395(,)
1160 # Delete forwards from the current position to the end of the line
1161 fun void DelLineRight=2396(,)
1163 # Set the focus to this Scintilla widget.
1165 fun void GrabFocus=2400(,)
1167 # Start notifying the container of all key presses and commands.
1168 fun void StartRecord=3001(,)
1170 # Stop notifying the container of all key presses and commands.
1171 fun void StopRecord=3002(,)
1173 # Set the lexing language of the document.
1174 set void SetLexer=4001(int lexer,)
1176 # Retrieve the lexing language of the document.
1177 get int GetLexer=4002(,)
1179 # Colourise a segment of the document using the current lexing language.
1180 fun void Colourise=4003(position start, position end)
1182 # Set up a value that may be used by a lexer for some optional feature.
1183 set void SetProperty=4004(string key, string value)
1185 # Set up the key words used by the lexer.
1186 set void SetKeyWords=4005(int keywordSet, string keyWords)
1188 # Set the lexing language of the document based on string name.
1189 set void SetLexerLanguage=4006(, string language)
1192 # Type of modification and the action which caused the modification
1193 # These are defined as a bit mask to make it easy to specify which notifications are wanted.
1194 # One bit is set from each of SC_MOD_* and SC_PERFORMED_*.
1195 val SC_MOD_INSERTTEXT=0x1
1196 val SC_MOD_DELETETEXT=0x2
1197 val SC_MOD_CHANGESTYLE=0x4
1198 val SC_MOD_CHANGEFOLD=0x8
1199 val SC_PERFORMED_USER=0x10
1200 val SC_PERFORMED_UNDO=0x20
1201 val SC_PERFORMED_REDO=0x40
1202 val SC_LASTSTEPINUNDOREDO=0x100
1203 val SC_MOD_CHANGEMARKER=0x200
1204 val SC_MOD_BEFOREINSERT=0x400
1205 val SC_MOD_BEFOREDELETE=0x800
1206 val SC_MODEVENTMASKALL=0xF77
1208 # For compatibility, these go through the COMMAND notification rather than NOTIFY
1209 # and have exactly the same values as the EN_* constants.
1211 val SCEN_SETFOCUS=512
1212 val SCEN_KILLFOCUS=256
1214 # Symbolic key codes and modifier flags
1215 # ASCII and other printable characters below 256
1216 # Extended keys above 300
1233 val SCK_SUBTRACT=311
1240 ################################################
1242 val SCLEX_CONTAINER=0
1251 val SCLEX_PROPERTIES=9
1252 val SCLEX_ERRORLIST=10
1253 val SCLEX_MAKEFILE=11
1266 val SCLEX_EIFFELKW=24
1268 # When a lexer specifies its language as SCLEX_AUTOMATIC it receives a
1269 # value assigned in sequence from SCLEX_AUTOMATIC+1.
1270 val SCLEX_AUTOMATIC=1000
1271 # Lexical states for SCLEX_PYTHON
1273 val SCE_P_COMMENTLINE=1
1276 val SCE_P_CHARACTER=4
1279 val SCE_P_TRIPLEDOUBLE=7
1280 val SCE_P_CLASSNAME=8
1282 val SCE_P_OPERATOR=10
1283 val SCE_P_IDENTIFIER=11
1284 val SCE_P_COMMENTBLOCK=12
1285 val SCE_P_STRINGEOL=13
1286 # Lexical states for SCLEX_CPP, SCLEX_VB
1289 val SCE_C_COMMENTLINE=2
1290 val SCE_C_COMMENTDOC=3
1294 val SCE_C_CHARACTER=7
1296 val SCE_C_PREPROCESSOR=9
1297 val SCE_C_OPERATOR=10
1298 val SCE_C_IDENTIFIER=11
1299 val SCE_C_STRINGEOL=12
1300 val SCE_C_VERBATIM=13
1302 val SCE_C_COMMENTLINEDOC=15
1304 # Lexical states for SCLEX_HTML, SCLEX_XML
1307 val SCE_H_TAGUNKNOWN=2
1308 val SCE_H_ATTRIBUTE=3
1309 val SCE_H_ATTRIBUTEUNKNOWN=4
1311 val SCE_H_DOUBLESTRING=6
1312 val SCE_H_SINGLESTRING=7
1318 val SCE_H_XMLSTART=12
1324 val SCE_H_QUESTION=18
1328 val SCE_H_XCCOMMENT=20
1331 # Embedded Javascript
1333 val SCE_HJ_DEFAULT=41
1334 val SCE_HJ_COMMENT=42
1335 val SCE_HJ_COMMENTLINE=43
1336 val SCE_HJ_COMMENTDOC=44
1337 val SCE_HJ_NUMBER=45
1339 val SCE_HJ_KEYWORD=47
1340 val SCE_HJ_DOUBLESTRING=48
1341 val SCE_HJ_SINGLESTRING=49
1342 val SCE_HJ_SYMBOLS=50
1343 val SCE_HJ_STRINGEOL=51
1346 val SCE_HJA_START=55
1347 val SCE_HJA_DEFAULT=56
1348 val SCE_HJA_COMMENT=57
1349 val SCE_HJA_COMMENTLINE=58
1350 val SCE_HJA_COMMENTDOC=59
1351 val SCE_HJA_NUMBER=60
1353 val SCE_HJA_KEYWORD=62
1354 val SCE_HJA_DOUBLESTRING=63
1355 val SCE_HJA_SINGLESTRING=64
1356 val SCE_HJA_SYMBOLS=65
1357 val SCE_HJA_STRINGEOL=66
1358 val SCE_HJA_REGEX=67
1361 val SCE_HB_DEFAULT=71
1362 val SCE_HB_COMMENTLINE=72
1363 val SCE_HB_NUMBER=73
1365 val SCE_HB_STRING=75
1366 val SCE_HB_IDENTIFIER=76
1367 val SCE_HB_STRINGEOL=77
1369 val SCE_HBA_START=80
1370 val SCE_HBA_DEFAULT=81
1371 val SCE_HBA_COMMENTLINE=82
1372 val SCE_HBA_NUMBER=83
1374 val SCE_HBA_STRING=85
1375 val SCE_HBA_IDENTIFIER=86
1376 val SCE_HBA_STRINGEOL=87
1379 val SCE_HP_DEFAULT=91
1380 val SCE_HP_COMMENTLINE=92
1381 val SCE_HP_NUMBER=93
1382 val SCE_HP_STRING=94
1383 val SCE_HP_CHARACTER=95
1385 val SCE_HP_TRIPLE=97
1386 val SCE_HP_TRIPLEDOUBLE=98
1387 val SCE_HP_CLASSNAME=99
1388 val SCE_HP_DEFNAME=100
1389 val SCE_HP_OPERATOR=101
1390 val SCE_HP_IDENTIFIER=102
1392 val SCE_HPA_START=105
1393 val SCE_HPA_DEFAULT=106
1394 val SCE_HPA_COMMENTLINE=107
1395 val SCE_HPA_NUMBER=108
1396 val SCE_HPA_STRING=109
1397 val SCE_HPA_CHARACTER=110
1398 val SCE_HPA_WORD=111
1399 val SCE_HPA_TRIPLE=112
1400 val SCE_HPA_TRIPLEDOUBLE=113
1401 val SCE_HPA_CLASSNAME=114
1402 val SCE_HPA_DEFNAME=115
1403 val SCE_HPA_OPERATOR=116
1404 val SCE_HPA_IDENTIFIER=117
1406 val SCE_HPHP_DEFAULT=118
1407 val SCE_HPHP_HSTRING=119
1408 val SCE_HPHP_SIMPLESTRING=120
1409 val SCE_HPHP_WORD=121
1410 val SCE_HPHP_NUMBER=122
1411 val SCE_HPHP_VARIABLE=123
1412 val SCE_HPHP_COMMENT=124
1413 val SCE_HPHP_COMMENTLINE=125
1414 val SCE_HPHP_HSTRING_VARIABLE=126
1415 val SCE_HPHP_OPERATOR=127
1416 # Lexical states for SCLEX_PERL
1417 val SCE_PL_DEFAULT=0
1419 val SCE_PL_COMMENTLINE=2
1424 val SCE_PL_CHARACTER=7
1425 val SCE_PL_PUNCTUATION=8
1426 val SCE_PL_PREPROCESSOR=9
1427 val SCE_PL_OPERATOR=10
1428 val SCE_PL_IDENTIFIER=11
1429 val SCE_PL_SCALAR=12
1432 val SCE_PL_SYMBOLTABLE=15
1434 val SCE_PL_REGSUBST=18
1435 val SCE_PL_LONGQUOTE=19
1436 val SCE_PL_BACKTICKS=20
1437 val SCE_PL_DATASECTION=21
1438 val SCE_PL_HERE_DELIM=22
1439 val SCE_PL_HERE_Q=23
1440 val SCE_PL_HERE_QQ=24
1441 val SCE_PL_HERE_QX=25
1442 val SCE_PL_STRING_Q=26
1443 val SCE_PL_STRING_QQ=27
1444 val SCE_PL_STRING_QX=28
1445 val SCE_PL_STRING_QR=29
1446 val SCE_PL_STRING_QW=30
1447 # Lexical states for SCLEX_LATEX
1453 # Lexical states for SCLEX_LUA
1454 val SCE_LUA_DEFAULT=0
1455 val SCE_LUA_COMMENT=1
1456 val SCE_LUA_COMMENTLINE=2
1457 val SCE_LUA_COMMENTDOC=3
1458 val SCE_LUA_NUMBER=4
1460 val SCE_LUA_STRING=6
1461 val SCE_LUA_CHARACTER=7
1462 val SCE_LUA_LITERALSTRING=8
1463 val SCE_LUA_PREPROCESSOR=9
1464 val SCE_LUA_OPERATOR=10
1465 val SCE_LUA_IDENTIFIER=11
1466 val SCE_LUA_STRINGEOL=12
1467 # Lexical states for SCLEX_ERRORLIST
1468 val SCE_ERR_DEFAULT=0
1469 val SCE_ERR_PYTHON=1
1473 val SCE_ERR_BORLAND=5
1477 val SCE_ERR_DIFF_CHANGED=10
1478 val SCE_ERR_DIFF_ADDITION=11
1479 val SCE_ERR_DIFF_DELETION=12
1480 val SCE_ERR_DIFF_MESSAGE=13
1481 # Lexical states for SCLEX_BATCH
1482 val SCE_BAT_DEFAULT=0
1483 val SCE_BAT_COMMENT=1
1487 val SCE_BAT_COMMAND=5
1488 val SCE_BAT_IDENTIFIER=6
1489 val SCE_BAT_OPERATOR=7
1490 # Lexical states for SCLEX_MAKEFILE
1491 val SCE_MAKE_DEFAULT=0
1492 val SCE_MAKE_COMMENT=1
1493 val SCE_MAKE_PREPROCESSOR=2
1494 val SCE_MAKE_IDENTIFIER=3
1495 val SCE_MAKE_OPERATOR=4
1496 val SCE_MAKE_TARGET=5
1497 val SCE_MAKE_IDEOL=9
1498 # Lexical states for the SCLEX_CONF (Apache Configuration Files Lexer)
1499 val SCE_CONF_DEFAULT=0
1500 val SCE_CONF_COMMENT=1
1501 val SCE_CONF_NUMBER=2
1502 val SCE_CONF_IDENTIFIER=3
1503 val SCE_CONF_EXTENSION=4
1504 val SCE_CONF_PARAMETER=5
1505 val SCE_CONF_STRING=6
1506 val SCE_CONF_OPERATOR=7
1508 val SCE_CONF_DIRECTIVE=9
1510 val SCE_AVE_DEFAULT=0
1511 val SCE_AVE_COMMENT=1
1512 val SCE_AVE_NUMBER=2
1514 val SCE_AVE_KEYWORD=4
1515 val SCE_AVE_STATEMENT=5
1516 val SCE_AVE_STRING=6
1518 val SCE_AVE_STRINGEOL=8
1519 val SCE_AVE_IDENTIFIER=9
1520 val SCE_AVE_OPERATOR=10
1521 # Lexical states for SCLEX_ADA
1522 val SCE_ADA_DEFAULT=0
1523 val SCE_ADA_COMMENT=1
1524 val SCE_ADA_NUMBER=2
1526 val SCE_ADA_STRING=4
1527 val SCE_ADA_CHARACTER=5
1528 val SCE_ADA_OPERATOR=6
1529 val SCE_ADA_IDENTIFIER=7
1530 val SCE_ADA_STRINGEOL=8
1531 # Lexical states for SCLEX_LISP
1532 val SCE_LISP_DEFAULT=0
1533 val SCE_LISP_COMMENT=1
1534 val SCE_LISP_NUMBER=2
1535 val SCE_LISP_KEYWORD=3
1536 val SCE_LISP_STRING=6
1537 val SCE_LISP_STRINGEOL=8
1538 val SCE_LISP_IDENTIFIER=9
1539 val SCE_LISP_OPERATOR=10
1540 # Lexical states for SCLEX_EIFFEL and SCLEX_EIFFELKW
1541 val SCE_EIFFEL_DEFAULT=0
1542 val SCE_EIFFEL_COMMENTLINE=1
1543 val SCE_EIFFEL_NUMBER=2
1544 val SCE_EIFFEL_WORD=3
1545 val SCE_EIFFEL_STRING=4
1546 val SCE_EIFFEL_CHARACTER=5
1547 val SCE_EIFFEL_OPERATOR=6
1548 val SCE_EIFFEL_IDENTIFIER=7
1549 val SCE_EIFFEL_STRINGEOL=8
1553 evt void StyleNeeded=2000(int position)
1554 evt void CharAdded=2001(int ch)
1555 evt void SavePointReached=2002(void)
1556 evt void SavePointLeft=2003(void)
1557 evt void ModifyAttemptRO=2004(void)
1558 # GTK+ Specific to work around focus and accelerator problems:
1559 evt void Key=2005(int ch, int modifiers)
1560 evt void DoubleClick=2006(void)
1561 evt void UpdateUI=2007(void)
1562 # The old name for SCN_UPDATEUI
1563 val SCN_CHECKBRACE=2007
1564 evt void Modified=2008(int position, int modificationType, string text, int length, int linesAdded, int line, int foldLevelNow, int foldLevelPrev)
1565 # Optional module for macro recording
1566 evt void MacroRecord=2009(int message, int wParam, int lParam)
1567 evt void MarginClick=2010(int modifiers, int position, int margin)
1568 evt void NeedShown=2011(int position, int length)
1569 evt void PosChanged=2012(int position)
1570 evt void Painted=2013(void)
1571 evt void UserListSelection=2014(int listType, string text)
1572 evt void URIDropped=2015(string text)
1573 evt void DwellStart=2016(int position)
1574 evt void DwellEnd=2017(int position)
1580 ################################################
1583 # ***** DEPRECATED from here to end of file ******
1585 # Will a paste succeed?
1586 fun bool EM_CanPaste=1074(,)
1588 # Are there any undoable actions in the undo history.
1589 fun bool EM_CanUndo=198(,)
1591 # Find the position and line from a point within the window.
1592 fun int EM_CharFromPos=215(,point pt)
1594 # Delete the undo history.
1595 fun void EM_EmptyUndoBuffer=205(,)
1597 # Retrieve the selection range.
1598 fun void EM_ExGetSel=1076(,charrangeresult cr)
1600 # Retrieve the line number of a position in the document.
1601 get int EM_ExLineFromChar=1078(,position pos)
1603 # Select a range of text.
1604 fun void EM_ExSetSel=1079(,charrange cr)
1606 # Find some text in the document.
1607 fun position EM_FindText=1080(int flags, findtext ft)
1609 # Find some text in the document. Returns range of found text in ft argument.
1610 fun position EM_FindTextEx=1103(int flags, findtextex ft)
1612 # On Windows will draw the document into a display context such as a printer.
1613 fun void EM_FormatRange=1081(bool draw, formatrange fr)
1615 # Retrieve the line at the top of the display.
1616 get int EM_GetFirstVisibleLine=206(,)
1618 # Retrieve the contents of a line.
1619 # Returns the length of the line.
1620 fun int EM_GetLine=196(int line, countedstring text)
1622 # Returns the number of lines in the document. There is always at least one.
1623 fun int EM_GetLineCount=186(,)
1625 # Returns the size in pixels of left and right margins packed into one integer.
1626 # The left margin is in the low half and the right margin in the high half.
1627 fun int EM_GetMargins=212(,)
1629 # Is the document different from when it was last saved?
1630 get bool EM_GetModify=184(,)
1632 # Get the area used to display the document.
1633 fun void EM_GetRect=178(,rectangle r)
1635 # Return the selection packed into one integer with the start of the selection
1636 # in the low half and the end in the high half.
1637 fun int EM_GetSel=176(,)
1639 # Retrieve the selected text.
1640 # Return the length of the text.
1641 fun int EM_GetSelText=1086(,stringresult text)
1643 # Retrieve a range of text.
1644 # Return the length of the text.
1645 fun int EM_GetTextRange=1099(, textrange tr)
1647 # Draw the selection in normal style or with selection highlighted.
1648 fun void EM_HideSelection=1087(bool normal,)
1650 # Retrieve the line of a position.
1651 fun int EM_LineFromChar=201(position pos,)
1653 # Retrieve the position at the start of a line.
1654 fun position EM_LineIndex=187(int line,)
1656 # Retrieve the number of characters on a line not including end of line characters.
1657 fun int EM_LineLength=193(int line,)
1659 # Scroll horizontally and vertically.
1660 fun void EM_LineScroll=182(int columns, int lines)
1662 # Retrieve the point in the window where a position is displayed.
1663 fun void EM_PosFromChar=214(pointresult pt, position pos)
1665 # Replace the selected text with the argument text.
1666 fun void EM_ReplaceSel=194(, string text)
1668 # Ensure the caret is visible.
1669 fun void EM_ScrollCaret=183(,)
1671 # Returns SEL_EMPTY if selection contains no characters, otherwise SEL_TEXT.
1672 fun void EM_SelectionType=1090(,)
1674 # Set the width of the left and right margins
1675 fun void EM_SetMargins=211(int flags, int values)
1677 # Set to read only or read write.
1678 set void EM_SetReadOnly=207(bool readOnly,)
1680 # Select the range of text from start to end.
1681 fun void EM_SetSel=177(position start, position end)
1683 # Undo one action in the undo history.
1684 fun void EM_Undo=199(,)
1687 fun void WM_Null=0(,)
1689 # Clear the selection.
1690 fun void WM_Clear=771(,)
1692 fun void WM_Command=273(,)
1694 # Copy the selection to the clipboard.
1695 fun void WM_Copy=769(,)
1697 # Cut the selection to the clipboard.
1698 fun void WM_Cut=768(,)
1700 # Retrieve all the text in the document.
1701 # Returns number of characters retrieved.
1702 fun int WM_GetText=13(int length, stringresult text)
1704 # Retrieve the number of characters in the document.
1705 fun int WM_GetTextLength=14(,)
1707 # Notification back to container
1708 fun void WM_Notify=78(int id, int stuff)
1710 # Paste the contents of the clipboard into the document replacing the selection.
1711 fun void WM_Paste=770(,)
1713 # Replace the contents of the document with the argument text.
1714 fun void WM_SetText=12(, string text)
1716 # Undo one action in the undo history.
1717 fun void WM_Undo=772(,)
1719 # Notification codes
1721 val EN_KILLFOCUS=512
1724 # Flags for setting margins.
1726 val EC_RIGHTMARGIN=2
1727 val EC_USEFONTINFO=0xffff
1733 # Find replace mask constants
1734 val FR_MATCHCASE=0x4
1735 val FR_WHOLEWORD=0x2
1738 # Key modifier flag.
1740 val LEFT_CTRL_PRESSED=2
1741 val LEFT_ALT_PRESSED=4
1744 evt void EN_Change=768(void)