From 7aa71813a370fb9462cdbc79cd7eeb95c4803c52 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Sat, 29 Mar 2008 11:43:15 +0000 Subject: Document fixes from Andrew Howell. --- doc/ScintillaDoc.html | 167 +++++++++++++++++++++++++------------------------- 1 file changed, 82 insertions(+), 85 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 02553bda6..f3aeec90b 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -116,7 +116,7 @@ Arguments point at text buffers that Scintilla will fill with text. In some cases, another argument will tell Scintilla the buffer size. In others, you must make sure that the buffer is big enough to hold the requested text. If a NULL pointer (0) is passed - then, for SCI_* calls, the length that should be allocated is returned. + then, for SCI_* calls, the length that should be allocated is returned. @@ -134,11 +134,11 @@ alpha Translucency is set using an alpha value. - Alpha ranges from 0 (SC_ALPHA_TRANSPARENT) which is completely transparent to - 255 (SC_ALPHA_OPAQUE) which is opaque. The value 256 (SC_ALPHA_NOALPHA) - is opaque and uses code that is not alpha-aware and may be faster. Not all platforms support - translucency and only some Scintilla features implement translucency. - The default alpha value for most features is SC_ALPHA_NOALPHA. + Alpha ranges from 0 (SC_ALPHA_TRANSPARENT) which is completely transparent to + 255 (SC_ALPHA_OPAQUE) which is opaque. The value 256 (SC_ALPHA_NOALPHA) + is opaque and uses code that is not alpha-aware and may be faster. Not all platforms support + translucency and only some Scintilla features implement translucency. + The default alpha value for most features is SC_ALPHA_NOALPHA. @@ -561,7 +561,7 @@ struct TextRange { SCFIND_POSIX Treat regular expression in a more POSIX compatible manner - by interpreting bare ( and ) for tagged sections rather than \( and \). + by interpreting bare ( and ) for tagged sections rather than \( and \). @@ -609,7 +609,7 @@ struct TextRange { - \> + \> This matches the end of a word using Scintilla's definition of words. @@ -785,8 +785,8 @@ struct TextToFind {

SCI_REPLACETARGET(int length, const char *text)
If length is -1, text is a zero terminated string, otherwise length sets the number of character to replace the target with. - After replacement, the target range refers to the replacement text. - The return value + After replacement, the target range refers to the replacement text. + The return value is the length of the replacement string.
Note that the recommended way to delete text in the document is to set the target to the text to be removed, and to perform a replace target with an empty string.

@@ -797,8 +797,8 @@ struct TextToFind { characters to use. The replacement string is formed from the text string with any sequences of \1 through \9 replaced by tagged matches from the most recent regular expression search. - After replacement, the target range refers to the replacement text. - The return value is the length of the replacement string.

+ After replacement, the target range refers to the replacement text. + The return value is the length of the replacement string.

See also: SCI_FINDTEXT

@@ -1630,8 +1630,8 @@ struct TextToFind { If you never wish to see it, call SCI_SETHSCROLLBAR(0). Use SCI_SETHSCROLLBAR(1) to enable it again. SCI_GETHSCROLLBAR returns the current state. The default state is to display it - when needed. - See also: SCI_SETSCROLLWIDTH.

+ when needed.

+

See also: SCI_SETSCROLLWIDTH.

SCI_SETVSCROLLBAR(bool visible)
SCI_GETVSCROLLBAR
@@ -1716,7 +1716,7 @@ struct TextToFind {

The effect of using any other wsMode value is undefined.

-

SCI_SETWHITESPACEFORE<(bool useWhitespaceForeColour, int SCI_SETWHITESPACEFORE(bool useWhitespaceForeColour, int colour)
SCI_SETWHITESPACEBACK(bool useWhitespaceBackColour, int colour)
@@ -1937,8 +1937,8 @@ struct TextToFind { 36 This style sets the font used when drawing control characters. - Only the font, size, bold, italics, and character set attributes are used and not - the colour attributes. See + Only the font, size, bold, italics, and character set attributes are used and not + the colour attributes. See also: SCI_SETCONTROLCHARSYMBOL. @@ -1959,7 +1959,7 @@ struct TextToFind { Call tips normally use the font attributes defined by STYLE_DEFAULT. Use of SCI_CALLTIPUSESTYLE - causes call tips to use this style instead. Only the font face name, font size, + causes call tips to use this style instead. Only the font face name, font size, foreground and background colours and character set attributes are used. @@ -2036,7 +2036,7 @@ struct TextToFind { SCI_STYLEGETCHANGEABLE(int styleNumber)
SCI_STYLESETHOTSPOT(int styleNumber, bool hotspot)
- SCI_STYLEGETHOTSPOT(int styleNumber)
+ SCI_STYLEGETHOTSPOT(int styleNumber)

SCI_STYLERESETDEFAULT
@@ -2223,7 +2223,7 @@ struct TextToFind { href="#colour">colour)
SCI_GETCARETFORE
The colour of the caret can be set with SCI_SETCARETFORE and retrieved with - SCI_CETCARETFORE.

+ SCI_GETCARETFORE.

SCI_SETCARETLINEVISIBLE(bool show)
SCI_GETCARETLINEVISIBLE
@@ -2239,11 +2239,11 @@ struct TextToFind { The two SCI_GETCARET* functions return the state and the colour. This form of background colouring has highest priority when a line has markers that would otherwise change the background colour. - The caret line may also be drawn translucently which allows other background colours to show - through. This is done by setting the alpha (translucency) value by calling - SCI_SETCARETLINEBACKALPHA. When the alpha is not SC_ALPHA_NOALPHA, - the caret line is drawn after all other features so will affect the colour of all other features. -

+ The caret line may also be drawn translucently which allows other background colours to show + through. This is done by setting the alpha (translucency) value by calling + SCI_SETCARETLINEBACKALPHA. When the alpha is not SC_ALPHA_NOALPHA, + the caret line is drawn after all other features so will affect the colour of all other features. +

SCI_SETCARETPERIOD(int milliseconds)
SCI_GETCARETPERIOD
@@ -2535,11 +2535,11 @@ struct TextToFind {

SCI_SETWHITESPACECHARS(<unused>, const char *chars)
Similar to SCI_SETWORDCHARS, this message allows the user to define which chars Scintilla considers - as whitespace. Setting the whitespace chars allows the user to fine-tune Scintilla's behaviour doing - such things as moving the cursor to the start or end of a word; for example, by defining punctuation chars - as whitespace, they will be skipped over when the user presses ctrl+left or ctrl+right. - This function should be called after SCI_SETWORDCHARS as it will - reset the whitespace characters to the default set.

+ as whitespace. Setting the whitespace chars allows the user to fine-tune Scintilla's behaviour doing + such things as moving the cursor to the start or end of a word; for example, by defining punctuation chars + as whitespace, they will be skipped over when the user presses ctrl+left or ctrl+right. + This function should be called after SCI_SETWORDCHARS as it will + reset the whitespace characters to the default set.

SCI_SETCHARSDEFAULT
Use the default sets of word and whitespace characters. This sets whitespace to space, tab and other characters with codes less than 0x20, with word characters set to alphanumeric and '_'. @@ -2550,7 +2550,7 @@ struct TextToFind { SCI_SETFOCUS(bool focus)
SCI_GETFOCUS
Scintilla can be told to grab the focus with this message. This is needed more on GTK+ where - focus handling is more complicated than on Windows.

+ focus handling is more complicated than on Windows.

The internal focus flag can be set with SCI_SETFOCUS. This is used by clients that have complex focus requirements such as having their own window that gets the real focus @@ -2639,14 +2639,13 @@ struct TextToFind { (0) to create all tabs and indents out of spaces. The default is true. You can use SCI_GETCOLUMN to get the column of a position taking the width of a tab into account.

- SCI_SETINDENT(int widthInChars)
+

SCI_SETINDENT(int widthInChars)
SCI_GETINDENT
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.
-
- + less than 0 or large values may have undesirable effects. +

SCI_SETTABINDENTS(bool tabIndents)
SCI_GETTABINDENTS
@@ -2693,16 +2692,16 @@ struct TextToFind { SC_IV_LOOKFORWARD Indentation guides are shown beyond the actual indentation up to the level of the - next non-empty line. - If the previous non-empty line was a fold header then indentation guides are shown for - one more level of indent than that line. This setting is good for Python. + next non-empty line. + If the previous non-empty line was a fold header then indentation guides are shown for + one more level of indent than that line. This setting is good for Python. SC_IV_LOOKBOTH Indentation guides are shown beyond the actual indentation up to the level of the - next non-empty line or previous non-empty line whichever is the greater. - This setting is good for most languages. + next non-empty line or previous non-empty line whichever is the greater. + This setting is good for most languages. @@ -2774,7 +2773,7 @@ struct TextToFind { and SC_MARK_FULLRECT.

The SC_MARK_BACKGROUND marker changes the background colour of the line only. - The SC_MARK_FULLRECT symbol mirrors this, changing only the margin background colour. + The SC_MARK_FULLRECT symbol mirrors this, changing only the margin background colour. The SC_MARK_EMPTY symbol is invisible, allowing client code to track the movement of lines. You would also use it if you changed the folding style and wanted one or more of the SC_FOLDERNUM_* markers to have no associated symbol.

@@ -3091,7 +3090,7 @@ struct TextToFind { 7 A rectangle with rounded corners around the text using translucent drawing with the - interior more transparent than the border. + interior more transparent than the border. @@ -3173,14 +3172,14 @@ struct TextToFind { and SCI_SETSTYLING with the values INDIC0_MASK, INDIC1_MASK and INDIC2_MASK.

-

If you are using indicators in a buffer that has a lexer active - (see SCI_SETLEXER), - you must save lexing state information before setting any indicators and restore it afterwards. - Use SCI_GETENDSTYLED - to retrieve the current "styled to" position and - SCI_STARTSTYLING - to reset the styling position and mask (0x1f in the default layout of 5 style bits and 3 indicator bits) - when you are done.

+

If you are using indicators in a buffer that has a lexer active + (see SCI_SETLEXER), + you must save lexing state information before setting any indicators and restore it afterwards. + Use SCI_GETENDSTYLED + to retrieve the current "styled to" position and + SCI_STARTSTYLING + to reset the styling position and mask (0x1f in the default layout of 5 style bits and 3 indicator bits) + when you are done.

The number of bits used for styles can be altered with SCI_SETSTYLEBITS from 0 to 7 bits. The remaining bits @@ -3421,7 +3420,7 @@ struct TextToFind {

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 + notification to be sent to the container. Small up and 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.

@@ -4278,6 +4277,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETWRAPMODE
SCI_SETWRAPVISUALFLAGS(int wrapVisualFlags)
SCI_GETWRAPVISUALFLAGS
+ SCI_SETWRAPVISUALFLAGSLOCATION(int wrapVisualFlagsLocation)
+ SCI_GETWRAPVISUALFLAGSLOCATION
SCI_SETWRAPSTARTINDENT(int indent)
SCI_GETWRAPSTARTINDENT
SCI_SETLAYOUTCACHE(int cacheMode)
@@ -4295,10 +4296,10 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ style is wider than the window then the break occurs after the last character that completely fits on the line. The horizontal scroll bar does not appear when wrap mode is on.

-

For wrapped lines Scintilla can draw visual flags (little arrows) at end of a a subline of a - wrapped line and at begin of the next subline. These can be enabled individually, but if Scintilla - draws the visual flag at begin of the next subline this subline will be indented by one char. - Independent from drawing a visual flag at the begin the subline can have an indention.

+

For wrapped lines Scintilla can draw visual flags (little arrows) at end of a a subline of a + wrapped line and at begin of the next subline. These can be enabled individually, but if Scintilla + draws the visual flag at begin of the next subline this subline will be indented by one char. + Independent from drawing a visual flag at the begin the subline can have an indention.

Much of the time used by Scintilla is spent on laying out and drawing text. The same text layout calculations may be performed many times even when the data used in these calculations @@ -4331,8 +4332,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETWRAPVISUALFLAGS(int wrapVisualFlags)
SCI_GETWRAPVISUALFLAGS
- You can enable the drawing of visual flags to indicate a line is wrapped. Bits set in - wrapVisualFlags determine which visual flags are drawn. + You can enable the drawing of visual flags to indicate a line is wrapped. Bits set in + wrapVisualFlags determine which visual flags are drawn. @@ -4360,16 +4361,16 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ + Subline is indented by at least 1 to make room for the flag.
+
SC_WRAPVISUALFLAG_START 2 Visual flag at begin of subline of a wrapped line.
- Subline is indented by at least 1 to make room for the flag.
-

SCI_SETWRAPVISUALFLAGSLOCATION(int wrapVisualFlagsLocation)
SCI_GETWRAPVISUALFLAGSLOCATION
- You can set wether the visual flags to indicate a line is wrapped are drawn near the border or near the text. - Bits set in wrapVisualFlagsLocation set the location to near the text for the corresponding visual flag. + You can set wether the visual flags to indicate a line is wrapped are drawn near the border or near the text. + Bits set in wrapVisualFlagsLocation set the location to near the text for the corresponding visual flag. @@ -4400,18 +4401,17 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
- -
+

SCI_SETWRAPSTARTINDENT(int indent)
SCI_GETWRAPSTARTINDENT
SCI_SETWRAPSTARTINDENT sets the size of indentation of sublines for - wrapped lines in terms of the width of a space in - STYLE_DEFAULT. - There are no limits on indent sizes, but values less than 0 or large values may have - undesirable effects.
- The indention of sublines is independent of visual flags, but if - SC_WRAPVISUALFLAG_START is set an indent of at least 1 is used. + wrapped lines in terms of the width of a space in + STYLE_DEFAULT. + There are no limits on indent sizes, but values less than 0 or large values may have + undesirable effects.
+ The indention of sublines is independent of visual flags, but if + SC_WRAPVISUALFLAG_START is set an indent of at least 1 is used.

SCI_SETLAYOUTCACHE(int cacheMode)
@@ -4463,7 +4463,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -
+

SCI_SETPOSITIONCACHE(int size)
SCI_GETPOSITIONCACHE
@@ -4557,7 +4557,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ of a space character in STYLE_DEFAULT, 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. . + mixture of bold, italic and normal text. @@ -4570,9 +4570,6 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -
-
-

SCI_SETEDGECOLUMN(int column)
SCI_GETEDGECOLUMN
@@ -4736,7 +4733,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ 

 struct NotifyHeader {   // This matches the Win32 NMHDR structure
     void *hwndFrom;     // environment specific window handle/pointer
-    uptr_t idFrom;	// CtrlID of the window issuing the notification
+    uptr_t idFrom;        // CtrlID of the window issuing the notification
     unsigned int code;  // The SCN_* notification code
 };
 
@@ -4831,8 +4828,8 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);
     character) that is entered into the text. The container can use this to decide to display a call tip or an auto
     completion list. The character is in SCNotification.ch.
-	This notification is sent before the character has been styled so processing that depends on
-	styling should instead be performed in the SCN_UPDATEUI notification.

+        This notification is sent before the character has been styled so processing that depends on
+        styling should instead be performed in the SCN_UPDATEUI notification.

 
     
SCN_SAVEPOINTREACHED

      SCN_SAVEPOINTLEFT

@@ -4919,8 +4916,8 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);
           Valid for text changes, not for style changes. If we are collecting undo
           information this holds a pointer to the text that is handed to the Undo system, otherwise
           it is zero. For user performed SC_MOD_BEFOREDELETE the text field is 0 and
-		  for user performed SC_MOD_BEFOREINSERT the text field points to an array of cells,
-	 	  not bytes and the length is the number of cells.
+                  for user performed SC_MOD_BEFOREINSERT the text field points to an array of cells,
+                   not bytes and the length is the number of cells.
         
 
         
@@ -5101,7 +5098,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);
           0x8000
 
           A line state has changed because SCI_SETLINESTATE
-	  was called.
+          was called.
 
           line
         
@@ -5122,11 +5119,11 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);
           0x2000
 
           This is set on a SC_PERFORMED_USER action when it is the
-	  first or only step in an undo transaction. This can be used to integrate the Scintilla
-	  undo stack with an undo stack in the container application by adding a Scintilla
-	  action to the container's stack for the currently opened container transaction or
-	  to open a new container transaction if there is no open container transaction.
-	  
+          first or only step in an undo transaction. This can be used to integrate the Scintilla
+          undo stack with an undo stack in the container application by adding a Scintilla
+          action to the container's stack for the currently opened container transaction or
+          to open a new container transaction if there is no open container transaction.
+          
 
           None
         
-- 
cgit v1.2.3