|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `keyboard` mod in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, keyboard"><title>smithay_client_toolkit::keyboard - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../smithay_client_toolkit/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module keyboard</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>smithay_client_toolkit</a></p><script>window.sidebarCurrent = {name: 'keyboard', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/smithay_client_toolkit/keyboard/mod.rs.html#1-893' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>smithay_client_toolkit</a>::<wbr><a class="mod" href=''>keyboard</a></span></h1><div class='docblock'><p>Utilities for keymap interpretation of keyboard input
|
|
|
This module provides an implementation for <code>wl_keyboard</code>
|
|
|
objects using <code>libxkbcommon</code> to interpret the keyboard input
|
|
|
given the user keymap.</p>
|
|
|
<p>You simply need to provide an implementation to receive the
|
|
|
intepreted events, as described by the <code>Event</code> enum of this modules.</p>
|
|
|
<p>Implementation of you <code>NewProxy<WlKeyboard></code> can be done with the
|
|
|
<code>map_keyboard_auto</code> or the <code>map_keyboard_rmlvo</code> functions depending
|
|
|
on whether you wish to use the keymap provided by the server or a
|
|
|
specific one.</p>
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="keysyms/index.html" title='smithay_client_toolkit::keyboard::keysyms mod'>keysyms</a></td><td class='docblock-short'></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.KeyRepeatEvent.html" title='smithay_client_toolkit::keyboard::KeyRepeatEvent struct'>KeyRepeatEvent</a></td><td class='docblock-short'><p>An event sent at repeated intervals for certain keys determined by xkb_keymap_key_repeats</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ModifiersState.html" title='smithay_client_toolkit::keyboard::ModifiersState struct'>ModifiersState</a></td><td class='docblock-short'><p>Represents the current state of the keyboard modifiers</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RMLVO.html" title='smithay_client_toolkit::keyboard::RMLVO struct'>RMLVO</a></td><td class='docblock-short'><p>The RMLVO description of a keymap</p>
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.Error.html" title='smithay_client_toolkit::keyboard::Error enum'>Error</a></td><td class='docblock-short'><p>An error that occurred while trying to initialize a mapped keyboard</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Event.html" title='smithay_client_toolkit::keyboard::Event enum'>Event</a></td><td class='docblock-short'><p>Events received from a mapped keyboard</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.KeyRepeatKind.html" title='smithay_client_toolkit::keyboard::KeyRepeatKind enum'>KeyRepeatKind</a></td><td class='docblock-short'><p>Determines the behavior of key repetition</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.KeyState.html" title='smithay_client_toolkit::keyboard::KeyState enum'>KeyState</a></td><td class='docblock-short'><p>physical key state</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.map_keyboard_auto.html" title='smithay_client_toolkit::keyboard::map_keyboard_auto fn'>map_keyboard_auto</a></td><td class='docblock-short'><p>Implement a keyboard to automatically detect the keymap</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.map_keyboard_auto_with_repeat.html" title='smithay_client_toolkit::keyboard::map_keyboard_auto_with_repeat fn'>map_keyboard_auto_with_repeat</a></td><td class='docblock-short'><p>Implement a keyboard to automatically detect the keymap and send KeyRepeatEvents
|
|
|
at set intervals</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.map_keyboard_rmlvo.html" title='smithay_client_toolkit::keyboard::map_keyboard_rmlvo fn'>map_keyboard_rmlvo</a></td><td class='docblock-short'><p>Implement a keyboard for a predefined keymap</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.map_keyboard_rmlvo_with_repeat.html" title='smithay_client_toolkit::keyboard::map_keyboard_rmlvo_with_repeat fn'>map_keyboard_rmlvo_with_repeat</a></td><td class='docblock-short'><p>Implement a keyboard for a predefined keymap and send KeyRepeatEvents at set
|
|
|
intervals</p>
|
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "smithay_client_toolkit";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |
