Struct ShellItems 

pub struct ShellItems { /* private fields */ }

Resolved shell items ready to create a context menu from.

Holds the parent IShellFolder and one or more child PIDLs. For background menus (right-clicking empty space inside a folder), child_pidls is empty and the parent itself is the folder.

Create instances via ShellItems::from_path, ShellItems::from_paths, or ShellItems::folder_background.

Implementations

impl ShellItems

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Resolve a single file or folder path to shell items.

Errors

Returns Error::ParsePath if the path does not exist or cannot be resolved by the shell.

Examples found in repository

examples/enumerate.rs (line 12)

fn main() -> win_context_menu::Result<()> {
    let _com = init_com()?;

    let path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| r"C:\Windows\notepad.exe".to_string());

    println!("Enumerating context menu items for: {}\n", path);

    let items = ShellItems::from_path(&path)?;
    let menu = ContextMenu::new(items)?;
    let entries = menu.enumerate()?;

    print_items(&entries, 0);

    Ok(())
}

examples/basic.rs (line 12)

fn main() -> win_context_menu::Result<()> {
    let _com = init_com()?;

    let path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| r"C:\Windows\notepad.exe".to_string());

    println!("Showing context menu for: {}", path);

    let items = ShellItems::from_path(&path)?;
    let menu = ContextMenu::new(items)?;

    match menu.show()? {
        Some(selected) => {
            println!(
                "Selected: {} (verb: {:?})",
                selected.menu_item().label,
                selected.menu_item().command_string
            );
            selected.execute()?;
        }
        None => println!("No item selected."),
    }

    Ok(())
}

examples/extended.rs (line 12)

fn main() -> win_context_menu::Result<()> {
    let _com = init_com()?;

    let path = std::env::args()
        .nth(1)
        .unwrap_or_else(|| r"C:\Windows\notepad.exe".to_string());

    println!("Showing extended context menu (Shift+right-click) for: {}", path);

    let items = ShellItems::from_path(&path)?;
    let menu = ContextMenu::new(items)?.extended(true);

    match menu.show()? {
        Some(selected) => {
            println!(
                "Selected: {} (verb: {:?})",
                selected.menu_item().label,
                selected.menu_item().command_string
            );
            selected.execute()?;
        }
        None => println!("No item selected."),
    }

    Ok(())
}

pub fn from_paths(paths: &[impl AsRef<Path>]) -> Result<Self>

Resolve multiple paths. All paths must share the same parent folder.

This is the multi-select equivalent — the resulting context menu will act on all specified items at once (like selecting several files in Explorer, then right-clicking).

Errors

• Error::NoCommonParent if paths is empty or the paths do not share a common parent folder.
• Error::ParsePath if any path cannot be resolved.

Examples found in repository

examples/multi_select.rs (line 21)

fn main() -> win_context_menu::Result<()> {
    let _com = init_com()?;

    let args: Vec<String> = std::env::args().skip(1).collect();
    let paths: Vec<String> = if args.is_empty() {
        vec![
            r"C:\Windows\notepad.exe".to_string(),
            r"C:\Windows\regedit.exe".to_string(),
        ]
    } else {
        args
    };

    println!("Showing context menu for {} items:", paths.len());
    for p in &paths {
        println!("  - {}", p);
    }

    let items = ShellItems::from_paths(&paths)?;
    let menu = ContextMenu::new(items)?;

    match menu.show()? {
        Some(selected) => {
            println!(
                "Selected: {} (verb: {:?})",
                selected.menu_item().label,
                selected.menu_item().command_string
            );
            selected.execute()?;
        }
        None => println!("No item selected."),
    }

    Ok(())
}

pub fn folder_background(folder: impl AsRef<Path>) -> Result<Self>

Create shell items for the background of a folder.

This is equivalent to right-clicking the empty space inside a folder in Explorer (rather than right-clicking a specific file). The resulting context menu typically offers “New”, “Paste”, “View”, etc.

Errors

Returns Error::ParsePath if the folder path cannot be resolved.

Examples found in repository

examples/folder_background.rs (line 12)

fn main() -> win_context_menu::Result<()> {
    let _com = init_com()?;

    let folder = std::env::args()
        .nth(1)
        .unwrap_or_else(|| r"C:\Windows".to_string());

    println!("Showing background context menu for folder: {}", folder);

    let items = ShellItems::folder_background(&folder)?;
    let menu = ContextMenu::new(items)?;

    match menu.show()? {
        Some(selected) => {
            println!(
                "Selected: {} (verb: {:?})",
                selected.menu_item().label,
                selected.menu_item().command_string
            );
            selected.execute()?;
        }
        None => println!("No item selected."),
    }

    Ok(())
}