From 745f63f831239eae7fe222fe690cbfca9fb9d3c6 Mon Sep 17 00:00:00 2001
From: nyamatongwe
Date: Wed, 26 Jul 2000 09:57:15 +0000
Subject: Ensured all messages are documented.
---
doc/ScintillaDoc.html | 30 +++++++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 7fc43f4ea..389a861cc 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -63,6 +63,7 @@ SCI_ADDTEXT(int length, char *s)
SCI_ADDSTYLEDTEXT(int length, cell *s)
SCI_INSERTTEXT(int pos, char *text)
SCI_CLEARALL
+SCI_CLEARDOCUMENTSTYLE
SCI_GETCHARAT(int position)
SCI_GETSTYLEAT(int position)
SCI_GETSTYLEDTEXT(<unused>, TEXTRANGE *tr)
@@ -97,6 +98,11 @@ SCI_GETSTYLEBITS
in height then calculations involving positioning of text would require that text to be
styled first.
+
+ When wanting to completely restyle the document, for example after choosing a lexer,
+ the SCI_CLEARDOCUMENTSTYLE can be used to clear all styling information and
+ reset the folding state.
+
Standard commands
@@ -141,6 +147,7 @@ SCI_SETSEL(int start, int end)
SCI_GETSELTEXT(<unused>, char *text)
SCI_LINEFROMPOSITION(int position)
SCI_POSITIONFROMLINE(int line)
+SCI_GETLINEENDPOSITION(int line)
SCI_LINELENGTH(int line)
SCI_LINESCROLL(int column, int line)
SCI_SCROLLCARET
@@ -251,6 +258,7 @@ SCI_SETSTYLING(int length, int style)
SCI_SETSTYLINGEX(int length, stylesequence *s)
SCI_SETLINESTATE(int line, int value)
SCI_GETLINESTATE(int line)
+SCI_GETMAXLINESTATE
Scintilla keeps a record of the last character that is likely to be styled correctly. This
@@ -272,6 +280,9 @@ SCI_GETLINESTATE(int line)
As well as the 8 bits of lexical state stored for each character there is also an integer stored
for each line. This can be used for longer lived parse states such as what the current scripting
language is in an ASP page.
+
+
+ The last line that has any line state can be found with SCI_GETMAXLINESTATE.
Style Definition
@@ -585,6 +596,8 @@ SCI_AUTOCSTOPS(<unused>,char *chars)
SCI_AUTOCSETSEPARATOR(char separator)
SCI_AUTOCGETSEPARATOR
SCI_AUTOCSELECT(<unused>,char *stringtoselect)
+SCI_AUTOCSETCANCELATSTART(bool cancel)
+SCI_AUTOCGETCANCELATSTART
Auto completion displays a list box based upon the users typing showing likely identifiers.
@@ -602,6 +615,12 @@ SCI_AUTOCSELECT(<unused>,char *stringtoselect)
typing an identifier. A set of characters which will cancel autocompletion can be specified
with the SCI_AUTOCSTOPS.
+
+ The default behaviour is for the list to be cancelled if the caret moves before the location it was
+ at when the list was displayed. By calling SCI_AUTOCSETCANCELATSTART with
+ a false argument, the list is not cancelled until the caret moves before the first character of the
+ word being completed.
+
Calltips
@@ -687,13 +706,15 @@ SCI_UPPERCASE
SCI_ASSIGNCMDKEY((short key,short modifiers), int message)
SCI_CLEARCMDKEY((short key,short modifiers))
SCI_CLEARALLCMDKEYS
+SCI_NULL
There is a default binding of keys to commands in Scintilla which can be overridden with
these messages. To fit the parameters into a message, the first argument contains the key
code in the low word and the key modifiers (possibly shift and control) in the high word. The
key code is from the VK_* enumeration, and the modifiers are a combination of zero or more of
- SHIFT_PRESSED and LEFT_CTRL_PRESSED.
+ SHIFT_PRESSED and LEFT_CTRL_PRESSED. SCI_NULL does nthing and is the
+ value assigned to keys that perform no action.
Popup edit menu
@@ -791,6 +812,7 @@ SCI_RELEASEDOCUMENT(<unused>,document *pdoc)
SCI_VISIBLEFROMDOCLINE(int docLine)
SCI_DOCLINEFROMVISIBLE(int displayLine)
SCI_SETFOLDLEVEL(int line, int level)
+SCI_SETFOLDFLAGS(int flags)
SCI_GETFOLDLEVEL(int level)
SCI_GETLASTCHILD(int line)
SCI_GETFOLDPARENT(int line)
@@ -845,6 +867,12 @@ SCI_ENSUREVISIBLE(int line)
contracted. SCI_ENSUREVISIBLE travels up the fold hierarchy, expanding any
contracted folds until it reaches the top level. The line will then be visible.
+
+ The fold flags is a set of bit flags set with the SCI_SETFOLDFLAGS message to
+ determine where folding lines are drawn. 2 is draw above if expanded, 4 is draw above
+ if not expanded. 8 is draw below if expanded and 16 is draw below if not expanded.
+ This feature needs to be redesigned to be sensible.
+
Zooming
--
cgit v1.2.3