Struct FileSpec

pub struct FileSpec {
    pub name: &'static str,
    pub extensions: &'static [&'static str],
}

A description of a filetype, for specifying allowed types in a file dialog.

Windows

Each instance of this type is converted to a COMDLG_FILTERSPEC struct.

macOS

These file types also apply to directories to define them as packages.

Fields

name: &'static str

A human readable name, describing this filetype.

This is used in the Windows file dialog, where the user can select from a dropdown the type of file they would like to choose.

This should not include the file extensions; they will be added automatically. For instance, if we are describing Word documents, the name would be “Word Document”, and the displayed string would be “Word Document (*.doc)”.

extensions: &'static [&'static str]

The file extensions used by this file type.

This should not include the leading ‘.’.

Implementations

impl FileSpec

pub const TEXT: FileSpec

pub const JPG: FileSpec

pub const GIF: FileSpec

pub const PNG: FileSpec

pub const PDF: FileSpec

pub const HTML: FileSpec

pub const fn new( name: &'static str, extensions: &'static [&'static str], ) -> FileSpec

Create a new FileSpec.

Examples found in repository

examples/open_save.rs (line 40)

fn ui_builder() -> impl Widget<String> {
    let rs = FileSpec::new("Rust source", &["rs"]);
    let txt = FileSpec::new("Text file", &["txt"]);
    let other = FileSpec::new("Bogus file", &["foo", "bar", "baz"]);
    // The options can also be generated at runtime,
    // so to show that off we create a String for the default save name.
    let default_save_name = String::from("MyFile.txt");
    let save_dialog_options = FileDialogOptions::new()
        .allowed_types(vec![rs, txt, other])
        .default_type(txt)
        .default_name(default_save_name)
        .name_label("Target")
        .title("Choose a target for this lovely file")
        .button_text("Export");
    let open_dialog_options = save_dialog_options
        .clone()
        .default_name("MySavedFile.txt")
        .name_label("Source")
        .title("Where did you put that file?")
        .button_text("Import");

    let input = TextBox::new();
    let save = Button::new("Save").on_click(move |ctx, _, _| {
        ctx.submit_command(druid::commands::SHOW_SAVE_PANEL.with(save_dialog_options.clone()))
    });
    let open = Button::new("Open").on_click(move |ctx, _, _| {
        ctx.submit_command(druid::commands::SHOW_OPEN_PANEL.with(open_dialog_options.clone()))
    });

    let mut col = Flex::column();
    col.add_child(input);
    col.add_spacer(8.0);
    col.add_child(save);
    col.add_child(open);
    Align::centered(col)
}

Trait Implementations

impl Clone for FileSpec

fn clone(&self) -> FileSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileSpec

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

Formats the value using the given formatter.

impl PartialEq for FileSpec

fn eq(&self, other: &FileSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FileSpec

impl Eq for FileSpec

impl StructuralPartialEq for FileSpec