Skip to content

Commit 07efac7

Browse files
committed
docs: Update CHANGESv3 with eventq details
1 parent 7d31d2d commit 07efac7

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

CHANGESv3.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@
44
> _Tcell_ v3 is currently in development, and these details are subject to change
55
> before we release.
66
7-
### Termbox Compatibility Removed
7+
### Events (PostEvent, PollEvent, ChannelEvents)
88

9-
The `termbox` compatibility package is removed. Few applications were using it,
10-
and the compatibility was imperfect. Also the package had limited support for many
11-
newer features. Further, _Termbox_ itself is no longer being maintained.
12-
Applications that still need this should keep using _Tcell_ v2.
9+
The event channel is now directly exposed via `EventQ`, and events may be read from or written
10+
directly to the queue. This should help applications that want to integrate into `select`
11+
statements (e.g. for timed key presses).
12+
13+
The `ChannelEvents`, `PollEvent`, `PostEvent`, and `PostEventWait` functions are removed.
14+
Most simple applications can just change to read from the screen `EventQ` directly.
1315

1416
### Cell and Contents APIs
1517

@@ -21,6 +23,14 @@ newer APIs exist in their place.
2123
- `SetContents` is deprecated and may be removed before release. Use `Put` instead.
2224
- `GetContents` is removed. Use `Get` instead.
2325

26+
### Termbox Compatibility Removed
27+
28+
The `termbox` compatibility package is removed. Few applications were using it,
29+
and the compatibility was imperfect. Also the package had limited support for many
30+
newer features. Further, _Termbox_ itself is no longer being maintained.
31+
Applications that still need this should keep using _Tcell_ v2.
32+
33+
2434
### Support for Grapheme Clusters in EventKey
2535

2636
`EventKey` now carries a string for `KeyRune` instead of a single rune.
@@ -63,15 +73,9 @@ to further savings in the memory per-cell.
6373

6474
`AttrUnderline` is gone. It was not sufficient to describe styled and colored underlines.
6575

66-
### Blocking PostEvent
67-
68-
The `PostEventWait` function is gone. Use `PostEvent` instead, and check the error status
69-
to determine if the event queue was too full. (Unless your application is buggy or you
70-
are overwhelming it with events, the event queue should never fill up.)
71-
7276
### Removed Capability Queries
7377

74-
Deprecated APIs `HasKey` and `CanDisplay` are removed.
78+
Deprecated APIs `HasKey`, `HasMouse`, and `CanDisplay` are removed.
7579
These functions weren't reliable and served no useful purpose.
7680

7781
### Windows Console API

0 commit comments

Comments
 (0)