diff options
Diffstat (limited to 'doc/ScintillaDoc.html')
| -rw-r--r-- | doc/ScintillaDoc.html | 270 |
1 files changed, 226 insertions, 44 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 41cac0d2b..7e120c44c 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -51,7 +51,9 @@ table.standard td { padding: 1px 5px 1px 5px; } - + tr.section { + border-top:1px solid #808080; + } .S0 { color: #808080; } @@ -99,6 +101,12 @@ .deprecated { text-decoration: line-through red; } + A.discouraged { + text-decoration: line-through #FFB000; + } + .discouraged { + text-decoration: line-through #FFB000; + } .parameter { font-style:italic; } @@ -364,7 +372,7 @@ </tr> <tr> - <td>○ <a class="toc" href="#CaretAndSelectionStyles">Caret, selection, and hotspot styles</a></td> + <td>○ <a class="toc" href="#CaretAndSelectionStyles">Selection, caret, and hotspot styles</a></td> <td>○ <a class="toc" href="#CharacterRepresentations">Character representations</a></td> @@ -1713,12 +1721,15 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → position</a><br /> <br /> - <a class="message" href="#SCI_SETADDITIONALSELALPHA">SCI_SETADDITIONALSELALPHA(alpha alpha)</a><br /> - <a class="message" href="#SCI_GETADDITIONALSELALPHA">SCI_GETADDITIONALSELALPHA → int</a><br /> - <a class="message" href="#SCI_SETADDITIONALSELFORE">SCI_SETADDITIONALSELFORE(colour fore)</a><br /> - <a class="message" href="#SCI_SETADDITIONALSELBACK">SCI_SETADDITIONALSELBACK(colour back)</a><br /> - <a class="message" href="#SCI_SETADDITIONALCARETFORE">SCI_SETADDITIONALCARETFORE(colour fore)</a><br /> - <a class="message" href="#SCI_GETADDITIONALCARETFORE">SCI_GETADDITIONALCARETFORE → colour</a><br /> + <a class="element" href="#SC_ELEMENT_SELECTION_ADDITIONAL_TEXT">SC_ELEMENT_SELECTION_ADDITIONAL_TEXT : colouralpha</a><br /> + <a class="element" href="#SC_ELEMENT_SELECTION_ADDITIONAL_BACK">SC_ELEMENT_SELECTION_ADDITIONAL_BACK : colouralpha</a><br /> + <a class="discouraged message" href="#SCI_SETADDITIONALSELALPHA">SCI_SETADDITIONALSELALPHA(alpha alpha)</a><br /> + <a class="discouraged message" href="#SCI_GETADDITIONALSELALPHA">SCI_GETADDITIONALSELALPHA → int</a><br /> + <a class="discouraged message" href="#SCI_SETADDITIONALSELFORE">SCI_SETADDITIONALSELFORE(colour fore)</a><br /> + <a class="discouraged message" href="#SCI_SETADDITIONALSELBACK">SCI_SETADDITIONALSELBACK(colour back)</a><br /> + <a class="element" href="#SC_ELEMENT_CARET_ADDITIONAL">SC_ELEMENT_CARET_ADDITIONAL : colouralpha</a><br /> + <a class="discouraged message" href="#SCI_SETADDITIONALCARETFORE">SCI_SETADDITIONALCARETFORE(colour fore)</a><br /> + <a class="discouraged message" href="#SCI_GETADDITIONALCARETFORE">SCI_GETADDITIONALCARETFORE → colour</a><br /> <a class="message" href="#SCI_SETADDITIONALCARETSBLINK">SCI_SETADDITIONALCARETSBLINK(bool additionalCaretsBlink)</a><br /> <a class="message" href="#SCI_GETADDITIONALCARETSBLINK">SCI_GETADDITIONALCARETSBLINK → bool</a><br /> <a class="message" href="#SCI_SETADDITIONALCARETSVISIBLE">SCI_SETADDITIONALCARETSVISIBLE(bool additionalCaretsVisible)</a><br /> @@ -1871,15 +1882,22 @@ struct Sci_TextToFind { After setting the rectangular selection, this is broken down into multiple selections, one for each line.</p> <p> + <b id="SC_ELEMENT_SELECTION_ADDITIONAL_TEXT">SC_ELEMENT_SELECTION_ADDITIONAL_TEXT : colouralpha</b><br /> + <b id="SC_ELEMENT_SELECTION_ADDITIONAL_BACK">SC_ELEMENT_SELECTION_ADDITIONAL_BACK : colouralpha</b><br /> <b id="SCI_SETADDITIONALSELALPHA">SCI_SETADDITIONALSELALPHA(<a class="jump" href="#alpha">alpha</a> alpha)</b><br /> <b id="SCI_GETADDITIONALSELALPHA">SCI_GETADDITIONALSELALPHA → int</b><br /> <b id="SCI_SETADDITIONALSELFORE">SCI_SETADDITIONALSELFORE(<a class="jump" href="#colour">colour</a> fore)</b><br /> <b id="SCI_SETADDITIONALSELBACK">SCI_SETADDITIONALSELBACK(<a class="jump" href="#colour">colour</a> back)</b><br /> Modify the appearance of additional selections so that they can be differentiated from the main selection which has its appearance set with + <a class="element" href="#SC_ELEMENT_SELECTION_TEXT"><code>SC_ELEMENT_SELECTION_TEXT</code></a>, + <a class="element" href="#SC_ELEMENT_SELECTION_BACK"><code>SC_ELEMENT_SELECTION_BACK</code></a>, <a class="message" href="#SCI_SETSELALPHA"><code>SCI_SETSELALPHA</code></a>, <a class="message" href="#SCI_GETSELALPHA"><code>SCI_GETSELALPHA</code></a>, <a class="message" href="#SCI_SETSELFORE"><code>SCI_SETSELFORE</code></a>, and <a class="message" href="#SCI_SETSELBACK"><code>SCI_SETSELBACK</code></a>. + The element APIs are preferred and the following messages discouraged. + The additional selection background is drawn on the layer defined for all selection backgrounds by + <a class="message" href="#SCI_SETSELECTIONLAYER"><code>SCI_SETSELECTIONLAYER</code></a>. <code>SCI_SETADDITIONALSELFORE</code> and <code>SCI_SETADDITIONALSELBACK</code> calls have no effect until <a class="message" href="#SCI_SETSELFORE"><code>SCI_SETSELFORE</code></a> @@ -1888,12 +1906,15 @@ struct Sci_TextToFind { <a class="message" href="#SCI_SETSELFORE"><code>SCI_SETSELFORE</code></a>, and <a class="message" href="#SCI_SETSELBACK"><code>SCI_SETSELBACK</code></a> will overwrite the values set by <code>SCI_SETADDITIONALSEL*</code> functions.</p> + <p> + <b id="SC_ELEMENT_CARET_ADDITIONAL">SC_ELEMENT_CARET_ADDITIONAL : colouralpha</b><br /> <b id="SCI_SETADDITIONALCARETFORE">SCI_SETADDITIONALCARETFORE(<a class="jump" href="#colour">colour</a> fore)</b><br /> <b id="SCI_GETADDITIONALCARETFORE">SCI_GETADDITIONALCARETFORE → colour</b><br /> <b id="SCI_SETADDITIONALCARETSBLINK">SCI_SETADDITIONALCARETSBLINK(bool additionalCaretsBlink)</b><br /> <b id="SCI_GETADDITIONALCARETSBLINK">SCI_GETADDITIONALCARETSBLINK → bool</b><br /> Modify the appearance of additional carets so that they can be differentiated from the main caret which has its appearance set with + <a class="element" href="#SC_ELEMENT_CARET"><code>SC_ELEMENT_CARET</code></a>, <a class="message" href="#SCI_SETCARETFORE"><code>SCI_SETCARETFORE</code></a>, <a class="message" href="#SCI_GETCARETFORE"><code>SCI_GETCARETFORE</code></a>, <a class="message" href="#SCI_SETCARETPERIOD"><code>SCI_SETCARETPERIOD</code></a>, and @@ -2451,7 +2472,7 @@ struct Sci_TextToFind { <b id="SCI_GETMOUSEWHEELCAPTURES">SCI_GETMOUSEWHEELCAPTURES → bool</b><br /> On Windows, Scintilla captures all <code>WM_MOUSEWHEEL</code> messages if it has the focus, even if the mouse pointer is nowhere near the Scintilla editor window. This - behavior can be changed with <code>SCI_SETMOUSEWHEELCAPTURES(0)</code> so that + behaviour can be changed with <code>SCI_SETMOUSEWHEELCAPTURES(0)</code> so that Scintilla passes the <code>WM_MOUSEWHEEL</code> messages to its parent window. Scintilla will still react to the mouse wheel if the mouse pointer is over the editor window.</p> @@ -3269,7 +3290,7 @@ struct Sci_TextToFind { </tr> </thead> <tbody valign="top"> - <tr> + <tr class="section"> <th align="left"><code>SC_ELEMENT_LIST</code></th> <td>0</td> <td>Opaque</td> @@ -3297,6 +3318,83 @@ struct Sci_TextToFind { <td>Win32</td> <td>Background colour of selected item in autocompletion lists</td> </tr> + <tr class="section"> + <th align="left"><code>SC_ELEMENT_SELECTION_TEXT</code></th> + <td>10</td> + <td>Translucent</td> + <td>All</td> + <td>Text colour of main selection</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_BACK</code></th> + <td>11</td> + <td>Translucent</td> + <td>All</td> + <td>Background colour of main selection</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_ADDITIONAL_TEXT</code></th> + <td>12</td> + <td>Translucent</td> + <td>All</td> + <td>Text colour of additional selections</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_ADDITIONAL_BACK</code></th> + <td>13</td> + <td>Translucent</td> + <td>All</td> + <td>Background colour of additional selections</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_SECONDARY_TEXT</code></th> + <td>14</td> + <td>Translucent</td> + <td>All</td> + <td>Text colour of selections when another window contains the primary selection</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_SECONDARY_BACK</code></th> + <td>15</td> + <td>Translucent</td> + <td>All</td> + <td>Background colour of selections when another window contains the primary selection</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_NO_FOCUS_TEXT</code></th> + <td>16</td> + <td>Translucent</td> + <td>All</td> + <td>Text colour of selections when another window has focus</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_SELECTION_NO_FOCUS_BACK</code></th> + <td>17</td> + <td>Translucent</td> + <td>All</td> + <td>Background colour of selections when another window has focus</td> + </tr> + <tr class="section"> + <th align="left"><code>SC_ELEMENT_CARET</code></th> + <td>40</td> + <td>Translucent</td> + <td>All</td> + <td>Colour of caret for main selection</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_CARET_ADDITIONAL</code></th> + <td>41</td> + <td>Translucent</td> + <td>All</td> + <td>Colour of caret for additional selections</td> + </tr> + <tr> + <th align="left"><code>SC_ELEMENT_CARET_SECONDARY</code></th> + <td>42</td> + <td>Translucent</td> + <td>All</td> + <td>Colour of carets when another window has focus</td> + </tr> </tbody> </table> @@ -3309,22 +3407,40 @@ struct Sci_TextToFind { The default value is US English "en-us". </p> - <h2 id="CaretAndSelectionStyles">Caret, selection, and hotspot styles</h2> + <h2 id="CaretAndSelectionStyles">Selection, caret, and hotspot styles</h2> - <p>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 - selection by changing the background to light grey and leaving the foreground the same as when + <p>The selection is shown by changing the text and/or background colours. + If the selected text colour is not set then that attribute is not changed for the selection. + The default is to show the + selection by changing the background and leaving the foreground the same as when it was not selected. When there is no selection, the current insertion point is marked by the text caret. This is a vertical line that is normally blinking on and off to attract the users attention.</p> - <code><a class="message" href="#SCI_SETSELFORE">SCI_SETSELFORE(bool useSetting, colour fore)</a><br /> - <a class="message" href="#SCI_SETSELBACK">SCI_SETSELBACK(bool useSetting, colour back)</a><br /> - <a class="message" href="#SCI_SETSELALPHA">SCI_SETSELALPHA(alpha alpha)</a><br /> - <a class="message" href="#SCI_GETSELALPHA">SCI_GETSELALPHA → int</a><br /> + <p>On most platforms, a default grey selection background is used but, on macOS, the system-defined + selection background is used. The application can call APIs to change the colours used.</p> + <code> + <a class="element" href="#SC_ELEMENT_SELECTION_TEXT">SC_ELEMENT_SELECTION_TEXT : colouralpha</a><br /> + <a class="discouraged message" href="#SCI_SETSELFORE">SCI_SETSELFORE(bool useSetting, colour fore)</a><br /> + <a class="element" href="#SC_ELEMENT_SELECTION_BACK">SC_ELEMENT_SELECTION_BACK : colouralpha</a><br /> + <a class="discouraged message" href="#SCI_SETSELBACK">SCI_SETSELBACK(bool useSetting, colour back)</a><br /> + <a class="message" href="#SCI_SETSELECTIONLAYER">SCI_SETSELECTIONLAYER(int layer)</a><br /> + <a class="message" href="#SCI_GETSELECTIONLAYER">SCI_GETSELECTIONLAYER → int</a><br /> + <a class="discouraged message" href="#SCI_SETSELALPHA">SCI_SETSELALPHA(alpha alpha)</a><br /> + <a class="discouraged message" href="#SCI_GETSELALPHA">SCI_GETSELALPHA → int</a><br /> <a class="message" href="#SCI_SETSELEOLFILLED">SCI_SETSELEOLFILLED(bool filled)</a><br /> <a class="message" href="#SCI_GETSELEOLFILLED">SCI_GETSELEOLFILLED → bool</a><br /> - <a class="message" href="#SCI_SETCARETFORE">SCI_SETCARETFORE(colour fore)</a><br /> - <a class="message" href="#SCI_GETCARETFORE">SCI_GETCARETFORE → colour</a><br /> + <br /> + <a class="element" href="#SC_ELEMENT_CARET">SC_ELEMENT_CARET : colouralpha</a><br /> + <a class="discouraged message" href="#SCI_SETCARETFORE">SCI_SETCARETFORE(colour fore)</a><br /> + <a class="discouraged message" href="#SCI_GETCARETFORE">SCI_GETCARETFORE → colour</a><br /> + <br /> + <a class="element" href="#SC_ELEMENT_SELECTION_SECONDARY_TEXT">SC_ELEMENT_SELECTION_SECONDARY_TEXT : colouralpha</a><br /> + <a class="element" href="#SC_ELEMENT_SELECTION_SECONDARY_BACK">SC_ELEMENT_SELECTION_SECONDARY_BACK : colouralpha</a><br /> + <a class="element" href="#SC_ELEMENT_CARET_SECONDARY">SC_ELEMENT_CARET_SECONDARY : colouralpha</a><br /> + <br /> + <a class="element" href="#SC_ELEMENT_SELECTION_NO_FOCUS_TEXT">SC_ELEMENT_SELECTION_NO_FOCUS_TEXT : colouralpha</a><br /> + <a class="element" href="#SC_ELEMENT_SELECTION_NO_FOCUS_BACK">SC_ELEMENT_SELECTION_NO_FOCUS_BACK : colouralpha</a><br /> + <br /> <a class="message" href="#SCI_SETCARETLINEVISIBLE">SCI_SETCARETLINEVISIBLE(bool show)</a><br /> <a class="message" href="#SCI_GETCARETLINEVISIBLE">SCI_GETCARETLINEVISIBLE → bool</a><br /> <a class="message" href="#SCI_SETCARETLINEBACK">SCI_SETCARETLINEBACK(colour back)</a><br /> @@ -3335,12 +3451,17 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETCARETLINEFRAME">SCI_GETCARETLINEFRAME → int</a><br /> <a class="message" href="#SCI_SETCARETLINEVISIBLEALWAYS">SCI_SETCARETLINEVISIBLEALWAYS(bool alwaysVisible)</a><br /> <a class="message" href="#SCI_GETCARETLINEVISIBLEALWAYS">SCI_GETCARETLINEVISIBLEALWAYS → bool</a><br /> + <br /> <a class="message" href="#SCI_SETCARETPERIOD">SCI_SETCARETPERIOD(int periodMilliseconds)</a><br /> <a class="message" href="#SCI_GETCARETPERIOD">SCI_GETCARETPERIOD → int</a><br /> <a class="message" href="#SCI_SETCARETSTYLE">SCI_SETCARETSTYLE(int caretStyle)</a><br /> <a class="message" href="#SCI_GETCARETSTYLE">SCI_GETCARETSTYLE → int</a><br /> <a class="message" href="#SCI_SETCARETWIDTH">SCI_SETCARETWIDTH(int pixelWidth)</a><br /> <a class="message" href="#SCI_GETCARETWIDTH">SCI_GETCARETWIDTH → int</a><br /> + <a class="message" href="#SCI_SETCARETSTICKY">SCI_SETCARETSTICKY(int useCaretStickyBehaviour)</a><br /> + <a class="message" href="#SCI_GETCARETSTICKY">SCI_GETCARETSTICKY → int</a><br /> + <a class="message" href="#SCI_TOGGLECARETSTICKY">SCI_TOGGLECARETSTICKY</a><br /> + <br /> <a class="message" href="#SCI_SETHOTSPOTACTIVEFORE">SCI_SETHOTSPOTACTIVEFORE(bool useSetting, colour fore)</a><br /> <a class="message" href="#SCI_GETHOTSPOTACTIVEFORE">SCI_GETHOTSPOTACTIVEFORE → colour</a><br /> <a class="message" href="#SCI_SETHOTSPOTACTIVEBACK">SCI_SETHOTSPOTACTIVEBACK(bool useSetting, colour back)</a><br /> @@ -3349,31 +3470,87 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETHOTSPOTACTIVEUNDERLINE">SCI_GETHOTSPOTACTIVEUNDERLINE → bool</a><br /> <a class="message" href="#SCI_SETHOTSPOTSINGLELINE">SCI_SETHOTSPOTSINGLELINE(bool singleLine)</a><br /> <a class="message" href="#SCI_GETHOTSPOTSINGLELINE">SCI_GETHOTSPOTSINGLELINE → bool</a><br /> - <a class="message" href="#SCI_SETCARETSTICKY">SCI_SETCARETSTICKY(int useCaretStickyBehaviour)</a><br /> - <a class="message" href="#SCI_GETCARETSTICKY">SCI_GETCARETSTICKY → int</a><br /> - <a class="message" href="#SCI_TOGGLECARETSTICKY">SCI_TOGGLECARETSTICKY</a><br /> </code> - <p><b id="SCI_SETSELFORE">SCI_SETSELFORE(bool useSetting, <a class="jump" href="#colour">colour</a> fore)</b><br /> + <p> + <b id="SC_ELEMENT_SELECTION_TEXT">SC_ELEMENT_SELECTION_TEXT : colouralpha</b><br /> + <b id="SCI_SETSELFORE">SCI_SETSELFORE(bool useSetting, <a class="jump" href="#colour">colour</a> fore)</b><br /> + <b id="SC_ELEMENT_SELECTION_BACK">SC_ELEMENT_SELECTION_BACK : colouralpha</b><br /> <b id="SCI_SETSELBACK">SCI_SETSELBACK(bool useSetting, <a class="jump" href="#colour">colour</a> back)</b><br /> - You can choose to override the default selection colouring with these two messages. The colour + You can choose to override the default selection colouring with these elements and messages. + The <a href="#ElementColours">element APIs</a> are now preferred as they handle translucency + layering and + cooperation with defaults better. + With the messages, the colour you provide is used if you set <code class="parameter">useSetting</code> to <code>true</code>. If it is set to <code>false</code>, the default styled colouring is used and the <code class="parameter">fore</code> or <code class="parameter">back</code> argument has no effect.</p> + + <p><b id="SCI_SETSELECTIONLAYER">SCI_SETSELECTIONLAYER(int layer)</b><br /> + <b id="SCI_GETSELECTIONLAYER">SCI_GETSELECTIONLAYER → int</b><br /> + The selection background can be drawn translucently over the text + or opaquely on the base layer. + The <code class="parameter">layer</code> argument can be one of:</p> + + <table class="standard" summary="Layer"> + <tbody valign="top"> + <tr> + <th align="left"><code>SC_LAYER_BASE</code></th> + + <td>0</td> + + <td>Draw the selection background opaquely on the base layer</td> + </tr> + + <tr> + <th align="left"><code>SC_LAYER_OVER_TEXT</code></th> + + <td>10</td> + + <td>Draw the selection background translucently over the text</td> + </tr> + + </tbody> + </table> + <p><b id="SCI_SETSELALPHA">SCI_SETSELALPHA(<a class="jump" href="#alpha">alpha</a> alpha)</b><br /> <b id="SCI_GETSELALPHA">SCI_GETSELALPHA → int</b><br /> - The selection can be drawn translucently in the selection background colour by - setting an alpha value.</p> + These APIs are now discouraged and should be replaced with + a combination of setting the layer with SCI_SETSELECTIONLAYER and + setting translucency through the SC_ELEMENT_SELECTION_BACK element.</p> <p><b id="SCI_SETSELEOLFILLED">SCI_SETSELEOLFILLED(bool filled)</b><br /> <b id="SCI_GETSELEOLFILLED">SCI_GETSELEOLFILLED → bool</b><br /> The selection can be drawn up to the right hand border by setting this property.</p> - <p><b id="SCI_SETCARETFORE">SCI_SETCARETFORE(<a class="jump" href="#colour">colour</a> fore)</b><br /> + <p> + <b id="SC_ELEMENT_CARET">SC_ELEMENT_CARET : colouralpha</b><br /> + <b id="SCI_SETCARETFORE">SCI_SETCARETFORE(<a class="jump" href="#colour">colour</a> fore)</b><br /> <b id="SCI_GETCARETFORE">SCI_GETCARETFORE → colour</b><br /> - The colour of the caret can be set with <code>SCI_SETCARETFORE</code> and retrieved with - <code>SCI_GETCARETFORE</code>.</p> + The colour of the caret can be set with + <a class="message" href="#SCI_SETELEMENTCOLOUR"><code>SCI_SETELEMENTCOLOUR(SC_ELEMENT_CARET)</code></a> or + <code>SCI_SETCARETFORE</code> and retrieved with + <a class="message" href="#SCI_GETELEMENTCOLOUR"><code>SCI_GETELEMENTCOLOUR(SC_ELEMENT_CARET)</code></a> or + <code>SCI_GETCARETFORE</code>. + The element APIs are preferred and allow setting the translucency of carets.</p> + + <p> + <b id="SC_ELEMENT_SELECTION_SECONDARY_TEXT">SC_ELEMENT_SELECTION_SECONDARY_TEXT : colouralpha</b><br /> + <b id="SC_ELEMENT_SELECTION_SECONDARY_BACK">SC_ELEMENT_SELECTION_SECONDARY_TEXT : colouralpha</b><br /> + <b id="SC_ELEMENT_CARET_SECONDARY">SC_ELEMENT_CARET_SECONDARY : colouralpha</b><br /> + On Unix systems running with the X window system or Wayland there is a 'primary selection' which is the text most recently + selected in any application and which can be pasted by a middle button click. + When working with a selection, it is commonly the primary selection so Scintilla draws the primary selection with the main and additional + colours defined earlier. When another application takes over the primary selection, these <code>_SECONDARY</code> colours are used. + They are commonly defined as grey to highlight that it is the selection in the other application that is now available as primary. + </p> + + <p> + <b id="SC_ELEMENT_SELECTION_NO_FOCUS_TEXT">SC_ELEMENT_SELECTION_NO_FOCUS_TEXT : colouralpha</b><br /> + <b id="SC_ELEMENT_SELECTION_NO_FOCUS_BACK">SC_ELEMENT_SELECTION_NO_FOCUS_BACK : colouralpha</b><br /> + When a window no longer has the keyboard focus, it is customary to make its selection less noticeable by colouring it grey. + These elements define the colours to be used for selections without focus. + </p> <p><b id="SCI_SETCARETLINEVISIBLE">SCI_SETCARETLINEVISIBLE(bool show)</b><br /> <b id="SCI_GETCARETLINEVISIBLE">SCI_GETCARETLINEVISIBLE → bool</b><br /> @@ -3467,19 +3644,6 @@ struct Sci_TextToFind { This setting only affects the width of the cursor when the cursor style is set to line caret mode, it does not affect the width for a block caret.</p> - <p><b id="SCI_SETHOTSPOTACTIVEFORE">SCI_SETHOTSPOTACTIVEFORE(bool useSetting, <a class="jump" href="#colour">colour</a> fore)</b><br /> - <b id="SCI_GETHOTSPOTACTIVEFORE">SCI_GETHOTSPOTACTIVEFORE → colour</b><br /> - <b id="SCI_SETHOTSPOTACTIVEBACK">SCI_SETHOTSPOTACTIVEBACK(bool useSetting, - <a class="jump" href="#colour">colour</a> back)</b><br /> - <b id="SCI_GETHOTSPOTACTIVEBACK">SCI_GETHOTSPOTACTIVEBACK → colour</b><br /> - <b id="SCI_SETHOTSPOTACTIVEUNDERLINE">SCI_SETHOTSPOTACTIVEUNDERLINE(bool underline)</b><br /> - <b id="SCI_GETHOTSPOTACTIVEUNDERLINE">SCI_GETHOTSPOTACTIVEUNDERLINE → bool</b><br /> - <b id="SCI_SETHOTSPOTSINGLELINE">SCI_SETHOTSPOTSINGLELINE(bool singleLine)</b><br /> - <b id="SCI_GETHOTSPOTSINGLELINE">SCI_GETHOTSPOTSINGLELINE → bool</b><br /> - 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. - Single line mode stops a hotspot from wrapping onto next line.</p> - <p><b id="SCI_SETCARETSTICKY">SCI_SETCARETSTICKY(int useCaretStickyBehaviour)</b><br /> <b id="SCI_GETCARETSTICKY">SCI_GETCARETSTICKY → int</b><br /> <b id="SCI_TOGGLECARETSTICKY">SCI_TOGGLECARETSTICKY</b><br /> @@ -3500,6 +3664,19 @@ struct Sci_TextToFind { <p><code>SCI_TOGGLECARETSTICKY</code> switches from <code>SC_CARETSTICKY_ON</code> and <code>SC_CARETSTICKY_WHITESPACE</code> to <code>SC_CARETSTICKY_OFF</code> and from <code>SC_CARETSTICKY_OFF</code> to <code>SC_CARETSTICKY_ON</code>.</p> + <p><b id="SCI_SETHOTSPOTACTIVEFORE">SCI_SETHOTSPOTACTIVEFORE(bool useSetting, <a class="jump" href="#colour">colour</a> fore)</b><br /> + <b id="SCI_GETHOTSPOTACTIVEFORE">SCI_GETHOTSPOTACTIVEFORE → colour</b><br /> + <b id="SCI_SETHOTSPOTACTIVEBACK">SCI_SETHOTSPOTACTIVEBACK(bool useSetting, + <a class="jump" href="#colour">colour</a> back)</b><br /> + <b id="SCI_GETHOTSPOTACTIVEBACK">SCI_GETHOTSPOTACTIVEBACK → colour</b><br /> + <b id="SCI_SETHOTSPOTACTIVEUNDERLINE">SCI_SETHOTSPOTACTIVEUNDERLINE(bool underline)</b><br /> + <b id="SCI_GETHOTSPOTACTIVEUNDERLINE">SCI_GETHOTSPOTACTIVEUNDERLINE → bool</b><br /> + <b id="SCI_SETHOTSPOTSINGLELINE">SCI_SETHOTSPOTSINGLELINE(bool singleLine)</b><br /> + <b id="SCI_GETHOTSPOTSINGLELINE">SCI_GETHOTSPOTSINGLELINE → bool</b><br /> + 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. + Single line mode stops a hotspot from wrapping onto next line.</p> + <h2 id="CharacterRepresentations">Character representations</h2> <p>Some characters, such as control characters and invalid bytes, do not have a visual glyph or use a glyph that is hard to distinguish.</p> @@ -8877,7 +9054,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next provisional status. To avoid using provisional messages compile with the symbol <code>SCI_DISABLE_PROVISIONAL</code> defined.</p> - <h2 id="DeprecatedMessages">Deprecated messages and notifications</h2> + <h2 id="DeprecatedMessages">Deprecated and discouraged messages and notifications</h2> <p>The following messages are currently supported to emulate existing Windows controls, but they will be removed in future versions of Scintilla. If you use these messages you should @@ -8964,6 +9141,11 @@ EM_FORMATRANGE Any use of these symbols should be removed and replaced with <a href="#Indicators">standard indicators</a>. <code>SCI_GETSTYLEBITS</code> and <code>SCI_GETSTYLEBITSNEEDED</code> always return 8, indicating that 8 bits are used for styling and there are 256 styles.</p> + + <p>Discouraged APIs are a step before deprecation. A new preferred API has been implemented that new code should use + but the old API is unlikely to be removed. + Discouraged APIs are marked with a <span class="discouraged">orange strikethrough</span> and their documentation mentions the preferred API. + </p> <h2 id="EditMessagesNeverSupportedByScintilla">Edit messages never supported by Scintilla</h2> <pre> |