Struct RubberBand 

pub struct RubberBand { /* private fields */ }

A rectangle drawn with a drag, in the units of the content. The selection follows the drag through its binding, and on_select gets it on release; a press and release without moving clears it. Escape cancels a drag.

Keyboard: the arrows move it, with Alt they resize it (and with Shift, further), Enter selects it, Delete or Escape clears it. With nothing selected, an arrow starts from the middle quarter of the content.

While dragging it paints without a build, so it costs no rebuilds if nothing else reads the selection.

use ravenrs_core::Rect;
use ravenrs_reactive::State;
use ravenrs_widgets::RubberBand;

let selection = State::new(None::<Rect>);
let band = RubberBand::new(selection.binding())
    .keep(false)
    .on_select(|rect| println!("zoom to {rect:?}"))
    .size(320.0, 200.0);

Implementations

impl RubberBand

pub fn new(selection: Binding<Option<Rect>>) -> Self

A band bound to selection, in the units of its space.

pub fn on_select(self, handler: impl Fn(Rect) + 'static) -> Self

Runs handler with the rectangle when a drag ends, or on Enter.

pub fn keep(self, keep: bool) -> Self

Whether the rectangle stays after the release (it does by default). A box for zooming, say, goes away as soon as it is used.

pub fn disabled(self, disabled: bool) -> Self

Takes no input while disabled, which leaves the pointer to what is underneath: for a band that only works in one mode or with a key held.

pub fn label(self, label: impl Into<String>) -> Self

The name screen readers announce, instead of the one in Labels.

impl RubberBand

pub fn size(self, width: f32, height: f32) -> Self

Fixed size in logical pixels, instead of taking the free space.

pub fn grow(self, grow: f32) -> Self

How much of the free space along the parent stack it takes: 1 by default, or 0 over a stage, which then decides the size.

pub fn stage(self, stage: impl View + 'static) -> Self

The view it goes over, such as an Image or a ZoomPanView, which gives it its size. Without one, put it in a ZStack with a fixed size.

pub fn space(self, space: ContentSpace) -> Self

Where the content is, and so the units of its coordinates: by default, its own box.

Trait Implementations

impl Debug for RubberBand

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

Formats the value using the given formatter.

impl View for RubberBand

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.