diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Design.html | 16 | ||||
| -rw-r--r-- | doc/Icons.html | 4 | ||||
| -rw-r--r-- | doc/Lexer.txt | 18 | ||||
| -rw-r--r-- | doc/ScintillaDoc.html | 26 | ||||
| -rw-r--r-- | doc/ScintillaUsage.html | 14 |
5 files changed, 39 insertions, 39 deletions
diff --git a/doc/Design.html b/doc/Design.html index a68390558..9c4b70a1f 100644 --- a/doc/Design.html +++ b/doc/Design.html @@ -49,7 +49,7 @@ library and with limited use of templates. </p> <p> - The currently supported platforms, Windows, GTK+/Linux and wxWindows are fairly similar in + The currently supported platforms, Windows, GTK+/Linux and wxWindows are fairly similar in many ways. Each has windows, menus and bitmaps. These features generally work in similar ways so each has a way to move a window or draw a red line. Sometimes one platform requires a sequence of @@ -100,7 +100,7 @@ have to use the limited set of already available colours. </p> A Palette object holds a set of colour pairs and can make the appropriate calls to ask to - allocate these colours and to see what the platform has decided will be allowed. + allocate these colours and to see what the platform has decided will be allowed. <h4> Font </h4> @@ -164,7 +164,7 @@ </h3> <p> The bulk of Scintilla's code is platform independent. This is made up of the CellBuffer, - ContractionState, Document, Editor, Indicator, LineMarker, Style, ViewStyle, KeyMap, + ContractionState, Document, Editor, Indicator, LineMarker, Style, ViewStyle, KeyMap, ScintillaBase, CallTip, and AutoComplete primary classes. </p> @@ -204,14 +204,14 @@ </h4> <p> The Editor object is central to Scintilla. It is responsible for displaying a document and - responding to user actions and requests from the container. It uses ContractionState, Indicator, - LineMarker, Style, and ViewStyle objects to display the document and a KeyMap class to - map key presses to functions. - The visibility of each line is kept in the ContractionState which is also responsible for mapping + responding to user actions and requests from the container. It uses ContractionState, Indicator, + LineMarker, Style, and ViewStyle objects to display the document and a KeyMap class to + map key presses to functions. + The visibility of each line is kept in the ContractionState which is also responsible for mapping from display lines to documents lines and vice versa. </p> <p> - There may be multiple Editor objects attached to one Document object. Changes to a + There may be multiple Editor objects attached to one Document object. Changes to a document are broadcast to the editors through the DocWatcher mechanism. </p> <h4> diff --git a/doc/Icons.html b/doc/Icons.html index cb6232728..314b759a6 100644 --- a/doc/Icons.html +++ b/doc/Icons.html @@ -27,10 +27,10 @@ Icons </h2> <p> - These images may be used under the same license as Scintilla. + These images may be used under the same license as Scintilla. </p> <p> - Drawn by Iago Rubio, Philippe Lhoste, and Neil Hodgson. + Drawn by Iago Rubio, Philippe Lhoste, and Neil Hodgson. </p> <p> <a href="http://prdownloads.sourceforge.net/scintilla/icons1.zip?download">zip format</a> (70K) diff --git a/doc/Lexer.txt b/doc/Lexer.txt index 0aeb66bae..9b9e54f5a 100644 --- a/doc/Lexer.txt +++ b/doc/Lexer.txt @@ -47,7 +47,7 @@ The task of a lexer can be summarized briefly: for each range r of characters that are to be colored the same, the lexer should call styler.ColourTo(i, state) - + where i is the position of the last character of the range r. The lexer should set the state variable to the coloring state of the character at position i and continue until the entire text has been colored. @@ -139,8 +139,8 @@ characters in ASCII for operators, comment markers, etc. Special case: Folding -Folding may be performed in the lexer function. It is better to use a -separate folder function as that avoids some troublesome interaction +Folding may be performed in the lexer function. It is better to use a +separate folder function as that avoids some troublesome interaction between styling and folding. The folder function will be run after the lexer function if folding is enabled. The rest of this section explains how to perform folding within the lexer function. @@ -148,15 +148,15 @@ how to perform folding within the lexer function. During initialization, lexers that support folding set bool fold = styler.GetPropertyInt("fold"); - + If folding is enabled in the editor, fold will be TRUE and the lexer should call: styler.SetLevel(line, level); - + at the end of each line and just before exiting. -The line parameter is simply the count of the number of newlines seen. +The line parameter is simply the count of the number of newlines seen. It's initial value is styler.GetLine(startPos) and it is incremented (after calling styler.SetLevel) whenever a newline is seen. @@ -169,7 +169,7 @@ comments, of course). The following flag bits, defined in Scintilla.h, may be set or cleared in the flags parameter. The SC_FOLDLEVELWHITEFLAG flag is set if the lexer considers that the line contains nothing but whitespace. The -SC_FOLDLEVELHEADERFLAG flag indicates that the line is a fold point. +SC_FOLDLEVELHEADERFLAG flag indicates that the line is a fold point. This normally means that the next line has a greater level than present line. However, the lexer may have some other basis for determining a fold point. For example, a lexer might create a header line for the @@ -193,7 +193,7 @@ seen: if ((levelCurrent > levelPrev) && (visChars > 0)) lev |= SC_FOLDLEVELHEADERFLAG; styler.SetLevel(lineCurrent, lev); - + // reinitialize the folding vars describing the present line. lineCurrent++; visChars = 0; // Number of non-whitespace characters on the line. @@ -210,7 +210,7 @@ The following code appears in the C++ lexer just before exit: flagsNext &= ~SC_FOLDLEVELNUMBERMASK; styler.SetLevel(lineCurrent, levelPrev | flagsNext); } - + Don't worry about performance diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 34722f259..5a5a3a532 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -2730,7 +2730,7 @@ struct Sci_TextToFind { <p><b id="SCI_STYLESETCASE">SCI_STYLESETCASE(int styleNumber, int caseMode)</b><br /> <b id="SCI_STYLEGETCASE">SCI_STYLEGETCASE(int styleNumber)</b><br /> The value of caseMode determines how text is displayed. You can set upper case - (<code>SC_CASE_UPPER</code>, 1) or lower case (<code>SC_CASE_LOWER</code>, 2) or camel case (<code>SC_CASE_CAMEL</code>, 3) + (<code>SC_CASE_UPPER</code>, 1) or lower case (<code>SC_CASE_LOWER</code>, 2) or camel case (<code>SC_CASE_CAMEL</code>, 3) or display normally (<code>SC_CASE_MIXED</code>, 0). This does not change the stored text, only how it is displayed.</p> @@ -4256,9 +4256,9 @@ struct Sci_TextToFind { <b id="SCI_INDICSETHOVERFORE">SCI_INDICSETHOVERFORE(int indicatorNumber, int <a class="jump" href="#colour">colour</a>)</b><br /> <b id="SCI_INDICGETHOVERFORE">SCI_INDICGETHOVERFORE(int indicatorNumber)</b><br /> These messages set and get the colour and style used to draw indicators when the mouse is over them or the caret moved into them. - The mouse cursor also changes when an indicator is drawn in hover style. + The mouse cursor also changes when an indicator is drawn in hover style. The default is for the hover appearance to be the same as the normal appearance and calling - <a class="message" href="#SCI_INDICSETFORE">SCI_INDICSETFORE</a> or + <a class="message" href="#SCI_INDICSETFORE">SCI_INDICSETFORE</a> or <a class="message" href="#SCI_INDICSETSTYLE">SCI_INDICSETSTYLE</a> will also reset the hover attribute.</p> @@ -6575,7 +6575,7 @@ struct SCNotification { int token; /* SCN_MODIFIED with SC_MOD_CONTAINER */ int annotationLinesAdded; /* SCN_MODIFIED with SC_MOD_CHANGEANNOTATION */ int updated; /* SCN_UPDATEUI */ - int listCompletionMethod; + int listCompletionMethod; /* SCN_AUTOCSELECTION, SCN_AUTOCCOMPLETED, SCN_USERLISTSELECTION */ }; @@ -7268,19 +7268,19 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <tr> <td align="left"><code>ch</code></td> - <td align="left">If a fillup character was the method of selection, the used + <td align="left">If a fillup character was the method of selection, the used character, otherwise 0.</td> </tr> <tr> <td align="left"><code>listCompletionMethod</code></td> - <td align="left">A value indicating the way in which the completion + <td align="left">A value indicating the way in which the completion occurred. See the table below.</td> </tr> </tbody> </table> <br /> - + See the <code><a class="jump" href="#SCN_AUTOCCOMPLETED">SCN_AUTOCCOMPLETED</a></code> notification for the possible values for <code>listCompletionMethod.</code> <p><b id="SCN_URIDROPPED">SCN_URIDROPPED</b><br /> @@ -7396,13 +7396,13 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <tr> <td align="left"><code>ch</code></td> - <td align="left">If a fillup character was the method of selection, the used + <td align="left">If a fillup character was the method of selection, the used character, otherwise 0.</td> </tr> <tr> <td align="left"><code>listCompletionMethod</code></td> - <td align="left">A value indicating the way in which the completion + <td align="left">A value indicating the way in which the completion occurred. See the table below.</td> </tr> </tbody> @@ -7426,7 +7426,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <td align="center">0x01</td> - <td>A fillup character triggered the completion. The character used is + <td>A fillup character triggered the completion. The character used is in ch. </td> </tr> @@ -7465,7 +7465,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <td>The <code> - <a class="message" href="#SCI_AUTOCSELECT">SCI_AUTOCSELECT</a></code> message + <a class="message" href="#SCI_AUTOCSELECT">SCI_AUTOCSELECT</a></code> message triggered the completion. ch is 0.</td> </tr> @@ -7486,7 +7486,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next <code>SCN_FOCUSOUT</code> (2029) when it loses focus.</p> <p><b id="SCN_AUTOCCOMPLETED">SCN_AUTOCCOMPLETED<br /> - </b>This notification is generated after an autocompletion has inserted its + </b>This notification is generated after an autocompletion has inserted its text. The fields are identical to the <code> <a class="jump" href="#SCN_AUTOCSELECTION">SCN_AUTOCSELECTION</a></code> @@ -7643,7 +7643,7 @@ EM_FORMATRANGE <b id="SCI_GETUSEPALETTE">SCI_GETUSEPALETTE</b> Deprecated<br /> Scintilla no longer supports palette mode. The last version to support palettes was 2.29. Any calls to these methods should be removed.</p> - + <p><b id="SCI_SETKEYSUNICODE">SCI_SETKEYSUNICODE(bool keysUnicode)</b> Deprecated<br /> <b id="SCI_GETKEYSUNICODE">SCI_GETKEYSUNICODE</b> Deprecated<br /> On Windows, Scintilla no longer supports narrow character windows so input is always treated as Unicode.</p> diff --git a/doc/ScintillaUsage.html b/doc/ScintillaUsage.html index 1ddafafd3..984360d39 100644 --- a/doc/ScintillaUsage.html +++ b/doc/ScintillaUsage.html @@ -191,7 +191,7 @@ SPAN { class='S11'>linebuf</span><span class='S10'>)));</span><span class='S0'><br /> </span> <span class='S10'>}</span><span class='S0'><br /> </span> <span class='S10'>}</span><br /> - + <p style="margin-bottom: 0in"> Of course, fancier handling could be implemented. For example, if the previous line was the start of a control construct, the next line could be automatically indented one tab further. @@ -249,7 +249,7 @@ SPAN { class='S11'>endStyled</span><span class='S10'>,</span><span class='S0'> </span> <span class='S11'>notification</span><span class='S10'>-></span><span class='S11'>position</span><span class='S10'>);</span><br /> - + <p> Colourize(start, end) retrieves the specified range of text and then calls ColourizeDoc in keywords.cxx. It starts the process by calling: @@ -259,7 +259,7 @@ SPAN { class='S11'>SCI_STARTSTYLING</span><span class='S10'>,</span><span class='S0'> </span> <span class='S11'>startPos</span><span class='S10'>,</span><span class='S0'> </span> <span class='S4'>31</span><span class='S10'>);</span><br /> - + <p> and then for each token of the text, calling: </p> @@ -268,7 +268,7 @@ SPAN { class='S11'>SCI_SETSTYLING</span><span class='S10'>,</span><span class='S0'> </span> <span class='S11'>length</span><span class='S10'>,</span><span class='S0'> </span> <span class='S11'>style</span><span class='S10'>);</span><br /> - + <p> where style is a number from 0 to 31 whose appearance has been defined using the SCI_STYLESET... messages. @@ -324,7 +324,7 @@ SPAN { class='S10'>=</span><span class='S0'> </span> <span class='S11'>linebuf</span><span class='S0'> </span> <span class='S10'>+</span><span class='S0'> </span> <span class='S11'>startword</span><span class='S10'>;</span><br /> - + <p> Then if a calltip is available it can be displayed. The calltip appears immediately below the position specified. The calltip can be multiple lines separated by newlines (\n). @@ -344,7 +344,7 @@ SPAN { class='S11'>wordLen</span><span class='S0'> </span> <span class='S10'>-</span><span class='S0'> </span> <span class='S4'>1</span><span class='S10'>,</span><span class='S0'> </span> <span class='S11'>calltip</span><span class='S10'>);</span><br /> - + <p> The calltip can be removed when a closing parenthesis is entered: </p> @@ -360,7 +360,7 @@ SPAN { SCI_CALLTIPCANCEL</span><span class='S10'>,</span><span class='S0'> </span> <span class='S4'>0</span><span class='S10'>,</span><span class='S0'> </span> <span class='S4'> 0</span><span class='S10'>);</span><br /> - + <p> Obviously, it is up the application to look after supplying the appropriate calltip text. </p> |