Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

brlapi_setFocus (3)

Name

brlapi_setFocus - How to take control of ttys for direct braille display / read.

Synopsis

Macros
#define BRLAPI_TTY_DEFAULT   -1

Functions
int BRLAPI_STDCALL brlapi_enterTtyMode (int tty, const char *driver)
int BRLAPI_STDCALL brlapi__enterTtyMode (brlapi_handle_t *handle, int
tty, const char *driver)
int BRLAPI_STDCALL brlapi_enterTtyModeWithPath (int *ttys, int count,
const char *driver)
int BRLAPI_STDCALL brlapi__enterTtyModeWithPath (brlapi_handle_t
*handle, int *ttys, int count, const char *driver)
int BRLAPI_STDCALL brlapi_leaveTtyMode (void)
int BRLAPI_STDCALL brlapi__leaveTtyMode (brlapi_handle_t *handle)
int BRLAPI_STDCALL brlapi_setFocus (int tty)
int BRLAPI_STDCALL brlapi__setFocus (brlapi_handle_t *handle, int tty)

Description

brlapi_tty(3)                       BrlAPI                       brlapi_tty(3)



NAME
       brlapi_tty - How to take control of ttys for direct braille display /
       read.


SYNOPSIS
   Macros
       #define BRLAPI_TTY_DEFAULT   -1

   Functions
       int BRLAPI_STDCALL brlapi_enterTtyMode (int tty, const char *driver)
       int BRLAPI_STDCALL brlapi__enterTtyMode (brlapi_handle_t *handle, int
           tty, const char *driver)
       int BRLAPI_STDCALL brlapi_enterTtyModeWithPath (int *ttys, int count,
           const char *driver)
       int BRLAPI_STDCALL brlapi__enterTtyModeWithPath (brlapi_handle_t
           *handle, int *ttys, int count, const char *driver)
       int BRLAPI_STDCALL brlapi_leaveTtyMode (void)
       int BRLAPI_STDCALL brlapi__leaveTtyMode (brlapi_handle_t *handle)
       int BRLAPI_STDCALL brlapi_setFocus (int tty)
       int BRLAPI_STDCALL brlapi__setFocus (brlapi_handle_t *handle, int tty)

Detailed Description
       Before being able to write on the braille display, the application must
       tell the server which tty it will handle.

       The application must also specify how braille keys will be delivered to
       it. Two ways are possible: key codes and commands:

       o key codes are specific to each braille driver, since the raw key
         code, as defined in the driver will be given for each key press.
         Using them leads to building highly driver-dependent applications,
         which can yet sometimes be useful to mimic existing proprietary
         applications for instance.

       o commands means that applications will get exactly the same values as
         brltty. This allows driver-independent clients, which will hopefully
         be nice to use with a lot of different terminals.

       See also:
           brlapi_readKey()

Macro Definition Documentation
   #define BRLAPI_TTY_DEFAULT   -1
       Select the default tty.

       The library takes the following steps:

       1.  Try to get the tty number from the WINDOWID environment variable
           (for the xterm case).

       2.  Try to get the tty number from the CONTROLVT environment variable.

       3.  Read /proc/self/stat (on Linux).

       See also:
           brlapi_enterTtyMode()

Function Documentation
   int BRLAPI_STDCALL brlapi__enterTtyMode (brlapi_handle_t * handle, int tty,
       const char * driver)
   int BRLAPI_STDCALL brlapi__enterTtyModeWithPath (brlapi_handle_t * handle,
       int * ttys, int count, const char * driver)
   int BRLAPI_STDCALL brlapi__leaveTtyMode (brlapi_handle_t * handle)
   int BRLAPI_STDCALL brlapi__setFocus (brlapi_handle_t * handle, int tty)
   int BRLAPI_STDCALL brlapi_enterTtyMode (int tty, const char * driver)
       Ask for some tty, with some key mechanism

       Parameters:
           tty

           o If tty>=0 then take control of the specified tty.

           o If tty==BRLAPI_TTY_DEFAULT then take control of the default tty.

           driver tells how the application wants brlapi_readKey() to return
           key presses. NULL or '' means BRLTTY commands are required, whereas
           a driver name means that raw key codes returned by this driver are
           expected.

       WINDOWPATH and WINDOWID should be propagated when running remote
       applications via ssh, for instance, along with BRLAPI_HOST and the
       authorization key (see SendEnv in ssh_config(5) and AcceptEnv in
       sshd_config(5))

       Returns:
           the used tty number on success, -1 on error

       See also:
           brlapi_leaveTtyMode() brlapi_readKey()

   int BRLAPI_STDCALL brlapi_enterTtyModeWithPath (int * ttys, int count,
       const char * driver)
       Ask for some tty specified by its path in the tty tree, with some key
       mechanism

       Parameters:
           ttys points on the array of ttys representing the tty path to be
           got. Can be NULL if nttys is 0.
           count gives the number of elements in ttys.
           driver has the same meaning as in brlapi_enterTtyMode()

       Providing nttys == 0 means to get the root.

       See also:
           brlapi_enterTtyMode()

   int BRLAPI_STDCALL brlapi_leaveTtyMode (void)
       Stop controlling the tty

       Returns:
           0 on success, -1 on error.

       See also:
           brlapi_enterTtyMode()

   int BRLAPI_STDCALL brlapi_setFocus (int tty)
       Tell the current tty to brltty

       This is intended for focus tellers, such as brltty, xbrlapi, screen,
       ... brlapi_enterTtyMode() must have been called beforehand to tell
       where this focus applies in the tty tree.

       Returns:
           0 on success, -1 on error.

       See also:
           brlapi_enterTtyMode() brlapi_leaveTtyMode()

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
       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-5.4.tar.xz

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



Version 1.0                     Wed May 29 2019                  brlapi_tty(3)