From 1a8e44e42ba62254b3464fb0d70bafb57e3ceea3 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Tue, 15 Apr 2003 12:34:57 +0000 Subject: Added new features for 1.52. --- doc/ScintillaDoc.html | 93 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 83 insertions(+), 10 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 537a230dd..b7478257f 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -38,7 +38,7 @@

Scintilla Documentation

-

Last edited 15/Feb/2003 NH

+

Last edited 15/April/2003 NH

There is an overview of the internal design of Scintilla.
@@ -174,7 +174,7 @@ o Style definition - o Caret and selection styles + o Caret, selection, and hotspot styles @@ -494,6 +494,12 @@ struct TextRange { The search string should be interpreted as a regular expression. + + SCFIND_POSIX + + Treat regular expression in a more POSIX compatible manner + by interpreting bare ( and ) for tagged sections rather than \( and \). + @@ -1851,6 +1857,8 @@ struct TextToFind { visible)
SCI_STYLESETCHANGEABLE(int styleNumber, bool changeable)
+ SCI_STYLESETHOTSPOT(int styleNumber, bool + hotspot)

SCI_STYLERESETDEFAULT
@@ -1941,7 +1949,17 @@ struct TextToFind { read-only. Currently it only stops the caret from being within not-changeable text and does not yet stop deleting a range that contains not-changeable text.

-

Caret and selection styles

+

SCI_STYLESETHOTSPOT(int styleNumber, bool + hotspot)
+ This style is used to mark ranges of text that can detect mouse clicks. + The cursor changes to a hand over hotspots, and the foreground, and background colours + may change and an underline appear to indicate that these areas are sensitive to clicking. + This may be used to allow hyperlinks to other documents.

+ + SCI_STYLESETHOTSPOT(int styleNumber, bool + hotspot)
+ +

Caret, selection, and hotspot styles

The selection is shown by changing the foreground and/or background colours. If one of these is not set then that attribute is not changed for the selection. The default is to show the @@ -1964,6 +1982,9 @@ struct TextToFind { SCI_GETCARETPERIOD
SCI_SETCARETWIDTH(int pixels)
SCI_GETCARETWIDTH
+ SCI_SETHOTSPOTACTIVEFORE
+ SCI_SETHOTSPOTACTIVEBACK
+ SCI_SETHOTSPOTACTIVEUNDERLINE
SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
@@ -2011,6 +2032,14 @@ struct TextToFind { SCI_GETCARETWIDTH. A width of 0 makes the caret invisible (added at version 1.50).

+

SCI_SETHOTSPOTACTIVEFORE(bool useHotSpotForeColour, int colour)
+ SCI_SETHOTSPOTACTIVEBACK(bool useHotSpotBackColour, int colour)
+ SCI_SETHOTSPOTACTIVEUNDERLINE(bool underline,)
+ While the cursor hovers over text in a style with the hotspot attribute set, + the default colouring can be modified and an underline drawn with these settings.

+

SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
By default, Scintilla displays control characters (characters with codes less than 32) in a @@ -2919,6 +2948,13 @@ struct TextToFind { language uses). See SciTEBase::CharAdded() in SciTEBase.cxx for an example of call tip use.

+

The mouse may be clicked on call tips and this causes a + SCN_CALLTIPCLICK + notification to be sent to the container. Small up an down arrows may be displayed within + a call tip by, respectively, including the characters '\001', or '\002'. This is useful + for showing that there are overloaded variants of one function name and that the user can + click on the arrows to cycle through the overloads.

+

Alternatively, call tips can be displayed when you leave the mouse pointer for a while over a word in response to the SCN_DWELLSTART SCI_HOMEEXTEND + SCI_HOMEWRAP + + SCI_HOMEWRAPEXTEND + + + SCI_LINEEND SCI_LINEENDEXTEND + + SCI_LINEENDWRAP + + SCI_LINEENDWRAPEXTEND @@ -3140,11 +3186,9 @@ struct TextToFind { SCI_LINEENDDISPLAYEXTEND - - + SCI_VCHOMEWRAP - - + SCI_VCHOMEWRAPEXTEND @@ -3658,6 +3702,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_SETLAYOUTCACHE(int cacheMode)
SCI_GETLAYOUTCACHE
SCI_LINESSPLIT
+ SCI_LINESJOIN

By default, Scintilla does not wrap lines of text. If you enable line wrapping, lines wider @@ -3747,6 +3792,12 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ When pixelWidth is 0 then the width of the window is used.
+

SCI_LINESJOIN
+ Join a range of lines indicated by the target into one line by + removing line end characters. + Where this would lead to no space between words, an extra space is inserted. +
+

Zooming

Scintilla incorporates a "zoom factor" that lets you make all the text in the document @@ -3955,9 +4006,12 @@ struct NotifyHeader { // This matches the Win32 NMHDR structure struct SCNotification { struct NotifyHeader nmhdr; - int position; // SCN_STYLENEEDED, SCN_MODIFIED, SCN_DWELLSTART, SCN_DWELLEND + int position; + // SCN_STYLENEEDED, SCN_MODIFIED, SCN_DWELLSTART, + // SCN_DWELLEND, SCN_CALLTIPCLICK, + // SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK int ch; // SCN_CHARADDED, SCN_KEY - int modifiers; // SCN_KEY + int modifiers; // SCN_KEY, SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK int modificationType; // SCN_MODIFIED const char *text; // SCN_MODIFIED int length; // SCN_MODIFIED @@ -3995,6 +4049,9 @@ struct SCNotification { SCN_DWELLSTART
SCN_DWELLEND
SCN_ZOOM
+ SCN_HOTSPOTCLICK
+ SCN_HOTSPOTDOUBLECLICK
+ SCN_CALLTIPCLICK

The following SCI_* messages are associated with these notifications:

@@ -4499,7 +4556,6 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next

-

SCI_SETMOUSEDWELLTIME
SCI_GETMOUSEDWELLTIME
These two messages set and get the time the mouse must sit still, in milliseconds, to generate @@ -4513,6 +4569,23 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next to maintain sizes in terms of characters rather than pixels. SCNotification has no additional information.

+

+ SCN_HOTSPOTCLICK
+ SCN_HOTSPOTDOUBLECLICK
+ These notifications are generated when the user clicks or double clicks on + text that is in a style with the hotspot attribute set. + This notification can be used to link to variable definitions or web pages. + The position field is set the text position of the click or + double click and the modifiers field set to the key modifiers + held down in a similar manner to SCN_KEY.

+ +

SCN_CALLTIPCLICK
+ This notification is generated when the user clicks on a calltip. + This notification can be used to display the next function prototype when a + function name is overloaded with different arguments. + The position field is set to 1 if the click is in an up arrow, + 2 if in a down arrow, and 0 if elsewhere.

+

Deprecated messages and notifications

The following messages are currently supported to emulate existing Windows controls, but -- cgit v1.2.3