Flag Enumeration

enum Flag : Enum<ScanText.Flag>

Options controlling how recognised text is rendered into a string.

Entries

APPEND_LOCALE

APPEND_LOCALE

Include the language each run of text was recognised in.

APPEND_TYPEFACE

APPEND_TYPEFACE

Include the font name, where the recogniser identified one.

APPEND_FONT_SIZE

APPEND_FONT_SIZE

Include the font size in points, where the recogniser identified one.

APPEND_FONT_SIZE_DIP

APPEND_FONT_SIZE_DIP

Include the font size in density-independent pixels.

APPEND_STYLE

APPEND_STYLE

Include text styling such as bold and italic.

APPEND_UNCERTAIN

APPEND_UNCERTAIN

Append color span for uncertain symbols.

Properties

entries

val entries: EnumEntries<ScanText.Flag>

Returns a representation of an immutable list of all enum entries, in the order they’re declared.

name

val name: String

ordinal

val ordinal: Int

Functions

or

infix fun or(other: ScanText.Flag): EnumSet<ScanText.Flag>

Combines two flags into a set.

valueOf

fun valueOf(value: String): ScanText.Flag

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ScanText.Flag>

Returns an array containing the constants of this enum type, in the order they’re declared.