Struct CtxEntry

pub struct CtxEntry {
    pub name_path: Vec<String>,
    pub entry_type: ActivationType,
}

Fields

name_path: Vec<String>

The path to the entry as a list of entry names

entry_type: ActivationType

Implementations

impl CtxEntry

pub fn get<N: AsRef<str>>( name_path: &[N], entry_type: &ActivationType, ) -> Option<CtxEntry>

Gets an existing entry at the given name path. The last name corresponds to the returned entry.

Examples

let name_path = &["Root entry", "Sub entry", "Sub sub entry"];
let entry = CtxEntry::get(name_path, &ActivationType::Folder)?;

pub fn get_all_of_type(entry_type: &ActivationType) -> HashMap<String, CtxEntry>

Gets all root entries with the given entry type.

Examples

let entries = CtxEntry::get_all_of_type(&ActivationType::Folder);

pub fn new(name: &str, entry_type: &ActivationType) -> Result<CtxEntry>

Creates a new top-level entry with the given entry type. The resulting entry will appear in the context menu but will do nothing until modified.

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Background)?;

pub fn new_with_options( name: &str, entry_type: &ActivationType, opts: &EntryOptions, ) -> Result<CtxEntry>

Creates a new top-level entry under the given entry_type.

Examples

let entry = CtxEntry::new(
    "Open in terminal",
    &ActivationType::Folder,
    &EntryOptions {
        // This command opens the target directory in cmd.
        command: Some("cmd /s /k pushd \"%V\""),
        icon: Some("C:\\Windows\\System32\\cmd.exe"),
        position: None,
        extended: false,
    }
)?;

pub fn delete(self) -> Result<()>

Deletes the entry and any children.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
entry.delete()?;

pub fn name(&self) -> Result<String>

Gets the entry’s current name.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let name = entry.name()?;

pub fn rename(&mut self, new_name: &str) -> Result<()>

Renames the entry.

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
entry.rename("Renamed entry")?;

pub fn command(&self) -> Result<Option<String>>

Gets the entry’s command, if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let command = entry.command()?;

pub fn set_command(&mut self, command: Option<&str>) -> Result<()>

Sets the entry’s command.

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Folder)?;
// This command opens the target directory in Powershell.
entry.set_command(Some("powershell.exe -noexit -command Set-Location -literalPath '%V'"))?;

pub fn icon(&self) -> Result<Option<String>>

Gets the entry’s icon, if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let icon = entry.icon()?;

pub fn set_icon(&mut self, icon: Option<&str>) -> Result<()>

Sets the entry’s icon.

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
entry.set_icon(Some("C:\\Windows\\System32\\control.exe"))?;

pub fn position(&self) -> Result<Option<MenuPosition>>

Gets the entry’s position, if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let position = entry.position()?;

pub fn set_position(&mut self, position: Option<MenuPosition>) -> Result<()>

Sets the entry’s menu position. By default, new root entries are positioned at the top. Does not affect child entries.

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
entry.set_position(Some(MenuPosition::Bottom))?;

pub fn extended(&self) -> Result<bool>

Gets whether the entry appears with Shift+RClick.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let is_extended = entry.extended()?;

pub fn set_extended(&mut self, extended: bool) -> Result<()>

Sets whether the entry should only appear with Shift+RClick.

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
entry.set_extended(true)?;

pub fn separator(&self) -> Result<Option<Separator>>

Gets the entry’s separator(s), if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let separator = entry.separator()?;

pub fn set_separator(&mut self, separator: Option<Separator>) -> Result<()>

Sets the entry’s separator(s).

Examples

let mut entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
entry.set_separator(Some(Separator::After))?;

pub fn parent(&self) -> Option<CtxEntry>

Gets the entry’s parent, if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let child = entry.new_child("Basic child entry")?;
let parent = child.parent()?;
assert_eq!(entry.name().unwrap(), parent.name().unwrap());

pub fn child(&self, name: &str) -> Result<Option<CtxEntry>>

Gets one of the entry’s children, if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let created_child = entry.new_child("Basic child entry")?;
let retrieved_child = entry.child("Basic child entry")?;
assert_eq!(created_child.name().unwrap(), retrieved_child.name().unwrap());

pub fn children(&self) -> Result<Vec<CtxEntry>>

Gets the entry’s children, if any.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let child_1 = entry.new_child("Child 1")?;
let child_2 = entry.new_child("Child 2")?;
let children = entry.children()?;

pub fn new_child(&self, name: &str) -> Result<CtxEntry>

Creates a new child entry under the entry. The resulting entry will appear in the context menu but will do nothing until modified.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let child = entry.new_child("Basic child entry")?;

pub fn new_child_with_options( &self, name: &str, opts: &EntryOptions, ) -> Result<CtxEntry>

Creates a new child entry under the entry.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let child = entry.new_child_with_options(
    "Basic child entry",
    &EntryOptions {
        // This command opens the target directory in cmd.
        command: Some("cmd /s /k pushd \"%V\""),
        icon: Some("C:\\Windows\\System32\\cmd.exe"),
        position: None,
        extended: false,
    }
)?;

pub fn path(&self) -> String

Gets the full path to the entry’s registry key.

Examples

let entry = CtxEntry::new("Basic entry", ActivationType::Background)?;
let path = entry.path();