From e8eebb2c38bebb1939ddd9024edc0d294516808f Mon Sep 17 00:00:00 2001 From: Carsten Seeger Date: Mon, 5 Feb 2024 12:05:55 +0100 Subject: [PATCH] feat: disableClipboard --- .../config/editor/editor_configurations.dart | 11 +++++++++++ .../raw_editor/raw_editor_configurations.dart | 9 +++++++++ lib/src/widgets/editor/editor.dart | 1 + lib/src/widgets/others/text_selection.dart | 8 +++++--- .../widgets/raw_editor/raw_editor_state.dart | 19 ++++++++++++------- 5 files changed, 38 insertions(+), 10 deletions(-) diff --git a/lib/src/models/config/editor/editor_configurations.dart b/lib/src/models/config/editor/editor_configurations.dart index d6a4ecb1..74fb7fa4 100644 --- a/lib/src/models/config/editor/editor_configurations.dart +++ b/lib/src/models/config/editor/editor_configurations.dart @@ -33,6 +33,7 @@ class QuillEditorConfigurations extends Equatable { this.expands = false, this.placeholder, this.readOnly = false, + this.disableClipboard = false, this.textSelectionThemeData, this.showCursor, this.paintCursorAboveText, @@ -92,6 +93,14 @@ class QuillEditorConfigurations extends Equatable { /// Defaults to `false`. Must not be `null`. final bool readOnly; + /// Disable Clipboard features + /// + /// when this is set to `true` clipboard can not be used + /// this disables the clipboard notification for requesting permissions + /// + /// Defaults to `false`. Must not be `null`. + final bool disableClipboard; + /// Whether this editor should create a scrollable container for its content. /// /// When set to `true` the editor's height can be controlled by [minHeight], @@ -342,6 +351,7 @@ class QuillEditorConfigurations extends Equatable { QuillController? controller, String? placeholder, bool? readOnly, + bool? disableClipboard, bool? scrollable, double? scrollBottomInset, EdgeInsetsGeometry? padding, @@ -389,6 +399,7 @@ class QuillEditorConfigurations extends Equatable { controller: controller ?? this.controller, placeholder: placeholder ?? this.placeholder, readOnly: readOnly ?? this.readOnly, + disableClipboard: disableClipboard ?? this.disableClipboard, scrollable: scrollable ?? this.scrollable, scrollBottomInset: scrollBottomInset ?? this.scrollBottomInset, padding: padding ?? this.padding, diff --git a/lib/src/models/config/raw_editor/raw_editor_configurations.dart b/lib/src/models/config/raw_editor/raw_editor_configurations.dart index abe92a04..65342949 100644 --- a/lib/src/models/config/raw_editor/raw_editor_configurations.dart +++ b/lib/src/models/config/raw_editor/raw_editor_configurations.dart @@ -50,6 +50,7 @@ class QuillRawEditorConfigurations extends Equatable { this.scrollable = true, this.padding = EdgeInsets.zero, this.readOnly = false, + this.disableClipboard = false, this.placeholder, this.onLaunchUrl, this.contextMenuBuilder = defaultContextMenuBuilder, @@ -99,6 +100,14 @@ class QuillRawEditorConfigurations extends Equatable { /// Defaults to false. Must not be null. final bool readOnly; + /// Disable Clipboard features + /// + /// when this is set to true clipboard can not be used + /// this disables the clipboard notification for requesting permissions + /// + /// Defaults to false. Must not be null. + final bool disableClipboard; + final String? placeholder; /// Callback which is triggered when the user wants to open a URL from diff --git a/lib/src/widgets/editor/editor.dart b/lib/src/widgets/editor/editor.dart index c2f4d982..e66d91b9 100644 --- a/lib/src/widgets/editor/editor.dart +++ b/lib/src/widgets/editor/editor.dart @@ -235,6 +235,7 @@ class QuillEditorState extends State scrollBottomInset: configurations.scrollBottomInset, padding: configurations.padding, readOnly: configurations.readOnly, + disableClipboard: configurations.disableClipboard, placeholder: configurations.placeholder, onLaunchUrl: configurations.onLaunchUrl, contextMenuBuilder: showSelectionToolbar diff --git a/lib/src/widgets/others/text_selection.dart b/lib/src/widgets/others/text_selection.dart index 8016201f..4a11cf5c 100644 --- a/lib/src/widgets/others/text_selection.dart +++ b/lib/src/widgets/others/text_selection.dart @@ -70,8 +70,8 @@ class EditorTextSelectionOverlay { required this.debugRequiredFor, required this.selectionCtrls, required this.selectionDelegate, - required this.clipboardStatus, required this.contextMenuBuilder, + this.clipboardStatus, this.onSelectionHandleTapped, this.dragStartBehavior = DragStartBehavior.start, this.handlesVisible = false, @@ -82,7 +82,9 @@ class EditorTextSelectionOverlay { // our listener being created // we won't know the status unless there is forced update // i.e. occasionally no paste - clipboardStatus.update(); + if (clipboardStatus != null) { + clipboardStatus!.update(); + } } TextEditingValue value; @@ -167,7 +169,7 @@ class EditorTextSelectionOverlay { /// /// Useful because the actual value of the clipboard can only be checked /// asynchronously (see [Clipboard.getData]). - final ClipboardStatusNotifier clipboardStatus; + final ClipboardStatusNotifier? clipboardStatus; /// A pair of handles. If this is non-null, there are always 2, though the /// second is hidden when the selection is collapsed. diff --git a/lib/src/widgets/raw_editor/raw_editor_state.dart b/lib/src/widgets/raw_editor/raw_editor_state.dart index 37ee67b7..dec2ca5c 100644 --- a/lib/src/widgets/raw_editor/raw_editor_state.dart +++ b/lib/src/widgets/raw_editor/raw_editor_state.dart @@ -97,7 +97,7 @@ class QuillRawEditorState extends EditorState String get pastePlainText => _pastePlainText; String _pastePlainText = ''; - final ClipboardStatusNotifier _clipboardStatus = ClipboardStatusNotifier(); + ClipboardStatusNotifier? _clipboardStatus; final LayerLink _toolbarLayerLink = LayerLink(); final LayerLink _startHandleLayerLink = LayerLink(); final LayerLink _endHandleLayerLink = LayerLink(); @@ -319,7 +319,8 @@ class QuillRawEditorState extends EditorState /// Copied from [EditableTextState]. List get contextMenuButtonItems { return EditableText.getEditableButtonItems( - clipboardStatus: _clipboardStatus.value, +// clipboardStatus: _clipboardStatus.value, + clipboardStatus: null, onCopy: copyEnabled ? () => copySelection(SelectionChangedCause.toolbar) : null, @@ -522,6 +523,10 @@ class QuillRawEditorState extends EditorState ), ); + if (!widget.configurations.disableClipboard) { + _clipboardStatus = ClipboardStatusNotifier(); + } + if (widget.configurations.scrollable) { /// Since [SingleChildScrollView] does not implement /// `computeDistanceToActualBaseline` it prevents the editor from @@ -1117,7 +1122,7 @@ class QuillRawEditorState extends EditorState void initState() { super.initState(); - _clipboardStatus.addListener(_onChangedClipboardStatus); +// _clipboardStatus.addListener(_onChangedClipboardStatus); controller.addListener(_didChangeTextEditingValueListener); @@ -1271,9 +1276,9 @@ class QuillRawEditorState extends EditorState controller.removeListener(_didChangeTextEditingValueListener); widget.configurations.focusNode.removeListener(_handleFocusChanged); _cursorCont.dispose(); - _clipboardStatus - ..removeListener(_onChangedClipboardStatus) - ..dispose(); + //_clipboardStatus + // ..removeListener(_onChangedClipboardStatus) + // ..dispose(); super.dispose(); } @@ -1371,7 +1376,7 @@ class QuillRawEditorState extends EditorState renderObject: renderEditor, selectionCtrls: widget.configurations.selectionCtrls, selectionDelegate: this, - clipboardStatus: _clipboardStatus, + //clipboardStatus: _clipboardStatus, contextMenuBuilder: widget.configurations.contextMenuBuilder == null ? null : (context) =>