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 # Set caret to start of a line and ensure it is visible.
138 fun void GotoLine=2024(int line,)
140 # Set caret to a position and ensure it is visible.
141 fun void GotoPos=2025(position pos,)
143 # Set the selection anchor to a position. The anchor is the opposite
144 # end of the selection from the caret.
145 set void SetAnchor=2026(position posAnchor,)
147 # Retrieve the text of the line containing the caret.
148 # Returns the index of the caret on the line.
149 fun int GetCurLine=2027(int length, stringresult text)
151 # Retrieve the position of the last correctly styled character.
152 get position GetEndStyled=2028(,)
154 # Convert all line endings in the document to use the current mode.
155 fun void ConvertEOLs=2029(,)
161 # Retrieve the current end of line mode - one of CRLF, CR, or LF.
162 get int GetEOLMode=2030(,)
164 # Set the current end of line mode.
165 set void SetEOLMode=2031(int eolMode,)
167 # Set the current styling position to pos and the styling mask to mask.
168 # The styling mask can be used to protect some bits in each styling byte from
170 fun void StartStyling=2032(position pos, int mask)
172 # Change style from current styling position for length characters to a style
173 # and move the current styling position to after this newly styled segment.
174 fun void SetStyling=2033(int length, int style)
176 # Is drawing done first into a buffer or direct to the screen.
177 get bool GetBufferedDraw=2034(,)
179 # If drawing is buffered then each line of text is drawn into a bitmap buffer
180 # before drawing it to the screen to avoid flicker.
181 set void SetBufferedDraw=2035(bool buffered,)
183 # Change the visible size of a tab to be a multiple of the width of a space
185 set void SetTabWidth=2036(int tabWidth,)
187 # Retrieve the visible size of a tab.
188 get int GetTabWidth=2121(,)
190 # The SC_CP_UTF8 value can be used to enter Unicode mode.
191 # This is the same value as CP_UTF8 in Windows
194 # Set the code page used to interpret the bytes of the document as characters.
195 # The SC_CP_UTF8 value can be used to enter Unicode mode.
196 set void SetCodePage=2037(int codePage,)
198 # In palette mode, Scintilla uses the environments palette calls to display
199 # more colours. This may lead to ugly displays.
200 set void SetUsePalette=2039(bool usePalette,)
204 val SC_MARK_ROUNDRECT=1
206 val SC_MARK_SMALLRECT=3
207 val SC_MARK_SHORTARROW=4
209 val SC_MARK_ARROWDOWN=6
213 val SC_MARKNUM_FOLDER=30
214 val SC_MARKNUM_FOLDEROPEN=31
216 # Set the symbol used for a particular marker number.
217 fun void MarkerDefine=2040(int markerNumber, int markerSymbol)
219 # Set the foreground colour used for a particular marker number.
220 fun void MarkerSetFore=2041(int markerNumber, colour fore)
222 # Set the background colour used for a particular marker number.
223 fun void MarkerSetBack=2042(int markerNumber, colour back)
225 # Add a marker to a line.
226 fun void MarkerAdd=2043(int line, int markerNumber)
228 # Delete a marker from a line
229 fun void MarkerDelete=2044(int line, int markerNumber)
231 # Delete all markers with a particular number from all lines
232 fun void MarkerDeleteAll=2045(int markerNumber,)
234 # Get a bit mask of all the markers set on a line.
235 fun int MarkerGet=2046(int line,)
237 # Find the next line after lineStart that includes a marker in mask.
238 fun int MarkerNext=2047(int lineStart, int markerMask)
240 # Find the previous line before lineStart that includes a marker in mask.
241 fun int MarkerPrevious=2048(int lineStart, int markerMask)
243 val SC_MARGIN_SYMBOL=0
244 val SC_MARGIN_NUMBER=1
246 # Set a margin to be either numeric or symbolic.
247 set void SetMarginTypeN=2240(int margin, int marginType)
249 # Retrieve the type of a margin.
250 get int GetMarginTypeN=2241(int margin,)
252 # Set the width of a margin to a width expressed in pixels.
253 set void SetMarginWidthN=2242(int margin, int pixelWidth)
255 # Retrieve the width of a margin in pixels.
256 get int GetMarginWidthN=2243(int margin,)
258 # Set a mask that determines which markers are displayed in a margin.
259 set void SetMarginMaskN=2244(int margin, int mask)
261 # Retrieve the marker mask of a margin.
262 get int GetMarginMaskN=2245(int margin,)
264 # Make a margin sensitive or insensitive to mouse clicks.
265 set void SetMarginSensitiveN=2246(int margin, bool sensitive)
267 # Retrieve the mouse click sensitivity of a margin.
268 get bool GetMarginSensitiveN=2247(int margin,)
271 val STYLE_LINENUMBER=33
272 val STYLE_BRACELIGHT=34
273 val STYLE_BRACEBAD=35
274 val STYLE_CONTROLCHAR=36
275 val STYLE_INDENTGUIDE=37
278 # Character set identifiers are used in StyleSetCharacterSet.
279 # The values are the same as the Windows *_CHARSET values.
280 val SC_CHARSET_ANSI=0
281 val SC_CHARSET_DEFAULT=1
282 val SC_CHARSET_BALTIC=186
283 val SC_CHARSET_CHINESEBIG5=136
284 val SC_CHARSET_EASTEUROPE=238
285 val SC_CHARSET_GB2312=134
286 val SC_CHARSET_GREEK=161
287 val SC_CHARSET_HANGUL=129
288 val SC_CHARSET_MAC=77
289 val SC_CHARSET_OEM=255
290 val SC_CHARSET_RUSSIAN=204
291 val SC_CHARSET_SHIFTJIS=128
292 val SC_CHARSET_SYMBOL=2
293 val SC_CHARSET_TURKISH=162
294 val SC_CHARSET_JOHAB=130
295 val SC_CHARSET_HEBREW=177
296 val SC_CHARSET_ARABIC=178
297 val SC_CHARSET_VIETNAMESE=163
298 val SC_CHARSET_THAI=222
300 # Clear all the styles and make equivalent to the global default style.
301 set void StyleClearAll=2050(,)
303 # Set the foreground colour of a style.
304 set void StyleSetFore=2051(int style, colour fore)
306 # Set the background colour of a style.
307 set void StyleSetBack=2052(int style, colour back)
309 # Set a style to be bold or not.
310 set void StyleSetBold=2053(int style, bool bold)
312 # Set a style to be italic or not.
313 set void StyleSetItalic=2054(int style, bool italic)
315 # Set the size of characters of a style.
316 set void StyleSetSize=2055(int style, int sizePoints)
318 # Set the font of a style.
319 set void StyleSetFont=2056(int style, string fontName)
321 # Set a style to have its end of line filled or not.
322 set void StyleSetEOLFilled=2057(int style, bool filled)
324 # Reset the default style to its state at startup
325 fun void StyleResetDefault=2058(,)
327 # Set a style to be underlined or not.
328 set void StyleSetUnderline=2059(int style, bool underline)
330 # Set the character set of the font in a style.
331 set void StyleSetCharacterSet=2066(int style, int characterSet)
333 # Set the foreground colour of the selection and whether to use this setting.
334 fun void SetSelFore=2067(bool useSetting, colour fore)
336 # Set the background colour of the selection and whether to use this setting.
337 fun void SetSelBack=2068(bool useSetting, colour back)
339 # Set the foreground colour of the caret.
340 set void SetCaretFore=2069(colour fore,)
342 # When key+modifier combination km is pressed perform msg.
343 fun void AssignCmdKey=2070(keymod km, int msg)
345 # When key+modifier combination km do nothing.
346 fun void ClearCmdKey=2071(keymod km,)
348 # Drop all key mappings.
349 fun void ClearAllCmdKeys=2072(,)
351 # Set the styles for a segment of the document.
352 fun void SetStylingEx=2073(int length, string styles)
354 # Set a style to be visible or not.
355 set void StyleSetVisible=2074(int style, bool visible)
357 # Get the time in milliseconds that the caret is on and off.
358 get int GetCaretPeriod=2075(,)
360 # Get the time in milliseconds that the caret is on and off. 0 = steady on.
361 set void SetCaretPeriod=2076(int periodMilliseconds,)
363 # Set the set of characters making up words for when moving or selecting
365 set void SetWordChars=2077(, string characters)
367 # Start a sequence of actions that is undone and redone as a unit.
369 fun void BeginUndoAction=2078(,)
371 # End a sequence of actions that is undone and redone as a unit.
372 fun void EndUndoAction=2079(,)
384 ##INDIC0_MASK | INDIC1_MASK | INDIC2_MASK
386 # Set an indicator to plain, squiggle or TT.
387 set void IndicSetStyle=2080(int indic, int style)
389 # Retrieve the style of an indicator.
390 get int IndicGetStyle=2081(int indic,)
392 # Set the foreground colour of an indicator.
393 set void IndicSetFore=2082(int indic, colour fore)
395 # Retrieve the foreground colour of an indicator.
396 get colour IndicGetFore=2083(int indic,)
398 # Divide each styling byte into lexical class bits (default:5) and indicator
399 # bits (default:3). If a lexer requires more than 32 lexical states, then this
400 # is used to expand the possible states.
401 set void SetStyleBits=2090(int bits,)
403 # Retrieve number of bits in style bytes used to hold the lexical state.
404 get int GetStyleBits=2091(,)
406 # Used to hold extra styling information for each line.
407 set void SetLineState=2092(int line, int state)
409 # Retrieve the extra styling information for a line.
410 get int GetLineState=2093(int line,)
412 # Retrieve the last line number that has line state.
413 get int GetMaxLineState=2094(,)
415 # Display a auto-completion list.
416 # The lenEntered parameter indicates how many characters before
417 # the caret should be used to provide context.
418 fun void AutoCShow=2100(int lenEntered, string itemList)
420 # Remove the auto-completion list from the screen.
421 fun void AutoCCancel=2101(,)
423 # Is there an auto-completion list visible?
424 fun bool AutoCActive=2102(,)
426 # Retrieve the position of the caret when the auto-completion list was
428 fun position AutoCPosStart=2103(,)
430 # User has selected an item so remove the list and insert the selection.
431 fun void AutoCComplete=2104(,)
433 # Define a set of character that when typed cancel the auto-completion list.
434 fun void AutoCStops=2105(, string characterSet)
436 # Change the separator character in the string setting up an auto-completion
437 # list. Default is space but can be changed if items contain space.
438 set void AutoCSetSeparator=2106(int separatorCharacter,)
440 # Retrieve the auto-completion list separator character.
441 get int AutoCGetSeparator=2107(,)
443 # Select the item in the auto-completion list that starts with a string.
444 fun void AutoCSelect=2108(, string text)
446 # Should the auto-completion list be cancelled if the user backspaces to a
447 # position before where the box was created.
448 set void AutoCSetCancelAtStart=2110(bool cancel,)
450 # Retrieve whether auto-completion cancelled by backspacing before start.
451 get bool AutoCGetCancelAtStart=2111(,)
453 # Define a set of character that when typed fills up the selected word.
454 set void AutoCSetFillUps=2112(, string characterSet)
456 # Should a single item auto-completion list automatically choose the item.
457 set void AutoCSetChooseSingle=2113(bool chooseSingle,)
459 # Retrieve whether a single item auto-completion list automatically choose the item.
460 get bool AutoCGetChooseSingle=2114(,)
462 # Set whether case is significant when performing auto-completion searches.
463 set void AutoCSetIgnoreCase=2115(bool ignoreCase,)
465 # Retrieve state of ignore case flag.
466 get bool AutoCGetIgnoreCase=2116(,)
468 # Set the number of spaces used for one level of indentation.
469 set void SetIndent=2122(int indentSize,)
471 # Retrieve indentation size.
472 get int GetIndent=2123(,)
474 # Indentation will only use space characters if useTabs is false, otherwise
475 # it will use a combination of tabs and spaces.
476 set void SetUseTabs=2124(bool useTabs,)
478 # Retrieve whether tabs will be used in indentation.
479 get bool GetUseTabs=2125(,)
481 # Change the indentation of a line to a number of columns.
482 set void SetLineIndentation=2126(int line, int indentSize)
484 # Retrieve the number of columns that a line is indented.
485 get int GetLineIndentation=2127(int line,)
487 # Retrieve the position before the first non indentation character on a line.
488 get position GetLineIndentPosition=2128(int line,)
490 # Retrieve the column number of a position, taking tab width into account.
491 get int GetColumn=2129(position pos,)
493 # Show or hide the horizontal scroll bar.
494 set void SetHScrollBar=2130(bool show,)
496 # Is the horizontal scroll bar visible?
497 get bool GetHScrollBar=2131(,)
499 # Show or hide indentation guides.
500 set void SetIndentationGuides=2132(bool show,)
502 # Are the indentation guides visible?
503 get bool GetIndentationGuides=2133(,)
505 # Set the highlighted indentation guide column.
506 # 0 = no highlighted guide.
507 set void SetHighlightGuide=2134(int column,)
509 # Get the highlighted indentation guide column.
510 get int GetHighlightGuide=2135(,)
512 # Get the position after the last visible characters on a line.
513 get int GetLineEndPosition=2136(int line,)
515 # Get the code page used to interpret the bytes of the document as characters.
516 get int GetCodePage=2137(,)
518 # Get the foreground colour of the caret.
519 get colour GetCaretFore=2138(,)
522 get bool GetUsePalette=2139(,)
525 get bool GetReadOnly=2140(,)
527 # Sets the position of the caret.
528 set void SetCurrentPos=2141(position pos,)
530 # Sets the position that starts the selection - this becomes the anchor.
531 set void SetSelectionStart=2142(position pos,)
533 # Returns the position at the start of the selection.
534 get position GetSelectionStart=2143(,)
536 # Sets the position that ends the selection - this becomes the currentPosition.
537 set void SetSelectionEnd=2144(position pos,)
539 # Returns the position at the end of the selection.
540 get position GetSelectionEnd=2145(,)
542 # Sets the print magnification added to the point size of each style for printing.
543 set void SetPrintMagnification=2146(int magnification,)
545 # Returns the print magnification.
546 get int GetPrintMagnification=2147(,)
548 # PrintColourMode - use same colours as screen.
549 val SC_PRINT_NORMAL=0
550 # PrintColourMode - invert the light value of each style for printing.
551 val SC_PRINT_INVERTLIGHT=1
552 # PrintColourMode - force black text on white background for printing.
553 val SC_PRINT_BLACKONWHITE=2
555 # Modify colours when printing for clearer printed text.
556 set void SetPrintColourMode=2148(int mode,)
558 # Returns the print colour mode.
559 get int GetPrintColourMode=2149(,)
562 val SCFIND_WHOLEWORD=2
563 val SCFIND_MATCHCASE=4
564 val SCFIND_WORDSTART=0x00100000
565 # SCFIND_REGEXP is not yet implemented.
566 val SCFIND_REGEXP=0x00200000
568 # Find some text in the document.
569 fun position FindText=2150(int flags, findtext ft)
571 # On Windows will draw the document into a display context such as a printer.
572 fun void FormatRange=2151(bool draw, formatrange fr)
574 # Retrieve the line at the top of the display.
575 get int GetFirstVisibleLine=2152(,)
577 # Retrieve the contents of a line.
578 # Returns the length of the line.
579 fun int GetLine=2153(int line, stringresult text)
581 # Returns the number of lines in the document. There is always at least one.
582 get int GetLineCount=2154(,)
584 # Sets the size in pixels of the left margin.
585 set void SetMarginLeft=2155(, int width)
587 # Returns the size in pixels of the left margin.
588 get int GetMarginLeft=2156(,)
590 # Sets the size in pixels of the right margin.
591 set void SetMarginRight=2157(, int width)
593 # Returns the size in pixels of the right margin.
594 get int GetMarginRight=2158(,)
596 # Is the document different from when it was last saved?
597 get bool GetModify=2159(,)
599 # Select a range of text.
600 fun void SetSel=2160(position start, position end)
602 # Retrieve the selected text.
603 # Return the length of the text.
604 fun int GetSelText=2161(,stringresult text)
606 # Retrieve a range of text.
607 # Return the length of the text.
608 fun int GetTextRange=2162(, textrange tr)
610 # Draw the selection in normal style or with selection highlighted.
611 fun void HideSelection=2163(bool normal,)
613 # Retrieve the x value of the point in the window where a position is displayed.
614 fun int PointXFromPosition=2164(, position pos)
616 # Retrieve the y value of the point in the window where a position is displayed.
617 fun int PointYFromPosition=2165(, position pos)
619 # Retrieve the line containing a position.
620 fun int LineFromPosition=2166(position pos,)
622 # Retrieve the position at the start of a line.
623 fun int PositionFromLine=2167(int line,)
625 # Scroll horizontally and vertically.
626 fun void LineScroll=2168(int columns, int lines)
628 # Ensure the caret is visible.
629 fun void ScrollCaret=2169(,)
631 # Replace the selected text with the argument text.
632 fun void ReplaceSel=2170(, string text)
634 # Set to read only or read write.
635 set void SetReadOnly=2171(bool readOnly,)
638 fun void Null=2172(,)
640 # Will a paste succeed?
641 fun bool CanPaste=2173(,)
643 # Are there any undoable actions in the undo history.
644 fun bool CanUndo=2174(,)
646 # Delete the undo history.
647 fun void EmptyUndoBuffer=2175(,)
649 # Undo one action in the undo history.
650 fun void Undo=2176(,)
652 # Cut the selection to the clipboard.
655 # Copy the selection to the clipboard.
656 fun void Copy=2178(,)
658 # Paste the contents of the clipboard into the document replacing the selection.
659 fun void Paste=2179(,)
661 # Clear the selection.
662 fun void Clear=2180(,)
664 # Replace the contents of the document with the argument text.
665 fun void SetText=2181(, string text)
667 # Retrieve all the text in the document.
668 # Returns number of characters retrieved.
669 fun int GetText=2182(int length, stringresult text)
671 # Retrieve the number of characters in the document.
672 get int GetTextLength=2183(,)
674 # Retrieve a pointer to a function that processes messages for this Scintilla.
675 get int GetDirectFunction=2184(,)
677 # Retrieve a pointer value to use as the first argument when calling
678 # the function returned by GetDirectFunction.
679 get int GetDirectPointer=2185(,)
681 # Set to overtype (true) or insert mode
682 set void SetOvertype=2186(bool overtype,)
684 # Returns true if overtype mode is active otherwise false is returned.
685 get bool GetOvertype=2187(,)
687 # Show a call tip containing a definition near position pos.
688 fun void CallTipShow=2200(position pos, string definition)
690 # Remove the call tip from the screen.
691 fun void CallTipCancel=2201(,)
693 # Is there an active call tip?
694 fun bool CallTipActive=2202(,)
696 # Retrieve the position where the caret was before displaying the call tip.
697 fun position CallTipPosStart=2203(,)
699 # Highlight a segment of the definition.
700 fun void CallTipSetHlt=2204(int start, int end)
702 # Set the background colour for the call tip.
703 set void CallTipSetBack=2205(colour back,)
705 # Find the display line of a document line taking hidden lines into account.
706 fun int VisibleFromDocLine=2220(int line,)
708 # Find the document line of a display line taking hidden lines into account.
709 fun int DocLineFromVisible=2221(int lineDisplay,)
711 val SC_FOLDLEVELBASE=0x400
712 val SC_FOLDLEVELWHITEFLAG=0x1000
713 val SC_FOLDLEVELHEADERFLAG=0x2000
714 val SC_FOLDLEVELNUMBERMASK=0x0FFF
716 # Set the fold level of a line.
717 # This encodes an integer level along with flags indicating whether the
718 # line is a header and whether it is effectively white space.
719 set void SetFoldLevel=2222(int line, int level)
721 # Retrieve the fold level of a line.
722 get int GetFoldLevel=2223(int line,)
724 # Find the last child line of a header line.
725 get int GetLastChild=2224(int line, int level)
727 # Find the parent line of a child line.
728 get int GetFoldParent=2225(int line,)
730 # Make a range of lines visible.
731 fun void ShowLines=2226(int lineStart, int lineEnd)
733 # Make a range of lines invisible.
734 fun void HideLines=2227(int lineStart, int lineEnd)
737 get bool GetLineVisible=2228(int line,)
739 # Show the children of a header line.
740 set void SetFoldExpanded=2229(int line, bool expanded)
742 # Is a header line expanded?
743 get bool GetFoldExpanded=2230(int line,)
745 # Switch a header line between expanded and contracted.
746 fun void ToggleFold=2231(int line,)
748 # Ensure a particular line is visible by expanding any header line hiding it.
749 fun void EnsureVisible=2232(int line,)
751 # Set some debugging options for folding
752 fun void SetFoldFlags=2233(int flags,)
754 ## Start of key messages
755 # Move caret down one line.
756 fun void LineDown=2300(,)
758 # Move caret down one line extending selection to new caret position.
759 fun void LineDownExtend=2301(,)
761 # Move caret up one line.
762 fun void LineUp=2302(,)
764 # Move caret up one line extending selection to new caret position.
765 fun void LineUpExtend=2303(,)
767 # Move caret left one character.
768 fun void CharLeft=2304(,)
770 # Move caret left one character extending selection to new caret position.
771 fun void CharLeftExtend=2305(,)
773 # Move caret right one character.
774 fun void CharRight=2306(,)
776 # Move caret right one character extending selection to new caret position.
777 fun void CharRightExtend=2307(,)
779 # Move caret left one word.
780 fun void WordLeft=2308(,)
782 # Move caret left one word extending selection to new caret position.
783 fun void WordLeftExtend=2309(,)
785 # Move caret right one word.
786 fun void WordRight=2310(,)
788 # Move caret right one word extending selection to new caret position.
789 fun void WordRightExtend=2311(,)
791 # Move caret to first position on line.
792 fun void Home=2312(,)
794 # Move caret to first position on line extending selection to new caret position.
795 fun void HomeExtend=2313(,)
797 # Move caret to last position on line.
798 fun void LineEnd=2314(,)
800 # Move caret to last position on line extending selection to new caret position.
801 fun void LineEndExtend=2315(,)
803 # Move caret to first position in document.
804 fun void DocumentStart=2316(,)
806 # Move caret to first position in document extending selection to new caret position.
807 fun void DocumentStartExtend=2317(,)
809 # Move caret to last position in document.
810 fun void DocumentEnd=2318(,)
812 # Move caret to last position in document extending selection to new caret position.
813 fun void DocumentEndExtend=2319(,)
815 # Move caret one page up.
816 fun void PageUp=2320(,)
818 # Move caret one page up extending selection to new caret position.
819 fun void PageUpExtend=2321(,)
821 # Move caret one page down.
822 fun void PageDown=2322(,)
824 # Move caret one page down extending selection to new caret position.
825 fun void PageDownExtend=2323(,)
827 # Switch from insert to overtype mode or the reverse.
828 fun void EditToggleOvertype=2324(,)
830 # Cancel any modes such as call tip or auto-completion list display.
831 fun void Cancel=2325(,)
833 # Delete the selection or if no selection, the character before the caret.
834 fun void DeleteBack=2326(,)
836 # If selection is empty or all on one line replace the selection with a tab
838 # If more than one line selected, indent the lines.
841 # Dedent the selected lines.
842 fun void BackTab=2328(,)
844 # Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
845 fun void NewLine=2329(,)
847 # Insert a Form Feed character.
848 fun void FormFeed=2330(,)
850 # Move caret to before first visible character on line.
851 # If already there move to first character on line.
852 fun void VCHome=2331(,)
854 # Like VCHome but extending selection to new caret position.
855 fun void VCHomeExtend=2332(,)
857 # Magnify the displayed text by increasing the sizes by 1 point.
858 fun void ZoomIn=2333(,)
860 # Make the displayed text smaller by decreasing the sizes by 1 point.
861 fun void ZoomOut=2334(,)
863 # Delete the word to the left of the caret.
864 fun void DelWordLeft=2335(,)
866 # Delete the word to the right of the caret.
867 fun void DelWordRight=2336(,)
869 # Cut the line containing the caret.
870 fun void LineCut=2337(,)
872 # Delete the line containing the caret.
873 fun void LineDelete=2338(,)
875 # Switch the current line with the previous.
876 fun void LineTranspose=2339(,)
878 # Transform the selection to lower case.
879 fun void LowerCase=2340(,)
881 # Transform the selection to upper case.
882 fun void UpperCase=2341(,)
884 # Scroll the document down, keeping the caret visible.
885 fun void LineScrollDown=2342(,)
887 # Scroll the document up, keeping the caret visible.
888 fun void LineScrollUp=2343(,)
890 # How many characters are on a line, not including end of line characters.
891 fun int LineLength=2350(int line,)
893 # Highlight the characters at two positions.
894 fun void BraceHighlight=2351(position pos1,position pos2)
896 # Highlight the character at a position indicating there is no matching brace.
897 fun void BraceBadLight=2352(position pos,)
899 # Find the position of a matching brace or INVALID_POSITION if no match.
900 fun position BraceMatch=2353(position pos,)
902 # Are the end of line characters visible.
903 get bool GetViewEOL=2355(,)
905 # Make the end of line characters visible or invisible
906 set void SetViewEOL=2356(bool visible,)
908 # Retrieve a pointer to the document object.
909 get int GetDocPointer=2357(,)
911 # Change the document object used.
912 set void SetDocPointer=2358(int pointer,)
914 # Set which document modification events are sent to the container.
915 set void SetModEventMask=2359(int mask,)
919 val EDGE_BACKGROUND=2
921 # Retrieve the column number which text should be kept within.
922 get int GetEdgeColumn=2360(,)
924 # Set the column number of the edge.
925 # If text goes past the edge then it is highlighted.
926 set void SetEdgeColumn=2361(int column,)
928 # Retrieve the edge highlight mode.
929 get int GetEdgeMode=2362(,)
931 # The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
932 # goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
933 set void SetEdgeMode=2363(int mode,)
935 # Retrieve the colour used in edge indication.
936 get colour GetEdgeColour=2364(,)
938 # Change the colour used in edge indication.
939 set void SetEdgeColour=2365(colour edgeColour,)
941 # Sets the current caret position to be the search anchor.
942 fun void SearchAnchor=2366(,)
944 # Find some text starting at the search anchor.
945 fun int SearchNext=2367(int flags, string text)
947 # Find some text starting at the search anchor and moving backwards.
948 fun int SearchPrev=2368(int flags, string text)
950 # Show caret within N lines of edge when it's scrolled to view
952 # Center caret on screen when it's scrolled to view
953 val CARET_CENTER=0x02
954 # OR this with CARET_CENTER to reposition even when visible, or
955 # OR this with CARET_SLOP to reposition whenever outside slop border
956 val CARET_STRICT=0x04
957 # Set the way the line the caret is on is kept visible.
958 fun void SetCaretPolicy=2369(int caretPolicy, int caretSlop)
960 # Retrieves the number of lines completely visible.
961 get int LinesOnScreen=2370(,)
963 # Set whether a pop up menu is displayed automatically when the user presses
964 # the wrong mouse button.
965 fun void UsePopUp=2371(bool allowPopUp,)
967 # Is the selection a rectangular. The alternative is the more common stream selection.
968 get bool SelectionIsRectangle=2372(,)
970 # Set the zoom level. This number of points is added to the size of all fonts.
971 # It may be positive to magnify or negative to reduce.
972 set void SetZoom=2373(int zoom,)
973 # Retrieve the zoom level.
974 get int GetZoom=2374(,)
976 # Create a new document object.
977 # Starts with reference count of 1 and not selected into editor.
978 fun int CreateDocument=2375(,)
979 # Extend life of document.
980 fun void AddRefDocument=2376(, int doc)
981 # Release a reference to the document, deleting document if it fades to black.
982 fun void ReleaseDocument=2377(, int doc)
984 # Get which document modification events are sent to the container.
985 get int GetModEventMask=2378(,)
987 # Set the focus to this Scintilla widget.
989 fun void GrabFocus=2400(,)
991 # Start notifying the container of all key presses and commands.
992 fun void StartRecord=3001(,)
994 # Stop notifying the container of all key presses and commands.
995 fun void StopRecord=3002(,)
997 # Set the lexing language of the document.
998 set void SetLexer=4001(int lexer,)
1000 # Retrieve the lexing language of the document.
1001 get int GetLexer=4002(,)
1003 # Colourise a segment of the document using the current lexing language.
1004 fun void Colourise=4003(position start, position end)
1006 # Set up a value that may be used by a lexer for some optional feature.
1007 set void SetProperty=4004(string key, string value)
1009 # Set up the key words used by the lexer.
1010 set void SetKeyWords=4005(int keywordSet, string keyWords)
1013 # Type of modification and the action which caused the modification
1014 # These are defined as a bit mask to make it easy to specify which notifications are wanted.
1015 # One bit is set from each of SC_MOD_* and SC_PERFORMED_*.
1016 val SC_MOD_INSERTTEXT=0x1
1017 val SC_MOD_DELETETEXT=0x2
1018 val SC_MOD_CHANGESTYLE=0x4
1019 val SC_MOD_CHANGEFOLD=0x8
1020 val SC_PERFORMED_USER=0x10
1021 val SC_PERFORMED_UNDO=0x20
1022 val SC_PERFORMED_REDO=0x40
1023 val SC_LASTSTEPINUNDOREDO=0x100
1024 val SC_MOD_CHANGEMARKER=0x200
1025 val SC_MOD_BEFOREINSERT=0x400
1026 val SC_MOD_BEFOREDELETE=0x800
1027 val SC_MODEVENTMASKALL=0xF77
1029 # For compatibility, these go through the COMMAND notification rather than NOTIFY
1030 # and have exactly the same values as the EN_* constants.
1032 val SCEN_SETFOCUS=512
1033 val SCEN_KILLFOCUS=256
1035 # Symbolic key codes and modifier flags
1036 # ASCII and other printable characters below 256
1037 # Extended keys above 300
1054 val SCK_SUBTRACT=311
1061 ################################################
1063 val SCLEX_CONTAINER=0
1072 val SCLEX_PROPERTIES=9
1073 val SCLEX_ERRORLIST=10
1074 val SCLEX_MAKEFILE=11
1080 # Lexical states for SCLEX_PYTHON
1082 val SCE_P_COMMENTLINE=1
1085 val SCE_P_CHARACTER=4
1088 val SCE_P_TRIPLEDOUBLE=7
1089 val SCE_P_CLASSNAME=8
1091 val SCE_P_OPERATOR=10
1092 val SCE_P_IDENTIFIER=11
1093 val SCE_P_COMMENTBLOCK=12
1094 val SCE_P_STRINGEOL=13
1095 # Lexical states for SCLEX_CPP, SCLEX_VB
1098 val SCE_C_COMMENTLINE=2
1099 val SCE_C_COMMENTDOC=3
1103 val SCE_C_CHARACTER=7
1105 val SCE_C_PREPROCESSOR=9
1106 val SCE_C_OPERATOR=10
1107 val SCE_C_IDENTIFIER=11
1108 val SCE_C_STRINGEOL=12
1109 val SCE_C_VERBATIM=13
1110 # Lexical states for SCLEX_HTML, SCLEX_XML
1113 val SCE_H_TAGUNKNOWN=2
1114 val SCE_H_ATTRIBUTE=3
1115 val SCE_H_ATTRIBUTEUNKNOWN=4
1117 val SCE_H_DOUBLESTRING=6
1118 val SCE_H_SINGLESTRING=7
1124 val SCE_H_XMLSTART=12
1130 val SCE_H_QUESTION=18
1133 # Embedded Javascript
1135 val SCE_HJ_DEFAULT=41
1136 val SCE_HJ_COMMENT=42
1137 val SCE_HJ_COMMENTLINE=43
1138 val SCE_HJ_COMMENTDOC=44
1139 val SCE_HJ_NUMBER=45
1141 val SCE_HJ_KEYWORD=47
1142 val SCE_HJ_DOUBLESTRING=48
1143 val SCE_HJ_SINGLESTRING=49
1144 val SCE_HJ_SYMBOLS=50
1145 val SCE_HJ_STRINGEOL=51
1147 val SCE_HJA_START=55
1148 val SCE_HJA_DEFAULT=56
1149 val SCE_HJA_COMMENT=57
1150 val SCE_HJA_COMMENTLINE=58
1151 val SCE_HJA_COMMENTDOC=59
1152 val SCE_HJA_NUMBER=60
1154 val SCE_HJA_KEYWORD=62
1155 val SCE_HJA_DOUBLESTRING=63
1156 val SCE_HJA_SINGLESTRING=64
1157 val SCE_HJA_SYMBOLS=65
1158 val SCE_HJA_STRINGEOL=66
1161 val SCE_HB_DEFAULT=71
1162 val SCE_HB_COMMENTLINE=72
1163 val SCE_HB_NUMBER=73
1165 val SCE_HB_STRING=75
1166 val SCE_HB_IDENTIFIER=76
1167 val SCE_HB_STRINGEOL=77
1169 val SCE_HBA_START=80
1170 val SCE_HBA_DEFAULT=81
1171 val SCE_HBA_COMMENTLINE=82
1172 val SCE_HBA_NUMBER=83
1174 val SCE_HBA_STRING=85
1175 val SCE_HBA_IDENTIFIER=86
1176 val SCE_HBA_STRINGEOL=87
1179 val SCE_HP_DEFAULT=91
1180 val SCE_HP_COMMENTLINE=92
1181 val SCE_HP_NUMBER=93
1182 val SCE_HP_STRING=94
1183 val SCE_HP_CHARACTER=95
1185 val SCE_HP_TRIPLE=97
1186 val SCE_HP_TRIPLEDOUBLE=98
1187 val SCE_HP_CLASSNAME=99
1188 val SCE_HP_DEFNAME=100
1189 val SCE_HP_OPERATOR=101
1190 val SCE_HP_IDENTIFIER=102
1192 val SCE_HPA_START=105
1193 val SCE_HPA_DEFAULT=106
1194 val SCE_HPA_COMMENTLINE=107
1195 val SCE_HPA_NUMBER=108
1196 val SCE_HPA_STRING=109
1197 val SCE_HPA_CHARACTER=110
1198 val SCE_HPA_WORD=111
1199 val SCE_HPA_TRIPLE=112
1200 val SCE_HPA_TRIPLEDOUBLE=113
1201 val SCE_HPA_CLASSNAME=114
1202 val SCE_HPA_DEFNAME=115
1203 val SCE_HPA_OPERATOR=116
1204 val SCE_HPA_IDENTIFIER=117
1206 val SCE_HPHP_DEFAULT=118
1207 val SCE_HPHP_HSTRING=119
1208 val SCE_HPHP_SIMPLESTRING=120
1209 val SCE_HPHP_WORD=121
1210 val SCE_HPHP_NUMBER=122
1211 val SCE_HPHP_VARIABLE=123
1212 val SCE_HPHP_COMMENT=124
1213 val SCE_HPHP_COMMENTLINE=125
1214 val SCE_HPHP_STRINGEOL=126
1215 # Lexical states for SCLEX_PERL
1216 val SCE_PL_DEFAULT=0
1218 val SCE_PL_COMMENTLINE=2
1223 val SCE_PL_CHARACTER=7
1224 val SCE_PL_PUNCTUATION=8
1225 val SCE_PL_PREPROCESSOR=9
1226 val SCE_PL_OPERATOR=10
1227 val SCE_PL_IDENTIFIER=11
1228 val SCE_PL_SCALAR=12
1231 val SCE_PL_SYMBOLTABLE=15
1234 val SCE_PL_REGSUBST=18
1235 val SCE_PL_LONGQUOTE=19
1236 val SCE_PL_BACKTICKS=20
1237 val SCE_PL_DATASECTION=21
1238 # Lexical states for SCLEX_LATEX
1244 # Lexical states for SCLEX_LUA
1245 val SCE_LUA_DEFAULT=0
1246 val SCE_LUA_COMMENT=1
1247 val SCE_LUA_COMMENTLINE=2
1248 val SCE_LUA_COMMENTDOC=3
1249 val SCE_LUA_NUMBER=4
1251 val SCE_LUA_STRING=6
1252 val SCE_LUA_CHARACTER=7
1253 val SCE_LUA_LITERALSTRING=8
1254 val SCE_LUA_PREPROCESSOR=9
1255 val SCE_LUA_OPERATOR=10
1256 val SCE_LUA_IDENTIFIER=11
1257 val SCE_LUA_STRINGEOL=12
1258 val SCE_ERR_DEFAULT=0
1259 val SCE_ERR_PYTHON=1
1263 val SCE_ERR_BORLAND=5
1268 evt void StyleNeeded=2000(int position)
1269 evt void CharAdded=2001(int ch)
1270 evt void SavePointReached=2002(void)
1271 evt void SavePointLeft=2003(void)
1272 evt void ModifyAttemptRO=2004(void)
1273 # GTK+ Specific to work around focus and accelerator problems:
1274 evt void Key=2005(int ch, int modifiers)
1275 evt void DoubleClick=2006(void)
1276 evt void UpdateUI=2007(void)
1277 # The old name for SCN_UPDATEUI
1278 val SCN_CHECKBRACE=2007
1279 evt void Modified=2008(int position, int modificationType, string text, int length, int linesAdded, int line, int foldLevelNow, int foldLevelPrev)
1280 # Optional module for macro recording
1281 evt void MacroRecord=2009(int message, int wParam, int lParam)
1282 evt void MarginClick=2010(int modifiers, int position, int margin)
1283 evt void NeedShown=2011(int position, int length)
1284 evt void PosChanged=2012(int position)
1288 ################################################
1291 # ***** DEPRECATED from here to end of file ******
1293 # Will a paste succeed?
1294 fun bool EM_CanPaste=1074(,)
1296 # Are there any undoable actions in the undo history.
1297 fun bool EM_CanUndo=198(,)
1299 # Find the position and line from a point within the window.
1300 fun int EM_CharFromPos=215(,point pt)
1302 # Delete the undo history.
1303 fun void EM_EmptyUndoBuffer=205(,)
1305 # Retrieve the selection range.
1306 fun void EM_ExGetSel=1076(,charrangeresult cr)
1308 # Retrieve the line number of a position in the document.
1309 get int EM_ExLineFromChar=1078(,position pos)
1311 # Select a range of text.
1312 fun void EM_ExSetSel=1079(,charrange cr)
1314 # Find some text in the document.
1315 fun position EM_FindText=1080(int flags, findtext ft)
1317 # Find some text in the document. Returns range of found text in ft argument.
1318 fun position EM_FindTextEx=1103(int flags, findtextex ft)
1320 # On Windows will draw the document into a display context such as a printer.
1321 fun void EM_FormatRange=1081(bool draw, formatrange fr)
1323 # Retrieve the line at the top of the display.
1324 get int EM_GetFirstVisibleLine=206(,)
1326 # Retrieve the contents of a line.
1327 # Returns the length of the line.
1328 fun int EM_GetLine=196(int line, countedstring text)
1330 # Returns the number of lines in the document. There is always at least one.
1331 fun int EM_GetLineCount=186(,)
1333 # Returns the size in pixels of left and right margins packed into one integer.
1334 # The left margin is in the low half and the right margin in the high half.
1335 fun int EM_GetMargins=212(,)
1337 # Is the document different from when it was last saved?
1338 get bool EM_GetModify=184(,)
1340 # Get the area used to display the document.
1341 fun void EM_GetRect=178(,rectangle r)
1343 # Return the selection packed into one integer with the start of the selection
1344 # in the low half and the end in the high half.
1345 fun int EM_GetSel=176(,)
1347 # Retrieve the selected text.
1348 # Return the length of the text.
1349 fun int EM_GetSelText=1086(,stringresult text)
1351 # Retrieve a range of text.
1352 # Return the length of the text.
1353 fun int EM_GetTextRange=1099(, textrange tr)
1355 # Draw the selection in normal style or with selection highlighted.
1356 fun void EM_HideSelection=1087(bool normal,)
1358 # Retrieve the line of a position.
1359 fun int EM_LineFromChar=201(position pos,)
1361 # Retrieve the position at the start of a line.
1362 fun position EM_LineIndex=187(int line,)
1364 # Retrieve the number of characters on a line not including end of line characters.
1365 fun int EM_LineLength=193(int line,)
1367 # Scroll horizontally and vertically.
1368 fun void EM_LineScroll=182(int columns, int lines)
1370 # Retrieve the point in the window where a position is displayed.
1371 fun void EM_PosFromChar=214(pointresult pt, position pos)
1373 # Replace the selected text with the argument text.
1374 fun void EM_ReplaceSel=194(, string text)
1376 # Ensure the caret is visible.
1377 fun void EM_ScrollCaret=183(,)
1379 # Returns SEL_EMPTY if selection contains no characters, otherwise SEL_TEXT.
1380 fun void EM_SelectionType=1090(,)
1382 # Set the width of the left and right margins
1383 fun void EM_SetMargins=211(int flags, int values)
1385 # Set to read only or read write.
1386 set void EM_SetReadOnly=207(bool readOnly,)
1388 # Select the range of text from start to end.
1389 fun void EM_SetSel=177(position start, position end)
1391 # Undo one action in the undo history.
1392 fun void EM_Undo=199(,)
1395 fun void WM_Null=0(,)
1397 # Clear the selection.
1398 fun void WM_Clear=771(,)
1400 fun void WM_Command=273(,)
1402 # Copy the selection to the clipboard.
1403 fun void WM_Copy=769(,)
1405 # Cut the selection to the clipboard.
1406 fun void WM_Cut=768(,)
1408 # Retrieve all the text in the document.
1409 # Returns number of characters retrieved.
1410 fun int WM_GetText=13(int length, stringresult text)
1412 # Retrieve the number of characters in the document.
1413 fun int WM_GetTextLength=14(,)
1415 # Notification back to container
1416 fun void WM_Notify=78(int id, int stuff)
1418 # Paste the contents of the clipboard into the document replacing the selection.
1419 fun void WM_Paste=770(,)
1421 # Replace the contents of the document with the argument text.
1422 fun void WM_SetText=12(, string text)
1424 # Undo one action in the undo history.
1425 fun void WM_Undo=772(,)
1427 # Notification codes
1429 val EN_KILLFOCUS=512
1432 # Flags for setting margins.
1434 val EC_RIGHTMARGIN=2
1435 val EC_USEFONTINFO=0xffff
1441 # Find replace mask constants
1442 val FR_MATCHCASE=0x4
1443 val FR_WHOLEWORD=0x2
1446 # Key modifier flag.
1448 val LEFT_CTRL_PRESSED=2
1449 val LEFT_ALT_PRESSED=4
1452 evt void EN_Change=768(void)