This commit is contained in:
Brad Robinson 2020-09-02 10:01:50 +10:00
Родитель 192907270c
Коммит cb5ff31fca
12 изменённых файлов: 585 добавлений и 0 удалений

Просмотреть файл

@ -43,6 +43,24 @@ navTree:
- text: Properties - text: Properties
subItems: subItems:
- text: IsNone|./ref/Topten.RichTextKit.CaretInfo.IsNone - text: IsNone|./ref/Topten.RichTextKit.CaretInfo.IsNone
- text: FontFallback
subItems:
- text: Overview|./ref/Topten.RichTextKit.FontFallback
- text: Constructors|./ref/Topten.RichTextKit.FontFallback..ctor
- text: Fields
subItems:
- text: CharacterMatcher|./ref/Topten.RichTextKit.FontFallback.CharacterMatcher
- text: Methods
subItems:
- text: GetFontRuns|./ref/Topten.RichTextKit.FontFallback.GetFontRuns
- text: FontFallback.Run
subItems:
- text: Overview|./ref/Topten.RichTextKit.FontFallback.Run
- text: Fields
subItems:
- text: Length|./ref/Topten.RichTextKit.FontFallback.Run.Length
- text: Start|./ref/Topten.RichTextKit.FontFallback.Run.Start
- text: Typeface|./ref/Topten.RichTextKit.FontFallback.Run.Typeface
- text: FontMapper - text: FontMapper
subItems: subItems:
- text: Overview|./ref/Topten.RichTextKit.FontMapper - text: Overview|./ref/Topten.RichTextKit.FontMapper
@ -107,6 +125,12 @@ navTree:
- text: Properties - text: Properties
subItems: subItems:
- text: IsNone|./ref/Topten.RichTextKit.HitTestResult.IsNone - text: IsNone|./ref/Topten.RichTextKit.HitTestResult.IsNone
- text: ICharacterMatcher
subItems:
- text: Overview|./ref/Topten.RichTextKit.ICharacterMatcher
- text: Methods
subItems:
- text: MatchCharacter|./ref/Topten.RichTextKit.ICharacterMatcher.MatchCharacter
- text: IStyle - text: IStyle
subItems: subItems:
- text: Overview|./ref/Topten.RichTextKit.IStyle - text: Overview|./ref/Topten.RichTextKit.IStyle

Просмотреть файл

@ -0,0 +1,37 @@
---
title: "FontFallback..ctor"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">FontFallback Constructor</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback">FontFallback</a><br />
</small>
</p>
<pre class="language-csharp"><code class="language-csharp">public FontFallback();</code></pre>

Просмотреть файл

@ -0,0 +1,40 @@
---
title: "FontFallback.CharacterMatcher"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">FontFallback.CharacterMatcher Field</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback">FontFallback</a><br />
</small>
</p>
<p>Specifies the instance of the character matcher to be used for font fallback</p>
<pre class="language-csharp"><code class="language-csharp">public static ICharacterMatcher CharacterMatcher;</code></pre>
<h2 id="remarks">Remarks</h2><p>This instance is shared by all TextBlock instances and should be thread safe
if used in a multi-threaded environment.</p>
<h2 id="field-type">Field Type</h2> <table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.ICharacterMatcher">ICharacterMatcher</a></td>
<td></td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,63 @@
---
title: "FontFallback.GetFontRuns"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">FontFallback.GetFontRuns Method</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback">FontFallback</a><br />
</small>
</p>
<p>Splits a sequence of code points into a series of runs with font fallback applied</p>
<pre class="language-csharp"><code class="language-csharp">[Runtime.CompilerServices.IteratorStateMachine(Topten.RichTextKit.FontFallback&#x2B;&lt;GetFontRuns&gt;d__2)]&#xD;&#xA;public static IEnumerable&lt;Run&gt; GetFontRuns(Utils.Slice&lt;int&gt; codePoints, SkiaSharp.SKTypeface typeface);</code></pre>
<h2 id="parameters">Parameters</h2> <table class="name-description">
<tr>
<td>
<a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Utils.Slice&lt;int&gt;</a> codePoints
</td>
<td><p>The code points</p>
</td>
</tr>
<tr>
<td>
SkiaSharp.SKTypeface typeface
</td>
<td><p>The preferred typeface</p>
</td>
</tr>
</table>
<h2 id="returns">Returns</h2> <table class="name-description">
<tr>
<td><a href="https://docs.microsoft.com/dotnet/api/System.Collections.Generic.IEnumerable-1">IEnumerable&lt;Run&gt;</a></td>
<td><p>A sequence of runs with unsupported code points replaced by a selected font fallback</p>
</td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,38 @@
---
title: "FontFallback.Run.Length"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">FontFallback.Run.Length Field</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback.Run">FontFallback.Run</a><br />
</small>
</p>
<p>The length of this run in code points</p>
<pre class="language-csharp"><code class="language-csharp">public int Length;</code></pre>
<h2 id="field-type">Field Type</h2> <table class="name-description">
<tr>
<td><a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a></td>
<td></td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,38 @@
---
title: "FontFallback.Run.Start"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">FontFallback.Run.Start Field</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback.Run">FontFallback.Run</a><br />
</small>
</p>
<p>The starting code point index of this run</p>
<pre class="language-csharp"><code class="language-csharp">public int Start;</code></pre>
<h2 id="field-type">Field Type</h2> <table class="name-description">
<tr>
<td><a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a></td>
<td></td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,38 @@
---
title: "FontFallback.Run.Typeface"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">FontFallback.Run.Typeface Field</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback.Run">FontFallback.Run</a><br />
</small>
</p>
<p>The typeface to be used for this run</p>
<pre class="language-csharp"><code class="language-csharp">public SkiaSharp.SKTypeface Typeface;</code></pre>
<h2 id="field-type">Field Type</h2> <table class="name-description">
<tr>
<td>SkiaSharp.SKTypeface</td>
<td></td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,65 @@
---
title: "Topten.RichTextKit.FontFallback.Run"
isMarkdown: false
import: "../.common.page"
---
<h1 id="definition" data-nav-secondary-text="Definition">FontFallback.Run Struct</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.FontFallback">FontFallback</a><br />
</small>
</p>
<p>Specified details about a font fallback run</p>
<pre class="language-csharp"><code class="language-csharp">public struct FontFallback.Run</code></pre>
<h2 id="inherits">Inheritance</h2>
<p>
FontFallback.Run
&rarr; <a href="https://docs.microsoft.com/dotnet/api/System.ValueType">ValueType</a> &rarr; <a href="https://docs.microsoft.com/dotnet/api/System.Object">object</a> </p>
<h2 id="fields">Fields</h2>
<table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.Run.Length">Length</a></td>
<td><p>The length of this run in code points</p>
</td>
</tr>
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.Run.Start">Start</a></td>
<td><p>The starting code point index of this run</p>
</td>
</tr>
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.Run.Typeface">Typeface</a></td>
<td><p>The typeface to be used for this run</p>
</td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,78 @@
---
title: "Topten.RichTextKit.FontFallback"
isMarkdown: false
import: "../.common.page"
---
<h1 id="definition" data-nav-secondary-text="Definition">FontFallback Class</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
</small>
</p>
<p>Helper to split a run of code points based on a particular typeface
into a series of runs where unsupported code points are mapped to a
fallback font.</p>
<pre class="language-csharp"><code class="language-csharp">public class FontFallback</code></pre>
<h2 id="inherits">Inheritance</h2>
<p>
FontFallback
&rarr; <a href="https://docs.microsoft.com/dotnet/api/System.Object">object</a> </p>
<h2 id="constructors">Constructors</h2>
<table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback..ctor">FontFallback()</a></td>
<td></td>
</tr>
</table>
<h2 id="fields">Fields</h2>
<table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.CharacterMatcher">CharacterMatcher</a></td>
<td><p>Specifies the instance of the character matcher to be used for font fallback</p>
</td>
</tr>
</table>
<h2 id="methods">Methods</h2>
<table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.GetFontRuns">GetFontRuns(Utils.Slice&lt;int&gt;, SkiaSharp.SKTypeface)</a></td>
<td><p>Splits a sequence of code points into a series of runs with font fallback applied</p>
</td>
</tr>
</table>
<h2 id="nested-types">Nested Types</h2>
<table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.Run">FontFallback.Run</a></td>
<td><p>Specified details about a font fallback run</p>
</td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,95 @@
---
title: "ICharacterMatcher.MatchCharacter"
isMarkdown: false
import: "../.common.page"
---
<h1 data-nav-secondary-text="Definition" id="definition">ICharacterMatcher.MatchCharacter Method</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
Declaring Type: <a href="./../ref/Topten.RichTextKit.ICharacterMatcher">ICharacterMatcher</a><br />
</small>
</p>
<p>Provide a fallback typeface for a specified code point index</p>
<pre class="language-csharp"><code class="language-csharp">SkiaSharp.SKTypeface MatchCharacter(string familyName, int weight, int width, SkiaSharp.SKFontStyleSlant slant, string[] bcp47, int character);</code></pre>
<h2 id="parameters">Parameters</h2> <table class="name-description">
<tr>
<td>
<a href="https://docs.microsoft.com/dotnet/api/System.String">string</a> familyName
</td>
<td><p>The family name to use when searching.</p>
</td>
</tr>
<tr>
<td>
<a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a> weight
</td>
<td><p>The font weight to use when searching.</p>
</td>
</tr>
<tr>
<td>
<a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a> width
</td>
<td><p>The font width to use when searching.</p>
</td>
</tr>
<tr>
<td>
SkiaSharp.SKFontStyleSlant slant
</td>
<td><p>The font slant to use when searching.</p>
</td>
</tr>
<tr>
<td>
<a href="https://docs.microsoft.com/dotnet/api/System.String">string</a>[] bcp47
</td>
<td><p>The ISO 639, 15924, and 3166-1 code to use when searching, such as &quot;ja&quot; and &quot;zh&quot;.</p>
</td>
</tr>
<tr>
<td>
<a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a> character
</td>
<td><p>The character to find a typeface for.</p>
</td>
</tr>
</table>
<h2 id="returns">Returns</h2> <table class="name-description">
<tr>
<td>SkiaSharp.SKTypeface</td>
<td><p>Returns the SkiaSharp.SKTypeface that contains the given character, or null if none was found.</p>
</td>
</tr>
</table>

Просмотреть файл

@ -0,0 +1,52 @@
---
title: "Topten.RichTextKit.ICharacterMatcher"
isMarkdown: false
import: "../.common.page"
---
<h1 id="definition" data-nav-secondary-text="Definition">ICharacterMatcher Interface</h1>
<p>
<small>
Assembly: Topten.RichTextKit.dll<br />
Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
</small>
</p>
<p>Provides a mechanism to override the default font fallback character matching</p>
<pre class="language-csharp"><code class="language-csharp">public interface ICharacterMatcher</code></pre>
<h2 id="remarks">Remarks</h2>
<p>To override font fallback selection, assign an implementation of this interface
to the <a href="./../ref/Topten.RichTextKit.FontFallback.CharacterMatcher">FontFallback.CharacterMatcher</a> property.</p>
<h2 id="methods">Methods</h2>
<table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.ICharacterMatcher.MatchCharacter">MatchCharacter(string, int, int, SkiaSharp.SKFontStyleSlant, string[], int)</a></td>
<td><p>Provide a fallback typeface for a specified code point index</p>
</td>
</tr>
</table>

Просмотреть файл

@ -8,6 +8,13 @@ import: "../.common.page"
<h2 id="classes">Classes</h2> <h2 id="classes">Classes</h2>
<table class="name-description"> <table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback"> FontFallback</a></td>
<td><p>Helper to split a run of code points based on a particular typeface
into a series of runs where unsupported code points are mapped to a
fallback font.</p>
</td>
</tr>
<tr> <tr>
<td><a href="./../ref/Topten.RichTextKit.FontMapper"> FontMapper</a></td> <td><a href="./../ref/Topten.RichTextKit.FontMapper"> FontMapper</a></td>
<td><p>The FontMapper class is responsible for mapping style typeface information <td><p>The FontMapper class is responsible for mapping style typeface information
@ -68,6 +75,11 @@ style.</p>
<h2 id="interfaces">Interfaces</h2> <h2 id="interfaces">Interfaces</h2>
<table class="name-description"> <table class="name-description">
<tr>
<td><a href="./../ref/Topten.RichTextKit.ICharacterMatcher"> ICharacterMatcher</a></td>
<td><p>Provides a mechanism to override the default font fallback character matching</p>
</td>
</tr>
<tr> <tr>
<td><a href="./../ref/Topten.RichTextKit.IStyle"> IStyle</a></td> <td><a href="./../ref/Topten.RichTextKit.IStyle"> IStyle</a></td>
<td><p>Provides styling information for a run of text.</p> <td><p>Provides styling information for a run of text.</p>
@ -81,6 +93,11 @@ style.</p>
<td><a href="./../ref/Topten.RichTextKit.CaretInfo"> CaretInfo</a></td> <td><a href="./../ref/Topten.RichTextKit.CaretInfo"> CaretInfo</a></td>
<td><p>Used to return caret positioning information from the <td><p>Used to return caret positioning information from the
<a href="./../ref/Topten.RichTextKit.TextBlock.GetCaretInfo">TextBlock.GetCaretInfo(int)</a> method.</p> <a href="./../ref/Topten.RichTextKit.TextBlock.GetCaretInfo">TextBlock.GetCaretInfo(int)</a> method.</p>
</td>
</tr>
<tr>
<td><a href="./../ref/Topten.RichTextKit.FontFallback.Run"> FontFallback.Run</a></td>
<td><p>Specified details about a font fallback run</p>
</td> </td>
</tr> </tr>
<tr> <tr>