plain_text library
Plain text documents (.txt, .md, logs and the like).
PlainTextView shows the lines a PlainTextController has loaded, with search highlights, wrapped or not.
Classes
- DocumentController
- What every format's controller does, so an app can build one toolbar, search bar and position display for all of them.
- DocumentLocation
- Where the reader is in a document: "page 3 of 12", "row 40 of 900".
- DocumentSearchState
- A search in a document: the query, how many times it occurs and which occurrence is current.
- DocumentViewerStrings
- The text the package's widgets show: messages, labels, tooltips and screen-reader descriptions. English by default.
- DocumentViewerStringsScope
- Gives the package's widgets below it strings instead of English.
- DocumentViewerTheme
- Colours the package's views use for search matches, as a ThemeExtension on the app's theme.
- PlainTextController
- Loads a plain-text document for PlainTextView: its lines, line wrap, zoom, search and the scroll position.
- PlainTextView
- Shows a PlainTextController's document as scrolling lines.
- PositionKeys
- Keys used in ReadingPosition maps, per reader.
- TextMatch
- One occurrence of a search in a plain-text document: on line line (from 0), starting at character start.
Enums
- DocumentLoadError
- Why a document couldn't be opened.
- DocumentStatus
- Where a DocumentController is in its document's life.
- DocumentUnit
- What DocumentLocation.current and DocumentLocation.count count.
Typedefs
-
ReadingPosition
= Map<
String, Object?> - A reader's saved place in a document, as plain JSON-safe values.