windows-common-dialog 0.1.0

Wrapper for Windows file chooser dialog with files&folders mode
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

//! File type filters offered by the dialog.

use windows::Win32::UI::Shell::Common::COMDLG_FILTERSPEC;
use windows::core::{HSTRING, PCWSTR};

/// A named file type filter, e.g. `("Text files", "*.txt;*.md")`.
///
/// `patterns` is a semicolon-separated list of wildcard patterns.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WinFileFilter {
    /// Human-readable name shown in the type dropdown.
    pub name: HSTRING,
    /// Wildcard patterns, e.g. `"*.txt;*.md"`.
    pub patterns: HSTRING,
}

impl WinFileFilter {
    /// Creates a new filter.
    pub fn new(name: impl Into<HSTRING>, patterns: impl Into<HSTRING>) -> Self {
        Self {
            name: name.into(),
            patterns: patterns.into(),
        }
    }

    /// Returns the matching `COMDLG_FILTERSPEC`.
    pub fn as_comdlg_filterspec(&self) -> COMDLG_FILTERSPEC {
        COMDLG_FILTERSPEC {
            pszName: PCWSTR(self.name.as_ptr()),
            pszSpec: PCWSTR(self.patterns.as_ptr()),
        }
    }
}