aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index b320621cf..95a830beb 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -3348,6 +3348,8 @@ struct Sci_TextToFindFull {
<a class="message" href="#SCI_STYLESETWEIGHT">SCI_STYLESETWEIGHT(int style, int
weight)</a><br />
<a class="message" href="#SCI_STYLEGETWEIGHT">SCI_STYLEGETWEIGHT(int style) &rarr; int</a><br />
+ <a class="message" href="#SCI_STYLESETSTRETCH">SCI_STYLESETSTRETCH(int style, int stretch)</a><br />
+ <a class="message" href="#SCI_STYLEGETSTRETCH">SCI_STYLEGETSTRETCH(int style) &rarr; int</a><br />
<a class="message" href="#SCI_STYLESETITALIC">SCI_STYLESETITALIC(int style, bool
italic)</a><br />
<a class="message" href="#SCI_STYLEGETITALIC">SCI_STYLEGETITALIC(int style) &rarr; bool</a><br />
@@ -3407,6 +3409,8 @@ struct Sci_TextToFindFull {
<b id="SCI_STYLEGETBOLD">SCI_STYLEGETBOLD(int style) &rarr; bool</b><br />
<b id="SCI_STYLESETWEIGHT">SCI_STYLESETWEIGHT(int style, int weight)</b><br />
<b id="SCI_STYLEGETWEIGHT">SCI_STYLEGETWEIGHT(int style) &rarr; int</b><br />
+ <b id="SCI_STYLESETSTRETCH">SCI_STYLESETSTRETCH(int style, int stretch)</b><br />
+ <b id="SCI_STYLEGETSTRETCH">SCI_STYLEGETSTRETCH(int style) &rarr; int</b><br />
<b id="SCI_STYLESETITALIC">SCI_STYLESETITALIC(int style, bool italic)</b><br />
<b id="SCI_STYLEGETITALIC">SCI_STYLEGETITALIC(int style) &rarr; bool</b><br />
These messages (plus <a class="message"
@@ -3435,6 +3439,68 @@ struct Sci_TextToFindFull {
The <code>SCI_STYLESETBOLD</code> message takes a boolean argument with 0 choosing <code>SC_WEIGHT_NORMAL</code>
and 1 <code>SC_WEIGHT_BOLD</code>.
</p>
+ <p>The stretch of a font can be set with <code>SCI_STYLESETSTRETCH</code> which can produce condensed or expanded text.
+ The weight is a number between 1 and 9 which corresponds to a horizontal magnification between 50% and 200%
+ with 1 being very condensed, 5 normal, and 9 very expanded.
+ While any value can be used, fonts and platforms often only support between 2 and 3 stretches.
+ The best supported and useful values are
+ <code>SC_STRETCH_CONDENSED</code>,
+ <code>SC_STRETCH_NORMAL</code>, and
+ <code>SC_STRETCH_EXPANDED</code>.
+ The Inconsolata variable font supports many stretch values and can be useful for experimenting.
+ Condensed text can be used to display more text in a narrower window and expanded text may be used
+ for clearer text that is easier to read.
+ The API is based on the Cascading Style Sheets font-stretch property.
+ </p>
+ <table class="standard" summary="Stretch">
+ <tbody valign="top">
+ <tr>
+ <th align="left"><code>SC_STRETCH_ULTRA_CONDENSED</code></th>
+ <td>1</td>
+ <td>50%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_EXTRA_CONDENSED</code></th>
+ <td>2</td>
+ <td>62.5%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_CONDENSED</code></th>
+ <td>3</td>
+ <td>75%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_SEMI_CONDENSED</code></th>
+ <td>4</td>
+ <td>87.5%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_NORMAL</code></th>
+ <td>5</td>
+ <td>100%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_SEMI_EXPANDED</code></th>
+ <td>6</td>
+ <td>112.5%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_EXPANDED</code></th>
+ <td>7</td>
+ <td>125%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_EXTRA_EXPANDED</code></th>
+ <td>8</td>
+ <td>150%</td>
+ </tr>
+ <tr>
+ <th align="left"><code>SC_STRETCH_ULTRA_EXPANDED</code></th>
+ <td>9</td>
+ <td>200%</td>
+ </tr>
+ </tbody>
+ </table>
<p><b id="SCI_STYLESETUNDERLINE">SCI_STYLESETUNDERLINE(int style, bool
underline)</b><br />