Flag Enumeration

enum Flag : Enum<ScanReader.Flag>

Options controlling how recognised text is rendered into a string.

Entries

NONE

NONE

No optional recognition behaviour.

NL_AFTER_TEXT_BLOCKS

NL_AFTER_TEXT_BLOCKS

Start a new line after each block of text.

NL_AFTER_PARAGRAPHS

NL_AFTER_PARAGRAPHS

Start a new line after each paragraph.

NL_AFTER_TEXT_LINES

NL_AFTER_TEXT_LINES

Start a new line after each recognised line.

SP_BETWEEN_WORDS

SP_BETWEEN_WORDS

Separate words with a space.

SYMBOL_CONFIDENCE

SYMBOL_CONFIDENCE

Append the recogniser’s confidence for each symbol, for diagnostics.

Properties

entries

val entries: EnumEntries<ScanReader.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: ScanReader.Flag): EnumSet<ScanReader.Flag>

Combines two flags into a set.

valueOf

fun valueOf(value: String): ScanReader.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<ScanReader.Flag>

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

Top