Struct SharedSelection 

pub struct SharedSelection {
    pub resource: Option<ActionResource>,
    pub anchor: SelectionAnchor,
    pub resource_kind: Option<String>,
    pub bounds: Option<Rect>,
}

A person’s selection in one window: the resource it is in, when known, and where in it.

Fields

resource: Option<ActionResource>

The published resource the selection is in. The app runner fills it from its publication when the widget does not name one.

anchor: SelectionAnchor

The place, the application’s own interaction anchor and the excerpt.

resource_kind: Option<String>

The kind of the resource the place’s item belongs to, which picks the published resource when Self::resource is absent. Local only.

bounds: Option<Rect>

Where the selection is drawn, in the window’s logical coordinates: the selected text’s lines, else the text block holding it. The shell keeps its agent composer clear of it. Local only: geometry is no part of what an agent is told.

Implementations

impl SharedSelection

pub fn of_text(text: &str) -> SharedSelection

Selected text, with no place.

pub fn of_items<I, L>( items: impl IntoIterator<Item = (I, L)>, ) -> SharedSelection

where I: Into<String>, L: AsRef<str>,

Several whole items selected, each (id, label) in the order shown (files in a folder, rows of a list): every item named as a place and the excerpt listing their labels.

pub fn at(self, place: SelectionPlace) -> SharedSelection

This selection at place.

pub fn in_resource(self, resource: ActionResource) -> SharedSelection

This selection in resource.

pub fn in_kind(self, kind: impl Into<String>) -> SharedSelection

This selection in a resource of kind, resolved against the app’s publication.

pub fn within(self, bounds: Rect) -> SharedSelection

This selection drawn within bounds, in window coordinates.

pub fn protocol_bounds(&self) -> Option<[f64; 4]>

Where the selection is drawn, as the shell protocol carries it: None when unknown or degenerate.

pub fn to_attached( &self, app: Option<&str>, record: Option<&str>, ) -> Option<Attached>

This selection as a thing to send: the record it is in, with the item or the run of characters it names, or — when the app publishes no resource to go with the words — the words quoted.

app names the app that publishes that record and record its workspace record (None: the app’s own); app is None when nobody says which app’s record it is, and what travels then is the words alone: a reference to no app addresses nothing. A selection of several items travels as those items; a range inside one travels as that item and its character span, in the app’s own unit, so the app can address the run again when the chip is opened. None when the person selected nothing worth sending.

pub fn is_empty(&self) -> bool

Whether there is nothing to ask about.

pub fn resolve_resource(&mut self, published: &[ResourceSpec])

Name the published resource the selection is in when the widget did not: the resource of Self::resource_kind, else the first one.

Trait Implementations

impl Clone for SharedSelection

fn clone(&self) -> SharedSelection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SharedSelection

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for SharedSelection

fn default() -> SharedSelection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SharedSelection

fn deserialize<__D>( __deserializer: __D, ) -> Result<SharedSelection, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SharedSelection

fn eq(&self, other: &SharedSelection) -> 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 Serialize for SharedSelection

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SharedSelection