flutter_pdfview_platform_interface library

The common platform interface for the flutter_pdfview plugin.

Platform implementations should extend FlutterPdfViewPlatform and register themselves by assigning to FlutterPdfViewPlatform.instance. App authors should depend on package:flutter_pdfview/flutter_pdfview.dart instead of this package.

Classes

FlutterPdfViewPlatform
The interface every platform implementation of flutter_pdfview implements.
MethodChannelFlutterPdfView
The default FlutterPdfViewPlatform, backed by method channels.
MethodChannelPdfViewController
Drives one native PDF view over its per-view method channel.
PdfViewCallbacks
The callbacks a platform implementation invokes as the native viewer reports events.
PdfViewCreationParams
The parameters handed to a native PDF view when it is first created.
PdfViewPlatformController
Drives a single PDF view that a platform implementation has created.
PdfViewSettings
A snapshot of the mutable settings of a PDF view.

Enums

FitPolicy
Determines how the pages of a document are scaled to fit the viewport.
PageAlignment
How a document that is shorter than the viewport is placed inside it.
PdfColorMode
Color theme for PDF page content and the gutter behind it.
PDFPasswordFailure
Why an encrypted document could not be opened.

Constants

kPdfViewType → const String
The view type registered by the native plugins on both platforms.

Typedefs

DrawCallback = void Function(double pdfXOffset, double pdfYOffset, double pdfScale)
Signature for the callback that is invoked while the document is drawn, reporting the current horizontal offset, vertical offset and zoom scale.
ErrorCallback = void Function(dynamic error)
Signature for the callback that is invoked when the native viewer fails to open a document, reporting the platform error.
LinkHandlerCallback = void Function(String? uri)
Signature for the callback that is invoked when a link inside the document is tapped, reporting the target uri.
LoadCompleteCallback = void Function(int? pages)
Signature for the callback that is invoked once the document has finished loading, reporting the number of pages it contains.
PageChangedCallback = void Function(int? page, int? total)
Signature for the callback that is invoked when the visible page changes, reporting the zero-based page index and the total number of pages.
PageErrorCallback = void Function(int? page, dynamic error)
Signature for the callback that is invoked when a single page cannot be rendered, reporting the zero-based page index and the platform error.
PasswordRequiredCallback = void Function(PDFPasswordFailure failure)
Signature for the callback that is invoked when an encrypted document could not be opened, reporting why in failure.
RenderCallback = void Function(int? pages)
Signature for the callback that is invoked when the document has been rendered, reporting the number of pages it contains.
TapCallback = void Function()
Signature for the callback that is invoked when the user single-taps the PDF view.