win-ctx 1.1.0

Library for managing Windows context menu entries
Documentation 
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

win-ctx
[![win-ctx on crates.io][cratesio-image]][cratesio]
[![win-ctx on docs.rs][docsrs-image]][docsrs]
======

[cratesio-image]: https://img.shields.io/crates/v/win-ctx.svg
[cratesio]: https://crates.io/crates/win-ctx
[docsrs-image]: https://docs.rs/win-ctx/badge.svg
[docsrs]: https://docs.rs/win-ctx

A Rust library for managing Windows context menu entries.

## Installation


```sh
cargo add win-ctx
```

## Features


- Create and edit context menu entries and sub-entries
- Toggle the pre-Windows 11 context menu

## Basic examples


The following code creates a top-level context menu entry that appears on
right-clicked folders and opens the target folder in the terminal.

```rust
use win_ctx::*;

CtxEntry::new_with_options(
    "Open in terminal",
    &ActivationType::Folder,
    &EntryOptions {
        command: Some("cmd /s /k pushd \"%V\""),
        icon: Some("C:\\Windows\\System32\\cmd.exe"),
        position: None,
        extended: false,
    }
)?;
```

The following code creates a context menu entry with child entries that each
open the target folder in the selected program.

To reduce line count, the more basic non-options functions can be used,
and individual values are then set on the resulting entries.

```rust
use win_ctx::{CtxEntry, ActivationType};

let mut parent = CtxEntry::new("Open directory in", &ActivationType::Background)?;

let mut child_1 = parent.new_child("Terminal")?;
child_1.set_command(Some("cmd /s /k pushd \"%V\""))?;
child_1.set_icon(Some("C:\\Windows\\System32\\cmd.exe"))?;

let mut child_2 = parent.new_child("Powershell")?;
child_2.set_command(Some("powershell -noexit -command Set-Location -literalPath '%V'"))?;
child_2.set_icon(Some("C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"))?;
```

## Errors


It's possible that an entry's underlying registry key goes out of sync,
so most `CtxEntry` functions verify this and return a [`std::io::Result`].

Errors will have an [`ErrorKind`] of either:
- `PermissionDenied` for insufficient privileges,
- `InvalidValue` for invalid entry renames, or
- `NotFound` for operations on missing keys and values.

[`ErrorKind`]: https://doc.rust-lang.org/std/io/enum.ErrorKind.html
[`std::io::Result`]: https://doc.rust-lang.org/std/io/type.Result.html