aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html84
1 files changed, 43 insertions, 41 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 2d51277d0..2a5d7c52e 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -38,7 +38,7 @@
<h1>Scintilla Documentation</h1>
- <p>Last edited 3/Jan/2003 NH</p>
+ <p>Last edited 24/Jan/2003 NH</p>
<p>There is <a class="jump" href="Design.html">an overview of the internal design of
Scintilla</a>.<br />
@@ -48,6 +48,8 @@
C++ on Windows</a>.<br />
<a class="jump" href="http://www.scintilla.org/SciTry.vb">A simple sample using Scintilla from
Visual Basic</a>.<br />
+ <a class="jump" href="http://www.scintilla.org/bait.zip">Bait is a tiny sample using Scintilla
+ on GTK+</a>.<br />
<a class="jump" href="Lexer.txt">A detailed description of how to write a lexer, including a
discussion of folding</a>.<br />
The <a class="jump" href="SciCoding.html">coding style</a> used in Scintilla and SciTE is
@@ -302,7 +304,7 @@
*tr)</a><br />
<a class="message" href="#SCI_SETSTYLEBITS">SCI_SETSTYLEBITS(int bits)</a><br />
<a class="message" href="#SCI_GETSTYLEBITS">SCI_GETSTYLEBITS</a><br />
- </code>
+ </code>
<p><b id="SCI_GETTEXT">SCI_GETTEXT(int length, char *text)</b><br />
This returns <code>length</code>-1 characters of text from the start of the document plus one
@@ -461,7 +463,7 @@ struct TextRange {
*text)</a><br />
<a class="jump" href="#SearchAndReplaceUsingTheTarget">Search and replace using the
target</a><br />
- </code>
+ </code>
<p><b id="searchFlags"><code>searchFlags</code></b><br />
Several of the search routines use flag options, which include a simple regular expression
@@ -683,7 +685,7 @@ struct TextToFind {
<a class="message" href="#SCI_GETSEARCHFLAGS">SCI_GETSEARCHFLAGS</a><br />
<a class="message" href="#SCI_SEARCHINTARGET">SCI_SEARCHINTARGET(int length, const char
*text)</a><br />
- </code>
+ </code>
<p><b id="SCI_SETTARGETSTART">SCI_SETTARGETSTART(int pos)</b><br />
<b id="SCI_GETTARGETSTART">SCI_GETTARGETSTART</b><br />
@@ -778,7 +780,7 @@ struct TextToFind {
<a class="message" href="#SCI_GETUNDOCOLLECTION">SCI_GETUNDOCOLLECTION</a><br />
<a class="message" href="#SCI_BEGINUNDOACTION">SCI_BEGINUNDOACTION</a><br />
<a class="message" href="#SCI_ENDUNDOACTION">SCI_ENDUNDOACTION</a><br />
- </code>
+ </code>
<p><b id="SCI_UNDO">SCI_UNDO</b><br />
<b id="SCI_CANUNDO">SCI_CANUNDO</b><br />
@@ -813,7 +815,7 @@ struct TextToFind {
<code>SCI_EMPTYUNDOBUFFER</code> to avoid the undo buffer being unsynchronized with the data in
the buffer. <br />
<br />
-
+
<p>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
@@ -876,7 +878,7 @@ struct TextToFind {
<a class="message" href="#SCI_TEXTWIDTH">SCI_TEXTWIDTH(int styleNumber, char *text)</a><br />
<a class="message" href="#SCI_TEXTHEIGHT">SCI_TEXTHEIGHT(int line)</a><br />
<a class="message" href="#SCI_CHOOSECARETX">SCI_CHOOSECARETX</a><br />
- </code>
+ </code>
<p><b id="SCI_GETTEXTLENGTH">SCI_GETTEXTLENGTH</b><br />
<b id="SCI_GETLENGTH">SCI_GETLENGTH</b><br />
@@ -1024,7 +1026,7 @@ struct TextToFind {
buffer. The buffer must be at least
<code>SCI_GETSELECTIONEND()-SCI_SETSELECTIONSTART()+1</code> bytes long. <br />
<br />
-
+
<p>See also: <code><a class="message" href="#SCI_GETCURLINE">SCI_GETCURLINE</a>, <a
class="message" href="#SCI_GETLINE">SCI_GETLINE</a>, <a class="message"
@@ -1196,7 +1198,7 @@ struct TextToFind {
<a class="message" href="#SCI_SETENDATLASTLINE">SCI_SETENDATLASTLINE(bool
endAtLastLine)</a><br />
<a class="message" href="#SCI_GETENDATLASTLINE">SCI_GETENDATLASTLINE</a><br />
- </code>
+ </code>
<p><b id="SCI_LINESCROLL">SCI_LINESCROLL(int column, int line)</b><br />
This will attempt to scroll the display by the number of columns and lines that you specify.
@@ -1510,7 +1512,7 @@ struct TextToFind {
useWhitespaceForeColour, int colour)</a><br />
<a class="message" href="#SCI_SETWHITESPACEBACK">SCI_SETWHITESPACEBACK(bool
useWhitespaceBackColour, int colour)</a><br />
- </code>
+ </code>
<p><b id="SCI_SETVIEWWS">SCI_SETVIEWWS(int wsMode)</b><br />
<b id="SCI_GETVIEWWS">SCI_GETVIEWWS</b><br />
@@ -1617,7 +1619,7 @@ struct TextToFind {
<a class="message" href="#">SCI_CONVERTEOLS(int eolMode)</a><br />
<a class="message" href="#">SCI_SETVIEWEOL(bool visible)</a><br />
<a class="message" href="#">SCI_GETVIEWEOL</a><br />
- </code>
+ </code>
<p><b id="SCI_SETEOLMODE">SCI_SETEOLMODE(int eolMode)</b><br />
<b id="SCI_GETEOLMODE">SCI_GETEOLMODE</b><br />
@@ -1664,7 +1666,7 @@ struct TextToFind {
<a class="message" href="#SCI_SETLINESTATE">SCI_SETLINESTATE(int line, int value)</a><br />
<a class="message" href="#SCI_GETLINESTATE">SCI_GETLINESTATE(int line)</a><br />
<a class="message" href="#SCI_GETMAXLINESTATE">SCI_GETMAXLINESTATE</a><br />
- </code>
+ </code>
<p><b id="SCI_GETENDSTYLED">SCI_GETENDSTYLED</b><br />
Scintilla keeps a record of the last character that is likely to be styled correctly. This is
@@ -1843,7 +1845,7 @@ struct TextToFind {
visible)</a><br />
<a class="message" href="#SCI_STYLESETCHANGEABLE">SCI_STYLESETCHANGEABLE(int styleNumber, bool
changeable)</a><br />
- </code>
+ </code>
<p><b id="SCI_STYLERESETDEFAULT">SCI_STYLERESETDEFAULT</b><br />
This message resets <code>STYLE_DEFAULT</code> to its state when Scintilla was
@@ -1959,7 +1961,7 @@ struct TextToFind {
<a class="message" href="#SCI_SETCONTROLCHARSYMBOL">SCI_SETCONTROLCHARSYMBOL(int
symbol)</a><br />
<a class="message" href="#SCI_GETCONTROLCHARSYMBOL">SCI_GETCONTROLCHARSYMBOL</a><br />
- </code>
+ </code>
<p><b id="SCI_SETSELFORE">SCI_SETSELFORE(bool useSelectionForeColour, int <a class="jump"
href="#colour">colour</a>)</b><br />
@@ -2055,7 +2057,7 @@ struct TextToFind {
<a class="message" href="#SCI_SETMARGINRIGHT">SCI_SETMARGINRIGHT(&lt;unused&gt;, int
pixels)</a><br />
<a class="message" href="#SCI_GETMARGINRIGHT">SCI_GETMARGINRIGHT</a><br />
- </code>
+ </code>
<p><b id="SCI_SETMARGINTYPEN">SCI_SETMARGINTYPEN(int margin, int iType)</b><br />
<b id="SCI_GETMARGINTYPEN">SCI_GETMARGINTYPEN(int margin)</b><br />
@@ -2129,7 +2131,7 @@ struct TextToFind {
<a class="message" href="#SCI_GRABFOCUS">SCI_GRABFOCUS</a><br />
<a class="message" href="#SCI_SETFOCUS">SCI_SETFOCUS(bool focus)</a><br />
<a class="message" href="#SCI_GETFOCUS">SCI_GETFOCUS</a><br />
- </code>
+ </code>
<p><b id="SCI_SETUSEPALETTE">SCI_SETUSEPALETTE(bool allowPaletteUse)</b><br />
<b id="SCI_GETUSEPALETTE">SCI_GETUSEPALETTE</b><br />
@@ -2217,7 +2219,7 @@ struct TextToFind {
<a class="message" href="#SCI_BRACEBADLIGHT">SCI_BRACEBADLIGHT(int pos1)</a><br />
<a class="message" href="#SCI_BRACEMATCH">SCI_BRACEMATCH(int position, int
maxReStyle)</a><br />
- </code>
+ </code>
<p><b id="SCI_BRACEHIGHLIGHT">SCI_BRACEHIGHLIGHT(int pos1, int pos2)</b><br />
Up to two characters can be highlighted in a 'brace highlighting style', which is defined as
@@ -2279,7 +2281,7 @@ struct TextToFind {
<a class="message" href="#SCI_GETINDENTATIONGUIDES">SCI_GETINDENTATIONGUIDES</a><br />
<a class="message" href="#SCI_SETHIGHLIGHTGUIDE">SCI_SETHIGHLIGHTGUIDE(int column)</a><br />
<a class="message" href="#SCI_GETHIGHLIGHTGUIDE">SCI_GETHIGHLIGHTGUIDE</a><br />
- </code>
+ </code>
<p><b id="SCI_SETTABWIDTH">SCI_SETTABWIDTH(int widthInChars)</b><br />
<b id="SCI_GETTABWIDTH">SCI_GETTABWIDTH</b><br />
@@ -2301,7 +2303,7 @@ struct TextToFind {
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. <br />
<br />
-
+
<p><b id="SCI_SETTABINDENTS">SCI_SETTABINDENTS(bool tabIndents)</b><br />
<b id="SCI_GETTABINDENTS">SCI_GETTABINDENTS</b><br />
@@ -2380,7 +2382,7 @@ struct TextToFind {
<a class="message" href="#SCI_MARKERLINEFROMHANDLE">SCI_MARKERLINEFROMHANDLE(int
handle)</a><br />
<a class="message" href="#SCI_MARKERDELETEHANDLE">SCI_MARKERDELETEHANDLE(int handle)</a><br />
- </code>
+ </code>
<p><b id="SCI_MARKERDEFINE">SCI_MARKERDEFINE(int markerNumber, int markerSymbols)</b><br />
This message associates a marker number in the range 0 to 31 with one of the marker symbols or
@@ -2418,7 +2420,7 @@ struct TextToFind {
number 1 use:<br />
<code>SCI_MARKETDEFINE(1, SC_MARK_CHARACETR+65)</code>. <br />
<br />
-
+
<p>The marker numbers <code>SC_MARKNUM_FOLDER</code> and <code>SC_MARKNUM_FOLDEROPEN</code> are
used for showing that a fold is present and open or closed. Any symbols may be assigned for
@@ -2619,7 +2621,7 @@ struct TextToFind {
<a class="message" href="#SCI_INDICSETFORE">SCI_INDICSETFORE(int indicatorNumber, int
colour)</a><br />
<a class="message" href="#SCI_INDICGETFORE">SCI_INDICGETFORE(int indicatorNumber)</a><br />
- </code>
+ </code>
<p><b id="SCI_INDICSETSTYLE">SCI_INDICSETSTYLE(int indicatorNumber, int
indicatorStyle)</b><br />
@@ -2738,7 +2740,7 @@ struct TextToFind {
<a class="message" href="#SCI_AUTOCSETDROPRESTOFWORD">SCI_AUTOCSETDROPRESTOFWORD(bool
dropRestOfWord)</a><br />
<a class="message" href="#SCI_AUTOCGETDROPRESTOFWORD">SCI_AUTOCGETDROPRESTOFWORD</a><br />
- </code>
+ </code>
<p><b id="SCI_AUTOCSHOW">SCI_AUTOCSHOW(int lenEntered, const char *list)</b><br />
This message causes a list to be displayed. <code>lenEntered</code> is the number of
@@ -2881,7 +2883,7 @@ struct TextToFind {
<a class="message" href="#SCI_CALLTIPSETHLT">SCI_CALLTIPSETHLT(int highlightStart, int
highlightEnd)</a><br />
<a class="message" href="#SCI_CALLTIPSETBACK">SCI_CALLTIPSETBACK(int colour)</a><br />
- </code>
+ </code>
<p><b id="SCI_CALLTIPSHOW">SCI_CALLTIPSHOW(int posStart, const char *definition)</b><br />
This message starts the process by displaying the call tip window. If a call tip is already
@@ -3096,7 +3098,7 @@ struct TextToFind {
<a class="message" href="#SCI_CLEARCMDKEY">SCI_CLEARCMDKEY(int keyDefinition)</a><br />
<a class="message" href="#SCI_CLEARALLCMDKEYS">SCI_CLEARALLCMDKEYS</a><br />
<a class="message" href="#SCI_NULL">SCI_NULL</a><br />
- </code>
+ </code>
<p><b id="keyDefinition">keyDefinition</b><br />
A key definition contains the key code in the low 16-bits and the key modifiers in the high
@@ -3168,7 +3170,7 @@ struct TextToFind {
<a class="message" href="#SCI_GETPRINTCOLOURMODE">SCI_GETPRINTCOLOURMODE</a><br />
<a class="message" href="#SCI_SETPRINTWRAPMODE">SCI_SETPRINTWRAPMODE</a><br />
<a class="message" href="#SCI_GETPRINTWRAPMODE">SCI_GETPRINTWRAPMODE</a><br />
- </code>
+ </code>
<p><b id="SCI_FORMATRANGE">SCI_FORMATRANGE(bool bDraw, RangeToFormat *pfr)</b><br />
This call allows Windows users to render a range of text into a device context. If you use
@@ -3289,7 +3291,7 @@ struct RangeToFormat {
<h2 id="DirectAccess">Direct access</h2>
<code><a class="message" href="#SCI_GETDIRECTFUNCTION">SCI_GETDIRECTFUNCTION</a><br />
<a class="message" href="#SCI_GETDIRECTPOINTER">SCI_GETDIRECTPOINTER</a><br />
- </code>
+ </code>
<p>On Windows, the message-passing scheme used to communicate between the container and
Scintilla is mediated by the operating system <code>SendMessage</code> function and can lead to
@@ -3355,7 +3357,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
*pDoc)</a><br />
<a class="message" href="#SCI_RELEASEDOCUMENT">SCI_RELEASEDOCUMENT(&lt;unused&gt;, document
*pDoc)</a><br />
- </code>
+ </code>
<p><b id="SCI_GETDOCPOINTER">SCI_GETDOCPOINTER</b><br />
This returns a pointer to the document currently in use by the window. It has no other
@@ -3430,7 +3432,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<a class="message" href="#SCI_ENSUREVISIBLE">SCI_ENSUREVISIBLE(int line)</a><br />
<a class="message" href="#SCI_ENSUREVISIBLEENFORCEPOLICY">SCI_ENSUREVISIBLEENFORCEPOLICY(int
line)</a><br />
- </code>
+ </code>
<p><b id="SCI_VISIBLEFROMDOCLINE">SCI_VISIBLEFROMDOCLINE(int docLine)</b><br />
When some lines are folded, then a particular line in the document may be displayed at a
@@ -3476,7 +3478,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
If you use a lexer, you should not need to use <code>SCI_SETFOLDLEVEL</code> as this is far
better handled by the lexer. You will need to use <code>SCI_GETFOLDLEVEL</code> to decide how
to handle user folding requests. If you do change the fold levels, the folding margin will
- update to match your changes.
+ update to match your changes.
<p><b id="SCI_SETFOLDFLAGS">SCI_SETFOLDFLAGS(int flags)</b><br />
In addition to showing markers in the folding margin, you can indicate folds to the user by
@@ -3582,7 +3584,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<a class="message" href="#SCI_GETWRAPMODE">SCI_GETWRAPMODE</a><br />
<a class="message" href="#SCI_SETLAYOUTCACHE">SCI_SETLAYOUTCACHE(int cacheMode)</a><br />
<a class="message" href="#SCI_GETLAYOUTCACHE">SCI_GETLAYOUTCACHE</a><br />
- </code>
+ </code>
<p>By default, Scintilla does not wrap lines of text. If you enable line wrapping, lines wider
than the window width are continued on the following lines. Lines are broken after space or tab
@@ -3665,7 +3667,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
</table>
<br />
<br />
-
+
<h2 id="Zooming">Zooming</h2>
@@ -3676,7 +3678,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<a class="message" href="#SCI_ZOOMOUT">SCI_ZOOMOUT</a><br />
<a class="message" href="#SCI_SETZOOM">SCI_SETZOOM(int zoomInPoints)</a><br />
<a class="message" href="#SCI_GETZOOM">SCI_GETZOOM</a><br />
- </code>
+ </code>
<p><b id="SCI_ZOOMIN">SCI_ZOOMIN</b><br />
<b id="SCI_ZOOMOUT">SCI_ZOOMOUT</b><br />
@@ -3700,7 +3702,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<a class="message" href="#SCI_GETEDGECOLUMN">SCI_GETEDGECOLUMN</a><br />
<a class="message" href="#SCI_SETEDGECOLOUR">SCI_SETEDGECOLOUR(int colour)</a><br />
<a class="message" href="#SCI_GETEDGECOLOUR">SCI_GETEDGECOLOUR</a><br />
- </code>
+ </code>
<p><b id="SCI_SETEDGEMODE">SCI_SETEDGEMODE(int edgeMode)</b><br />
<b id="SCI_GETEDGEMODE">SCI_GETEDGEMODE</b><br />
@@ -3752,7 +3754,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
</table>
<br />
<br />
-
+
<p><b id="SCI_SETEDGECOLUMN">SCI_SETEDGECOLUMN(int column)</b><br />
<b id="SCI_GETEDGECOLUMN">SCI_GETEDGECOLUMN</b><br />
@@ -3786,7 +3788,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<a class="message" href="#SCI_SETPROPERTY">SCI_SETPROPERTY(char *key, char *value)</a><br />
<a class="message" href="#SCI_SETKEYWORDS">SCI_SETKEYWORDS(int keyWordSet, char
*keyWordList)</a><br />
- </code>
+ </code>
<p><b id="SCI_SETLEXER">SCI_SETLEXER(int lexer)</b><br />
<b id="SCI_GETLEXER">SCI_GETLEXER</b><br />
@@ -3915,7 +3917,7 @@ struct SCNotification {
<a class="message" href="#SCN_DWELLSTART">SCN_DWELLSTART</a><br />
<a class="message" href="#SCN_DWELLEND">SCN_DWELLEND</a><br />
<a class="message" href="#SCN_ZOOM">SCN_ZOOM</a><br />
- </code>
+ </code>
<p>The following <code>SCI_*</code> messages are associated with these notifications:</p>
<code><a class="message" href="#SCI_SETMODEVENTMASK">SCI_SETMODEVENTMASK(int
@@ -3923,14 +3925,14 @@ struct SCNotification {
<a class="message" href="#SCI_GETMODEVENTMASK">SCI_GETMODEVENTMASK</a><br />
<a class="message" href="#SCI_SETMOUSEDWELLTIME">SCI_SETMOUSEDWELLTIME</a><br />
<a class="message" href="#SCI_GETMOUSEDWELLTIME">SCI_GETMOUSEDWELLTIME</a><br />
- </code>
+ </code>
<p>The following additional notifications are sent using the <code>WM_COMMAND</code> message on
Windows and the "Command" signal on GTK+ to emulate the windows edit control:</p>
<code><a class="message" href="#SCEN_CHANGE">SCEN_CHANGE</a><br />
<a class="message" href="#SCEN_SETFOCUS">SCEN_SETFOCUS</a><br />
<a class="message" href="#SCEN_KILLFOCUS">SCEN_KILLFOCUS</a><br />
- </code>
+ </code>
<p><b id="SCN_STYLENEEDED">SCN_STYLENEEDED</b><br />
If you used <code><a class="message"
@@ -4374,7 +4376,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
</table>
<br />
<br />
-
+
<p><b id="SCN_URIDROPPED">SCN_URIDROPPED</b><br />
Only on the GTK+ version. Indicates that the user has dragged a URI such as a file name or web
@@ -4418,7 +4420,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
</table>
<br />
<br />
-
+
<p><b id="SCI_SETMOUSEDWELLTIME">SCI_SETMOUSEDWELLTIME</b><br />
<b id="SCI_GETMOUSEDWELLTIME">SCI_GETMOUSEDWELLTIME</b><br />
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-14 12:11:58 +0000