diff options
Diffstat (limited to 'doc/ScintillaDoc.html')
| -rw-r--r-- | doc/ScintillaDoc.html | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 6ec941395..786b6f27f 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -457,6 +457,8 @@ <tr> <td>○ <a class="toc" href="#BuildingScintilla">Building Scintilla</a></td> + <td>○ <a class="toc" href="#EndOfLineAnnotations">End of Line Annotations</a></td> + </tr> </tbody> </table> @@ -3725,6 +3727,99 @@ struct Sci_TextToFind { before <code>SCI_ANNOTATIONSETSTYLEOFFSET</code> and use the result as the argument to <code>SCI_ANNOTATIONSETSTYLEOFFSET</code>. </p> + <h2 id="EndOfLineAnnotations">End of Line Annotations</h2> + + <p>End of Line Annotations are read-only lines of text at the end of each line of editable text. + End of Line Annotations can be used to display an assembler version of code for debugging or to show diagnostic messages inline or to + line up different versions of text in a merge tool.</p> + + <p>End of Line Annotations used to display an assembler version of code for debugging</p> + <p><img src="eolannotation.png" alt="End of Line Annotations used to display an assembler version of code for debugging" /></p> + + <code> + <a class="message" href="#SCI_EOLANNOTATIONSETTEXT">SCI_EOLANNOTATIONSETTEXT(line line, const char *text)</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONGETTEXT">SCI_EOLANNOTATIONGETTEXT(line line, char *text) → int</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONSETSTYLE">SCI_EOLANNOTATIONSETSTYLE(line line, int style)</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONGETSTYLE">SCI_EOLANNOTATIONGETSTYLE(line line) → int</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONCLEARALL">SCI_EOLANNOTATIONCLEARALL</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONSETVISIBLE">SCI_EOLANNOTATIONSETVISIBLE(int visible)</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONGETVISIBLE">SCI_EOLANNOTATIONGETVISIBLE → int</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONSETSTYLEOFFSET">SCI_EOLANNOTATIONSETSTYLEOFFSET(int style)</a><br /> + <a class="message" href="#SCI_EOLANNOTATIONGETSTYLEOFFSET">SCI_EOLANNOTATIONGETSTYLEOFFSET → int</a><br /> + </code> + + <p> + <b id="SCI_EOLANNOTATIONSETTEXT">SCI_EOLANNOTATIONSETTEXT(line line, const char *text)</b><br /> + <b id="SCI_EOLANNOTATIONGETTEXT">SCI_EOLANNOTATIONGETTEXT(line line, char *text) → int</b><br /> + <b id="SCI_EOLANNOTATIONSETSTYLE">SCI_EOLANNOTATIONSETSTYLE(line line, int style)</b><br /> + <b id="SCI_EOLANNOTATIONGETSTYLE">SCI_EOLANNOTATIONGETSTYLE(line line) → int</b><br /> + <b id="SCI_EOLANNOTATIONCLEARALL">SCI_EOLANNOTATIONCLEARALL</b><br /> + A different string may be set for each line with <code>SCI_EOLANNOTATIONSETTEXT</code>. + To clear end of line annotations call <code>SCI_EOLANNOTATIONSETTEXT</code> with a NULL pointer. + The whole of the text EOLANNOTATION on a line may be displayed in a particular style with + <code>SCI_EOLANNOTATIONSETSTYLE</code> or each character may be individually styled with + of the corresponding text byte similar to <code>SCI_SETSTYLINGEX</code>. The text must be set first as it + specifies how long the end of line annotation is so how many bytes of styling to read. + Setting an end of line annotation will cause a + <a class="message" href="#SC_MOD_CHANGEEOLANNOTATION"><code>SC_MOD_CHANGEEOLANNOTATION</code></a> + notification to be sent. + </p> + <p> + All the lines can be cleared of end of line annotations with <code>SCI_EOLANNOTATIONCLEARALL</code> + which is equivalent to clearing each line (setting to 0) and then deleting other memory used for this feature. + </p> + <p> + Only some style attributes are active in end of line annotations: font, size/sizeFractional, bold/weight, italics, fore, back, and characterSet. + </p> + <p> + <b id="SCI_EOLANNOTATIONSETVISIBLE">SCI_EOLANNOTATIONSETVISIBLE(int visible)</b><br /> + <b id="SCI_EOLANNOTATIONGETVISIBLE">SCI_EOLANNOTATIONGETVISIBLE → int</b><br /> + End of Line Annotations can be made visible in a view and there is a choice of display style when visible. + The two messages set and get the annotation display mode. The <code class="parameter">visible</code> + argument can be one of:</p> + + <table class="standard" summary="End of Line Annotation visibility"> + <tbody valign="top"> + <tr> + <th align="left"><code>EOLANNOTATION_HIDDEN</code></th> + + <td>0</td> + + <td>End of Line Annotations are not displayed.</td> + </tr> + + <tr> + <th align="left"><code>EOLANNOTATION_STANDARD</code></th> + + <td>1</td> + + <td>End of Line Annotations are drawn left justified with no adornment.</td> + </tr> + + <tr> + <th align="left"><code>EOLANNOTATION_BOXED</code></th> + + <td>2</td> + + <td>End of Line Annotations are indented to match the text and are surrounded by a box.</td> + </tr> + + </tbody> + </table> + + <p> + <b id="SCI_EOLANNOTATIONSETSTYLEOFFSET">SCI_EOLANNOTATIONSETSTYLEOFFSET(int style)</b><br /> + <b id="SCI_EOLANNOTATIONGETSTYLEOFFSET">SCI_EOLANNOTATIONGETSTYLEOFFSET → int</b><br /> + End of Line Annotation styles may be completely separated from standard text styles by setting a style offset. For example, + <code>SCI_EOLANNOTATIONSETSTYLEOFFSET(512)</code> would allow the end of line annotation styles to be numbered from + 512 up to 767 so they do not overlap styles set by lexers (or margins if margins offset is 256). + Each style number set with <code>SCI_EOLANNOTATIONSETSTYLE</code> + or <code>SCI_EOLANNOTATIONSETSTYLES</code> has the offset added before looking up the style. + </p> + <p> + Always call <a class="seealso" href="#SCI_ALLOCATEEXTENDEDSTYLES">SCI_ALLOCATEEXTENDEDSTYLES</a> + before <code>SCI_EOLANNOTATIONSETSTYLEOFFSET</code> and use the result as the argument to <code>SCI_EOLANNOTATIONSETSTYLEOFFSET</code>. + </p> <h2 id="OtherSettings">Other settings</h2> <code> <a class="message" href="#SCI_SETBUFFEREDDRAW">SCI_SETBUFFEREDDRAW(bool buffered)</a><br /> |