Struct Selection 

#[repr(C)]
pub(crate) struct Selection {
    reflector_: Reflector,
    document: Dom<Document>,
    range: DomRefCell<Option<SelectionRange>>,
    live_range: MutNullableDom<Range>,
    direction: Cell<Direction>,
    has_scheduled_selectionchange_event: Cell<bool>,
    visible_selection_dirty: Cell<bool>,
}

https://w3c.github.io/selection-api/#dfn-selection

Fields

reflector_: Reflector

document: Dom<Document>

range: DomRefCell<Option<SelectionRange>>

A range that holds the start and end of this selection, which may potentially cross shadow roots.

live_range: MutNullableDom<Range>

The live range version of this selection, which will never cross shadow roots.

direction: Cell<Direction>

The Direction of this Selection which determines which endpoint of Self::range is the anchor and which is the focus.

has_scheduled_selectionchange_event: Cell<bool>

https://w3c.github.io/selection-api/#dfn-has-scheduled-selectionchange-event

visible_selection_dirty: Cell<bool>

Whether or not this Selection needs to remark DOM nodes with selection flags after a change to its underlying Range.

Implementations

impl Selection

fn __assert_parent_type(&self)

impl Selection

pub(crate) fn delete_the_selection( &self, cx: &mut JSContext, context_object: &Document, block_merging: SelectionDeletionBlockMerging, strip_wrappers: SelectionDeletionStripWrappers, direction: SelectionDeleteDirection, )

https://w3c.github.io/editing/docs/execCommand/#delete-the-selection

pub(crate) fn set_the_selection_value( &self, cx: &mut JSContext, new_value: Option<DOMString>, command: CommandName, context_object: &Document, )

https://w3c.github.io/editing/docs/execCommand/#set-the-selection%27s-value

impl Selection

fn new_inherited(document: &Document) -> Selection

pub(crate) fn new(cx: &mut JSContext, document: &Document) -> DomRoot<Selection>

pub(crate) fn visible_selection_dirty(&self) -> bool

fn clear_cached_live_range(&self)

pub(crate) fn update_from_live_range( &self, live_range: &Range, notification: SelectionLiveRangeNotification, )

fn set_range(&self, new_range: Option<SelectionRange>) -> bool

pub(crate) fn set_live_range(&self, new_range: Option<&Range>)

fn selection_boundaries_changed(&self)

fn iter_nodes_with_overlaps_document_selection_flag<'no_gc>( &self, no_gc: &'no_gc NoGC, ) -> impl Iterator<Item = UnrootedDom<'no_gc, Node>>

pub(crate) fn update_overlaps_document_selection_flags<'no_gc>( &self, no_gc: &'no_gc NoGC, )

pub(crate) fn queue_selectionchange_task(&self)

https://w3c.github.io/selection-api/#dfn-schedule-a-selectionchange-event

fn is_in_document_of_range(&self, node: &Node) -> bool

pub(crate) fn start_boundary(&self, cx: &mut JSContext) -> (DomRoot<Node>, u32)

pub(crate) fn end_boundary(&self, cx: &mut JSContext) -> (DomRoot<Node>, u32)

fn assert_valid_selection(&self)

fn assert_valid_selection_and_live_range(&self)

pub(crate) fn active_range(&self, cx: &mut JSContext) -> Option<DomRoot<Range>>

https://w3c.github.io/editing/docs/execCommand/#active-range

The active range is the range of the selection given by calling getSelection() on the context object. (Thus the active range may be null.)

pub(crate) fn expect_active_range(&self, cx: &mut JSContext) -> DomRoot<Range>

pub(crate) fn set_visible_selection_dirty(&self)

fn composed_anchor_position(&self) -> Option<(DomRoot<Node>, u32)>

fn live_anchor_node(&self, cx: &mut JSContext) -> Option<DomRoot<Node>>

https://w3c.github.io/selection-api/#dfn-anchor

fn live_anchor_offset(&self, cx: &mut JSContext) -> u32

https://w3c.github.io/selection-api/#dfn-anchor

fn live_focus_node(&self, cx: &mut JSContext) -> Option<DomRoot<Node>>

https://w3c.github.io/selection-api/#dfn-focus

fn live_focus_offset(&self, cx: &mut JSContext) -> u32

https://w3c.github.io/selection-api/#dfn-focus

pub(crate) fn insert_steps(&self, parent: &Node, child: &Node, count: u32)

https://dom.spec.whatwg.org/#concept-node-insert steps 5.1-5.2 and https://dom.spec.whatwg.org/#move steps 17.1-17.2 adapted for selections.

pub(crate) fn remove_steps_for_removed_subtree( &self, inclusive_descendant_of_removed_node: &Node, parent_of_removed_node: &Node, index_of_removed_node: &mut dyn FnMut() -> u32, )

https://dom.spec.whatwg.org/#live-range-pre-remove-steps steps 4 and 5 adapted for selections.

These steps are run on the inclusive descendants of a removed node, but to avoid having to iterate through those nodes twice, they are run when the inclusive descendants themselves are unbound from the tree.

pub(crate) fn remove_steps_for_parent( &self, parent: &Node, node_index: &mut dyn FnMut() -> u32, )

https://dom.spec.whatwg.org/#live-range-pre-remove-steps steps 6 and 7 adapted for selections.

pub(crate) fn normalization_steps( &self, parent: &Node, node: &Node, current_node: &Node, current_node_index: &dyn Fn() -> u32, length: u32, )

https://dom.spec.whatwg.org/#dom-node-normalize Steps 6.1-6.4 adapted for selections.

• parent: The parent of both other node arguments.
• node: The node that text is being merged into.
• current_node: The node which has text being merged into node and will be removed from the DOM.
• length: The length of the text content that was merged into node from siblings before current_node.

pub(crate) fn replace_data_steps( &self, node: &Node, offset: u32, removed_code_units: u32, added_code_units: &mut dyn FnMut() -> u32, )

https://dom.spec.whatwg.org/#concept-cd-replace steps 8-11 adapted for selections.

pub(crate) fn text_split_steps( &self, node: &Node, offset: u32, parent_node: &Node, new_node: &Node, )

https://dom.spec.whatwg.org/#concept-text-split steps 7.2-7.3 adapted for selections.

pub(crate) fn collapse_to_dom_position( &self, cx: &mut JSContext, container: &Node, offset: Utf32CodeUnitsOrNodeOffset, )

pub(crate) fn collapse_or_extend_to_dom_position( &self, cx: &mut JSContext, container: &Node, offset: Utf32CodeUnitsOrNodeOffset, )

Trait Implementations

impl DomObject for Selection

type ReflectorType = ()

fn reflector(&self) -> &Reflector<Self::ReflectorType>

Returns the receiver’s reflector.

impl DomObjectWrap<DomTypeHolder> for Selection

const WRAP: unsafe fn(&mut JSContext, &GlobalScope, Option<HandleObject<'_>>, Box<Self>) -> Root<Dom<Self>>

Function pointer to the general wrap function type

impl Drop for Selection

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl HasParent for Selection

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl IDLInterface for Selection

const PROTO_FIRST: u16 = 492

First prototype ID in the DFS-ordered range for this interface and its descendants.

const PROTO_LAST: u16 = 492

Last prototype ID in the DFS-ordered range for this interface and its descendants.

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for Selection

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for Selection

unsafe fn init_reflector<Actual>(&self, obj: *mut JSObject)

Initializes the Reflector

unsafe fn init_reflector_without_associated_memory(&self, obj: *mut JSObject)

Initializes the Reflector without recording any associated memory usage.

impl PartialEq for Selection

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SelectionMethods<DomTypeHolder> for Selection

fn GetAnchorNode(&self, cx: &mut JSContext) -> Option<DomRoot<Node>>

https://w3c.github.io/selection-api/#dom-selection-anchornode

fn AnchorOffset(&self, cx: &mut JSContext) -> u32

https://w3c.github.io/selection-api/#dom-selection-anchoroffset

fn GetFocusNode(&self, cx: &mut JSContext) -> Option<DomRoot<Node>>

https://w3c.github.io/selection-api/#dom-selection-focusnode

fn FocusOffset(&self, cx: &mut JSContext) -> u32

https://w3c.github.io/selection-api/#dom-selection-focusoffset

fn IsCollapsed(&self, cx: &mut JSContext) -> bool

https://w3c.github.io/selection-api/#dom-selection-iscollapsed

fn RangeCount(&self) -> u32

https://w3c.github.io/selection-api/#dom-selection-rangecount

fn Type(&self) -> DOMString

https://w3c.github.io/selection-api/#dom-selection-type

fn GetRangeAt(&self, cx: &mut JSContext, index: u32) -> Fallible<DomRoot<Range>>

https://w3c.github.io/selection-api/#dom-selection-getrangeat

fn AddRange(&self, range: &Range)

https://w3c.github.io/selection-api/#dom-selection-addrange

fn RemoveRange(&self, range: &Range) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-removerange

fn RemoveAllRanges(&self)

https://w3c.github.io/selection-api/#dom-selection-removeallranges

fn Empty(&self)

https://w3c.github.io/selection-api/#dom-selection-empty

fn Collapse( &self, _cx: &mut JSContext, node: Option<&Node>, offset: u32, ) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-collapse

fn SetPosition( &self, cx: &mut JSContext, node: Option<&Node>, offset: u32, ) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-setposition

fn CollapseToStart(&self, cx: &mut JSContext) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-collapsetostart

fn CollapseToEnd(&self, cx: &mut JSContext) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-collapsetoend

fn Extend(&self, _cx: &mut JSContext, node: &Node, offset: u32) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-extend

fn SetBaseAndExtent( &self, _cx: &mut JSContext, anchor_node: &Node, anchor_offset: u32, focus_node: &Node, focus_offset: u32, ) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-setbaseandextent

fn SelectAllChildren(&self, _cx: &mut JSContext, node: &Node) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-selectallchildren

fn DeleteFromDocument(&self, cx: &mut JSContext) -> ErrorResult

https://w3c.github.io/selection-api/#dom-selection-deletecontents

fn ContainsNode(&self, node: &Node, allow_partial_containment: bool) -> bool

https://w3c.github.io/selection-api/#dom-selection-containsnode

fn Stringifier(&self, cx: &mut JSContext) -> DOMString

https://w3c.github.io/selection-api/#dom-selection-stringifier

impl ToJSValConvertible for Selection

fn to_jsval(&self, cx: &mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for Selection

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl Eq for Selection