Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

brlapi_keycodes.h (3)

Name

brlapi_keycodes.h - brlapi_keycodes.h

Synopsis

#include 'brlapi_constants.h'


Macros
#define BRLAPI_PRIxKEYCODE   PRIx64
#define BRLAPI_PRIuKEYCODE   PRIu64
#define BRLAPI_KEY_MAX   UINT64_C(0XFFFFFFFFFFFFFFFF)
#define BRLAPI_KEY_FLAGS_MASK   UINT64_C(0XFFFFFFFF00000000)
#define BRLAPI_KEY_FLAGS_SHIFT   32
#define BRLAPI_KEY_FLG(v)   ((brlapi_keyCode_t)(v) <<
BRLAPI_KEY_FLAGS_SHIFT)
#define BRLAPI_KEY_FLG_MOD1   BRLAPI_KEY_FLG(0x00000008)
#define BRLAPI_KEY_FLG_MOD2   BRLAPI_KEY_FLG(0x00000010)
#define BRLAPI_KEY_FLG_MOD3   BRLAPI_KEY_FLG(0x00000020)
#define BRLAPI_KEY_FLG_MOD4   BRLAPI_KEY_FLG(0x00000040)
#define BRLAPI_KEY_FLG_MOD5   BRLAPI_KEY_FLG(0x00000080)
#define BRLAPI_KEY_TYPE_MASK   UINT64_C(0X00000000E0000000)
#define BRLAPI_KEY_TYPE_SHIFT   29
#define BRLAPI_KEY_TYPE_CMD   UINT64_C(0X0000000020000000)
#define BRLAPI_KEY_TYPE_SYM   UINT64_C(0X0000000000000000)
#define BRLAPI_KEY_CODE_MASK   UINT64_C(0X000000001FFFFFFF)
#define BRLAPI_KEY_CODE_SHIFT   0
#define BRLAPI_KEY_CMD_BLK_MASK   UINT64_C(0X1FFF0000)
#define BRLAPI_KEY_CMD_BLK_SHIFT   16
#define BRLAPI_KEY_CMD_ARG_MASK   UINT64_C(0X0000FFFF)
#define BRLAPI_KEY_CMD_ARG_SHIFT   0
#define BRLAPI_KEY_CMD(v)   ((v) << BRLAPI_KEY_CMD_BLK_SHIFT)
#define BRLAPI_KEY_SYM_BACKSPACE   UINT64_C(0X0000FF08)
#define BRLAPI_KEY_SYM_TAB   UINT64_C(0X0000FF09)
#define BRLAPI_KEY_SYM_LINEFEED   UINT64_C(0X0000FF0D)
#define BRLAPI_KEY_SYM_ESCAPE   UINT64_C(0X0000FF1B)
#define BRLAPI_KEY_SYM_HOME   UINT64_C(0X0000FF50)
#define BRLAPI_KEY_SYM_LEFT   UINT64_C(0X0000FF51)
#define BRLAPI_KEY_SYM_UP   UINT64_C(0X0000FF52)
#define BRLAPI_KEY_SYM_RIGHT   UINT64_C(0X0000FF53)
#define BRLAPI_KEY_SYM_DOWN   UINT64_C(0X0000FF54)
#define BRLAPI_KEY_SYM_PAGE_UP   UINT64_C(0X0000FF55)
#define BRLAPI_KEY_SYM_PAGE_DOWN   UINT64_C(0X0000FF56)
#define BRLAPI_KEY_SYM_END   UINT64_C(0X0000FF57)
#define BRLAPI_KEY_SYM_INSERT   UINT64_C(0X0000FF63)
#define BRLAPI_KEY_SYM_FUNCTION   UINT64_C(0X0000FFBE)
#define BRLAPI_KEY_SYM_DELETE   UINT64_C(0X0000FFFF)
#define BRLAPI_KEY_SYM_UNICODE   UINT64_C(0X01000000)

Typedefs
typedef uint64_t brlapi_keyCode_t

Description

brlapi_keycodes.h(3)                BrlAPI                brlapi_keycodes.h(3)



NAME
       brlapi_keycodes.h

SYNOPSIS
       #include 'brlapi_constants.h'


   Macros
       #define BRLAPI_PRIxKEYCODE   PRIx64
       #define BRLAPI_PRIuKEYCODE   PRIu64
       #define BRLAPI_KEY_MAX   UINT64_C(0XFFFFFFFFFFFFFFFF)
       #define BRLAPI_KEY_FLAGS_MASK   UINT64_C(0XFFFFFFFF00000000)
       #define BRLAPI_KEY_FLAGS_SHIFT   32
       #define BRLAPI_KEY_FLG(v)   ((brlapi_keyCode_t)(v) <<
           BRLAPI_KEY_FLAGS_SHIFT)
       #define BRLAPI_KEY_FLG_MOD1   BRLAPI_KEY_FLG(0x00000008)
       #define BRLAPI_KEY_FLG_MOD2   BRLAPI_KEY_FLG(0x00000010)
       #define BRLAPI_KEY_FLG_MOD3   BRLAPI_KEY_FLG(0x00000020)
       #define BRLAPI_KEY_FLG_MOD4   BRLAPI_KEY_FLG(0x00000040)
       #define BRLAPI_KEY_FLG_MOD5   BRLAPI_KEY_FLG(0x00000080)
       #define BRLAPI_KEY_TYPE_MASK   UINT64_C(0X00000000E0000000)
       #define BRLAPI_KEY_TYPE_SHIFT   29
       #define BRLAPI_KEY_TYPE_CMD   UINT64_C(0X0000000020000000)
       #define BRLAPI_KEY_TYPE_SYM   UINT64_C(0X0000000000000000)
       #define BRLAPI_KEY_CODE_MASK   UINT64_C(0X000000001FFFFFFF)
       #define BRLAPI_KEY_CODE_SHIFT   0
       #define BRLAPI_KEY_CMD_BLK_MASK   UINT64_C(0X1FFF0000)
       #define BRLAPI_KEY_CMD_BLK_SHIFT   16
       #define BRLAPI_KEY_CMD_ARG_MASK   UINT64_C(0X0000FFFF)
       #define BRLAPI_KEY_CMD_ARG_SHIFT   0
       #define BRLAPI_KEY_CMD(v)   ((v) << BRLAPI_KEY_CMD_BLK_SHIFT)
       #define BRLAPI_KEY_SYM_BACKSPACE   UINT64_C(0X0000FF08)
       #define BRLAPI_KEY_SYM_TAB   UINT64_C(0X0000FF09)
       #define BRLAPI_KEY_SYM_LINEFEED   UINT64_C(0X0000FF0D)
       #define BRLAPI_KEY_SYM_ESCAPE   UINT64_C(0X0000FF1B)
       #define BRLAPI_KEY_SYM_HOME   UINT64_C(0X0000FF50)
       #define BRLAPI_KEY_SYM_LEFT   UINT64_C(0X0000FF51)
       #define BRLAPI_KEY_SYM_UP   UINT64_C(0X0000FF52)
       #define BRLAPI_KEY_SYM_RIGHT   UINT64_C(0X0000FF53)
       #define BRLAPI_KEY_SYM_DOWN   UINT64_C(0X0000FF54)
       #define BRLAPI_KEY_SYM_PAGE_UP   UINT64_C(0X0000FF55)
       #define BRLAPI_KEY_SYM_PAGE_DOWN   UINT64_C(0X0000FF56)
       #define BRLAPI_KEY_SYM_END   UINT64_C(0X0000FF57)
       #define BRLAPI_KEY_SYM_INSERT   UINT64_C(0X0000FF63)
       #define BRLAPI_KEY_SYM_FUNCTION   UINT64_C(0X0000FFBE)
       #define BRLAPI_KEY_SYM_DELETE   UINT64_C(0X0000FFFF)
       #define BRLAPI_KEY_SYM_UNICODE   UINT64_C(0X01000000)

   Typedefs
       typedef uint64_t brlapi_keyCode_t

Author
       Generated automatically by Doxygen for BrlAPI from the source code.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------------+
       |ATTRIBUTE TYPE |       ATTRIBUTE VALUE        |
       +---------------+------------------------------+
       |Availability   | library/accessibility/brltty |
       +---------------+------------------------------+
       |Stability      | Pass-through volatile        |
       +---------------+------------------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://mielke.cc/brltty//archive/brltty-6.0.tar.xz.

       Further information about this software can be found on the open source
       community website at http://mielke.cc/brltty/.



Version 0.7                     Mon Jun 27 2022           brlapi_keycodes.h(3)