1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
use crate::FileHandle;
use std::path::Path;
use std::path::PathBuf;
#[cfg(feature = "parent")]
use raw_window_handle::{HasRawWindowHandle, RawWindowHandle};
#[derive(Debug, Clone)]
pub(crate) struct Filter {
pub name: String,
pub extensions: Vec<String>,
}
/// ## Synchronous File Dialog
/// #### Supported Platforms:
/// - Linux
/// - Windows
/// - Mac
#[derive(Default, Debug, Clone)]
pub struct FileDialog {
pub(crate) filters: Vec<Filter>,
pub(crate) starting_directory: Option<PathBuf>,
pub(crate) file_name: Option<String>,
#[cfg(feature = "parent")]
pub(crate) parent: Option<RawWindowHandle>,
}
// Oh god, I don't like sending RawWindowHandle between threads but here we go anyways...
// fingers crossed
unsafe impl Send for FileDialog {}
impl FileDialog {
/// New file dialog builder
pub fn new() -> Self {
Default::default()
}
/// Add file extension filter.
///
/// Takes in the name of the filter, and list of extensions
///
/// #### Name of the filter will be displayed on supported platforms
/// - Windows
/// - Linux
///
/// On platforms that don't support filter names, all filters will be merged into one filter
pub fn add_filter(mut self, name: &str, extensions: &[&str]) -> Self {
self.filters.push(Filter {
name: name.into(),
extensions: extensions.iter().map(|e| e.to_string()).collect(),
});
self
}
/// Set starting directory of the dialog.
/// #### Supported Platforms:
/// - Linux
/// - Windows
/// - Mac
pub fn set_directory<P: AsRef<Path>>(mut self, path: P) -> Self {
self.starting_directory = Some(path.as_ref().into());
self
}
/// Set starting file name of the dialog.
/// #### Supported Platforms:
/// - Windows
/// - Linux
/// - Mac
pub fn set_file_name(mut self, file_name: &str) -> Self {
self.file_name = Some(file_name.into());
self
}
#[cfg(feature = "parent")]
/// Set parent windows explicitly (optional)
/// Suported in: `macos` and `windows`
pub fn set_parent<W: HasRawWindowHandle>(mut self, parent: &W) -> Self {
self.parent = Some(parent.raw_window_handle());
self
}
}
use crate::backend::{FilePickerDialogImpl, FileSaveDialogImpl, FolderPickerDialogImpl};
#[cfg(not(target_arch = "wasm32"))]
impl FileDialog {
/// Pick one file
pub fn pick_file(self) -> Option<PathBuf> {
FilePickerDialogImpl::pick_file(self)
}
/// Pick multiple files
pub fn pick_files(self) -> Option<Vec<PathBuf>> {
FilePickerDialogImpl::pick_files(self)
}
/// Pick one folder
pub fn pick_folder(self) -> Option<PathBuf> {
FolderPickerDialogImpl::pick_folder(self)
}
/// Opens save file dialog
///
/// #### Platform specific notes regarding save dialog filters:
/// - On MacOs
/// - If filter is set, all files will be grayed out (no matter the extension sadly)
/// - If user does not type an extension MacOs will append first available extension from filters list
/// - If user types in filename with extension MacOs will check if it exists in filters list, if not it will display appropriate message
/// - On GTK
/// - It only filters which already existing files get shown to the user
/// - It does not append extensions automatically
/// - It does not prevent users from adding any unsupported extension
/// - On Win:
/// - If no extension was provided it will just add currently selected one
/// - If selected extension was typed in by the user it will just return
/// - If unselected extension was provided it will append selected one at the end, example: `test.png.txt`
pub fn save_file(self) -> Option<PathBuf> {
FileSaveDialogImpl::save_file(self)
}
}
/// ## Asynchronous File Dialog
/// #### Supported Platforms:
/// - Linux
/// - Windows
/// - Mac
/// - WASM32
#[derive(Default, Debug, Clone)]
pub struct AsyncFileDialog {
file_dialog: FileDialog,
}
impl AsyncFileDialog {
/// New file dialog builder
pub fn new() -> Self {
Default::default()
}
/// Add file extension filter.
///
/// Takes in the name of the filter, and list of extensions
///
/// #### Name of the filter will be displayed on supported platforms
/// - Windows
/// - Linux
///
/// On platforms that don't support filter names, all filters will be merged into one filter
pub fn add_filter(mut self, name: &str, extensions: &[&str]) -> Self {
self.file_dialog = self.file_dialog.add_filter(name, extensions);
self
}
/// Set starting directory of the dialog.
/// #### Supported Platforms:
/// - Linux
/// - Windows
/// - Mac
pub fn set_directory<P: AsRef<Path>>(mut self, path: P) -> Self {
self.file_dialog = self.file_dialog.set_directory(path);
self
}
/// Set starting file name of the dialog.
/// #### Supported Platforms:
/// - Windows
/// - Linux
/// - Mac
pub fn set_file_name(mut self, file_name: &str) -> Self {
self.file_dialog = self.file_dialog.set_file_name(file_name);
self
}
#[cfg(feature = "parent")]
/// Set parent windows explicitly (optional)
/// Suported in: `macos` and `windows`
pub fn set_parent<W: HasRawWindowHandle>(mut self, parent: &W) -> Self {
self.file_dialog = self.file_dialog.set_parent(parent);
self
}
}
use crate::backend::{
AsyncFilePickerDialogImpl, AsyncFileSaveDialogImpl, AsyncFolderPickerDialogImpl,
};
use std::future::Future;
impl AsyncFileDialog {
/// Pick one file
pub fn pick_file(self) -> impl Future<Output = Option<FileHandle>> {
AsyncFilePickerDialogImpl::pick_file_async(self.file_dialog)
}
/// Pick multiple files
pub fn pick_files(self) -> impl Future<Output = Option<Vec<FileHandle>>> {
AsyncFilePickerDialogImpl::pick_files_async(self.file_dialog)
}
#[cfg(not(target_arch = "wasm32"))]
/// Pick one folder
///
/// Does not exist in `WASM32`
pub fn pick_folder(self) -> impl Future<Output = Option<FileHandle>> {
AsyncFolderPickerDialogImpl::pick_folder_async(self.file_dialog)
}
#[cfg(not(target_arch = "wasm32"))]
/// Opens save file dialog
///
/// Does not exist in `WASM32`
///
///
/// #### Platform specific notes regarding save dialog filters:
/// - On MacOs
/// - If filter is set, all files will be grayed out (no matter the extension sadly)
/// - If user does not type an extension MacOs will append first available extension from filters list
/// - If user types in filename with extension MacOs will check if it exists in filters list, if not it will display appropriate message
/// - On GTK
/// - It only filters which already existing files get shown to the user
/// - It does not append extensions automatically
/// - It does not prevent users from adding any unsupported extension
/// - On Win:
/// - If no extension was provided it will just add currently selected one
/// - If selected extension was typed in by the user it will just return
/// - If unselected extension was provided it will append selected one at the end, example: `test.png.txt`
pub fn save_file(self) -> impl Future<Output = Option<FileHandle>> {
AsyncFileSaveDialogImpl::save_file_async(self.file_dialog)
}
}
use crate::backend::AsyncMessageDialogImpl;
use crate::backend::MessageDialogImpl;
/// ## Synchronous Message Dialog
#[derive(Default, Debug, Clone)]
pub struct MessageDialog {
pub(crate) title: String,
pub(crate) description: String,
pub(crate) level: MessageLevel,
pub(crate) buttons: MessageButtons,
#[cfg(feature = "parent")]
pub(crate) parent: Option<RawWindowHandle>,
}
// Oh god, I don't like sending RawWindowHandle between threads but here we go anyways...
// fingers crossed
unsafe impl Send for MessageDialog {}
impl MessageDialog {
pub fn new() -> Self {
Default::default()
}
/// Set level of a dialog
///
/// Depending on the system it can result in level specific icon to show up,
/// the will inform user it message is a error, warning or just information.
pub fn set_level(mut self, level: MessageLevel) -> Self {
self.level = level;
self
}
/// Set title of a dialog
pub fn set_title(mut self, text: &str) -> Self {
self.title = text.into();
self
}
/// Set description of a dialog
///
/// Description is a content of a dialog
pub fn set_description(mut self, text: &str) -> Self {
self.description = text.into();
self
}
/// Set the set of button that will be displayed on the dialog
///
/// - `Ok` dialog is a single `Ok` button
/// - `OkCancel` dialog, will display 2 buttons ok and cancel.
/// - `YesNo` dialog, will display 2 buttons yes and no.
pub fn set_buttons(mut self, btn: MessageButtons) -> Self {
self.buttons = btn;
self
}
#[cfg(feature = "parent")]
/// Set parent windows explicitly (optional)
/// Suported in: `macos` and `windows`
pub fn set_parent<W: HasRawWindowHandle>(mut self, parent: &W) -> Self {
self.parent = Some(parent.raw_window_handle());
self
}
/// Shows a message dialog:
///
/// - In `Ok` dialog, it will return `true` when `OK` was pressed
/// - In `OkCancel` dialog, it will return `true` when `OK` was pressed
/// - In `YesNo` dialog, it will return `true` when `Yes` was pressed
pub fn show(self) -> bool {
MessageDialogImpl::show(self)
}
}
/// ## Asynchronous Message Dialog
#[derive(Default, Debug, Clone)]
pub struct AsyncMessageDialog(MessageDialog);
impl AsyncMessageDialog {
pub fn new() -> Self {
Default::default()
}
/// Set level of a dialog
///
/// Depending on the system it can result in level specific icon to show up,
/// the will inform user it message is a error, warning or just information.
pub fn set_level(mut self, level: MessageLevel) -> Self {
self.0 = self.0.set_level(level);
self
}
/// Set title of a dialog
pub fn set_title(mut self, text: &str) -> Self {
self.0 = self.0.set_title(text);
self
}
/// Set description of a dialog
///
/// Description is a content of a dialog
pub fn set_description(mut self, text: &str) -> Self {
self.0 = self.0.set_description(text);
self
}
/// Set the set of button that will be displayed on the dialog
///
/// - `Ok` dialog is a single `Ok` button
/// - `OkCancel` dialog, will display 2 buttons ok and cancel.
/// - `YesNo` dialog, will display 2 buttons yes and no.
pub fn set_buttons(mut self, btn: MessageButtons) -> Self {
self.0 = self.0.set_buttons(btn);
self
}
#[cfg(feature = "parent")]
/// Set parent windows explicitly (optional)
/// Suported in: `macos` and `windows`
pub fn set_parent<W: HasRawWindowHandle>(mut self, parent: &W) -> Self {
self.0 = self.0.set_parent(parent);
self
}
/// Shows a message dialog:
/// - In `Ok` dialog, it will return `true` when `OK` was pressed
/// - In `OkCancel` dialog, it will return `true` when `OK` was pressed
/// - In `YesNo` dialog, it will return `true` when `Yes` was pressed
pub fn show(self) -> impl Future<Output = bool> {
AsyncMessageDialogImpl::show_async(self.0)
}
}
#[derive(Debug, Clone, Copy)]
pub enum MessageLevel {
Info,
Warning,
Error,
}
impl Default for MessageLevel {
fn default() -> Self {
Self::Info
}
}
#[derive(Debug, Clone, Copy)]
pub enum MessageButtons {
Ok,
OkCancel,
YesNo,
}
impl Default for MessageButtons {
fn default() -> Self {
Self::Ok
}
}