From cb5ff31fca87772e8179494de6da807146c65f8f Mon Sep 17 00:00:00 2001 From: Brad Robinson Date: Wed, 2 Sep 2020 10:01:50 +1000 Subject: [PATCH] Updated documentation --- doc/.common.page | 24 +++++ ...Topten.RichTextKit.FontFallback..ctor.page | 37 ++++++++ ...TextKit.FontFallback.CharacterMatcher.page | 40 ++++++++ ....RichTextKit.FontFallback.GetFontRuns.page | 63 ++++++++++++ ...n.RichTextKit.FontFallback.Run.Length.page | 38 ++++++++ ...en.RichTextKit.FontFallback.Run.Start.page | 38 ++++++++ ...RichTextKit.FontFallback.Run.Typeface.page | 38 ++++++++ .../Topten.RichTextKit.FontFallback.Run.page | 65 +++++++++++++ doc/ref/Topten.RichTextKit.FontFallback.page | 78 +++++++++++++++ ...tKit.ICharacterMatcher.MatchCharacter.page | 95 +++++++++++++++++++ .../Topten.RichTextKit.ICharacterMatcher.page | 52 ++++++++++ doc/ref/Topten.RichTextKit.page | 17 ++++ 12 files changed, 585 insertions(+) create mode 100644 doc/ref/Topten.RichTextKit.FontFallback..ctor.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.CharacterMatcher.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.GetFontRuns.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.Run.Length.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.Run.Start.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.Run.Typeface.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.Run.page create mode 100644 doc/ref/Topten.RichTextKit.FontFallback.page create mode 100644 doc/ref/Topten.RichTextKit.ICharacterMatcher.MatchCharacter.page create mode 100644 doc/ref/Topten.RichTextKit.ICharacterMatcher.page diff --git a/doc/.common.page b/doc/.common.page index 1eb276c..2e3f724 100644 --- a/doc/.common.page +++ b/doc/.common.page @@ -43,6 +43,24 @@ navTree: - text: Properties subItems: - 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 subItems: - text: Overview|./ref/Topten.RichTextKit.FontMapper @@ -107,6 +125,12 @@ navTree: - text: Properties subItems: - 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 subItems: - text: Overview|./ref/Topten.RichTextKit.IStyle diff --git a/doc/ref/Topten.RichTextKit.FontFallback..ctor.page b/doc/ref/Topten.RichTextKit.FontFallback..ctor.page new file mode 100644 index 0000000..234b2fc --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback..ctor.page @@ -0,0 +1,37 @@ +--- +title: "FontFallback..ctor" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback Constructor

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback
+ +

+ + + + + + + + + + +
public FontFallback();
+ + + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.CharacterMatcher.page b/doc/ref/Topten.RichTextKit.FontFallback.CharacterMatcher.page new file mode 100644 index 0000000..85463f2 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.CharacterMatcher.page @@ -0,0 +1,40 @@ +--- +title: "FontFallback.CharacterMatcher" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback.CharacterMatcher Field

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback
+ +

+ + + + +

Specifies the instance of the character matcher to be used for font fallback

+ + +
public static ICharacterMatcher CharacterMatcher;
+ +

Remarks

This instance is shared by all TextBlock instances and should be thread safe +if used in a multi-threaded environment.

+ +

Field Type

+ + + + +
ICharacterMatcher
+ + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.GetFontRuns.page b/doc/ref/Topten.RichTextKit.FontFallback.GetFontRuns.page new file mode 100644 index 0000000..a35e097 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.GetFontRuns.page @@ -0,0 +1,63 @@ +--- +title: "FontFallback.GetFontRuns" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback.GetFontRuns Method

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback
+ +

+ + + + + + + + +

Splits a sequence of code points into a series of runs with font fallback applied

+ + +
[Runtime.CompilerServices.IteratorStateMachine(Topten.RichTextKit.FontFallback+<GetFontRuns>d__2)]
public static IEnumerable<Run> GetFontRuns(Utils.Slice<int> codePoints, SkiaSharp.SKTypeface typeface);
+ + +

Parameters

+ + + + + + + + +
+ + Utils.Slice<int> codePoints +

The code points

+
+ + SkiaSharp.SKTypeface typeface +

The preferred typeface

+
+

Returns

+ + + + +
IEnumerable<Run>

A sequence of runs with unsupported code points replaced by a selected font fallback

+
+ + + + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.Run.Length.page b/doc/ref/Topten.RichTextKit.FontFallback.Run.Length.page new file mode 100644 index 0000000..46b0a4f --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.Run.Length.page @@ -0,0 +1,38 @@ +--- +title: "FontFallback.Run.Length" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback.Run.Length Field

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback.Run
+ +

+ + + + +

The length of this run in code points

+ + +
public int Length;
+ + +

Field Type

+ + + + +
int
+ + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.Run.Start.page b/doc/ref/Topten.RichTextKit.FontFallback.Run.Start.page new file mode 100644 index 0000000..0bc5462 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.Run.Start.page @@ -0,0 +1,38 @@ +--- +title: "FontFallback.Run.Start" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback.Run.Start Field

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback.Run
+ +

+ + + + +

The starting code point index of this run

+ + +
public int Start;
+ + +

Field Type

+ + + + +
int
+ + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.Run.Typeface.page b/doc/ref/Topten.RichTextKit.FontFallback.Run.Typeface.page new file mode 100644 index 0000000..e1ad482 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.Run.Typeface.page @@ -0,0 +1,38 @@ +--- +title: "FontFallback.Run.Typeface" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback.Run.Typeface Field

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback.Run
+ +

+ + + + +

The typeface to be used for this run

+ + +
public SkiaSharp.SKTypeface Typeface;
+ + +

Field Type

+ + + + +
SkiaSharp.SKTypeface
+ + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.Run.page b/doc/ref/Topten.RichTextKit.FontFallback.Run.page new file mode 100644 index 0000000..b24cc8b --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.Run.page @@ -0,0 +1,65 @@ +--- +title: "Topten.RichTextKit.FontFallback.Run" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback.Run Struct

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: FontFallback
+ +

+ + +

Specified details about a font fallback run

+ + +
public struct FontFallback.Run
+ +

Inheritance

+

+ FontFallback.Run + → ValueType → object

+ + + + + + + + +

Fields

+ + + + + + + + + + + + + +
Length

The length of this run in code points

+
Start

The starting code point index of this run

+
Typeface

The typeface to be used for this run

+
+ + + + + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.FontFallback.page b/doc/ref/Topten.RichTextKit.FontFallback.page new file mode 100644 index 0000000..696461c --- /dev/null +++ b/doc/ref/Topten.RichTextKit.FontFallback.page @@ -0,0 +1,78 @@ +--- +title: "Topten.RichTextKit.FontFallback" +isMarkdown: false +import: "../.common.page" +--- + +

FontFallback Class

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ +

+ + +

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.

+ + +
public class FontFallback
+ +

Inheritance

+

+ FontFallback + → object

+ + + + + +

Constructors

+ + + + + +
FontFallback()
+ + + +

Fields

+ + + + + +
CharacterMatcher

Specifies the instance of the character matcher to be used for font fallback

+
+ + +

Methods

+ + + + + +
GetFontRuns(Utils.Slice<int>, SkiaSharp.SKTypeface)

Splits a sequence of code points into a series of runs with font fallback applied

+
+ + + + + + + +

Nested Types

+ + + + + +
FontFallback.Run

Specified details about a font fallback run

+
+ + diff --git a/doc/ref/Topten.RichTextKit.ICharacterMatcher.MatchCharacter.page b/doc/ref/Topten.RichTextKit.ICharacterMatcher.MatchCharacter.page new file mode 100644 index 0000000..b24d0e5 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.ICharacterMatcher.MatchCharacter.page @@ -0,0 +1,95 @@ +--- +title: "ICharacterMatcher.MatchCharacter" +isMarkdown: false +import: "../.common.page" +--- + +

ICharacterMatcher.MatchCharacter Method

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ + Declaring Type: ICharacterMatcher
+ +

+ + + + + + + + +

Provide a fallback typeface for a specified code point index

+ + +
SkiaSharp.SKTypeface MatchCharacter(string familyName, int weight, int width, SkiaSharp.SKFontStyleSlant slant, string[] bcp47, int character);
+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + string familyName +

The family name to use when searching.

+
+ + int weight +

The font weight to use when searching.

+
+ + int width +

The font width to use when searching.

+
+ + SkiaSharp.SKFontStyleSlant slant +

The font slant to use when searching.

+
+ + string[] bcp47 +

The ISO 639, 15924, and 3166-1 code to use when searching, such as "ja" and "zh".

+
+ + int character +

The character to find a typeface for.

+
+

Returns

+ + + + +
SkiaSharp.SKTypeface

Returns the SkiaSharp.SKTypeface that contains the given character, or null if none was found.

+
+ + + + + + + diff --git a/doc/ref/Topten.RichTextKit.ICharacterMatcher.page b/doc/ref/Topten.RichTextKit.ICharacterMatcher.page new file mode 100644 index 0000000..971eaaf --- /dev/null +++ b/doc/ref/Topten.RichTextKit.ICharacterMatcher.page @@ -0,0 +1,52 @@ +--- +title: "Topten.RichTextKit.ICharacterMatcher" +isMarkdown: false +import: "../.common.page" +--- + +

ICharacterMatcher Interface

+ + +

+ + Assembly: Topten.RichTextKit.dll
+ Namespace: Topten.RichTextKit
+ +

+ + +

Provides a mechanism to override the default font fallback character matching

+ + +
public interface ICharacterMatcher
+ + + + +

Remarks

+

To override font fallback selection, assign an implementation of this interface +to the FontFallback.CharacterMatcher property.

+ + + + + + + +

Methods

+ + + + + +
MatchCharacter(string, int, int, SkiaSharp.SKFontStyleSlant, string[], int)

Provide a fallback typeface for a specified code point index

+
+ + + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.page b/doc/ref/Topten.RichTextKit.page index 0a78353..2f4c28a 100644 --- a/doc/ref/Topten.RichTextKit.page +++ b/doc/ref/Topten.RichTextKit.page @@ -8,6 +8,13 @@ import: "../.common.page"

Classes

+ + + +
FontFallback

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.

+
FontMapper

The FontMapper class is responsible for mapping style typeface information @@ -68,6 +75,11 @@ style.

Interfaces

+ + + + + + + +
ICharacterMatcher

Provides a mechanism to override the default font fallback character matching

+
IStyle

Provides styling information for a run of text.

@@ -81,6 +93,11 @@ style.

 CaretInfo

Used to return caret positioning information from the TextBlock.GetCaretInfo(int) method.

+
FontFallback.Run

Specified details about a font fallback run