glok-core/uk.co.nickthecoder.glok.text

Package-level declarations

Types

class BitmapFont(val identifier: FontIdentifier, val texture: Texture, val glyphDataMap: Map<Char, BitmapGlyphData?>, val height: Float, val ascent: Float, val descent: Float, val top: Float, val bottom: Float, val italicInverseSlope: Float) : Font

BitmapFontBuilder

interface BitmapFontBuilder

BitmapFontBuilderFromCanvas

class BitmapFontBuilderFromCanvas(val identifier: FontIdentifier) : BitmapFontBuilder

The internal workhorse behind createBitmapFont.

BitmapGlyphData

data class BitmapGlyphData(val x: Float, val y: Float, val boundsTop: Float, val boundsRight: Float, val boundsBottom: Float, val boundsLeft: Float, val advance: Float)

DeleteString

interface DeleteString : StringChange

DeleteText

interface DeleteText : TextChange

FindAndReplace

class FindAndReplace

Performs find/replace on a StyledTextArea.

FindAndReplaceCommands

object FindAndReplaceCommands : Commands

Commands used by FindAndReplace

FindBar

class FindBar(val findAndReplace: FindAndReplace) : WrappedNode<ToolBar>

Font

interface Font

FontCache

object FontCache

FontIdentifier

data class FontIdentifier(val family: String, val size: Float, val style: FontStyle = FontStyle.PLAIN)

FontStyle

enum FontStyle : Enum<FontStyle>

GlyphMissingException

class GlyphMissingException(val c: Char) : Exception

GotoDialog

class GotoDialog(val textArea: TextAreaBase<*>) : Dialog

Highlight

interface Highlight

Highlights a piece of Text within a StyledTextDocument.

HighlightRange

open class HighlightRange(from: TextPosition, to: TextPosition, val highlight: Highlight, val owner: Any? = null)

Indentation

interface Indentation

Determines how TextArea and StyledTextArea should display leading tab and space characters, and the behaviour when the tab key is pressed.

InsertString

interface InsertString : StringChange

InsertText

interface InsertText : TextChange

PairedHighlightRange

class PairedHighlightRange(start: TextPosition, end: TextPosition, val highlight: Highlight, val owner: Any? = null, other: PairedHighlightRange?) : HighlightRange

A HighlightRange, which is part of a matched pair, for example, an opening and closing bracket.

RemoveRange

interface RemoveRange : StyledTextChange

ReplaceBar

class ReplaceBar(val findAndReplace: FindAndReplace) : WrappedNode<ToolBar>

SealedTextDocument

sealed class SealedTextDocument : HistoryDocumentBase

SkipWord

interface SkipWord

When you hold Ctrl and press the Left or Right arrow keys, it jumps by 1 word. However, what is considered a word isn't clear, and can depend on the context.

SkipWordByCategory

class SkipWordByCategory(val preSkipWhitespace: Boolean = true, val categories: List<(Char) -> Boolean>) : SkipWord

Each character is assigned a category. We skip over character which have the same category as the character at the start point.

SpacesToTabsConverter

class SpacesToTabsConverter(val columns: Int = 4) : Converter<String, String>

StringChange

sealed interface StringChange : Change

A Change for the HistoryDocuments (used by TextFields).

StringDocument

class StringDocument(initialText: String) : HistoryDocumentBase

The HistoryDocument used by TextField.

StyledTextChange

interface StyledTextChange : TextChange

StyledTextDocument

class StyledTextDocument(initialText: String) : TextDocument

TextChange

interface TextChange : Change

A Change for TextDocuments (used by TextAreas and StyledTextAreas).

TextDocument

open class TextDocument(initialText: String) : SealedTextDocument

A TextArea is a view of a TextDocument. Two or more TextAreas can share the same TextDocument. (e.g. a SplitPane with two views of the same documents side by side).

TextVAlignment

enum TextVAlignment : Enum<TextVAlignment>

ThemedHighlight

open class ThemedHighlight(val style: String) : Highlight

Applies a Theme rule (using Node.styles) to the highlighted Text.

Functions

createBitmapFont

expect fun createBitmapFont(identifier: FontIdentifier, block: BitmapFontBuilder.() -> Unit? = null): BitmapFont

actual fun createBitmapFont(identifier: FontIdentifier, block: BitmapFontBuilder.() -> Unit?): BitmapFont

Example :

internal_allFontFamilies

actual fun internal_allFontFamilies(): List<String>

To prevent fingerprinting, there is no API to list available fonts. Se instead, we return the so called "Web-Safe Fonts" which many websites assume exist on the client machine.

actual fun internal_allFontFamilies(): List<String>