Skip to main content

PaintedTargets

Struct PaintedTargets 

pub struct PaintedTargets { /* private fields */ }
Expand description

The pressable targets of a widget that paints its own content (a calculator’s keys, a map’s markers, a timeline’s clips): the same hover, press, focus and activation the retained controls have, for rects the host lays out itself.

Each frame the host registers every target it paints, in reading order (PaintedTargets::begin_frame, then PaintedTargets::target), forwards its events (PaintedTargets::handle_event), paints each target with PaintedTargets::interaction (and the focus ring with PaintedTargets::paint_focus), and acts on PaintedTargets::take_activated. Its accessibility node lists the targets as buttons (PaintedTargets::accessibility_children) and routes their activation back (PaintedTargets::perform_action, PaintedTargets::perform_semantic_action). Tab moves between the targets while the host holds keyboard focus (PaintedTargets::wants_tab_input).

Implementations§

§

impl PaintedTargets

pub fn new() -> PaintedTargets

pub fn begin_frame(&mut self)

Forget last frame’s targets; register this frame’s after it. Hover, press and focus stay with the ids that keep their target.

pub fn target( &mut self, id: impl Into<String>, rect: Rect, label: impl Into<String>, )

Register a target id at rect, announced as label. Later targets are on top: a point inside two goes to the later one.

pub fn disabled_target( &mut self, id: impl Into<String>, rect: Rect, label: impl Into<String>, )

Self::target that shows but does nothing (a key that does not apply now).

pub fn interaction(&self, id: &str) -> Interaction

How to paint target id now.

pub fn hit(&self, point: Point) -> Option<&str>

The target under point, topmost first.

pub fn focused(&self) -> Option<&str>

The id of the target that holds keyboard focus.

pub fn focus(&mut self, id: &str)

Move keyboard focus to target id.

pub fn set_host_focus(&mut self, focused: bool)

Follow the host’s own keyboard focus (Widget::set_focus): the first target takes it when the host gains it with none focused.

pub fn cancel_pointer_press(&mut self)

Cancel the gesture while retaining ownership of its eventual release.

pub fn wants_pointer_capture(&self) -> bool

Forward from the host’s pointer-capture query, including cancelled gestures.

pub fn wants_tab_input(&self) -> bool

Whether the next Tab moves between targets rather than out of the host: forward it from Widget::wants_tab_input.

pub fn take_activated(&mut self) -> Vec<String>

The ids activated since the last call, in order.

pub fn handle_pointer_event( &mut self, event: &WindowEvent, scale_factor: f64, handled: &mut bool, ) -> bool

Pointer routing for canvas hosts without a widget focus context. Uses the same completed-click and cancellation rules as handle_event, without requesting keyboard focus. Returns whether feedback changed; handled includes a cancelled gesture’s matching release.

pub fn handle_event( &mut self, event: &WindowEvent, ctx: &mut EventCtx<'_>, ) -> bool

Track the pointer and keys against the registered targets. A press and release on the same target activates it; Enter or Space activates the focused one; Tab and Shift+Tab move focus between targets. Marks the event handled when a target took it, and asks the host for keyboard focus when one is pressed. Returns whether anything visible changed.

pub fn paint_focus( &self, scene: &mut Scene, transform: Affine, radius: f64, theme: &Theme, )

The focus ring around the focused target, while the host holds keyboard focus.

pub fn accessibility_children(&self) -> Vec<AccessNode>

The targets as accessible buttons, for the host’s Widget::accessibility node, each routed back by its id.

pub fn perform_action(&mut self, action: &Action, key_path: &[u64]) -> bool

Route an assistive-technology action on one of Self::accessibility_children: forward the host’s Widget::perform_action key path here.

pub fn perform_semantic_action(&mut self, action: &Action, target: &str) -> bool

Self::perform_action by the target’s id (its semantic action target): forward the host’s Widget::perform_semantic_action here.

Trait Implementations§

§

impl Debug for PaintedTargets

§

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

Formats the value using the given formatter. Read more
§

impl Default for PaintedTargets

§

fn default() -> PaintedTargets

Returns the “default value” for a type. Read more

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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.
§

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.
§

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.
§

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.
§

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

§

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

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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

§

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

§

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

§

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

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

§

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

§

impl<T> WasmNotSendSync for T

§

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