@ckeditor/ckeditor5-engine 45.2.1 → 46.0.0-alpha.0

package/src/model/selection.d.ts

@@ -5,22 +5,22 @@
 /**
  * @module engine/model/selection
  */
-import TypeCheckable from './typecheckable.js';
-import Node from './node.js';
-import Position, { type PositionOffset } from './position.js';
-import Range from './range.js';
-import type DocumentSelection from './documentselection.js';
-import type Element from './element.js';
-import type Item from './item.js';
-declare const Selection_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
+import { ModelTypeCheckable } from './typecheckable.js';
+import { ModelNode } from './node.js';
+import { ModelPosition, type ModelPositionOffset } from './position.js';
+import { ModelRange } from './range.js';
+import { type ModelDocumentSelection } from './documentselection.js';
+import { type ModelElement } from './element.js';
+import { type ModelItem } from './item.js';
+declare const ModelSelection_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ModelTypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
- * Selection is a set of {@link module:engine/model/range~Range ranges}. It has a direction specified by its
- * {@link module:engine/model/selection~Selection#anchor anchor} and {@link module:engine/model/selection~Selection#focus focus}
- * (it can be {@link module:engine/model/selection~Selection#isBackward forward or backward}).
+ * Selection is a set of {@link module:engine/model/range~ModelRange ranges}. It has a direction specified by its
+ * {@link module:engine/model/selection~ModelSelection#anchor anchor} and {@link module:engine/model/selection~ModelSelection#focus focus}
+ * (it can be {@link module:engine/model/selection~ModelSelection#isBackward forward or backward}).
  * Additionally, selection may have its own attributes (think – whether text typed in in this selection
  * should have those attributes – e.g. whether you type a bolded text).
  */
-export default class Selection extends /* #__PURE__ */ Selection_base {
+export declare class ModelSelection extends /* #__PURE__ */ ModelSelection_base {
     /**
      * Specifies whether the last added range was added as a backward or forward range.
      */
@@ -30,9 +30,9 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      */
     protected _attrs: Map<string, unknown>;
     /** @internal */
-    _ranges: Array<Range>;
+    _ranges: Array<ModelRange>;
     /**
-     * Creates a new selection instance based on the given {@link module:engine/model/selection~Selectable selectable}
+     * Creates a new selection instance based on the given {@link module:engine/model/selection~ModelSelectable selectable}
      * or creates an empty selection if no arguments were passed.
      *
      * ```ts
@@ -65,11 +65,11 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * const paragraph = writer.createElement( 'paragraph' );
      * const selection = writer.createSelection( paragraph, offset );
      *
-     * // Creates a range inside an {@link module:engine/model/element~Element element} which starts before the
+     * // Creates a range inside an {@link module:engine/model/element~ModelElement element} which starts before the
      * // first child of that element and ends after the last child of that element.
      * const selection = writer.createSelection( paragraph, 'in' );
      *
-     * // Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends
+     * // Creates a range on an {@link module:engine/model/item~ModelItem item} which starts before the item and ends
      * // just after the item.
      * const selection = writer.createSelection( paragraph, 'on' );
      * ```
@@ -84,13 +84,13 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * @internal
      */
     constructor(...args: [] | [
-        selectable: Node,
-        placeOrOffset: PlaceOrOffset,
+        selectable: ModelNode,
+        placeOrOffset: ModelPlaceOrOffset,
         options?: {
             backward?: boolean;
         }
     ] | [
-        selectable?: Exclude<Selectable, Node>,
+        selectable?: Exclude<ModelSelectable, ModelNode>,
         options?: {
             backward?: boolean;
         }
@@ -102,15 +102,15 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * Anchor and {@link #focus} define the direction of the selection, which is important
      * when expanding/shrinking selection. The focus moves, while the anchor should remain in the same place.
      *
-     * Anchor is always set to the {@link module:engine/model/range~Range#start start} or
-     * {@link module:engine/model/range~Range#end end} position of the last of selection's ranges. Whether it is
+     * Anchor is always set to the {@link module:engine/model/range~ModelRange#start start} or
+     * {@link module:engine/model/range~ModelRange#end end} position of the last of selection's ranges. Whether it is
      * the `start` or `end` depends on the specified `options.backward`. See the {@link #setTo `setTo()`} method.
      *
      * May be set to `null` if there are no ranges in the selection.
      *
      * @see #focus
      */
-    get anchor(): Position | null;
+    get anchor(): ModelPosition | null;
     /**
      * Selection focus. Focus is the position where the selection ends. If a user is making a selection
      * by dragging the mouse, the focus is where the mouse cursor is.
@@ -119,7 +119,7 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      *
      * @see #anchor
      */
-    get focus(): Position | null;
+    get focus(): ModelPosition | null;
     /**
      * Whether the selection is collapsed. Selection is collapsed when there is exactly one range in it
      * and it is collapsed.
@@ -140,48 +140,48 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * @param otherSelection Selection to compare with.
      * @returns `true` if selections are equal, `false` otherwise.
      */
-    isEqual(otherSelection: Selection | DocumentSelection): boolean;
+    isEqual(otherSelection: ModelSelection | ModelDocumentSelection): boolean;
     /**
      * Returns an iterable object that iterates over copies of selection ranges.
      */
-    getRanges(): IterableIterator<Range>;
+    getRanges(): IterableIterator<ModelRange>;
     /**
      * Returns a copy of the first range in the selection.
-     * First range is the one which {@link module:engine/model/range~Range#start start} position
-     * {@link module:engine/model/position~Position#isBefore is before} start position of all other ranges
+     * First range is the one which {@link module:engine/model/range~ModelRange#start start} position
+     * {@link module:engine/model/position~ModelPosition#isBefore is before} start position of all other ranges
      * (not to confuse with the first range added to the selection).
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getFirstRange(): Range | null;
+    getFirstRange(): ModelRange | null;
     /**
      * Returns a copy of the last range in the selection.
-     * Last range is the one which {@link module:engine/model/range~Range#end end} position
-     * {@link module:engine/model/position~Position#isAfter is after} end position of all other ranges (not to confuse with the range most
-     * recently added to the selection).
+     * Last range is the one which {@link module:engine/model/range~ModelRange#end end} position
+     * {@link module:engine/model/position~ModelPosition#isAfter is after} end position of all other
+     * ranges (not to confuse with the range most recently added to the selection).
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getLastRange(): Range | null;
+    getLastRange(): ModelRange | null;
     /**
      * Returns the first position in the selection.
-     * First position is the position that {@link module:engine/model/position~Position#isBefore is before}
+     * First position is the position that {@link module:engine/model/position~ModelPosition#isBefore is before}
      * any other position in the selection.
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getFirstPosition(): Position | null;
+    getFirstPosition(): ModelPosition | null;
     /**
      * Returns the last position in the selection.
-     * Last position is the position that {@link module:engine/model/position~Position#isAfter is after}
+     * Last position is the position that {@link module:engine/model/position~ModelPosition#isAfter is after}
      * any other position in the selection.
      *
      * Returns `null` if there are no ranges in selection.
      */
-    getLastPosition(): Position | null;
+    getLastPosition(): ModelPosition | null;
     /**
      * Sets this selection's ranges and direction to the specified location based on the given
-     * {@link module:engine/model/selection~Selectable selectable}.
+     * {@link module:engine/model/selection~ModelSelectable selectable}.
      *
      * ```ts
      * // Removes all selection's ranges.
@@ -202,7 +202,7 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      *
      * // Sets selection to the given document selection.
      * // Note: It doesn't copy selection attributes.
-     * const documentSelection = new DocumentSelection( doc );
+     * const documentSelection = new ModelDocumentSelection( doc );
      * selection.setTo( documentSelection );
      *
      * // Sets collapsed selection at the given position.
@@ -213,14 +213,14 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * selection.setTo( paragraph, offset );
      * ```
      *
-     * Creates a range inside an {@link module:engine/model/element~Element element} which starts before the first child of
+     * Creates a range inside an {@link module:engine/model/element~ModelElement element} which starts before the first child of
      * that element and ends after the last child of that element.
      *
      * ```ts
      * selection.setTo( paragraph, 'in' );
      * ```
      *
-     * Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends just after the item.
+     * Creates a range on an {@link module:engine/model/item~ModelItem item} which starts before the item and ends just after the item.
      *
      * ```ts
      * selection.setTo( paragraph, 'on' );
@@ -234,38 +234,38 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * ```
      */
     setTo(...args: [
-        selectable: Node,
-        placeOrOffset: PlaceOrOffset,
+        selectable: ModelNode,
+        placeOrOffset: ModelPlaceOrOffset,
         options?: {
             backward?: boolean;
         }
     ] | [
-        selectable?: Exclude<Selectable, Node>,
+        selectable?: Exclude<ModelSelectable, ModelNode>,
         options?: {
             backward?: boolean;
         }
     ]): void;
     /**
      * Replaces all ranges that were added to the selection with given array of ranges. Last range of the array
-     * is treated like the last added range and is used to set {@link module:engine/model/selection~Selection#anchor} and
-     * {@link module:engine/model/selection~Selection#focus}. Accepts a flag describing in which direction the selection is made.
+     * is treated like the last added range and is used to set {@link module:engine/model/selection~ModelSelection#anchor} and
+     * {@link module:engine/model/selection~ModelSelection#focus}. Accepts a flag describing in which direction the selection is made.
      *
      * @fires change:range
      * @param newRanges Ranges to set.
      * @param isLastBackward Flag describing if last added range was selected forward - from start to end (`false`)
      * or backward - from end to start (`true`).
      */
-    protected _setRanges(newRanges: Iterable<Range>, isLastBackward?: boolean): void;
+    protected _setRanges(newRanges: Iterable<ModelRange>, isLastBackward?: boolean): void;
     /**
-     * Moves {@link module:engine/model/selection~Selection#focus} to the specified location.
+     * Moves {@link module:engine/model/selection~ModelSelection#focus} to the specified location.
      *
      * The location can be specified in the same form as
-     * {@link module:engine/model/writer~Writer#createPositionAt writer.createPositionAt()} parameters.
+     * {@link module:engine/model/writer~ModelWriter#createPositionAt writer.createPositionAt()} parameters.
      *
      * @fires change:range
-     * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/model/item~Item model item}.
+     * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/model/item~ModelItem model item}.
      */
-    setFocus(itemOrPosition: Item | Position, offset?: PositionOffset): void;
+    setFocus(itemOrPosition: ModelItem | ModelPosition, offset?: ModelPositionOffset): void;
     /**
      * Gets an attribute value for given key or `undefined` if that attribute is not set on the selection.
      *
@@ -313,13 +313,13 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      */
     setAttribute(key: string, value: unknown): void;
     /**
-     * Returns the selected element. {@link module:engine/model/element~Element Element} is considered as selected if there is only
+     * Returns the selected element. {@link module:engine/model/element~ModelElement Element} is considered as selected if there is only
      * one range in the selection, and that range contains exactly one element.
      * Returns `null` if there is no selected element.
      */
-    getSelectedElement(): Element | null;
+    getSelectedElement(): ModelElement | null;
     /**
-     * Gets elements of type {@link module:engine/model/schema~Schema#isBlock "block"} touched by the selection.
+     * Gets elements of type {@link module:engine/model/schema~ModelSchema#isBlock "block"} touched by the selection.
      *
      * This method's result can be used for example to apply block styling to all blocks covered by this selection.
      *
@@ -381,30 +381,30 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
      * <paragraph>]c</paragraph> // This block will not be returned
      * ```
      */
-    getSelectedBlocks(): IterableIterator<Element>;
+    getSelectedBlocks(): IterableIterator<ModelElement>;
     /**
      * Checks whether the selection contains the entire content of the given element. This means that selection must start
-     * at a position {@link module:engine/model/position~Position#isTouching touching} the element's start and ends at position
+     * at a position {@link module:engine/model/position~ModelPosition#isTouching touching} the element's start and ends at position
      * touching the element's end.
      *
      * By default, this method will check whether the entire content of the selection's current root is selected.
      * Useful to check if e.g. the user has just pressed <kbd>Ctrl</kbd> + <kbd>A</kbd>.
      */
-    containsEntireContent(element?: Element): boolean;
+    containsEntireContent(element?: ModelElement): boolean;
     /**
      * Adds given range to internal {@link #_ranges ranges array}. Throws an error
      * if given range is intersecting with any range that is already stored in this selection.
      */
-    protected _pushRange(range: Range): void;
+    protected _pushRange(range: ModelRange): void;
     /**
      * Checks if given range intersects with ranges that are already in the selection. Throws an error if it does.
      */
-    protected _checkRange(range: Range): void;
+    protected _checkRange(range: ModelRange): void;
     /**
      * Replaces all the ranges by the given ones.
      * Uses {@link #_popRange _popRange} and {@link #_pushRange _pushRange} to ensure proper ranges removal and addition.
      */
-    protected _replaceAllRanges(ranges: Array<Range>): void;
+    protected _replaceAllRanges(ranges: Array<ModelRange>): void;
     /**
      * Deletes ranges from internal range array. Uses {@link #_popRange _popRange} to
      * ensure proper ranges removal.
@@ -418,7 +418,7 @@ export default class Selection extends /* #__PURE__ */ Selection_base {
 /**
  * Describes one of the events: `change:range` or `change:attribute`.
  */
-export type SelectionChangeEvent = {
+export type ModelSelectionChangeEvent = {
     name: 'change' | 'change:range' | 'change:attribute';
     args: [
         {
@@ -430,16 +430,16 @@ export type SelectionChangeEvent = {
 /**
  * Fired when selection range(s) changed.
  *
- * @eventName ~Selection#change:range
- * @param directChange In case of {@link module:engine/model/selection~Selection} class it is always set
+ * @eventName ~ModelSelection#change:range
+ * @param directChange In case of {@link module:engine/model/selection~ModelSelection} class it is always set
  * to `true` which indicates that the selection change was caused by a direct use of selection's API.
- * The {@link module:engine/model/documentselection~DocumentSelection}, however, may change because its position
- * was directly changed through the {@link module:engine/model/writer~Writer writer} or because its position was
+ * The {@link module:engine/model/documentselection~ModelDocumentSelection}, however, may change because its position
+ * was directly changed through the {@link module:engine/model/writer~ModelWriter writer} or because its position was
  * changed because the structure of the model has been changed (which means an indirect change).
  * The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live")
  * which mean that they are not updated once the document changes.
  */
-export type SelectionChangeRangeEvent = {
+export type ModelSelectionChangeRangeEvent = {
     name: 'change' | 'change:range';
     args: [
         {
@@ -450,17 +450,17 @@ export type SelectionChangeRangeEvent = {
 /**
  * Fired when selection attribute changed.
  *
- * @eventName ~Selection#change:attribute
- * @param directChange In case of {@link module:engine/model/selection~Selection} class it is always set
+ * @eventName ~ModelSelection#change:attribute
+ * @param directChange In case of {@link module:engine/model/selection~ModelSelection} class it is always set
  * to `true` which indicates that the selection change was caused by a direct use of selection's API.
- * The {@link module:engine/model/documentselection~DocumentSelection}, however, may change because its attributes
- * were directly changed through the {@link module:engine/model/writer~Writer writer} or because its position was
+ * The {@link module:engine/model/documentselection~ModelDocumentSelection}, however, may change because its attributes
+ * were directly changed through the {@link module:engine/model/writer~ModelWriter writer} or because its position was
  * changed in the model and its attributes were refreshed (which means an indirect change).
  * The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live")
  * which mean that they are not updated once the document changes.
  * @param attributeKeys Array containing keys of attributes that changed.
  */
-export type SelectionChangeAttributeEvent = {
+export type ModelSelectionChangeAttributeEvent = {
     name: 'change' | 'change:attribute';
     args: [
         {
@@ -472,11 +472,11 @@ export type SelectionChangeAttributeEvent = {
 /**
  * An entity that is used to set selection.
  *
- * See also {@link module:engine/model/selection~Selection#setTo}.
+ * See also {@link module:engine/model/selection~ModelSelection#setTo}.
  */
-export type Selectable = Selection | DocumentSelection | Position | Range | Node | Iterable<Range> | null;
+export type ModelSelectable = ModelSelection | ModelDocumentSelection | ModelPosition | ModelRange | ModelNode | Iterable<ModelRange> | null;
 /**
  * The place or offset of the selection.
  */
-export type PlaceOrOffset = number | 'before' | 'end' | 'after' | 'on' | 'in';
+export type ModelPlaceOrOffset = number | 'before' | 'end' | 'after' | 'on' | 'in';
 export {};