Struct DropZone 

pub struct DropZone<C> { /* private fields */ }

A dashed area around any content, which takes files dropped on it and shows when they are over the window. Unlike FileUpload it keeps no list: the files go to DropZone::on_files, and what it holds and how it looks are up to the content.

A dropped file lands in the zone under the pointer. While it is being dragged, every zone on the screen lights up, because the platforms say only that files are over the window, and not where. A keyboard cannot drop anything, so DropZone::choosable is there for that.

use ravenrs_widgets::{DropZone, Text, Ui};

let zone = DropZone::new(Text::new("Photos of the session"))
    .accept(["jpg", "png"])
    .on_files(|files| println!("{} files", files.len()));
let mut ui = Ui::new(zone, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations

impl<C: View> DropZone<C>

pub fn new(content: C) -> Self

A zone around content, taking any file.

pub fn on_files(self, handler: impl Fn(Vec<PickedFile>) + 'static) -> Self

Called with the files it took. It is not called when all of them were refused.

pub fn on_refused(self, handler: impl Fn(Vec<String>) + 'static) -> Self

Called with one sentence for each refused file, in the words of crate::Labels, for showing them elsewhere. Without it they show inside the zone, under the content.

pub fn accept( self, extensions: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Only these extensions, such as ["pdf", "png"]. Any file by default.

pub fn most_bytes(self, bytes: u64) -> Self

The largest file taken, in bytes. 100 MiB by default.

pub fn most_files(self, files: usize) -> Self

The most files taken from one drop. No limit by default.

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

The name screen readers announce. By default, the words of the hint.

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

What shows over the content while files are over the window. By default, file_drop of the labels.

pub fn no_hint(self) -> Self

Shows nothing over the content while files are over the window, only the stronger edge.

pub fn choosable(self) -> Self

Makes the whole zone a button that opens the system’s chooser, with a click, Enter or Space, so that the keyboard can bring files too. Leave it off when the content has its own way of choosing.

pub fn quiet(self) -> Self

Draws the dashes only while files are over the window, for a zone that is a whole screen and should not look like one until then.

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

The space around the content, in logical pixels (space-4 by default).

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

The shortest it gets, in logical pixels.

pub fn fill(self) -> Self

Takes the free space of the parent, for a zone that is a whole screen.

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

Turns it off: it takes no files and does not react to them.

Trait Implementations

impl<C> Debug for DropZone<C>

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

Formats the value using the given formatter.

impl<C: View> View for DropZone<C>

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.