Struct IFileOpenDialog

pub struct IFileOpenDialog(/* private fields */);

Available on crate feature shell only.

IFileOpenDialog COM interface.

Automatically calls Release when the object goes out of scope.

Examples

Choosing a single existing TXT file:

use winsafe::{self as w, prelude::*, co};

let hparent: w::HWND; // initialized somewhere

let file_open = w::CoCreateInstance::<w::IFileOpenDialog>(
    &co::CLSID::FileOpenDialog,
    None,
    co::CLSCTX::INPROC_SERVER,
)?;

file_open.SetOptions(
    file_open.GetOptions()?
    | co::FOS::FORCEFILESYSTEM
    | co::FOS::FILEMUSTEXIST,
)?;

file_open.SetFileTypes(&[
    ("Text files", "*.txt"),
    ("All files", "*.*"),
])?;
file_open.SetFileTypeIndex(1)?;

if file_open.Show(&hparent)? {
    let chosen_file = file_open.GetResult()?
        .GetDisplayName(co::SIGDN::FILESYSPATH)?;
    println!("{}", chosen_file);
}

Trait Implementations

impl Clone for IFileOpenDialog

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for IFileOpenDialog

fn drop(&mut self)

Executes the destructor for this type.

impl ole_IUnknown for IFileOpenDialog

const IID: IID

Available on crate feature ole only.

The COM interface ID.

unsafe fn from_ptr(p: *mut c_void) -> Self

Available on crate feature ole only.

Creates an object from a COM virtual table pointer.

unsafe fn as_mut(&mut self) -> &mut *mut c_void

Available on crate feature ole only.

Returns a mutable reference do the underlying COM virtual table pointer.

fn ptr(&self) -> *mut c_void

Available on crate feature ole only.

Returns the pointer to the underlying COM virtual table.

unsafe fn null() -> Self

Available on crate feature ole only.

Creates an object from a null COM virtual table pointer.

fn leak(&mut self) -> *mut c_void

Available on crate feature ole only.

Returns the pointer to the underlying COM virtual table and sets the internal pointer to null, so that Release won’t be called.

fn QueryInterface<T>(&self) -> HrResult<T>

where T: ole_IUnknown,

Available on crate feature ole only.

IUnknown::QueryInterface method.

impl shell_IFileDialog for IFileOpenDialog

fn AddPlace(&self, si: &impl shell_IShellItem, fdap: FDAP) -> HrResult<()>

IFileDialog::AddPlace method.

fn Advise(&self, fde: &IFileDialogEvents) -> HrResult<u32>

IFileDialog::Advise method.

fn ClearClientData(&self) -> HrResult<()>

IFileDialog::ClearClientData method.

fn Close(&self, hr: ERROR) -> HrResult<()>

IFileDialog::Close method.

fn GetCurrentSelection(&self) -> HrResult<IShellItem>

IFileDialog::GetCurrentSelection method.

fn GetFileName(&self) -> HrResult<String>

IFileDialog::GetFileName method.

fn GetFileTypeIndex(&self) -> HrResult<u32>

IFileDialog::GetFileTypeIndex method.

fn GetFolder(&self) -> HrResult<IShellItem>

IFileDialog::GetFolder method.

fn GetOptions(&self) -> HrResult<FOS>

IFileDialog::GetOptions method.

fn GetResult(&self) -> HrResult<IShellItem>

IFileDialog::GetResult method.

fn SetClientGuid(&self, guid: &GUID) -> HrResult<()>

IFileDialog::SetClientGuid method.

fn SetDefaultExtension(&self, default_extension: &str) -> HrResult<()>

IFileDialog::SetDefaultExtension method.

fn SetDefaultFolder(&self, si: &impl shell_IShellItem) -> HrResult<()>

IFileDialog::SetDefaultFolder method.

fn SetFileName(&self, name: &str) -> HrResult<()>

IFileDialog::SetFileName method.

fn SetFileNameLabel(&self, label: &str) -> HrResult<()>

IFileDialog::SetFileNameLabel method.

fn SetFileTypeIndex(&self, index: u32) -> HrResult<()>

IFileDialog::SetFileTypeIndex method.

fn SetFileTypes<S: AsRef<str>>(&self, filter_spec: &[(S, S)]) -> HrResult<()>

IFileDialog::SetFileTypes method.

fn SetFolder(&self, si: &impl shell_IShellItem) -> HrResult<()>

IFileDialog::SetFolder method.

fn SetOkButtonLabel(&self, text: &str) -> HrResult<()>

IFileDialog::SetOkButtonLabel method.

fn SetOptions(&self, opts: FOS) -> HrResult<()>

IFileDialog::SetOptions method.

fn SetTitle(&self, text: &str) -> HrResult<()>

IFileDialog::SetTitle method.

fn Unadvise(&self, cookie: u32) -> HrResult<()>

IFileDialog::Unadvise method.

impl shell_IFileOpenDialog for IFileOpenDialog

fn GetResults(&self) -> HrResult<IShellItemArray>

IFileOpenDialog::GetResults method.

fn GetSelectedItems(&self) -> HrResult<IShellItemArray>

IFileOpenDialog::GetSelectedItems method.

impl shell_IModalWindow for IFileOpenDialog

fn Show(&self, hwnd_owner: &HWND) -> HrResult<bool>

IModalWindow::Show method.

impl Send for IFileOpenDialog