amass/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2024-11-22 18:59:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add documentation about ./example/util/print_key_press (#73)

Browse Source 
Fixed: https://github.com/ArthurSonzogni/FTXUI/issues/72
This commit is contained in:
Arthur Sonzogni 2021-02-13 20:00:00 +01:00 committed by GitHub
parent 73a3c24394
commit 6ed5051cfc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/doxygen_layout.xml
View File

@ -5,7 +5,7 @@
<tab type="examples" visible="yes" title="" intro=""/> <tab type="examples" visible="yes" title="" intro=""/>
<tab type="filelist" visible="yes" title=""/> <tab type="filelist" visible="yes" title=""/>
<tab type="pages" visible="yes" title="" intro=""/> <tab type="pages" visible="no" title="" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/> <tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title=""> <tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/> <tab type="namespacelist" visible="yes" title="" intro=""/>

14
include/ftxui/component/event.hpp
View File

@ -11,10 +11,16 @@ namespace ftxui {
/// @brief Represent an event. It can be key press event, a terminal resize, or /// @brief Represent an event. It can be key press event, a terminal resize, or
/// more ... /// more ...
// ///
// Documentation: /// For example:
// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html /// - Printable character can be created using Event::Character('a').
// /// - Some special are predefined, like Event::ArrowLeft.
/// - One can find arbitrary code for special Events using:
/// ./example/util/print_key_press
/// For instance, CTLR+A maps to Event::Special({1});
///
/// Useful documentation about xterm specification:
/// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
struct Event { struct Event {
// --- Constructor section --------------------------------------------------- // --- Constructor section ---------------------------------------------------
static Event Character(char); static Event Character(char);