Skip to main content

FileDropZone

Struct FileDropZone 

Source
pub struct FileDropZone { /* private fields */ }
Expand description

A click-and-drop file target.

let drop = FileDropZone::new().show(ui);
if drop.response.clicked() {
    // Open a native file picker, e.g. via the `rfd` crate.
}
for file in &drop.dropped_files {
    // Handle file.path / file.bytes.
    let _ = file;
}

Implementations§

Source§

impl FileDropZone

Source

pub fn new() -> Self

Create a drop zone with the default prompt, action word, and minimum height.

Source

pub fn prompt(self, prompt: impl Into<WidgetText>) -> Self

Override the prompt text. Defaults to “Drop files here, or browse”, where the action word is rendered in the sky accent.

Source

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

Override the action word rendered in the sky accent inside the prompt. Defaults to "browse". Ignored if Self::prompt is set.

Source

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

Set the hint line under the prompt (e.g. accepted formats and size limits). Defaults to no hint.

Source

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

Override the minimum height of the zone in points. Defaults to 120.

Source

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

Disable the zone. Defaults to enabled.

Source

pub fn show(self, ui: &mut Ui) -> FileDropResponse

Render the zone and return the response plus any files dropped on its rect this frame.

Trait Implementations§

Source§

impl Debug for FileDropZone

Source§

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

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

impl Default for FileDropZone

Source§

fn default() -> Self

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> 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, 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.