brlapi_unignoreKeyRange man page on YellowDog

Man page or keyword search:  
man Server   18644 pages
apropos Keyword Search (all sections)
Output format
YellowDog logo
[printable version]

Reading key presses(3)		    BrlAPI		Reading key presses(3)

NAME
       Reading key presses - How to read key presses from the braille
       terminal.

   Defines
       #define BRL_KEYCODE_MAX	 ((brl_keycode_t) (UINT32_MAX))
       #define BRLAPI_MAXKEYSETSIZE   (BRLAPI_MAXPACKETSIZE /
	   sizeof(brl_keycode_t))

   Typedefs
       typedef uint32_t brl_keycode_t

   Functions
       int brlapi_readKey (int block, brl_keycode_t *code)
       int brlapi_ignoreKeyRange (brl_keycode_t x, brl_keycode_t y)
       int brlapi_ignoreKeySet (const brl_keycode_t *s, unsigned int n)
       int brlapi_unignoreKeyRange (brl_keycode_t x, brl_keycode_t y)
       int brlapi_unignoreKeySet (const brl_keycode_t *s, unsigned int n)

Detailed Description
       Once brlapi_getTty() is called, the application can call
       brlapi_readKey() to read key presses. Either key codes or commands will
       be returned, depending on parameters given to brlapi_getTty().

       Key presses are buffered, so that calling brlapi_readKey() in non-
       blocking mode from times to times should suffice.

Define Documentation
   #define BRL_KEYCODE_MAX   ((brl_keycode_t) (UINT32_MAX))
       Brl_keycode_t's biggest value

       As defined in <stdint.h>

   #define BRLAPI_MAXKEYSETSIZE	  (BRLAPI_MAXPACKETSIZE /
       sizeof(brl_keycode_t))
       Maximum keyset size, i.e. maximum number of keys allowed in a key set

Typedef Documentation
   typedef uint32_t brl_keycode_t
       Type for key codes

       Its size is 32 bits, so driver implementors have to restrict themselves
       to a 32 bit space.

Function Documentation
   int brlapi_ignoreKeyRange (brl_keycode_t x, brl_keycode_t y)
       Ignore some key presses from the braille keyboard

       This function asks the server to give keys between x and y to brltty,
       rather than returning them to the application via brlapi_readKey()

       Note:
	   The given codes are either raw keycodes if some driver name was
	   given to brlapi_getTty(), or brltty commands if NULL or '' was
	   given.

   int brlapi_ignoreKeySet (const brl_keycode_t * s, unsigned int n)
       Ignore some key presses from the braille keyboard

       This function asks the server to give the n keys in set s to brltty,
       rather than returning them to the application via brlapi_readKey()

       Note:
	   The given codes are either raw keycodes if some driver name was
	   given to brlapi_getTty(), or brltty commands if NULL or '' was
	   given.

   int brlapi_readKey (int block, brl_keycode_t * code)
       Read a key from the braille keyboard

       This function returns one key press's code.

       If NULL or '' was given to brlapi_getTty(), a brltty command is
       returned, as described in <brltty/brldefs.h> . It is hence pretty
       driver-independent, and should be used by default when no other option
       is possible.

       By default, all commands but those which restart drivers and switch
       virtual terminals are returned to the application and not to brltty. If
       the application doesn't want to see some command events, it should call
       either brlapi_ignoreKeySet() or brlapi_ignoreKeyRange()

       If some driver name was given to brlapi_getTty(), a raw keycode is
       returned, as specified by the terminal driver, usually in
       <brltty/brldefs-xy> where xy is the driver's code. It generally
       corresponds to the very code that the terminal tells to the driver.
       This should only be used by applications which are dedicated to a
       particular braille terminal. Hence, checking the terminal type thanks
       to a call to brlapi_getDriverId() or even brlapi_getDriverName() before
       getting tty control is a pretty good idea.

       By default, all the keypresses will be passed to the client, none will
       go through brltty, so the application will have to handle console
       switching itself for instance.

       Parameters:
	   block tells whether the call should block until a key is pressed
	   (1) or should only probe key presses (0);
	   code holds the key code if a key press is indeed read.

       Returns:
	   -1 on error and *code is then undefined, 0 if block was 0 and no
	   key was pressed so far, or 1 and *code holds the key code.

   int brlapi_unignoreKeyRange (brl_keycode_t x, brl_keycode_t y)
       Unignore some key presses from the braille keyboard

       This function asks the server to return keys between x and y to the
       application, and not give them to brltty.

       Note:
	   You shouldn't ask the server to give you key presses which are
	   usually used to switch between TTYs, unless you really know what
	   you are doing!

	   The given codes are either raw keycodes if some driver name was
	   given to brlapi_getTty(), or brltty commands if NULL or '' was
	   given.

   int brlapi_unignoreKeySet (const brl_keycode_t * s, unsigned int n)
       Unignore some key presses from the braille keyboard

       This function asks the server to return all n keys in set s to the
       application, and not give them to brltty.

       Note:
	   You shouldn't ask the server to give you key presses which are
	   usually used to switch between TTYs, unless you really know what
	   you are doing!

	   The given codes are either raw keycodes if some driver name was
	   given to brlapi_getTty(), or brltty commands if NULL or '' was
	   given.

Version 1.0			  26 Dec 2005		Reading key presses(3)
[top]

List of man pages available for YellowDog

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net