EpubViewer class

Inheritance

Constructors

EpubViewer({Key? key, required EpubController epubController, required EpubSource epubSource, String? initialCfi, ValueChanged<List<EpubChapter>>? onChaptersLoaded, VoidCallback? onEpubLoaded, ValueChanged<EpubLocation>? onRelocated, ValueChanged<EpubTextSelection>? onTextSelected, EpubDisplaySettings? displaySettings, ContextMenu? selectionContextMenu, ValueChanged<String>? onAnnotationClicked})
const

Properties

displaySettings EpubDisplaySettings?
initial display settings
final
epubController EpubController
Epub controller to manage epub
final
epubSource EpubSource
Epub source, accepts url, file or assets opf format is not tested, use with caution
final
hashCode int
The hash code for this object.
no setterinherited
initialCfi String?
Initial cfi string to specify which part of epub to load initially if null, the first chapter will be loaded
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onAnnotationClicked ValueChanged<String>?
Callback for handling annotation click (Highlight and Underline)
final
onChaptersLoaded ValueChanged<List<EpubChapter>>?
Call back when chapters are loaded
final
onEpubLoaded VoidCallback?
Call back when epub is loaded and displayed
final
onRelocated ValueChanged<EpubLocation>?
Call back when epub page changes
final
onTextSelected ValueChanged<EpubTextSelection>?
Call back when text selection changes
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectionContextMenu ContextMenu?
context menu for text selection if null, the default context menu will be used
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<EpubViewer>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited