USB.Device.HID.Keyboard

Entities

Simple Types

Tagged Types

Subtypes

Constants

Subprograms

Description

---------------------------------------------------------------------------- -- Copyright (C) 2018-2021, AdaCore -- -- Redistribution and use in source and binary forms, with or without -- modification, are permitted provided that the following conditions are -- met: -- 1. Redistributions of source code must retain the above copyright -- notice, this list of conditions and the following disclaimer. -- 2. Redistributions in binary form must reproduce the above copyright -- notice, this list of conditions and the following disclaimer in -- the documentation and/or other materials provided with the -- distribution. -- 3. Neither the name of the copyright holder nor the names of its -- contributors may be used to endorse or promote products derived -- from this software without specific prior written permission. -- -- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -- HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -- -- ----------------------------------------------------------------------------

Instance

type Instance
is new Parent (Keyboard_Report_Size)
with private;

Is_On

function Is_On (This : Instance; L : LEDs) return Boolean

Return True if the Host request the given LED to be lit

Parameters
This
L
Return Value

Key_Codes_Full

function Key_Codes_Full (This : Instance) return Boolean

Return True if there is no more room for keycode in the report (Max_Key_Codes).

Parameters
This
Return Value

Keyboard_Report_Size

Keyboard_Report_Size : constant := Max_Key_Codes + 2;

LEDs

type LEDs is (Num_Lock, Caps_Lock, Scroll_Lock, Compose, Kana);
Enumeration Literal
Num_Lock
Caps_Lock
Scroll_Lock
Compose
Kana

Max_Key_Codes

Max_Key_Codes : constant := 6;

Modifiers

type Modifiers is (Ctrl_Left, Shift_Left, Alt_Left, Meta_Left,
                   Ctrl_Right, Shift_Right, Alt_Right, Meta_Right);
Enumeration Literal
Ctrl_Left
Shift_Left
Alt_Left
Meta_Left
Ctrl_Right
Shift_Right
Alt_Right
Meta_Right

Parent

subtype Parent is Abstract_HID_Class;

Push_Key_Code

procedure Push_Key_Code (This : in out Instance;
                         Code : UInt8)

Push keycode in the report, if not full.

Upon return from the Send_Report procedure, the stack is cleared.

Parameters
This
Code

Set_Modifier

procedure Set_Modifier (This  : in out Instance;
                        M     : Modifiers;
                        Value : Boolean := True)
Parameters
This
M
Value