Skip to content

Commit adddf0c

Browse files
Update the docs for version 5.2.0
1 parent 00d63fe commit adddf0c

File tree

8 files changed

+177
-146
lines changed

8 files changed

+177
-146
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# SharpHook Changelog
22

3+
## [v5.2.0](https://github.com/TolikPylypchuk/SharpHook/releases/tag/v5.2.0) (December 16, 2023)
4+
5+
- Simulated events can now be distinguished from real events using the `HookEventArgs.IsEventSimulated` property.
6+
7+
- Key codes which aren't present on modern keyboards have been deprecated.
8+
9+
- libuiohook was updated to commit
10+
[d710f0f](https://github.com/TolikPylypchuk/libuiohook/tree/d710f0f57194604f98a67514b8c86f442a7bbc3d).
11+
312
## [v5.1.2](https://github.com/TolikPylypchuk/SharpHook/releases/tag/v5.1.2) (November 25, 2023)
413

514
- An issue with key events changing the way some applications handle Alt keys on Windows was fixed.

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,15 @@ dotnet add package SharpHook.Reactive
1616

1717
## Upgrading
1818

19-
A [migration guide](https://sharphook.tolik.io/v5.1.2/articles/migration.html) is available for upgrading between major
19+
A [migration guide](https://sharphook.tolik.io/v5.2.0/articles/migration.html) is available for upgrading between major
2020
versions.
2121

2222
## Docs
2323

2424
You can find more information (including the API reference) in the docs at
2525
[https://sharphook.tolik.io](https://sharphook.tolik.io). Or if you need a specific version:
2626

27+
- [v5.2.0](https://sharphook.tolik.io/v5.2.0)
2728
- [v5.1.2](https://sharphook.tolik.io/v5.1.2) | [v5.1.1](https://sharphook.tolik.io/v5.1.1) | [v5.1.0](https://sharphook.tolik.io/v5.1.0)
2829
- [v5.0.0](https://sharphook.tolik.io/v5.0.0)
2930
- [v4.2.1](https://sharphook.tolik.io/v4.2.1) | [v4.2.0](https://sharphook.tolik.io/v4.2.0)
@@ -86,7 +87,7 @@ the accessibility API be enabled for the application if it wants to create a glo
8687
[may be coming](https://github.com/kwhat/libuiohook/issues/100), but it's not yet here.
8788

8889
More info on OS support can be found in
89-
[an article on OS-specific constraints](https://sharphook.tolik.io/v5.1.2/articles/os-constraints.html).
90+
[an article on OS-specific constraints](https://sharphook.tolik.io/v5.2.0/articles/os-constraints.html).
9091

9192
## Usage
9293

@@ -290,7 +291,7 @@ SharpHook provides the `IEventSimulator` interface, and the default implementati
290291

291292
### Text Entry Simulation
292293

293-
Starting with version 5.0.0, SharpHook also provides text entry simulation. `IEventSimulator` contains the
294+
Starting with version 5, SharpHook also provides text entry simulation. `IEventSimulator` contains the
294295
`SimulateTextEntry` method which accepts a `string`. The text to simulate doesn't depend on the current keyboard layout.
295296
The full range of UTF-16 (including surrogate pairs, e.g. emojis) is supported.
296297

SharpHook/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@ In general, you don't need to use the native methods directly. Instead, use the
1515
provided by SharpHook. However, you should still read this section to know how the high-level features work under
1616
the hood.
1717

18-
If you want to use the low-level functionality, you don't need to use the `UioHook` class directly. Instead you can use
19-
interfaces in the `SharpHook.Providers` namespace. The methods in those interfaces are the same as in the `UioHook`
20-
class. `SharpHook.Providers.UioHookProvider` implements all of these interfaces and simply calls the corresponding
21-
methods in `UioHook`. This should be done to decouple your code from `UioHook` and make testing easier.
22-
2318
`UioHook` contains the following methods for working with the global hook:
2419

2520
- `SetDispatchProc` - sets the function which will be called when an event is raised by libuiohook.
@@ -39,6 +34,11 @@ e.g. emojis) is supported.
3934
libuiohook also provides functions to get various system properties. The corresponding methods are also present in
4035
`UioHook`.
4136

37+
If you want to use the low-level functionality, you don't need to use the `UioHook` class directly. Instead you can use
38+
interfaces in the `SharpHook.Providers` namespace. The methods in those interfaces are the same as in the `UioHook`
39+
class. `SharpHook.Providers.UioHookProvider` implements all of these interfaces and simply calls the corresponding
40+
methods in `UioHook`. This should be done to decouple your code from `UioHook` and make testing easier.
41+
4242
### Global Hooks
4343

4444
SharpHook provides the `IGlobalHook` interface along with two default implementations which you can use to control the

docs/articles/about.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About SharpHook
22

3-
SharpHook. Version 5.1.2. Created by Tolik Pylypchuk.
3+
SharpHook. Version 5.2.0. Created by Tolik Pylypchuk.
44

55
## Library Status
66

@@ -10,6 +10,15 @@ rest assured that it's not abandoned! I'm not giving up on this library any time
1010

1111
## Changelog
1212

13+
### [v5.2.0](https://github.com/TolikPylypchuk/SharpHook/releases/tag/v5.2.0) (December 16, 2023)
14+
15+
- Simulated events can now be distinguished from real events using the `HookEventArgs.IsEventSimulated` property.
16+
17+
- Key codes which aren't present on modern keyboards have been deprecated.
18+
19+
- libuiohook was updated to commit
20+
[d710f0f](https://github.com/TolikPylypchuk/libuiohook/tree/d710f0f57194604f98a67514b8c86f442a7bbc3d).
21+
1322
### [v5.1.2](https://github.com/TolikPylypchuk/SharpHook/releases/tag/v5.1.2) (November 25, 2023)
1423

1524
- An issue with key events changing the way some applications handle Alt keys on Windows was fixed.

0 commit comments

Comments
 (0)