Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add documentation for selectable

Browse Source
This commit is contained in:
Lucas.Xu
2022-08-16 18:34:37 +08:00
parent 35d5bc92ac
commit 2c2127e84a
1 changed files with 24 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
frontend/app_flowy/packages/flowy_editor/lib/src/render/selection/selectable.dart
View File

@ -2,33 +2,40 @@ import 'package:flowy_editor/src/document/position.dart';
import 'package:flowy_editor/src/document/selection.dart'; import 'package:flowy_editor/src/document/selection.dart';
import 'package:flutter/material.dart'; import 'package:flutter/material.dart';
/// [Selectable] is used for the editor to calculate the position
/// and size of the selection.
///
/// The widget returned by NodeWidgetBuilder must be with [Selectable],
/// otherwise the [FlowySelectionService] will not work properly.
/// ///
mixin Selectable<T extends StatefulWidget> on State<T> { mixin Selectable<T extends StatefulWidget> on State<T> {
/// Returns a [List] of the [Rect] selection surrounded by start and end /// Returns the [Selection] surrounded by start and end
/// in current widget. /// in current widget.
/// ///
/// [start] and [end] are the offsets under the global coordinate system. /// [start] and [end] are the offsets under the global coordinate system.
/// ///
/// The return result must be a [List] of the [Rect]
/// under the local coordinate system.
Selection getSelectionInRange(Offset start, Offset end); Selection getSelectionInRange(Offset start, Offset end);
/// Returns a [List] of the [Rect] area within selection
/// in current widget.
///
/// The return result must be a [List] of the [Rect]
/// under the local coordinate system.
List<Rect> getRectsInSelection(Selection selection); List<Rect> getRectsInSelection(Selection selection);
/// Returns a [Rect] for the offset in current widget. /// Returns [Position] for the offset in current widget.
/// ///
/// [start] is the offset of the global coordination system. /// [start] is the offset of the global coordination system.
Position getPositionInOffset(Offset start);
/// Returns [Rect] for the position in current widget.
/// ///
/// The return result must be an offset of the local coordinate system. /// The return result must be an offset of the local coordinate system.
Position getPositionInOffset(Offset start);
Selection? getWorldBoundaryInOffset(Offset start) {
return null;
}
Rect? getCursorRectInPosition(Position position) { Rect? getCursorRectInPosition(Position position) {
return null; return null;
} }
/// Return global offset from local offset.
Offset localToGlobal(Offset offset); Offset localToGlobal(Offset offset);
Position start(); Position start();
@ -36,9 +43,15 @@ mixin Selectable<T extends StatefulWidget> on State<T> {
/// For [TextNode] only. /// For [TextNode] only.
/// ///
/// Returns a [TextSelection] or [Null].
///
/// Only the widget rendered by [TextNode] need to implement the detail, /// Only the widget rendered by [TextNode] need to implement the detail,
/// and the rest can return null. /// and the rest can return null.
TextSelection? getTextSelectionInSelection(Selection selection) => null; TextSelection? getTextSelectionInSelection(Selection selection) => null;
/// For [TextNode] only.
///
/// Only the widget rendered by [TextNode] need to implement the detail,
/// and the rest can return null.
Selection? getWorldBoundaryInOffset(Offset start) {
return null;
}
} }