90 lines
2.6 KiB
Rust
90 lines
2.6 KiB
Rust
// Copyright 2023 System76 <info@system76.com>
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
//! Request to open files and/or directories.
|
|
//!
|
|
//! Check out the [open-dialog](https://github.com/pop-os/libcosmic/tree/master/examples/open-dialog)
|
|
//! example in our repository.
|
|
|
|
use derive_setters::Setters;
|
|
use iced::Command;
|
|
|
|
/// A builder for an open file dialog, passed as a request by a [`Sender`]
|
|
#[derive(Setters)]
|
|
#[must_use]
|
|
pub struct Dialog {
|
|
/// The label for the dialog's window title.
|
|
title: String,
|
|
|
|
/// The label for the accept button. Mnemonic underlines are allowed.
|
|
#[setters(strip_option)]
|
|
accept_label: Option<String>,
|
|
|
|
/// Whether to select for folders instead of files. Default is to select files.
|
|
include_directories: bool,
|
|
|
|
/// Modal dialogs require user input before continuing the program.
|
|
modal: bool,
|
|
|
|
/// Whether to allow selection of multiple files. Default is no.
|
|
multiple_files: bool,
|
|
|
|
/// Adds a list of choices.
|
|
choices: Vec<super::Choice>,
|
|
|
|
/// Specifies the default file filter.
|
|
#[setters(into)]
|
|
current_filter: Option<super::FileFilter>,
|
|
|
|
/// A collection of file filters.
|
|
filters: Vec<super::FileFilter>,
|
|
}
|
|
|
|
impl Dialog {
|
|
pub(super) const fn new() -> Self {
|
|
Self {
|
|
title: String::new(),
|
|
accept_label: None,
|
|
include_directories: false,
|
|
modal: true,
|
|
multiple_files: false,
|
|
current_filter: None,
|
|
choices: Vec::new(),
|
|
filters: Vec::new(),
|
|
}
|
|
}
|
|
|
|
/// Creates a [`Command`] which opens the dialog.
|
|
pub fn create(self, sender: &mut super::Sender) -> Command<()> {
|
|
sender.open(self)
|
|
}
|
|
|
|
/// Adds a choice.
|
|
pub fn choice(mut self, choice: impl Into<super::Choice>) -> Self {
|
|
self.choices.push(choice.into());
|
|
self
|
|
}
|
|
|
|
/// Adds a files filter.
|
|
pub fn filter(mut self, filter: impl Into<super::FileFilter>) -> Self {
|
|
self.filters.push(filter.into());
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Creates a new file dialog, and begins to await its responses.
|
|
pub(super) async fn create(
|
|
dialog: Dialog,
|
|
) -> ashpd::Result<ashpd::desktop::Request<super::SelectedFiles>> {
|
|
ashpd::desktop::file_chooser::OpenFileRequest::default()
|
|
.title(Some(dialog.title.as_str()))
|
|
.accept_label(dialog.accept_label.as_deref())
|
|
.directory(dialog.include_directories)
|
|
.modal(dialog.modal)
|
|
.multiple(dialog.multiple_files)
|
|
.choices(dialog.choices)
|
|
.filters(dialog.filters)
|
|
.current_filter(dialog.current_filter)
|
|
.send()
|
|
.await
|
|
}
|