super_clipboard library
Classes
- ClipboardDataReader
- ClipboardEvents
- ClipboardReader
- Clipboard reader exposes contents of the clipboard.
- ClipboardReadEvent
- Event dispatched during a browser paste action (only available on web). Allows reading data from clipboard.
- ClipboardWriteEvent
- Event dispatched during copy and cut actions (only available on web). Allows writing data to clipboard. However this is generally more limited than ClipboardWriter and only allows writing text contents. It also does not support providing data asynchronously.
- ClipboardWriter
- Writes the provided data to the clipboard. The writer can be obtained using SystemClipboard.instance, if available, or from a ClipboardWriteEvent.
-
CustomValueFormat<
T extends Object> -
DataFormat<
T extends Object> - Base class for formats of data transferred to clipboard and drag & drop. This branches into ValueFormat for data values that need to be converted from and to platform specific formats (such as plain text, HTML snippet, uri) and FileFormat representing files that are processed without conversion (i.e. PNG, JPEG).
- DataReader
- DataReaderFile
- DataWriterItem
- Represents a single item in the clipboard. The item can have multiple renditions (each represented as entries in EncodedData). To get encoded data for values use DataFormat.call or DataFormat.lazy;
- EncodedData
- Clipboard data in platform specific format. Do not use directly.
- FileFormat
- Base format class for files that are in standardized formats and processed without conversion (i.e. PNG, JPEG).
- Formats
- NamedUri
-
PlatformCodec<
T extends Object> - Platform specific codec for a data format.
- PlatformDataProvider
- ReadProgress
- Progress of a read operation.
- SimpleFileFormat
-
SimplePlatformCodec<
T extends Object> -
SimpleValueFormat<
T extends Object> - SystemClipboard
-
ValueFormat<
T extends Object> - Format for values that need to be converted from and to platform specific formats (such as plain text, HTML snippet, uri).
- VirtualFileReceiver
- WriteProgress
- Progress of a write operation.
Enums
- VirtualFileStorage
- Preferred storage used when writing virtual file.
Typedefs
-
AsyncValueChanged<
T> = FutureOr< void> Function(T value) -
DataProvider<
T> = FutureOr< T> Function() - Callback to obtain data lazily. See DataFormat.lazy;
- PlatformFormat = String
- Platform specific name for data format. For example value for plain text for macOS and iOS would be 'public.utf8-plain-text', for android, Linux and web 'text/plain' and for windows 'NativeShell_CF_13', which maps to CF_UNICODETEXT (value of 13).
- VirtualFileEventSinkProvider = EventSink Function({required int fileSize})
- Returns stream sink for virtual file. File size must be provided before being able to write any content.
- VirtualFileProvider = void Function(VirtualFileEventSinkProvider sinkProvider, WriteProgress progress)
- Callback invoked when receiver requests a virtual file.