Skip to main content

SelectionToolbarRequest

Struct SelectionToolbarRequest 

Source
pub struct SelectionToolbarRequest {
    pub anchor: Rect,
    pub actions: SelectionToolbarActions,
    pub present_menu: bool,
}
Expand description

The selection-toolbar seam: the request a text field publishes when it has a selection (SelectionToolbarRequest/SelectionToolbarActions), and the knobs that decide who draws it.

set_selection_toolbar_policy chooses SelectionToolbarPolicy::Framework (the default — a field floats its own pod through the overlay portal) or SelectionToolbarPolicy::Native (the platform’s own edit menu, e.g. iOS’s UIEditMenuInteraction) — see that type’s own docs for the two-route split. This is not an unconditional free choice, though: a platform shell whose system owns the menu can LOCK it instead, with frust_core::lock_selection_toolbar_policy — once locked, set_selection_toolbar_policy is refused rather than obeyed, so an app cannot silently undo a platform requirement it doesn’t know exists. iOS’s shell locks SelectionToolbarPolicy::Native at start-up for exactly this reason: a framework-drawn toolbar’s own Paste button would break the exemption that keeps iOS’s per-app paste-permission prompt from firing on every paste.

set_selection_toolbar_builder installs the view a Framework-policy pod floats, replacing whatever the framework’s own baseline (installed at bootstrap, before the first frame) or an earlier design system already installed. A design system’s own installer should reach for frust_core::install_selection_toolbar_builder_if_unset instead — the cooperative, set-if-unset half of the same pair — so two catalogs linked into one binary never fight over the slot, and neither ever undoes an app’s own explicit override.

use frust::{
    SelectionToolbarPolicy, lock_selection_toolbar_policy, set_selection_toolbar_policy,
};

// A shell whose platform owns its own system edit menu locks the route,
// so that requirement wins no matter what app code does afterward.
let claimed = lock_selection_toolbar_policy(SelectionToolbarPolicy::Native);
assert!(claimed, "the first claim always takes the lock");

// An app's later override is refused rather than obeyed once locked.
set_selection_toolbar_policy(SelectionToolbarPolicy::Framework);

One focused field’s published “here is my selection, these verbs apply to it, and this is whether a menu is wanted over it right now”.

Published per paint pass by every focused field, with or without a selection; a pass without one means no field holds the focus. Two facts of different shapes travel together here: anchor and actions are a level — the state of the field as it stands this frame, which a platform responder chain must be able to read at any moment — while present_menu is the edge that asks for a menu to go up.

Fields§

§anchor: Rect

The selection’s bounding rect in absolute logical window space — the same space an OverlayEntry::window_rect uses, so a framework toolbar can be placed against it directly and a native menu can be anchored to it after the shell’s own scale conversion.

Falls back to the caret rect while the selection is collapsed, which is the right anchor for a paste-only menu.

§actions: SelectionToolbarActions

Which verbs apply. A level: computed from the field’s own state, not from whether any bar is up, so a hardware Cmd+C arriving with nothing on screen still finds an answer here.

§present_menu: bool

Whether the field wants a menu presented now — the one edge in an otherwise level-shaped request.

A field raises this when a gesture asks for the bar (a long press, a secondary press) and drops it again when the bar is dismissed, while it keeps republishing the same anchor and verbs either way. It is what RenderRoot::selection_toolbar_generation moves on, together with actions — an anchor that merely follows a growing selection must not ask a platform to re-present its menu.

Trait Implementations§

Source§

impl Clone for SelectionToolbarRequest

Source§

fn clone(&self) -> SelectionToolbarRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SelectionToolbarRequest

Source§

impl Debug for SelectionToolbarRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SelectionToolbarRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SelectionToolbarRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more