From 4c38a9fba8f157154653c655ec5d2645f239f6c8 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Fri, 24 Jan 2003 10:41:53 +0000 Subject: Added pointer to Bait. --- doc/ScintillaDoc.html | 84 ++++++++++++++++++++++++++------------------------- 1 file changed, 43 insertions(+), 41 deletions(-) (limited to 'doc/ScintillaDoc.html') 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 @@

Scintilla Documentation

-

Last edited 3/Jan/2003 NH

+

Last edited 24/Jan/2003 NH

There is an overview of the internal design of Scintilla.
@@ -48,6 +48,8 @@ C++ on Windows.
A simple sample using Scintilla from Visual Basic.
+ Bait is a tiny sample using Scintilla + on GTK+.
A detailed description of how to write a lexer, including a discussion of folding.
The coding style used in Scintilla and SciTE is @@ -302,7 +304,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 @@ -461,7 +463,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 @@ -683,7 +685,7 @@ struct TextToFind { SCI_GETSEARCHFLAGS
SCI_SEARCHINTARGET(int length, const char *text)
- +

SCI_SETTARGETSTART(int pos)
SCI_GETTARGETSTART
@@ -778,7 +780,7 @@ struct TextToFind { SCI_GETUNDOCOLLECTION
SCI_BEGINUNDOACTION
SCI_ENDUNDOACTION
- +

SCI_UNDO
SCI_CANUNDO
@@ -813,7 +815,7 @@ struct TextToFind { 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 @@ -876,7 +878,7 @@ struct TextToFind { SCI_TEXTWIDTH(int styleNumber, char *text)
SCI_TEXTHEIGHT(int line)
SCI_CHOOSECARETX
- +

SCI_GETTEXTLENGTH
SCI_GETLENGTH
@@ -1024,7 +1026,7 @@ struct TextToFind { buffer. The buffer must be at least SCI_GETSELECTIONEND()-SCI_SETSELECTIONSTART()+1 bytes long.

- +

See also: SCI_GETCURLINE, SCI_GETLINE, 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. @@ -1510,7 +1512,7 @@ struct TextToFind { useWhitespaceForeColour, int colour)
SCI_SETWHITESPACEBACK(bool useWhitespaceBackColour, int colour)
- +

SCI_SETVIEWWS(int wsMode)
SCI_GETVIEWWS
@@ -1617,7 +1619,7 @@ struct TextToFind { SCI_CONVERTEOLS(int eolMode)
SCI_SETVIEWEOL(bool visible)
SCI_GETVIEWEOL
- +

SCI_SETEOLMODE(int eolMode)
SCI_GETEOLMODE
@@ -1664,7 +1666,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 @@ -1843,7 +1845,7 @@ struct TextToFind { visible)
SCI_STYLESETCHANGEABLE(int styleNumber, bool changeable)
- +

SCI_STYLERESETDEFAULT
This message resets STYLE_DEFAULT to its state when Scintilla was @@ -1959,7 +1961,7 @@ struct TextToFind { SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
- +

SCI_SETSELFORE(bool useSelectionForeColour, int colour)
@@ -2055,7 +2057,7 @@ struct TextToFind { SCI_SETMARGINRIGHT(<unused>, int pixels)
SCI_GETMARGINRIGHT
- +

SCI_SETMARGINTYPEN(int margin, int iType)
SCI_GETMARGINTYPEN(int margin)
@@ -2129,7 +2131,7 @@ struct TextToFind { SCI_GRABFOCUS
SCI_SETFOCUS(bool focus)
SCI_GETFOCUS
- +

SCI_SETUSEPALETTE(bool allowPaletteUse)
SCI_GETUSEPALETTE
@@ -2217,7 +2219,7 @@ struct TextToFind { 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 @@ -2279,7 +2281,7 @@ struct TextToFind { SCI_GETINDENTATIONGUIDES
SCI_SETHIGHLIGHTGUIDE(int column)
SCI_GETHIGHLIGHTGUIDE
- +

SCI_SETTABWIDTH(int widthInChars)
SCI_GETTABWIDTH
@@ -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.

- +

SCI_SETTABINDENTS(bool tabIndents)
SCI_GETTABINDENTS
@@ -2380,7 +2382,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 @@ -2418,7 +2420,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 @@ -2619,7 +2621,7 @@ struct TextToFind { SCI_INDICSETFORE(int indicatorNumber, int colour)
SCI_INDICGETFORE(int indicatorNumber)
- +

SCI_INDICSETSTYLE(int indicatorNumber, int indicatorStyle)
@@ -2738,7 +2740,7 @@ 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 @@ -2881,7 +2883,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 @@ -3096,7 +3098,7 @@ struct TextToFind { SCI_CLEARCMDKEY(int keyDefinition)
SCI_CLEARALLCMDKEYS
SCI_NULL
- +

keyDefinition
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 { SCI_GETPRINTCOLOURMODE
SCI_SETPRINTWRAPMODE
SCI_GETPRINTWRAPMODE
- +

SCI_FORMATRANGE(bool bDraw, RangeToFormat *pfr)
This call allows Windows users to render a range of text into a device context. If you use @@ -3289,7 +3291,7 @@ struct RangeToFormat {

Direct access

SCI_GETDIRECTFUNCTION
SCI_GETDIRECTPOINTER
- +

On Windows, the message-passing scheme used to communicate between the container and Scintilla is mediated by the operating system SendMessage function and can lead to @@ -3355,7 +3357,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ *pDoc)
SCI_RELEASEDOCUMENT(<unused>, document *pDoc)
- +

SCI_GETDOCPOINTER
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){ SCI_ENSUREVISIBLE(int line)
SCI_ENSUREVISIBLEENFORCEPOLICY(int line)
- +

SCI_VISIBLEFROMDOCLINE(int docLine)
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 SCI_SETFOLDLEVEL as this is far better handled by the lexer. You will need to use SCI_GETFOLDLEVEL 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.

SCI_SETFOLDFLAGS(int flags)
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){ SCI_GETWRAPMODE
SCI_SETLAYOUTCACHE(int cacheMode)
SCI_GETLAYOUTCACHE
- +

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){

- +

Zooming

@@ -3676,7 +3678,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_ZOOMOUT
SCI_SETZOOM(int zoomInPoints)
SCI_GETZOOM
- +

SCI_ZOOMIN
SCI_ZOOMOUT
@@ -3700,7 +3702,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETEDGECOLUMN
SCI_SETEDGECOLOUR(int colour)
SCI_GETEDGECOLOUR
- +

SCI_SETEDGEMODE(int edgeMode)
SCI_GETEDGEMODE
@@ -3752,7 +3754,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

- +

SCI_SETEDGECOLUMN(int column)
SCI_GETEDGECOLUMN
@@ -3786,7 +3788,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
@@ -3915,7 +3917,7 @@ struct SCNotification { SCN_DWELLSTART
SCN_DWELLEND
SCN_ZOOM
- +

The following SCI_* messages are associated with these notifications:

SCI_SETMODEVENTMASK(int @@ -3923,14 +3925,14 @@ struct SCNotification { 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

- +

SCN_URIDROPPED
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

- +

SCI_SETMOUSEDWELLTIME
SCI_GETMOUSEDWELLTIME
-- cgit v1.2.3