brlapi_constants.h

Go to the documentation of this file.

/*
 * libbrlapi - A library providing access to braille terminals for applications.
 *
 * Copyright (C) 2002-2015 by
 *   Samuel Thibault <Samuel.Thibault@ens-lyon.org>
 *   Sébastien Hinderer <Sebastien.Hinderer@ens-lyon.org>
 *
 * libbrlapi comes with ABSOLUTELY NO WARRANTY.
 *
 * This is free software, placed under the terms of the
 * GNU Lesser General Public License, as published by the Free Software
 * Foundation; either version 2.1 of the License, or (at your option) any
 * later version. Please see the file LICENSE-LGPL for details.
 *
 * Web Page: http://brltty.com/
 *
 * This software is maintained by Dave Mielke <dave@mielke.cc>.
 */

#ifndef BRLAPI_INCLUDED_CONSTANTS
#define BRLAPI_INCLUDED_CONSTANTS

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0)

#define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1)

#define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) + 2)

#define BRLAPI_KEY_CMD_WINUP (BRLAPI_KEY_CMD(0) + 3)

#define BRLAPI_KEY_CMD_WINDN (BRLAPI_KEY_CMD(0) + 4)

#define BRLAPI_KEY_CMD_PRDIFLN (BRLAPI_KEY_CMD(0) + 5)

#define BRLAPI_KEY_CMD_NXDIFLN (BRLAPI_KEY_CMD(0) + 6)

#define BRLAPI_KEY_CMD_ATTRUP (BRLAPI_KEY_CMD(0) + 7)

#define BRLAPI_KEY_CMD_ATTRDN (BRLAPI_KEY_CMD(0) + 8)

#define BRLAPI_KEY_CMD_TOP (BRLAPI_KEY_CMD(0) + 9)

#define BRLAPI_KEY_CMD_BOT (BRLAPI_KEY_CMD(0) + 10)

#define BRLAPI_KEY_CMD_TOP_LEFT (BRLAPI_KEY_CMD(0) + 11)

#define BRLAPI_KEY_CMD_BOT_LEFT (BRLAPI_KEY_CMD(0) + 12)

#define BRLAPI_KEY_CMD_PRPGRPH (BRLAPI_KEY_CMD(0) + 13)

#define BRLAPI_KEY_CMD_NXPGRPH (BRLAPI_KEY_CMD(0) + 14)

#define BRLAPI_KEY_CMD_PRPROMPT (BRLAPI_KEY_CMD(0) + 15)

#define BRLAPI_KEY_CMD_NXPROMPT (BRLAPI_KEY_CMD(0) + 16)

#define BRLAPI_KEY_CMD_PRSEARCH (BRLAPI_KEY_CMD(0) + 17)

#define BRLAPI_KEY_CMD_NXSEARCH (BRLAPI_KEY_CMD(0) + 18)

#define BRLAPI_KEY_CMD_CHRLT (BRLAPI_KEY_CMD(0) + 19)

#define BRLAPI_KEY_CMD_CHRRT (BRLAPI_KEY_CMD(0) + 20)

#define BRLAPI_KEY_CMD_HWINLT (BRLAPI_KEY_CMD(0) + 21)

#define BRLAPI_KEY_CMD_HWINRT (BRLAPI_KEY_CMD(0) + 22)

#define BRLAPI_KEY_CMD_FWINLT (BRLAPI_KEY_CMD(0) + 23)

#define BRLAPI_KEY_CMD_FWINRT (BRLAPI_KEY_CMD(0) + 24)

#define BRLAPI_KEY_CMD_FWINLTSKIP (BRLAPI_KEY_CMD(0) + 25)

#define BRLAPI_KEY_CMD_FWINRTSKIP (BRLAPI_KEY_CMD(0) + 26)

#define BRLAPI_KEY_CMD_LNBEG (BRLAPI_KEY_CMD(0) + 27)

#define BRLAPI_KEY_CMD_LNEND (BRLAPI_KEY_CMD(0) + 28)

#define BRLAPI_KEY_CMD_HOME (BRLAPI_KEY_CMD(0) + 29)

#define BRLAPI_KEY_CMD_BACK (BRLAPI_KEY_CMD(0) + 30)

#define BRLAPI_KEY_CMD_RETURN (BRLAPI_KEY_CMD(0) + 31)

#define BRLAPI_KEY_CMD_FREEZE (BRLAPI_KEY_CMD(0) + 32)

#define BRLAPI_KEY_CMD_DISPMD (BRLAPI_KEY_CMD(0) + 33)

#define BRLAPI_KEY_CMD_SIXDOTS (BRLAPI_KEY_CMD(0) + 34)

#define BRLAPI_KEY_CMD_SLIDEWIN (BRLAPI_KEY_CMD(0) + 35)

#define BRLAPI_KEY_CMD_SKPIDLNS (BRLAPI_KEY_CMD(0) + 36)

#define BRLAPI_KEY_CMD_SKPBLNKWINS (BRLAPI_KEY_CMD(0) + 37)

#define BRLAPI_KEY_CMD_CSRVIS (BRLAPI_KEY_CMD(0) + 38)

#define BRLAPI_KEY_CMD_CSRHIDE (BRLAPI_KEY_CMD(0) + 39)

#define BRLAPI_KEY_CMD_CSRTRK (BRLAPI_KEY_CMD(0) + 40)

#define BRLAPI_KEY_CMD_CSRSIZE (BRLAPI_KEY_CMD(0) + 41)

#define BRLAPI_KEY_CMD_CSRBLINK (BRLAPI_KEY_CMD(0) + 42)

#define BRLAPI_KEY_CMD_ATTRVIS (BRLAPI_KEY_CMD(0) + 43)

#define BRLAPI_KEY_CMD_ATTRBLINK (BRLAPI_KEY_CMD(0) + 44)

#define BRLAPI_KEY_CMD_CAPBLINK (BRLAPI_KEY_CMD(0) + 45)

#define BRLAPI_KEY_CMD_TUNES (BRLAPI_KEY_CMD(0) + 46)

#define BRLAPI_KEY_CMD_AUTOREPEAT (BRLAPI_KEY_CMD(0) + 47)

#define BRLAPI_KEY_CMD_AUTOSPEAK (BRLAPI_KEY_CMD(0) + 48)

#define BRLAPI_KEY_CMD_HELP (BRLAPI_KEY_CMD(0) + 49)

#define BRLAPI_KEY_CMD_INFO (BRLAPI_KEY_CMD(0) + 50)

#define BRLAPI_KEY_CMD_LEARN (BRLAPI_KEY_CMD(0) + 51)

#define BRLAPI_KEY_CMD_PREFMENU (BRLAPI_KEY_CMD(0) + 52)

#define BRLAPI_KEY_CMD_PREFSAVE (BRLAPI_KEY_CMD(0) + 53)

#define BRLAPI_KEY_CMD_PREFLOAD (BRLAPI_KEY_CMD(0) + 54)

#define BRLAPI_KEY_CMD_MENU_FIRST_ITEM (BRLAPI_KEY_CMD(0) + 55)

#define BRLAPI_KEY_CMD_MENU_LAST_ITEM (BRLAPI_KEY_CMD(0) + 56)

#define BRLAPI_KEY_CMD_MENU_PREV_ITEM (BRLAPI_KEY_CMD(0) + 57)

#define BRLAPI_KEY_CMD_MENU_NEXT_ITEM (BRLAPI_KEY_CMD(0) + 58)

#define BRLAPI_KEY_CMD_MENU_PREV_SETTING (BRLAPI_KEY_CMD(0) + 59)

#define BRLAPI_KEY_CMD_MENU_NEXT_SETTING (BRLAPI_KEY_CMD(0) + 60)

#define BRLAPI_KEY_CMD_MUTE (BRLAPI_KEY_CMD(0) + 61)

#define BRLAPI_KEY_CMD_SPKHOME (BRLAPI_KEY_CMD(0) + 62)

#define BRLAPI_KEY_CMD_SAY_LINE (BRLAPI_KEY_CMD(0) + 63)

#define BRLAPI_KEY_CMD_SAY_ABOVE (BRLAPI_KEY_CMD(0) + 64)

#define BRLAPI_KEY_CMD_SAY_BELOW (BRLAPI_KEY_CMD(0) + 65)

#define BRLAPI_KEY_CMD_SAY_SLOWER (BRLAPI_KEY_CMD(0) + 66)

#define BRLAPI_KEY_CMD_SAY_FASTER (BRLAPI_KEY_CMD(0) + 67)

#define BRLAPI_KEY_CMD_SAY_SOFTER (BRLAPI_KEY_CMD(0) + 68)

#define BRLAPI_KEY_CMD_SAY_LOUDER (BRLAPI_KEY_CMD(0) + 69)

#define BRLAPI_KEY_CMD_SWITCHVT_PREV (BRLAPI_KEY_CMD(0) + 70)

#define BRLAPI_KEY_CMD_SWITCHVT_NEXT (BRLAPI_KEY_CMD(0) + 71)

#define BRLAPI_KEY_CMD_CSRJMP_VERT (BRLAPI_KEY_CMD(0) + 72)

#define BRLAPI_KEY_CMD_PASTE (BRLAPI_KEY_CMD(0) + 73)

#define BRLAPI_KEY_CMD_RESTARTBRL (BRLAPI_KEY_CMD(0) + 74)

#define BRLAPI_KEY_CMD_RESTARTSPEECH (BRLAPI_KEY_CMD(0) + 75)

#define BRLAPI_KEY_CMD_OFFLINE (BRLAPI_KEY_CMD(0) + 76)

#define BRLAPI_KEY_CMD_SHIFT (BRLAPI_KEY_CMD(0) + 77)

#define BRLAPI_KEY_CMD_UPPER (BRLAPI_KEY_CMD(0) + 78)

#define BRLAPI_KEY_CMD_CONTROL (BRLAPI_KEY_CMD(0) + 79)

#define BRLAPI_KEY_CMD_META (BRLAPI_KEY_CMD(0) + 80)

#define BRLAPI_KEY_CMD_TIME (BRLAPI_KEY_CMD(0) + 81)

#define BRLAPI_KEY_CMD_MENU_PREV_LEVEL (BRLAPI_KEY_CMD(0) + 82)

#define BRLAPI_KEY_CMD_ASPK_SEL_LINE (BRLAPI_KEY_CMD(0) + 83)

#define BRLAPI_KEY_CMD_ASPK_SEL_CHAR (BRLAPI_KEY_CMD(0) + 84)

#define BRLAPI_KEY_CMD_ASPK_INS_CHARS (BRLAPI_KEY_CMD(0) + 85)

#define BRLAPI_KEY_CMD_ASPK_DEL_CHARS (BRLAPI_KEY_CMD(0) + 86)

#define BRLAPI_KEY_CMD_ASPK_REP_CHARS (BRLAPI_KEY_CMD(0) + 87)

#define BRLAPI_KEY_CMD_ASPK_CMP_WORDS (BRLAPI_KEY_CMD(0) + 88)

#define BRLAPI_KEY_CMD_SPEAK_CURR_CHAR (BRLAPI_KEY_CMD(0) + 89)

#define BRLAPI_KEY_CMD_SPEAK_PREV_CHAR (BRLAPI_KEY_CMD(0) + 90)

#define BRLAPI_KEY_CMD_SPEAK_NEXT_CHAR (BRLAPI_KEY_CMD(0) + 91)

#define BRLAPI_KEY_CMD_SPEAK_CURR_WORD (BRLAPI_KEY_CMD(0) + 92)

#define BRLAPI_KEY_CMD_SPEAK_PREV_WORD (BRLAPI_KEY_CMD(0) + 93)

#define BRLAPI_KEY_CMD_SPEAK_NEXT_WORD (BRLAPI_KEY_CMD(0) + 94)

#define BRLAPI_KEY_CMD_SPEAK_CURR_LINE (BRLAPI_KEY_CMD(0) + 95)

#define BRLAPI_KEY_CMD_SPEAK_PREV_LINE (BRLAPI_KEY_CMD(0) + 96)

#define BRLAPI_KEY_CMD_SPEAK_NEXT_LINE (BRLAPI_KEY_CMD(0) + 97)

#define BRLAPI_KEY_CMD_SPEAK_FRST_CHAR (BRLAPI_KEY_CMD(0) + 98)

#define BRLAPI_KEY_CMD_SPEAK_LAST_CHAR (BRLAPI_KEY_CMD(0) + 99)

#define BRLAPI_KEY_CMD_SPEAK_FRST_LINE (BRLAPI_KEY_CMD(0) + 100)

#define BRLAPI_KEY_CMD_SPEAK_LAST_LINE (BRLAPI_KEY_CMD(0) + 101)

#define BRLAPI_KEY_CMD_DESC_CURR_CHAR (BRLAPI_KEY_CMD(0) + 102)

#define BRLAPI_KEY_CMD_SPELL_CURR_WORD (BRLAPI_KEY_CMD(0) + 103)

#define BRLAPI_KEY_CMD_ROUTE_CURR_LOCN (BRLAPI_KEY_CMD(0) + 104)

#define BRLAPI_KEY_CMD_SPEAK_CURR_LOCN (BRLAPI_KEY_CMD(0) + 105)

#define BRLAPI_KEY_CMD_SHOW_CURR_LOCN (BRLAPI_KEY_CMD(0) + 106)

#define BRLAPI_KEY_CMD_CLIP_SAVE (BRLAPI_KEY_CMD(0) + 107)

#define BRLAPI_KEY_CMD_CLIP_RESTORE (BRLAPI_KEY_CMD(0) + 108)

#define BRLAPI_KEY_CMD_BRLUCDOTS (BRLAPI_KEY_CMD(0) + 109)

#define BRLAPI_KEY_CMD_BRLKBD (BRLAPI_KEY_CMD(0) + 110)

#define BRLAPI_KEY_CMD_UNSTICK (BRLAPI_KEY_CMD(0) + 111)

#define BRLAPI_KEY_CMD_ALTGR (BRLAPI_KEY_CMD(0) + 112)

#define BRLAPI_KEY_CMD_GUI (BRLAPI_KEY_CMD(0) + 113)

#define BRLAPI_KEY_CMD_BRL_STOP (BRLAPI_KEY_CMD(0) + 114)

#define BRLAPI_KEY_CMD_BRL_START (BRLAPI_KEY_CMD(0) + 115)

#define BRLAPI_KEY_CMD_SPK_STOP (BRLAPI_KEY_CMD(0) + 116)

#define BRLAPI_KEY_CMD_SPK_START (BRLAPI_KEY_CMD(0) + 117)

#define BRLAPI_KEY_CMD_SCR_STOP (BRLAPI_KEY_CMD(0) + 118)

#define BRLAPI_KEY_CMD_SCR_START (BRLAPI_KEY_CMD(0) + 119)

#define BRLAPI_KEY_CMD_SELECTVT_PREV (BRLAPI_KEY_CMD(0) + 120)

#define BRLAPI_KEY_CMD_SELECTVT_NEXT (BRLAPI_KEY_CMD(0) + 121)

#define BRLAPI_KEY_CMD_PRNBWIN (BRLAPI_KEY_CMD(0) + 122)

#define BRLAPI_KEY_CMD_NXNBWIN (BRLAPI_KEY_CMD(0) + 123)

#define BRLAPI_KEY_CMD_TOUCH_NAV (BRLAPI_KEY_CMD(0) + 124)

#define BRLAPI_KEY_CMD_ROUTE BRLAPI_KEY_CMD(1)

#define BRLAPI_KEY_CMD_CLIP_NEW BRLAPI_KEY_CMD(2)

#define BRLAPI_KEY_CMD_CUTBEGIN BRLAPI_KEY_CMD(2)

#define BRLAPI_KEY_CMD_CLIP_ADD BRLAPI_KEY_CMD(3)

#define BRLAPI_KEY_CMD_CUTAPPEND BRLAPI_KEY_CMD(3)

#define BRLAPI_KEY_CMD_COPY_RECT BRLAPI_KEY_CMD(4)

#define BRLAPI_KEY_CMD_CUTRECT BRLAPI_KEY_CMD(4)

#define BRLAPI_KEY_CMD_COPY_LINE BRLAPI_KEY_CMD(5)

#define BRLAPI_KEY_CMD_CUTLINE BRLAPI_KEY_CMD(5)

#define BRLAPI_KEY_CMD_SWITCHVT BRLAPI_KEY_CMD(6)

#define BRLAPI_KEY_CMD_PRINDENT BRLAPI_KEY_CMD(7)

#define BRLAPI_KEY_CMD_NXINDENT BRLAPI_KEY_CMD(8)

#define BRLAPI_KEY_CMD_DESCCHAR BRLAPI_KEY_CMD(9)

#define BRLAPI_KEY_CMD_SETLEFT BRLAPI_KEY_CMD(10)

#define BRLAPI_KEY_CMD_SETMARK BRLAPI_KEY_CMD(11)

#define BRLAPI_KEY_CMD_GOTOMARK BRLAPI_KEY_CMD(12)

#define BRLAPI_KEY_CMD_GOTOLINE BRLAPI_KEY_CMD(13)

#define BRLAPI_KEY_CMD_PRDIFCHAR BRLAPI_KEY_CMD(14)

#define BRLAPI_KEY_CMD_NXDIFCHAR BRLAPI_KEY_CMD(15)

#define BRLAPI_KEY_CMD_CLIP_COPY BRLAPI_KEY_CMD(16)

#define BRLAPI_KEY_CMD_COPYCHARS BRLAPI_KEY_CMD(16)

#define BRLAPI_KEY_CMD_CLIP_APPEND BRLAPI_KEY_CMD(17)

#define BRLAPI_KEY_CMD_APNDCHARS BRLAPI_KEY_CMD(17)

#define BRLAPI_KEY_CMD_PASTE_HISTORY BRLAPI_KEY_CMD(18)

#define BRLAPI_KEY_CMD_SET_TEXT_TABLE BRLAPI_KEY_CMD(19)

#define BRLAPI_KEY_CMD_SET_ATTRIBUTES_TABLE BRLAPI_KEY_CMD(20)

#define BRLAPI_KEY_CMD_SET_CONTRACTION_TABLE BRLAPI_KEY_CMD(21)

#define BRLAPI_KEY_CMD_SET_KEYBOARD_TABLE BRLAPI_KEY_CMD(22)

#define BRLAPI_KEY_CMD_SET_LANGUAGE_PROFILE BRLAPI_KEY_CMD(23)

#define BRLAPI_KEY_CMD_SELECTVT BRLAPI_KEY_CMD(30)

#define BRLAPI_KEY_CMD_ALERT BRLAPI_KEY_CMD(31)

#define BRLAPI_KEY_CMD_PASSDOTS BRLAPI_KEY_CMD(34)

#define BRLAPI_KEY_CMD_PASSAT BRLAPI_KEY_CMD(35)

#define BRLAPI_KEY_CMD_PASSXT BRLAPI_KEY_CMD(36)

#define BRLAPI_KEY_CMD_PASSPS2 BRLAPI_KEY_CMD(37)

#define BRLAPI_KEY_CMD_CONTEXT BRLAPI_KEY_CMD(38)

#define BRLAPI_KEY_CMD_TOUCH_AT BRLAPI_KEY_CMD(39)

#define BRLAPI_KEY_FLG_TOGGLE_ON BRLAPI_KEY_FLG(0X0100)

#define BRLAPI_KEY_FLG_TOGGLE_OFF BRLAPI_KEY_FLG(0X0200)

#define BRLAPI_KEY_FLG_TOGGLE_MASK (BRLAPI_KEY_FLG_TOGGLE_ON | BRLAPI_KEY_FLG_TOGGLE_OFF)

#define BRLAPI_KEY_FLG_MOTION_ROUTE BRLAPI_KEY_FLG(0X0400)

#define BRLAPI_KEY_FLG_MOTION_SCALED BRLAPI_KEY_FLG(0X0800)

#define BRLAPI_KEY_FLG_MOTION_TOLEFT BRLAPI_KEY_FLG(0X1000)

#define BRLAPI_KEY_FLG_SHIFT BRLAPI_KEY_FLG(0X01)

#define BRLAPI_KEY_FLG_UPPER BRLAPI_KEY_FLG(0X02)

#define BRLAPI_KEY_FLG_CONTROL BRLAPI_KEY_FLG(0X04)

#define BRLAPI_KEY_FLG_META BRLAPI_KEY_FLG(0X08)

#define BRLAPI_KEY_FLG_ALTGR BRLAPI_KEY_FLG(0X10)

#define BRLAPI_KEY_FLG_GUI BRLAPI_KEY_FLG(0X20)

#define BRLAPI_KEY_FLG_KBD_RELEASE BRLAPI_KEY_FLG(0X0100)

#define BRLAPI_KEY_FLG_KBD_EMUL0 BRLAPI_KEY_FLG(0X0200)

#define BRLAPI_KEY_FLG_KBD_EMUL1 BRLAPI_KEY_FLG(0X0400)

#define BRLAPI_DOT1 1

#define BRLAPI_DOT2 2

#define BRLAPI_DOT3 4

#define BRLAPI_DOT4 8

#define BRLAPI_DOT5 16

#define BRLAPI_DOT6 32

#define BRLAPI_DOT7 64

#define BRLAPI_DOT8 128

#define BRLAPI_DOTC 256

#define BRLAPI_DOTS(dot1, dot2, dot3, dot4, dot5, dot6, dot7, dot8) (\
  ((dot1)? BRLAPI_DOT1: 0) | \
  ((dot2)? BRLAPI_DOT2: 0) | \
  ((dot3)? BRLAPI_DOT3: 0) | \
  ((dot4)? BRLAPI_DOT4: 0) | \
  ((dot5)? BRLAPI_DOT5: 0) | \
  ((dot6)? BRLAPI_DOT6: 0) | \
  ((dot7)? BRLAPI_DOT7: 0) | \
  ((dot8)? BRLAPI_DOT8: 0) \
)

#define BRLAPI_DOT_CHORD 256

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* BRLAPI_INCLUDED_CONSTANTS */