epub_pro library

Classes

Annotation
Base class for all annotation types.
AnnotationExport
Export data structure for annotations.
AnnotationStatistics
Statistics about annotations in a book.
AnnotationStorage
Abstract interface for annotation storage implementations.
BookmarkAnnotation
Represents a bookmark annotation.
CFI
EPUB Canonical Fragment Identifier (CFI) for precise positioning within EPUB content.
CFIAnnotationManager
Manages annotations (highlights, notes, bookmarks) using CFI for precise positioning.
CFIComparator
Utilities for comparing and sorting CFI objects.
CFILocation
Represents a resolved CFI location within an EPUB.
CFIPositionTracker
Tracks reading positions and progress using CFI for precise positioning.
CFIRange
Utilities for working with CFI ranges and text selections.
CFIStructureWithSplitInfo
CFI Structure extended with split information.
DOMDocument
Abstract representation of a DOM document.
DOMElement
Abstract representation of a DOM element.
DOMNode
Abstract representation of a DOM node for cross-platform compatibility.
DOMPosition
Represents a position within a DOM node.
DOMRange
Represents a range between two positions in the DOM.
DOMText
Abstract representation of a DOM text node.
EnumFromString<T>
EpubBook
Represents a complete EPUB book with all content loaded into memory.
EpubBookRef
Represents a reference to an EPUB book for lazy loading.
EpubBookSplitRef
A reference to an EPUB book that automatically splits long chapters.
EpubByteContentFile
EpubCFIManager
Manager for EPUB-specific CFI operations.
EpubChapter
Represents a chapter in an EPUB book.
EpubChapterRef
EpubChapterSplitRef
A reference to a part of a split chapter.
EpubContent
EpubContentFile
EpubGuide
EpubGuideReference
EpubManifest
EpubManifestItem
EpubMetadata
EpubMetadataCreator
EpubNavigation
EpubNavigationContent
EpubNavigationDocAuthor
EpubNavigationDocTitle
EpubNavigationHead
EpubNavigationHeadMeta
EpubNavigationLabel
EpubNavigationMap
EpubNavigationPoint
EpubPackage
EpubReader
A class that provides the primary interface to read EPUB files.
EpubSchema
EpubSpine
EpubSpineItemRef
EpubTextContentFile
EpubWriter
A class that provides functionality to write EPUB files.
HighlightAnnotation
Represents a highlight annotation.
Image
An Image is a container for ImageData and other various meta-data representing an image in memory.
NoteAnnotation
Represents a note annotation.
PartBoundary
Represents the character boundaries of a split chapter part.
PositionStorage
Abstract interface for position storage implementations.
ReadingMilestone
Represents a reading milestone during a session.
ReadingPosition
Represents a saved reading position.
ReadingProgress
Represents comprehensive reading progress information.
ReadingSession
Represents a reading session (group of milestones).
ReadingStatistics
Represents reading statistics for a book.
SplitAwareCFIManager
Enhanced CFI manager with split chapter awareness.
SplitCFI
A CFI extension that provides precise positioning within split chapters.
SplitCFIConverter
Converter for translating between Split CFI and Standard CFI formats.
SplitCFILocation
Enhanced CFI location that includes split chapter information.
SplitCFIParser
Parser extension for Split CFI notation.
SplitChapterPositionMapper
Maps positions between split chapters and their original chapters.
SplitInfo
Information about split part extracted from CFI string.
SyncData
Data structure for synchronizing reading data between devices.
XMLDOMDocument
XML-based implementation of the DOM abstraction using the xml package.
XMLDOMElement
XML-based implementation of DOMElement.
XMLDOMNode
XML-based implementation of DOMNode.
XMLDOMText
XML-based implementation of DOMText.

Enums

AnnotationType
Types of annotations.
DOMNodeType
Types of DOM nodes.
EpubContentType
EpubVersion
MergeStrategy
Strategies for merging imported annotations.

Extensions

CFISplitDetection on CFI
Extension to add split CFI detection to base CFI class.
EpubBookRefCFI on EpubBookRef
CFI extensions for EpubBookRef to add navigation and CFI generation capabilities.
EpubChapterRefCFI on EpubChapterRef
CFI extensions for EpubChapterRef to add CFI generation and navigation.