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
impl PaintedTargets
pub fn new() -> PaintedTargets
pub fn begin_frame(&mut self)
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>,
)
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>,
)
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
pub fn interaction(&self, id: &str) -> Interaction
How to paint target id now.
pub fn set_host_focus(&mut self, focused: bool)
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)
pub fn cancel_pointer_press(&mut self)
Cancel the gesture while retaining ownership of its eventual release.
pub fn wants_pointer_capture(&self) -> bool
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
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>
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
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
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,
)
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>
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
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
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
impl Debug for PaintedTargets
§impl Default for PaintedTargets
impl Default for PaintedTargets
§fn default() -> PaintedTargets
fn default() -> PaintedTargets
Auto Trait Implementations§
impl Freeze for PaintedTargets
impl RefUnwindSafe for PaintedTargets
impl Send for PaintedTargets
impl Sync for PaintedTargets
impl Unpin for PaintedTargets
impl UnsafeUnpin for PaintedTargets
impl UnwindSafe for PaintedTargets
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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