aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html57
1 files changed, 52 insertions, 5 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 616bacaa7..53bf4e794 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -2698,14 +2698,20 @@ struct Sci_TextToFind {
</tr>
<tr>
+ <th align="left"><code>STYLE_FOLDDISPLAYTEXT</code></th>
+
+ <td>39</td>
+
+ <td>This is the style used for drawing text tags attached to folded text.</td>
+ </tr>
+
+ <tr>
<th align="left"><code>STYLE_LASTPREDEFINED</code></th>
<td>39</td>
<td>To make it easier for client code to discover the range of styles that are
- predefined, this is set to the style number of the last predefined style. This is
- currently set to 39 and the last style with an identifier is 38, which reserves space
- for one future predefined style.</td>
+ predefined, this is set to the style number of the last predefined style.</td>
</tr>
<tr>
@@ -5668,6 +5674,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
<a class="message" href="#SCI_GETFOLDEXPANDED">SCI_GETFOLDEXPANDED(int line) &rarr; bool</a><br />
<a class="message" href="#SCI_CONTRACTEDFOLDNEXT">SCI_CONTRACTEDFOLDNEXT(int lineStart) &rarr; int</a><br />
<a class="message" href="#SCI_TOGGLEFOLD">SCI_TOGGLEFOLD(int line)</a><br />
+ <a class="message" href="#SCI_TOGGLEFOLDSHOWTEXT">SCI_TOGGLEFOLDSHOWTEXT(int line, const char *text)</a><br />
+ <a class="message" href="#SCI_FOLDDISPLAYTEXTSETSTYLE">SCI_FOLDDISPLAYTEXTSETSTYLE(int style)</a><br />
<a class="message" href="#SCI_FOLDLINE">SCI_FOLDLINE(int line, int action)</a><br />
<a class="message" href="#SCI_FOLDCHILDREN">SCI_FOLDCHILDREN(int line, int action)</a><br />
<a class="message" href="#SCI_FOLDALL">SCI_FOLDALL(int action)</a><br />
@@ -5819,10 +5827,49 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
inconsistent, the return value is -1.</p>
<p><b id="SCI_TOGGLEFOLD">SCI_TOGGLEFOLD(int line)</b><br />
+ <b id="SCI_TOGGLEFOLDSHOWTEXT">SCI_TOGGLEFOLDSHOWTEXT(int line, const char *text)</b><br />
Each fold point may be either expanded, displaying all its child lines, or contracted, hiding
- all the child lines. This message toggles the folding state of the given line as long as it has
- the <code>SC_FOLDLEVELHEADERFLAG</code> set. This message takes care of folding or expanding
+ all the child lines. These messages toggle the folding state of the given line as long as it has
+ the <code>SC_FOLDLEVELHEADERFLAG</code> set. These messages take care of folding or expanding
all the lines that depend on the line. The display updates after this message.</p>
+ <p>An optional text tag may be shown to the right of the folded text with the
+ <code class="parameter">text</code> argument to
+ <code>SCI_TOGGLEFOLDSHOWTEXT</code>.
+ The text is drawn with the
+ <code><a class="message" href="#StyleDefinition">STYLE_FOLDDISPLAYTEXT</a></code> style.</p>
+
+ <p><b id="SCI_FOLDDISPLAYTEXTSETSTYLE">SCI_FOLDDISPLAYTEXTSETSTYLE(int style)</b><br />
+ This message changes the appearance of fold text tags.</p>
+ <table cellpadding="1" cellspacing="2" border="0" summary="Fold flags">
+ <tbody>
+ <tr>
+ <th align="left">Symbol</th>
+ <th align="left">Value</th>
+ <th align="left">Effect</th>
+ </tr>
+ </tbody>
+
+ <tbody valign="top">
+ <tr>
+ <td align="left">SC_FOLDDISPLAYTEXT_HIDDEN</td>
+ <td align="left">0</td>
+ <td align="left">Do not display the text tags. This is the default.</td>
+ </tr>
+
+ <tr>
+ <td align="left">SC_FOLDDISPLAYTEXT_STANDARD</td>
+ <td align="left">1</td>
+ <td align="left">Display the text tags.</td>
+ </tr>
+
+ <tr>
+ <td align="left">SC_FOLDDISPLAYTEXT_BOXED</td>
+ <td align="left">2</td>
+ <td align="left">Display the text tags with a box drawn around them.</td>
+ </tr>
+
+ </tbody>
+ </table>
<p><b id="SCI_SETFOLDEXPANDED">SCI_SETFOLDEXPANDED(int line, bool expanded)</b><br />
<b id="SCI_GETFOLDEXPANDED">SCI_GETFOLDEXPANDED(int line) &rarr; bool</b><br />