From 15e3b049d5b49b7c5b51bcfa8c3f6ccdd3f827e4 Mon Sep 17 00:00:00 2001
From: nyamatongwe 
Scintilla
+ style="color:white;text-decoration:none;font-size:200%">Scintilla
@@ -261,8 +260,9 @@
href="#Indicators">indicators. This allows 32 fundamental styles, which is enough for most
languages, and three independent indicators so that, for example, syntax errors, deprecated
names and bad indentation could all be displayed at once. The number of bits used for styles
- can be altered with up to a
- maximum of 7 bits. The remaining bits can be used for indicators.
SCI_SETSTYLEBITS up to a maximum of 7 bits. The
+ remaining bits can be used for indicators.
Positions within the Scintilla document refer to a character or the gap before that character. The first character in a document is 0, the second 1 and so on. If a document @@ -280,7 +280,7 @@ largest font in any current style. This restriction is for performance; if lines differed in height then calculations involving positioning of text would require the text to be styled first.
- SCI_GETTEXT(int length, char *text)SCI_GETTEXT(int length, char *text)
SCI_SETTEXT(<unused>, const char *text)
SCI_SETSAVEPOINT
SCI_GETLINE(int line, char *text)
@@ -302,7 +302,7 @@
*tr)
SCI_SETSTYLEBITS(int bits)
SCI_GETSTYLEBITS
-
+
SCI_GETTEXT(int length, char *text)
This returns length-1 characters of text from the start of the document plus one
@@ -312,11 +312,11 @@
*text). If you then save the text, you should use SCI_SETSAVEPOINT to mark
the text as unmodified.
See also: , ,
+ href="#SCI_GETTEXTRANGE">SCI_GETTEXTRANGESCI_SETTEXT(<unused>, const char *text)
This replaces all the text in the document with the zero terminated text string you pass
@@ -332,8 +332,8 @@
href="#Notifications">notification messages, allowing the container to know if the file
should be considered dirty or not.
See also: ,
+See also: ,
SCI_GETLINE(int line, char *text)
This fills the buffer defined by text with the contents of the nominated line (lines start at
@@ -344,11 +344,11 @@
characters. If you ask for a line number outside the range of lines in the document, 0
characters are copied.
See also: , ,
+ href="#SCI_GETTEXT">SCI_GETTEXTSCI_REPLACESEL(<unused>, const char *text)
The currently selected text between the anchor
@@ -360,7 +360,7 @@
SCI_GETREADONLY
These messages set and get the read-only flag for the document. If you mark a document as read
only, attempts to modify the text cause the notification.
SCN_MODIFYATTEMPTRO notification.
SCI_GETTEXTRANGE(<unused>, TextRange *tr)
@@ -371,11 +371,11 @@
longer than the number of characters you wish to read. The return value is the length of the
returned text not including the terminating 0.
See also: , ,
+ href="#SCI_GETTEXT">SCI_GETTEXTSCI_GETSTYLEDTEXT(<unused>, TextRange *tr)
@@ -388,11 +388,11 @@
cpMin or cpMax. Positions outside the document return character codes
and style bytes of 0.
See also: , ,
+ href="#SCI_GETTEXT">SCI_GETTEXTSCI_ADDTEXT(int length, const char *s)
This inserts the first length characters from the string s,
@@ -452,7 +452,8 @@ struct TextRange {
SCI_FINDTEXT(int flags, TextToFind
+ *ttf)
SCI_SEARCHANCHOR
SCI_SEARCHNEXT(int searchFlags, const char
*text)
@@ -460,7 +461,7 @@ struct TextRange {
*text)
Search and replace using the
target
-
+
searchFlags
Several of the search routines use flag options, which include a simple regular expression
@@ -611,7 +612,8 @@ struct TextRange {
is succeeds. The chrgText.cpMin and chrgText.cpMax members of
TextToFind are filled in with the start and end positions of the found text.
See also:
+See also:
TextToFind
This structure is defined to have exactly the same shape as the Win32 structure
@@ -630,7 +632,7 @@ struct TextToFind {
These messages provide relocatable search support. This allows multiple incremental
interactive searches to be macro recorded while still setting the selection to found text so
the find/select operation is self-contained. These three messages send SCN_MACRORECORD notifications if macro recording is enabled.
SCI_SEARCHANCHOR sets the search start point used by
@@ -649,16 +651,16 @@ struct TextToFind {
of the matching text. The selection is updated to show the matched text, but is not scrolled
into view.
See also: ,
+See also: , +
Using , modifications cause
- scrolling and other visible changes, which may take some time and cause unwanted display
- updates. If performing many changes, such as a replace all command, the target can be used
- instead. First, set the range to be replaced. Then call SCI_REPLACETARGET or
- SCI_REPLACETARGETRE.
Using ,
+ modifications cause scrolling and other visible changes, which may take some time and cause
+ unwanted display updates. If performing many changes, such as a replace all command, the target
+ can be used instead. First, set the range to be replaced. Then call
+ SCI_REPLACETARGET or SCI_REPLACETARGETRE.
Searching can be performed within the target range with SCI_SEARCHINTARGET,
which uses a counted string to allow searching for null characters. It returns the length of
@@ -666,9 +668,10 @@ struct TextToFind {
SCI_SEARCHINTARGET such as SCFIND_MATCHCASE,
SCFIND_WHOLEWORD, SCFIND_WORDSTART, and SCFIND_REGEXP
can be set with SCI_SETSEARCHFLAGS. SCI_SEARCHINTARGET may be simpler
- for some clients to use than , as that
- requires using a pointer to a structure.
SCI_FINDTEXT, as that requires using a pointer to a
+ structure.
+ SCI_SETTARGETSTART(int pos)
SCI_GETTARGETSTART
SCI_SETTARGETEND(int pos)
SCI_GETTARGETEND
@@ -680,7 +683,7 @@ struct TextToFind {
SCI_GETSEARCHFLAGS
SCI_SEARCHINTARGET(int length, const char
*text)
-
+
SCI_SETTARGETSTART(int pos)
SCI_GETTARGETSTART
@@ -718,7 +721,7 @@ struct TextToFind {
text and the return value is the position of the start of the matching text. If the search
fails, the result is -1.
See also:
+See also:
SCI_BEGINUNDOACTION and
SCI_ENDUNDOACTION messages. These sequences can be nested and only the top-level
sequences are undone as units.
- SCI_UNDOSCI_UNDO
SCI_CANUNDO
SCI_EMPTYUNDOBUFFER
SCI_REDO
@@ -775,7 +778,7 @@ struct TextToFind {
SCI_GETUNDOCOLLECTION
SCI_BEGINUNDOACTION
SCI_ENDUNDOACTION
-
+
SCI_UNDO
SCI_CANUNDO
@@ -801,7 +804,7 @@ struct TextToFind {
href="#SCN_SAVEPOINTREACHED">SCN_SAVEPOINTREACHED notification to be sent to the
container.
See also:
+See also:
SCI_SETUNDOCOLLECTION(bool collectUndo)SCI_EMPTYUNDOBUFFER to avoid the undo buffer being unsynchronized with the data in
the buffer. You might wish to turn off saving undo information if you use the Scintilla to store text generated by a program (a Log view) or in a display window where text is often deleted and @@ -831,7 +834,7 @@ struct TextToFind { (after the last character). If you use messages, there is nothing to stop you setting a position that is in the middle of a CRLF pair, or in the middle of a 2 byte character. However, keyboard commands will not move the caret into such positions.
- SCI_GETTEXTLENGTHSCI_GETTEXTLENGTH
SCI_GETLENGTH
SCI_GETLINECOUNT
SCI_GETFIRSTVISIBLELINE
@@ -873,7 +876,7 @@ struct TextToFind {
SCI_TEXTWIDTH(int styleNumber, char *text)
SCI_TEXTHEIGHT(int line)
SCI_CHOOSECARETX
-
+
SCI_GETTEXTLENGTH
SCI_GETLENGTH
@@ -896,13 +899,13 @@ struct TextToFind {
SCI_GETMODIFY
This returns non-zero if the document is modified and 0 if it is unmodified. The modified
status of a document is determined by the undo position relative to the save point. The save
- point is set by , usually when
- you have saved data to a file.
SCI_SETSAVEPOINT,
+ usually when you have saved data to a file.
If you need to be notified when the document becomes modified, Scintilla notifies the
container that it has entered or left the save point with the and SCN_SAVEPOINTREACHED and notification messages.
SCI_SETSEL(int anchorPos, int currentPos)
@@ -927,7 +930,7 @@ struct TextToFind {
This sets the current position and creates a selection between the anchor and the current
position. The caret is not scrolled into view.
See also:
+See also:
SCI_GETCURRENTPOS
This returns the current position.
See also:
+See also:
SCI_GETANCHOR
This returns the current anchor position.
See also:
+See also:
SCI_GETSELECTIONSTART
SCI_GETSELECTIONEND
@@ -1021,12 +1024,13 @@ struct TextToFind {
buffer. The buffer must be at least
SCI_GETSELECTIONEND()-SCI_SETSELECTIONSTART()+1 bytes long.
+
-
-
See also: , , , ,
+See also: , , , ,
SCI_GETCURLINE(int textLen, char *text)
This retrieves the text of the line containing the caret and returns the position within the
@@ -1034,10 +1038,11 @@ struct TextToFind {
the text you wish to retrieve and a terminating 0 character. Set textLen to the
length of the buffer.
See also: , , , ,
+See also: , , , ,
SCI_SELECTIONISRECTANGLE
This returns 1 if the current selection is in rectangle mode, 0 if not.
SCI_SETWORDCHARS. The position
+ sets the start or the search, which is forwards when searching for the end and backwards when
+ searching for the start.
Set onlyWordCharacters to true (1) to stop searching at the first
non-word character in the search direction. If onlyWordCharacters is
@@ -1162,9 +1167,9 @@ struct TextToFind {
SCI_HIDESELECTION(bool hide)
The normal state is to make the selection visible by drawing it as set by and . However, if you hide the selection, it is drawn as
- normal text.
SCI_SETSELFORE and SCI_SETSELBACK. However, if you hide the selection, it
+ is drawn as normal text.
SCI_CHOOSECARETX
Scintilla remembers the x value of the last position horizontally moved to explicitly by the
@@ -1172,7 +1177,7 @@ struct TextToFind {
This message sets the current x position of the caret as the remembered value.
SCI_LINESCROLL(int column, int line)
SCI_SCROLLCARET
SCI_SETXCARETPOLICY(int caretPolicy, int
caretSlop)
@@ -1191,7 +1196,7 @@ struct TextToFind {
SCI_SETENDATLASTLINE(bool
endAtLastLine)
SCI_GETENDATLASTLINE
-
+
SCI_LINESCROLL(int column, int line)
This will attempt to scroll the display by the number of columns and lines that you specify.
@@ -1202,7 +1207,7 @@ struct TextToFind {
the column at the left edge of the view (i.e. they move the text leftwards as far as the user
is concerned). Negative values do the reverse.
See also:
+See also:
SCI_SCROLLCARET
If the current position (this is the caret if there is no selection) is not visible, the view
@@ -1460,9 +1465,9 @@ struct TextToFind {
SCI_SETVISIBLEPOLICY(int caretPolicy, int caretSlop)
This determines how the vertical positioning is determined when is called. It takes
- VISIBLE_SLOP and VISIBLE_STRICT flags for the policy parameter. It is
- similar in operation to is
+ called. It takes VISIBLE_SLOP and VISIBLE_STRICT flags for the policy
+ parameter. It is similar in operation to .
See also:
+See also:
SCI_SETSCROLLWIDTH(int pixelWidth)
SCI_GETSCROLLWIDTH
@@ -1499,13 +1504,13 @@ struct TextToFind {
scrolling one page below the last line.
SCI_SETVIEWWS(int wsMode)
SCI_GETVIEWWS
SCI_SETWHITESPACEFORE(bool
useWhitespaceForeColour, int colour)
SCI_SETWHITESPACEBACK(bool
useWhitespaceBackColour, int colour)
-
+
SCI_SETVIEWWS(int wsMode)
SCI_GETVIEWWS
@@ -1607,12 +1612,12 @@ struct TextToFind {
this can be changed with the SCI_SETEOLMODE message. You can also convert the
entire document to one of these line endings with SCI_CONVERTEOLS. Finally, you
can choose to display the line endings with SCI_SETVIEWEOL.
SCI_SETEOLMODE(int eolMode)
SCI_GETEOLMODE
SCI_CONVERTEOLS(int eolMode)
SCI_SETVIEWEOL(bool visible)
SCI_GETVIEWEOL
-
+
SCI_SETEOLMODE(int eolMode)
SCI_GETEOLMODE
@@ -1640,17 +1645,18 @@ struct TextToFind {
divide the 8 style bits available for each character into 5 bits (0 to 4 = styles 0 to 31) that set a style and three bits (5 to 7) that
define indicators. You can change the balance between
- styles and indicators with . If
- your styling needs can be met by one of the standard lexers, or if you can write your own, then
- a lexer is probably the easiest way to style your document. If you choose to use the container
- to do the styling you can use the
- command to select SCLEX_CONTAINER, in which case the container is sent a SCI_SETSTYLEBITS. If your styling needs can be met by
+ one of the standard lexers, or if you can write your own, then a lexer is probably the easiest
+ way to style your document. If you choose to use the container to do the styling you can use
+ the command to select
+ SCLEX_CONTAINER, in which case the container is sent a notification each time text needs styling for display. As another
alternative, you might use idle time to style the document. Even if you use a lexer, you might
use the styling commands to mark errors detected by a compiler. The following commands can be
used.
SCI_GETENDSTYLED
SCI_STARTSTYLING(int position, int mask)
SCI_SETSTYLING(int length, int style)
SCI_SETSTYLINGEX(int length, const char
@@ -1658,7 +1664,7 @@ struct TextToFind {
SCI_SETLINESTATE(int line, int value)
SCI_GETLINESTATE(int line)
SCI_GETMAXLINESTATE
-
+
SCI_GETENDSTYLED
Scintilla keeps a record of the last character that is likely to be styled correctly. This is
@@ -1710,9 +1716,10 @@ struct TextToFind {
While the style setting messages mentioned above, change the style numbers associated with
text, these messages define how those style numbers are interpreted visually. There are 128
lexer styles that can be set, numbered 0 to STYLEMAX (127). Unless you use to change the number of style
- bits, styles 0 to 31 are used to set the text attributes. There are also some predefined
- numbered styles starting at 32, The following STYLE_* constants are defined.
SCI_SETSTYLEBITS to change the number
+ of style bits, styles 0 to 31 are used to set the text attributes. There are also some
+ predefined numbered styles starting at 32, The following STYLE_* constants are
+ defined.
| 34 | This style sets the attributes used when highlighting braces with the message and when - highlighting the corresponding indentation with . | + class="message" href="#BraceHighlighting">
| 35 | This style sets the display attributes used when marking an unmatched brace with the - message. | + + message.
| This style sets the display attributes used when drawing control characters. See also: . | + href="#SCI_SETCONTROLCHARSYMBOL">|
This is not a style but is the number of the maximum style that can be set. Styles
between STYLE_LASTPREDEFINED and STYLE_MAX would be appropriate
- if you used to set more
- than 5 style bits. |
+ if you used
+ to set more than 5 style bits.
It is entirely up to you how you use styles. If you want to use syntax colouring you might use style 0 for white space, style 1 for numbers, style 2 for keywords, style 3 for strings, style 4 for preprocessor, style 5 for operators, and so on.
- SCI_STYLERESETDEFAULTSCI_STYLERESETDEFAULT
SCI_STYLECLEARALL
SCI_STYLESETFONT(int styleNumber, char
*fontName)
@@ -1835,7 +1843,7 @@ struct TextToFind {
visible)
SCI_STYLESETCHANGEABLE(int styleNumber, bool
changeable)
-
+
SCI_STYLERESETDEFAULT
This message resets STYLE_DEFAULT to its state when Scintilla was
@@ -1854,11 +1862,12 @@ struct TextToFind {
SCI_STYLESETBOLD(int styleNumber, bool bold)
SCI_STYLESETITALIC(int styleNumber, bool italic)
These messages (plus ) set the font attributes that are
- used to match the fonts you request to those available. The fontName is a zero
- terminated string holding the name of a font. Under Windows, only the first 32 characters of
- the name are used and the name is not case sensitive. For internal caching, Scintilla tracks
- fonts by name and does care about the casing of font names, so please be consistent.
SCI_STYLESETCHARACTERSET) set the font
+ attributes that are used to match the fonts you request to those available. The
+ fontName is a zero terminated string holding the name of a font. Under Windows,
+ only the first 32 characters of the name are used and the name is not case sensitive. For
+ internal caching, Scintilla tracks fonts by name and does care about the casing of font names,
+ so please be consistent.
SCI_STYLESETUNDERLINE(int styleNumber, bool
underline)
@@ -1932,7 +1941,7 @@ struct TextToFind {
it was not selected. When there is no selection, the current insertion point is marked by the
text caret. This is a vertical line that is normally blinking on and off to attract the users
attention.
SCI_SETSELFORE(bool useSelectionForeColour, int
colour)
SCI_SETSELBACK(bool useSelectionBackColour, int
colour)
@@ -1950,7 +1959,7 @@ struct TextToFind {
SCI_SETCONTROLCHARSYMBOL(int
symbol)
SCI_GETCONTROLCHARSYMBOL
-
+
SCI_SETSELFORE(bool useSelectionForeColour, int colour)
@@ -1989,9 +1998,10 @@ struct TextToFind {
SCI_SETCARETWIDTH(int pixels)
SCI_GETCARETWIDTH
- The width of the caret can be set with SCI_SETCARETWIDTH to a value of 1, 2 or 3
- pixels. The default width is 1 pixel. You can read back the current width with
- SCI_GETCARETWIDTH.
SCI_SETCARETWIDTH to a value of 0, 1, 2 or
+ 3 pixels. The default width is 1 pixel. You can read back the current width with
+ SCI_GETCARETWIDTH. A width of 0 makes the caret invisible (added at version
+ 1.50).
SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
@@ -2012,20 +2022,21 @@ struct TextToFind {
There may be up to three margins to the left of the text display, plus a gap either side of the text. Each margin can be set to display either symbols or line numbers with . The markers that can be - displayed in each margin are set with . Any markers not associated with a visible - margin will be displayed as changes in background colour in the text. A width in pixels can be - set for each margin. Margins with a zero width are ignored completely. You can choose if a - mouse click in a margin sends a - notification to the container or selects a line of text.
+ class="message" href="#SCI_SETMARGINTYPEN">SCI_SETMARGINTYPEN. The markers
+ that can be displayed in each margin are set with SCI_SETMARGINMASKN. Any markers not associated with
+ a visible margin will be displayed as changes in background colour in the text. A width in
+ pixels can be set for each margin. Margins with a zero width are ignored completely. You can
+ choose if a mouse click in a margin sends a SCN_MARGINCLICK notification to the container or
+ selects a line of text.
The margins are numbered 0 to 2. Using a margin number outside the valid range has no effect. By default, margin 0 is set to display line numbers, but is given a width of 0, so it is hidden. Margin 1 is set to display non-folding symbols and is given a width of 16 pixels, so it is visible. Margin 2 is set to display the folding symbols, but is given a width of 0, so it is hidden. Of course, you can set the margins to be whatever you wish.
- SCI_SETMARGINTYPEN(int margin, int +SCI_SETMARGINTYPEN(int margin, int
type)
SCI_GETMARGINTYPEN(int margin)
SCI_SETMARGINWIDTHN(int margin, int
@@ -2044,7 +2055,7 @@ struct TextToFind {
SCI_SETMARGINRIGHT(<unused>, int
pixels)
SCI_GETMARGINRIGHT
-
+
SCI_SETMARGINTYPEN(int margin, int iType)
SCI_GETMARGINTYPEN(int margin)
@@ -2071,16 +2082,16 @@ struct TextToFind {
symbols used to denote folding. You can assign a wide range of symbols and colours to each of
the 32 logical symbols, see Markers for more information. If (mask
& SC_MASK_FOLDERS)==0, the margin background colour is controlled by style 33 ().
STYLE_LINENUMBER).
You add logical markers to a line with . If a line has an associated marker that does not - appear in the mask of any margin with a non-zero width, the marker changes the background - colour of the line. For example, suppose you decide to use logical marker 10 to mark lines with - a syntax error and you want to show such lines by changing the background colour. The mask for - this marker is 1 shifted left 10 times (1<<10) which is 0x400. If you make sure that no - symbol margin includes 0x400 in its mask, any line with the marker gets the background colour - changed.
+ href="#SCI_MARKERADD">SCI_MARKERADD. If a line has an associated marker that
+ does not appear in the mask of any margin with a non-zero width, the marker changes the
+ background colour of the line. For example, suppose you decide to use logical marker 10 to mark
+ lines with a syntax error and you want to show such lines by changing the background colour.
+ The mask for this marker is 1 shifted left 10 times (1<<10) which is 0x400. If you make
+ sure that no symbol margin includes 0x400 in its mask, any line with the marker gets the
+ background colour changed.
To set a non-folding margin 1 use SCI_SETMARGINMASKN(1, ~SC_MASK_FOLDERS); to
set a folding margin 2 use SCI_SETMARGINMASKN(2, SC_MASK_FOLDERS). This is the
@@ -2092,10 +2103,11 @@ struct TextToFind {
sensitive)
SCI_GETMARGINSENSITIVEN(int margin)
Each of the three margins can be set sensitive or insensitive to mouse clicks. A click in a
- sensitive margin sends a notification to the container. Margins that are not
- sensitive act as selection margins which make it easy to select ranges of lines. By default,
- all margins are insensitive.
SCN_MARGINCLICK notification to the container. Margins that are not sensitive act as
+ selection margins which make it easy to select ranges of lines. By default, all margins are
+ insensitive.
SCI_SETMARGINLEFT(<unused>, int pixels)
SCI_GETMARGINLEFT
@@ -2105,7 +2117,8 @@ struct TextToFind {
The default is to one pixel on each side.
SCI_SETUSEPALETTE(bool
+ allowPaletteUse)
SCI_GETUSEPALETTE
SCI_SETBUFFEREDDRAW(bool isBuffered)
SCI_GETBUFFEREDDRAW
@@ -2116,7 +2129,7 @@ struct TextToFind {
SCI_GRABFOCUS
SCI_SETFOCUS(bool focus)
SCI_GETFOCUS
-
+
SCI_SETUSEPALETTE(bool allowPaletteUse)
SCI_GETUSEPALETTE
@@ -2199,19 +2212,20 @@ struct TextToFind {
but with the need to indicate that Scintilla has the logical focus.
SCI_BRACEHIGHLIGHT(int pos1, int
+ pos2)
SCI_BRACEBADLIGHT(int pos1)
SCI_BRACEMATCH(int position, int
maxReStyle)
-
+
SCI_BRACEHIGHLIGHT(int pos1, int pos2)
Up to two characters can be highlighted in a 'brace highlighting style', which is defined as
- style number (34). If you have
- enabled indent guides, you may also wish to highlight the indent that corresponds with the
- brace. You can locate the column with and highlight the indent with .
STYLE_BRACELIGHT (34).
+ If you have enabled indent guides, you may also wish to highlight the indent that corresponds
+ with the brace. You can locate the column with SCI_GETCOLUMN and highlight the indent with SCI_SETHIGHLIGHTGUIDE.
SCI_BRACEBADLIGHT(int pos1)
If there is no matching brace then the brace
@@ -2244,7 +2258,7 @@ struct TextToFind {
inserting a tab at the current character position and backspace unindents the line rather than
deleting a character. Scintilla can also display indentation guides (vertical lines) to help
you to generate code.
SCI_SETTABWIDTH(int widthInChars)
SCI_GETTABWIDTH
SCI_SETUSETABS(bool useTabs)
SCI_GETUSETABS
@@ -2265,7 +2279,7 @@ struct TextToFind {
SCI_GETINDENTATIONGUIDES
SCI_SETHIGHLIGHTGUIDE(int column)
SCI_GETHIGHLIGHTGUIDE
-
+
SCI_SETTABWIDTH(int widthInChars)
SCI_GETTABWIDTH
@@ -2278,16 +2292,16 @@ struct TextToFind {
SCI_SETUSETABS determines whether indentation should be created out of a mixture
of tabs and spaces or be based purely on spaces. Set useTabs to false
(0) to create all tabs and indents out of spaces. The default is true. You can use
- to get the column of a position
- taking the width of a tab into account.
SCI_GETCOLUMN to get the column of a
+ position taking the width of a tab into account.
SCI_SETINDENT(int widthInChars)SCI_SETINDENT sets the size of indentation in terms of the width of a space in STYLE_DEFAULT. If you set a width of 0, the indent
- size is the same as the tab size. There are no limits on indent sizes, but values less than 0
- or large values may have undesirable effects. STYLE_DEFAULT. If you set a width of
+ 0, the indent size is the same as the tab size. There are no limits on indent sizes, but values
+ less than 0 or large values may have undesirable effects. SCI_SETTABINDENTS(bool tabIndents)
SCI_GETTABINDENTS
@@ -2313,15 +2327,15 @@ struct TextToFind {
Indentation guides are dotted vertical lines that appear within indentation white space every
indent size columns. They make it easy to see which constructs line up especially when they
extend over multiple pages. Style (37) is used to specify the foreground and
- background colour of the indentation guides.
STYLE_INDENTGUIDE (37) is used to specify the
+ foreground and background colour of the indentation guides.
SCI_SETHIGHLIGHTGUIDE(int column)
SCI_GETHIGHLIGHTGUIDE
When brace highlighting occurs, the indentation guide corresponding to the braces may be
highlighted with the brace highlighting style, (34). Set column to 0 to cancel this
- highlight.
STYLE_BRACELIGHT (34). Set column to 0 to
+ cancel this highlight.
OR
operation, with the markers of the previous line.
- SCI_MARKERDEFINE(int markerNumber, int
+ SCI_MARKERDEFINE(int markerNumber, int
markerSymbols)
SCI_MARKERDEFINEPIXMAP(int markerNumber,
const char *xpm)
@@ -2366,7 +2380,7 @@ struct TextToFind {
SCI_MARKERLINEFROMHANDLE(int
handle)
SCI_MARKERDELETEHANDLE(int handle)
-
+
SCI_MARKERDEFINE(int markerNumber, int markerSymbols)
This message associates a marker number in the range 0 to 31 with one of the marker symbols or
@@ -2404,7 +2418,7 @@ struct TextToFind {
number 1 use:
SCI_MARKETDEFINE(1, SC_MARK_CHARACETR+65).
-
+
The marker numbers SC_MARKNUM_FOLDER and SC_MARKNUM_FOLDEROPEN are
used for showing that a fold is present and open or closed. Any symbols may be assigned for
@@ -2534,11 +2548,11 @@ struct TextToFind {
This message adds marker number markerNumber to a line. The message returns -1 if
this fails (illegal line number, out of memory) or it returns a marker handle number that
identifies the added marker. You can use this returned handle with to find where a marker is after
- moving or combining lines and with to delete the marker based on its
- handle. The message does not check that the value of markerNumber, nor does it check if the
- line already contains the marker.
SCI_MARKERLINEFROMHANDLE to find where a
+ marker is after moving or combining lines and with SCI_MARKERDELETEHANDLE to delete the marker
+ based on its handle. The message does not check that the value of markerNumber, nor does it
+ check if the line already contains the marker.
SCI_MARKERDELETE(int line, int markerNumber)
This searches the given line number for the given marker number and deletes it if it is
@@ -2566,14 +2580,14 @@ struct TextToFind {
SCI_MARKERLINEFROMHANDLE(int markerHandle)
The markerHandle argument is an identifier for a marker returned by . This function searches the document
- for the marker with this handle and returns the line number that contains it or -1 if it is not
- found.
SCI_MARKERADD. This function searches
+ the document for the marker with this handle and returns the line number that contains it or -1
+ if it is not found.
SCI_MARKERDELETEHANDLE(int markerHandle)
The markerHandle argument is an identifier for a marker returned by . This function searches the document
- for the marker with this handle and deletes the marker if it is found.
SCI_MARKERADD. This function searches
+ the document for the marker with this handle and deletes the marker if it is found.
The indicators are set using with a INDICS_MASK mask and with the values
+ href="#SCI_STARTSTYLING">SCI_STARTSTYLING with a INDICS_MASK mask
+ and with the values
INDIC0_MASK, INDIC1_MASK and INDIC2_MASK.
The number of bits used for styles can be altered with from 0 to 7 bits. The remaining bits can be used
- for indicators, so there can be from 1 to 8 indicators. However, the INDIC*_MASK
- constants defined in Scintilla.h all assume 5 bits of styling information and 3
- indicators. If you use a different arrangement, you must define your own constants.
SCI_SETSTYLEBITS from 0 to 7 bits. The remaining bits
+ can be used for indicators, so there can be from 1 to 8 indicators. However, the
+ INDIC*_MASK constants defined in Scintilla.h all assume 5 bits of
+ styling information and 3 indicators. If you use a different arrangement, you must define your
+ own constants.
The SCI_INDIC* messages allow you to get and set the visual appearance of the
indicators. They all use an indicatorNumber argument in the range 0 to 7 to set
the indicator to style. With the default settings, only indicators 0, 1 and 2 will have any
visible effect.
SCI_INDICSETSTYLE(int indicatorNumber, int
indicatorStyle)
SCI_INDICGETSTYLE(int indicatorNumber)
SCI_INDICSETFORE(int indicatorNumber, int
colour)
SCI_INDICGETFORE(int indicatorNumber)
-
+
SCI_INDICSETSTYLE(int indicatorNumber, int
indicatorStyle)
@@ -2694,7 +2709,7 @@ struct TextToFind {
To make use of autocompletion you must monitor each character added to the document. See
SciTEBase::CharAdded() in SciTEBase.cxx for an example of autocompletion.
SCI_AUTOCSHOW(int lenEntered, const char
*list)
SCI_AUTOCCANCEL
SCI_AUTOCACTIVE
@@ -2723,19 +2738,20 @@ struct TextToFind {
SCI_AUTOCSETDROPRESTOFWORD(bool
dropRestOfWord)
SCI_AUTOCGETDROPRESTOFWORD
-
+
SCI_AUTOCSHOW(int lenEntered, const char *list)
This message causes a list to be displayed. lenEntered is the number of
characters of the word already entered and list is the list of words separated by
separator characters. The initial separator character is a space but this can be set or got
- with and .
SCI_AUTOCSETSEPARATOR
+ and SCI_AUTOCGETSEPARATOR.
The list of words should be in sorted order. If set to ignore case mode with , then strings are
- matched after being converted to upper case. One result of this is that the list should be
- sorted with the punctuation characters '[', '\', ']', '^', '_', and '`' sorted after
+ class="message" href="#SCI_AUTOCSETIGNORECASE">SCI_AUTOCSETIGNORECASE, then
+ strings are matched after being converted to upper case. One result of this is that the list
+ should be sorted with the punctuation characters '[', '\', ']', '^', '_', and '`' sorted after
letters.
SCI_AUTOCCANCEL
@@ -2743,7 +2759,7 @@ struct TextToFind {
should disappear when the user types a character that can not be part of the autocompletion,
such as '.', '(' or '[' when typing an identifier. A set of characters that will cancel
autocompletion can be specified with .
SCI_AUTOCSTOPS.
SCI_AUTOCACTIVE
This message returns non-zero if there is an active autocompletion list and zero if there is
@@ -2769,12 +2785,13 @@ struct TextToFind {
SCI_AUTOCSELECT(<unused>,const char *select)
This message selects an item in the autocompletion list. It searches the list of words for the
first that matches select. By default, comparisons are case sensitive, but you can
- change this with .
- The match is character by character for the length of the select string. That is,
- if select is "Fred" it will match "Frederick" if this is the first item in the list that begins
- with "Fred". If an item is found, it is selected. If the item is not found, the autocompletion
- list closes if auto-hide is true (see ).
SCI_AUTOCSETIGNORECASE. The match is character
+ by character for the length of the select string. That is, if select is "Fred" it
+ will match "Frederick" if this is the first item in the list that begins with "Fred". If an
+ item is found, it is selected. If the item is not found, the autocompletion list closes if
+ auto-hide is true (see SCI_AUTOCSETAUTOHIDE).
SCI_AUTOCSETCANCELATSTART(bool cancel)
SCI_AUTOCGETCANCELATSTART
@@ -2805,7 +2822,7 @@ struct TextToFind {
By default, the list is cancelled if there are no viable matches (the user has typed
characters that no longer match a list entry). If you want to keep displaying the original
list, set autoHide to false. This also effects .
SCI_AUTOCSELECT.
SCI_AUTOCSETDROPRESTOFWORD(bool dropRestOfWord)
SCI_AUTOCGETDROPRESTOFWORD
@@ -2831,10 +2848,11 @@ struct TextToFind {
SCI_USERLISTSHOW(int listType, const char *list)
The listType parameter is returned to the container as the wParam
- field of the structure. It must be
- greater than 0 as this is how Scintilla tells the difference between an autocompletion list and
- a user list. If you have different types of list, for example a list of buffers and a list of
- macros, you can use listType to tell which one has returned a selection.
SCNotification
+ structure. It must be greater than 0 as this is how Scintilla tells the difference between an
+ autocompletion list and a user list. If you have different types of list, for example a list of
+ buffers and a list of macros, you can use listType to tell which one has returned
+ a selection.
SCI_CALLTIPSHOW(int posStart, const char
*definition)
SCI_CALLTIPCANCEL
SCI_CALLTIPACTIVE
@@ -2863,7 +2881,7 @@ struct TextToFind {
SCI_CALLTIPSETHLT(int highlightStart, int
highlightEnd)
SCI_CALLTIPSETBACK(int colour)
-
+
SCI_CALLTIPSHOW(int posStart, const char *definition)
This message starts the process by displaying the call tip window. If a call tip is already
@@ -2908,7 +2926,7 @@ struct TextToFind {
To allow the container application to perform any of the actions available to the user with keyboard, all the keyboard actions are messages. They do not take any parameters. These commands are also used when redefining the key bindings with the message.
+ href="#SCI_ASSIGNCMDKEY">SCI_ASSIGNCMDKEY message.
Scintilla incorporates a "zoom factor" that lets you make all the text in the document larger or smaller in steps of one point. The displayed point size never goes below 2, whatever zoom factor you set. You can set zoom factors in the range -10 to +20 points.
-
-
+
SCI_ZOOMIN
SCI_ZOOMOUT
@@ -3673,13 +3694,13 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
You can choose to mark lines that exceed a given length by drawing a vertical line or by colouring the background of characters that exceed the set length.
-
-
+
SCI_SETEDGEMODE(int edgeMode)
SCI_GETEDGEMODE
@@ -3713,9 +3734,10 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
SCI_SETEDGECOLUMN.
This works well for monospaced fonts. The line is drawn at a position based on the width
- of a space character in , so
- it may not work very well if your styles use proportional fonts or if your style have
- varied font sizes or you use a mixture of bold, italic and normal text. .SCI_SETEDGECOLUMN(int column)
SCI_GETEDGECOLUMN
@@ -3756,7 +3778,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
Scintilla (Windows version) also supports external lexers. These are DLLs that export four
functions: GetLexerCount, GetLexerName, Lex and
Fold. See externalLexer.cxx for more.
SCI_SETLEXER(int lexer)
SCI_GETLEXER
SCI_SETLEXERLANGUAGE(<unused>, char
*name)
@@ -3764,7 +3786,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
SCI_SETPROPERTY(char *key, char *value)
SCI_SETKEYWORDS(int keyWordSet, char
*keyWordList)
-
+
SCI_SETLEXER(int lexer)
SCI_GETLEXER
@@ -3786,8 +3808,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
LexerModule constructor is the name to use.
To test if your lexer assignment worked, use before and after setting the new lexer to see if the - lexer number changed.
+ href="#SCI_GETLEXER">SCI_GETLEXER before and after setting the new lexer to
+ see if the lexer number changed.
SCI_COLOURISE(int startPos, int endPos)
This forces the current lexer or the container (if the lexer is set to
@@ -3875,7 +3897,7 @@ struct SCNotification {
The notification messages that your container can choose to handle and the messages associated with them are:
- SCN_STYLENEEDEDSCN_STYLENEEDED
SCN_CHARADDED
SCN_SAVEPOINTREACHED
SCN_SAVEPOINTLEFT
@@ -3893,29 +3915,31 @@ struct SCNotification {
SCN_DWELLSTART
SCN_DWELLEND
SCN_ZOOM
-
+
The following SCI_* messages are associated with these notifications:
SCI_SETMODEVENTMASK(int
+ eventMask)
SCI_GETMODEVENTMASK
SCI_SETMOUSEDWELLTIME
SCI_GETMOUSEDWELLTIME
-
+
The following additional notifications are sent using the WM_COMMAND message on
Windows and the "Command" signal on GTK+ to emulate the windows edit control:
SCEN_CHANGE
SCEN_SETFOCUS
SCEN_KILLFOCUS
-
+
SCN_STYLENEEDED
If you used (SCLEX_CONTAINER) to make the container act as the
lexer, you will receive this notification when Scintilla is about to display or print text that
requires styling. You are required to style the text from the line that contains the position
- returned by up to the position
- passed in SCNotification.position. Symbolically, you need code of the form:
SCI_GETENDSTYLED up to
+ the position passed in SCNotification.position. Symbolically, you need code of the
+ form:
startPos = SCI_GETENDSTYLED()
lineNumber = SCI_POSITIONFROMLINE(lineNumber);
SCN_SAVEPOINTLEFT
Sent to the container when the save point is entered or left, allowing the container to
display a "document dirty" indicator and change its menus.
- See also: SCI_SETSAVEPOINT, SCI_GETMODIFY
+ See also: SCI_SETSAVEPOINT, SCI_GETMODIFY
SCN_MODIFYATTEMPTRO
When in read-only mode, this notification is sent to the container if the user tries to change
@@ -3960,16 +3984,17 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);
This was previously called because a common use is to check whether the
caret is next to a brace and set highlights on this brace and its corresponding matching brace.
- This also replaces , which is now
- deprecated.
+ This also replaces SCN_POSCHANGED,
+ which is now deprecated.
SCN_MODIFIED
This notification is sent when the text or styling of the document changes or is about to
change. You can set a mask for the notifications that are sent to the container with . The notification structure
- contains information about what changed, how the change occurred and whether this changed the
- number of lines in the document. No modifications may be performed while in a
- SCN_MODIFIED event. The SCNotification fields used are:
+ class="message" href="#SCI_SETMODEVENTMASK">SCI_SETMODEVENTMASK. The
+ notification structure contains information about what changed, how the change occurred and
+ whether this changed the number of lines in the document. No modifications may be performed
+ while in a SCN_MODIFIED event. The SCNotification fields used
+ are:
| 0xf77 | This is a mask for all valid flags. This is the default mask state set by . | + class="message" href="#SCI_SETMODEVENTMASK">None | @@ -4187,15 +4212,16 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); "Command" signal on GTK+ as this is the behavior of the standard edit control (
wParam |
This is set to the listType parameter from the message that initiated the
- list. |
+ class="message" href="#SCI_USERLISTSHOW">
SCN_URIDROPPED
Only on the GTK+ version. Indicates that the user has dragged a URI such as a file name or web
@@ -4390,7 +4418,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
SCI_SETMOUSEDWELLTIME
SCI_GETMOUSEDWELLTIME
@@ -4460,13 +4488,13 @@ EM_FORMATRANGE
SCN_POSCHANGED() Deprecated
Fired when the user moves the cursor to a different position in the text. Use instead.
SCN_UPDATEUI instead.
SCN_CHECKBRACE Deprecated
Either the text or styling of the document has changed or the selection range has changed.
- This is replaced by . You can also use
- for more detailed
- information on text and styling changes,
for more
+ detailed information on text and styling changes,
-- cgit v1.2.3