uefi.protocols.simpletextinex

Based on Protocol/SimpleTextInEx.h, original notice:

Simple Text Input Ex protocol from the UEFI 2.0 specification.

This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL which exposes much more state and modifier information from the input device, also allows one to register a notification for a particular keystroke.

Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Members

Aliases

EFI_INPUT_READ_KEY_EX alias EFI_INPUT_READ_KEY_EX = EFI_STATUS function(EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL* This, EFI_KEY_DATA* KeyData) @(nogc) nothrow: The function reads the next keystroke from the input device. If there is no pending keystroke the function returns EFI_NOT_READY. If there is a pending keystroke, then KeyData.Key.ScanCode is the EFI scan code defined in Error! Reference source not found. The KeyData.Key.UnicodeChar is the actual printable character or is zero if the key does not represent a printable character (control key, function key, etc.). The KeyData.KeyState is shift state for the character reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode . When interpreting the data from this function, it should be noted that if a class of printable characters that are normally adjusted by shift modifiers (e.g. Shift Key + "f" key) would be presented solely as a KeyData.Key.UnicodeChar without the associated shift state. So in the previous example of a Shift Key + "f" key being pressed, the only pertinent data returned would be KeyData.Key.UnicodeChar with the value of "F". This of course would not typically be the case for non-printable characters such as the pressing of the Right Shift Key + F10 key since the corresponding returned data would be reflected both in the KeyData.KeyState.KeyShiftState and KeyData.Key.ScanCode values. UEFI drivers which implement the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return KeyData.Key and KeyData.KeyState values. These drivers must always return the most current state of KeyData.KeyState.KeyShiftState and KeyData.KeyState.KeyToggleState. It should also be noted that certain input devices may not be able to produce shift or toggle state information, and in those cases the high order bit in the respective Toggle and Shift state fields should not be active.
EFI_INPUT_RESET_EX alias EFI_INPUT_RESET_EX = EFI_STATUS function(EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL* This, BOOLEAN ExtendedVerification) @(nogc) nothrow: The Reset() function resets the input device hardware. As part of initialization process, the firmware/device will make a quick but reasonable attempt to verify that the device is functioning. If the ExtendedVerification flag is TRUE the firmware may take an extended amount of time to verify the device is operating on reset. Otherwise the reset operation is to occur as quickly as possible. The hardware verification process is not defined by this specification and is left up to the platform firmware or driver to implement.
EFI_KEY_NOTIFY_FUNCTION alias EFI_KEY_NOTIFY_FUNCTION = EFI_STATUS function(EFI_KEY_DATA* KeyData) @(nogc) nothrow: The function will be called when the key sequence is typed specified by KeyData.
EFI_KEY_TOGGLE_STATE alias EFI_KEY_TOGGLE_STATE = UINT8: EFI_KEY_TOGGLE_STATE. The toggle states are defined. They are: EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE
EFI_REGISTER_KEYSTROKE_NOTIFY
alias EFI_REGISTER_KEYSTROKE_NOTIFY = EFI_STATUS function(EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL* This, EFI_KEY_DATA* KeyData, EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction, void** NotifyHandle) @(nogc) nothrow: The RegisterKeystrokeNotify() function registers a function which will be called when a specified keystroke will occur.
EFI_SET_STATE alias EFI_SET_STATE = EFI_STATUS function(EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL* This, EFI_KEY_TOGGLE_STATE* KeyToggleState) @(nogc) nothrow: The SetState() function allows the input device hardware to have state settings adjusted.
EFI_UNREGISTER_KEYSTROKE_NOTIFY alias EFI_UNREGISTER_KEYSTROKE_NOTIFY = EFI_STATUS function(EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL* This, void* NotificationHandle) @(nogc) nothrow: The UnregisterKeystrokeNotify() function removes the notification which was previously registered.

Manifest constants

EFI_CAPS_LOCK_ACTIVE enum EFI_CAPS_LOCK_ACTIVE;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_KEY_STATE_EXPOSED enum EFI_KEY_STATE_EXPOSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LEFT_ALT_PRESSED enum EFI_LEFT_ALT_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LEFT_CONTROL_PRESSED enum EFI_LEFT_CONTROL_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LEFT_LOGO_PRESSED enum EFI_LEFT_LOGO_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LEFT_SHIFT_PRESSED enum EFI_LEFT_SHIFT_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_MENU_KEY_PRESSED enum EFI_MENU_KEY_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_NUM_LOCK_ACTIVE enum EFI_NUM_LOCK_ACTIVE;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_RIGHT_ALT_PRESSED enum EFI_RIGHT_ALT_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_RIGHT_CONTROL_PRESSED enum EFI_RIGHT_CONTROL_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_RIGHT_LOGO_PRESSED enum EFI_RIGHT_LOGO_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_RIGHT_SHIFT_PRESSED enum EFI_RIGHT_SHIFT_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_SCROLL_LOCK_ACTIVE enum EFI_SCROLL_LOCK_ACTIVE;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_SHIFT_STATE_VALID enum EFI_SHIFT_STATE_VALID;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_SYS_REQ_PRESSED enum EFI_SYS_REQ_PRESSED;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_TOGGLE_STATE_VALID enum EFI_TOGGLE_STATE_VALID;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_BRIGHTNESS_DOWN enum SCAN_BRIGHTNESS_DOWN;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_BRIGHTNESS_UP enum SCAN_BRIGHTNESS_UP;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_EJECT enum SCAN_EJECT;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F11 enum SCAN_F11;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F12 enum SCAN_F12;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F13 enum SCAN_F13;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F14 enum SCAN_F14;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F15 enum SCAN_F15;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F16 enum SCAN_F16;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F17 enum SCAN_F17;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F18 enum SCAN_F18;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F19 enum SCAN_F19;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F20 enum SCAN_F20;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F21 enum SCAN_F21;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F22 enum SCAN_F22;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F23 enum SCAN_F23;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_F24 enum SCAN_F24;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_HIBERNATE enum SCAN_HIBERNATE;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_MUTE enum SCAN_MUTE;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_PAUSE enum SCAN_PAUSE;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_RECOVERY enum SCAN_RECOVERY;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_SUSPEND enum SCAN_SUSPEND;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_TOGGLE_DISPLAY enum SCAN_TOGGLE_DISPLAY;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_VOLUME_DOWN enum SCAN_VOLUME_DOWN;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SCAN_VOLUME_UP enum SCAN_VOLUME_UP;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

EFI_KEY_DATA struct EFI_KEY_DATA: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_KEY_STATE struct EFI_KEY_STATE: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL struct EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL: The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn device. It is an extension to the Simple Text Input protocol which allows a variety of extended shift state information to be returned.

Variables

EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID enum EFI_GUID EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID;: Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.