Blame doc/html/group__misc.html

Packit 57e92c
Packit 57e92c
Packit 57e92c
<html xmlns="http://www.w3.org/1999/xhtml">
Packit 57e92c
    <head>
Packit 57e92c
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
Packit 57e92c
        
Packit 57e92c
        <meta name="viewport" content="width=device-width, initial-scale=1">
Packit 57e92c
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Packit 57e92c
        <meta name="generator" content="Doxygen 1.8.15"/>
Packit 57e92c
        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
Packit 57e92c
        <title>libevdev: Miscellaneous helper functions</title>
Packit 57e92c
        
Packit 57e92c
        <script type="text/javascript" src="dynsections.js"></script>
Packit 57e92c
        <link href="search/search.css" rel="stylesheet" type="text/css"/>
Packit 57e92c
<script type="text/javascript" src="search/searchdata.js"></script>
Packit 57e92c
<script type="text/javascript" src="search/search.js"></script>
Packit 57e92c
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
Packit 57e92c
        <link href="bootstrap.css" rel="stylesheet" type="text/css"/>
Packit 57e92c
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
Packit 57e92c
<link href="libevdevdoxygen.css" rel="stylesheet" type="text/css"/>
Packit 57e92c
        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
Packit 57e92c
        <script type="text/javascript" src="doxy-boot.js"></script>
Packit 57e92c
    </head>
Packit 57e92c
    <body>
Packit 57e92c
        <nav class="navbar navbar-default" role="navigation">
Packit 57e92c
            
Packit 57e92c
                
Packit 57e92c
                    libevdev 1.8.0
Packit 57e92c
                
Packit 57e92c
            
Packit 57e92c
        </nav>
Packit 57e92c
        
Packit 57e92c
            
Packit 57e92c
                
Packit 57e92c
                    
Packit 57e92c
                        
Packit 57e92c
                            
Packit 57e92c
Packit 57e92c
Packit 57e92c
<script type="text/javascript">
Packit 57e92c
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
Packit 57e92c
var searchBox = new SearchBox("searchBox", "search",false,'Search');
Packit 57e92c
/* @license-end */
Packit 57e92c
</script>
Packit 57e92c
<script type="text/javascript" src="menudata.js"></script>
Packit 57e92c
<script type="text/javascript" src="menu.js"></script>
Packit 57e92c
<script type="text/javascript">
Packit 57e92c
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
Packit 57e92c
$(function() {
Packit 57e92c
  initMenu('',true,false,'search.php','Search');
Packit 57e92c
  $(document).ready(function() { init_search(); });
Packit 57e92c
});
Packit 57e92c
/* @license-end */</script>
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
     onmouseover="return searchBox.OnSearchSelectShow()"
Packit 57e92c
     onmouseout="return searchBox.OnSearchSelectHide()"
Packit 57e92c
     onkeydown="return searchBox.OnSearchSelectKey(event)">
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
        name="MSearchResults" id="MSearchResults">
Packit 57e92c
</iframe>
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
  
Packit 57e92c
Functions  
Packit 57e92c
  
Packit 57e92c
Miscellaneous helper functions
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

Functions for printing or querying event ranges.

Packit 57e92c
More...

Packit 57e92c
Packit 57e92c

Packit 57e92c
Functions
Packit 57e92c
int libevdev_event_is_type (const struct input_event *ev, unsigned int type)
Packit 57e92c
 Helper function to check if an event is of a specific type.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_is_code (const struct input_event *ev, unsigned int type, unsigned int code)
Packit 57e92c
 Helper function to check if an event is of a specific type and code.  More...
Packit 57e92c
 
Packit 57e92c
const char * libevdev_event_type_get_name (unsigned int type)
Packit 57e92c
 
Packit 57e92c
const char * libevdev_event_code_get_name (unsigned int type, unsigned int code)
Packit 57e92c
 
Packit 57e92c
const char * libevdev_event_value_get_name (unsigned int type, unsigned int code, int value)
Packit 57e92c
 This function resolves the event value for a code.  More...
Packit 57e92c
 
Packit 57e92c
const char * libevdev_property_get_name (unsigned int prop)
Packit 57e92c
 
Packit 57e92c
int libevdev_event_type_get_max (unsigned int type)
Packit 57e92c
 
Packit 57e92c
int libevdev_event_type_from_name (const char *name)
Packit 57e92c
 Look up an event-type by its name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_type_from_name_n (const char *name, size_t len)
Packit 57e92c
 Look up an event-type by its name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_code_from_name (unsigned int type, const char *name)
Packit 57e92c
 Look up an event code by its type and name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_code_from_name_n (unsigned int type, const char *name, size_t len)
Packit 57e92c
 Look up an event code by its type and name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_value_from_name (unsigned int type, unsigned int code, const char *name)
Packit 57e92c
 Look up an event value by its type, code and name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_type_from_code_name (const char *name)
Packit 57e92c
 Look up an event type for a event code name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_type_from_code_name_n (const char *name, size_t len)
Packit 57e92c
 Look up an event type for a event code name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_code_from_code_name (const char *name)
Packit 57e92c
 Look up an event code by its name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_code_from_code_name_n (const char *name, size_t len)
Packit 57e92c
 Look up an event code by its name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_event_value_from_name_n (unsigned int type, unsigned int code, const char *name, size_t len)
Packit 57e92c
 Look up an event value by its type, code and name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_property_from_name (const char *name)
Packit 57e92c
 Look up an input property by its name.  More...
Packit 57e92c
 
Packit 57e92c
int libevdev_property_from_name_n (const char *name, size_t len)
Packit 57e92c
 Look up an input property by its name.  More...
Packit 57e92c
 
Packit 57e92c
Packit 57e92c

Detailed Description

Packit 57e92c

Functions for printing or querying event ranges.

Packit 57e92c

The list of names is compiled into libevdev and is independent of the run-time kernel. Likewise, the max for each event type is compiled in and does not check the kernel at run-time.

Packit 57e92c

Function Documentation

Packit 57e92c
Packit 57e92c

◆ libevdev_event_code_from_code_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_code_from_code_name 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event code by its name.

Packit 57e92c

For example, the name "ABS_Y" returns 1. For the lookup to succeed, the name must be unique, which is the case for all defines as of kernel 5.0 and likely to be the case in the future.

Packit 57e92c

This is equivalent to libevdev_event_code_from_name() without the need for knowing the event type.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input-event value ("ABS_X", "REL_Y", "KEY_A", ...)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given event code for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_code_from_code_name_n()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_code_from_code_name_n 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          size_t 
Packit 57e92c
          len 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event code by its name.

Packit 57e92c

For example, the name "ABS_Y" returns 1. For the lookup to succeed, the name must be unique, which is the case for all defines as of kernel 5.0 and likely to be the case in the future.

Packit 57e92c

This is equivalent to libevdev_event_code_from_name_n() without the need for knowing the event type.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input-event value ("ABS_X", "REL_Y", "KEY_A", ...) 
Packit 57e92c
    lenThe length of the passed string excluding any terminating 0 character.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given event code for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_code_from_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_code_from_name 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          const char * 
Packit 57e92c
          name 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event code by its type and name.

Packit 57e92c

Event codes start with a fixed prefix followed by their name (eg., "ABS_X"). The prefix must be included in the name. It returns the constant assigned to the event code or -1 if not found.

Packit 57e92c

You have to pass the event type where to look for the name. For instance, to resolve "ABS_X" you need to pass EV_ABS as type and "ABS_X" as string. Supported event codes are codes starting with SYN_, KEY_, BTN_, REL_, ABS_, MSC_, SND_, SW_, LED_, REP_, FF_.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type (EV_* constant) where to look for the name. 
Packit 57e92c
    nameA non-NULL string describing an input-event code ("KEY_A", "ABS_X", "BTN_Y", ...), zero-terminated.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given code constant for the passed name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_code_from_name_n()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_code_from_name_n 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          const char * 
Packit 57e92c
          name, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          size_t 
Packit 57e92c
          len 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event code by its type and name.

Packit 57e92c

Event codes start with a fixed prefix followed by their name (eg., "ABS_X"). The prefix must be included in the name. It returns the constant assigned to the event code or -1 if not found.

Packit 57e92c

You have to pass the event type where to look for the name. For instance, to resolve "ABS_X" you need to pass EV_ABS as type and "ABS_X" as string. Supported event codes are codes starting with SYN_, KEY_, BTN_, REL_, ABS_, MSC_, SND_, SW_, LED_, REP_, FF_.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type (EV_* constant) where to look for the name. 
Packit 57e92c
    nameA non-NULL string describing an input-event code ("KEY_A", "ABS_X", "BTN_Y", ...). 
Packit 57e92c
    lenThe length of the string in name excluding any terminating 0 character.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given code constant for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_code_get_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          const char* libevdev_event_code_get_name 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          code 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type for the code to query (EV_SYN, EV_REL, etc.) 
Packit 57e92c
    codeThe event code to return the name for (e.g. ABS_X)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The name of the given event code (e.g. ABS_X) or NULL for an invalid type or code
Packit 57e92c
Note
The list of names is compiled into libevdev. If the kernel adds new defines for new event codes, libevdev will not automatically pick these up.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_is_code()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_is_code 
Packit 57e92c
          (
Packit 57e92c
          const struct input_event * 
Packit 57e92c
          ev, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          code 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Helper function to check if an event is of a specific type and code.

Packit 57e92c

This is virtually the same as:

 ev->type == type && ev->code == code
Packit 57e92c

with the exception that some sanity checks are performed to ensure type and code are valid.

Packit 57e92c
Note
The ranges for types and codes are compiled into libevdev. If the kernel changes the max value, libevdev will not automatically pick these up.
Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    evThe input event to check 
Packit 57e92c
    typeInput event type to compare the event against (EV_REL, EV_ABS, etc.) 
Packit 57e92c
    codeInput event code to compare the event against (ABS_X, REL_X, etc.)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
1 if the event type matches the given type and code, 0 otherwise (or if type/code are invalid)
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_is_type()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_is_type 
Packit 57e92c
          (
Packit 57e92c
          const struct input_event * 
Packit 57e92c
          ev, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          type 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Helper function to check if an event is of a specific type.

Packit 57e92c

This is virtually the same as:

 ev->type == type
Packit 57e92c

with the exception that some sanity checks are performed to ensure type is valid.

Packit 57e92c
Note
The ranges for types are compiled into libevdev. If the kernel changes the max value, libevdev will not automatically pick these up.
Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    evThe input event to check 
Packit 57e92c
    typeInput event type to compare the event against (EV_REL, EV_ABS, etc.)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
1 if the event type matches the given type, 0 otherwise (or if type is invalid)
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_type_from_code_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_type_from_code_name 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event type for a event code name.

Packit 57e92c

For example, the name "ABS_Y" returns EV_ABS. For the lookup to succeed, the name must be unique, which is the case for all defines as of kernel 5.0 and likely to be the case in the future.

Packit 57e92c

This is equivalent to libevdev_event_type_from_name() but takes the code name instead of the type name.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input-event value ("ABS_X", "REL_Y", "KEY_A", ...)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given event code for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_type_from_code_name_n()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_type_from_code_name_n 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          size_t 
Packit 57e92c
          len 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event type for a event code name.

Packit 57e92c

For example, the name "ABS_Y" returns EV_ABS. For the lookup to succeed, the name must be unique, which is the case for all defines as of kernel 5.0 and likely to be the case in the future.

Packit 57e92c

This is equivalent to libevdev_event_type_from_name_n() but takes the code name instead of the type name.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input-event value ("ABS_X", "REL_Y", "KEY_A", ...) 
Packit 57e92c
    lenThe length of the passed string excluding any terminating 0 character.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given event code for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_type_from_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_type_from_name 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event-type by its name.

Packit 57e92c

Event-types start with "EV_" followed by the name (eg., "EV_ABS"). The "EV_" prefix must be included in the name. It returns the constant assigned to the event-type or -1 if not found.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input-event type ("EV_KEY", "EV_ABS", ...), zero-terminated.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given type constant for the passed name or -1 if not found.
Packit 57e92c
Note
EV_MAX is also recognized.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_type_from_name_n()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_type_from_name_n 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          size_t 
Packit 57e92c
          len 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event-type by its name.

Packit 57e92c

Event-types start with "EV_" followed by the name (eg., "EV_ABS"). The "EV_" prefix must be included in the name. It returns the constant assigned to the event-type or -1 if not found.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input-event type ("EV_KEY", "EV_ABS", ...). 
Packit 57e92c
    lenThe length of the passed string excluding any terminating 0 character.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given type constant for the passed name or -1 if not found.
Packit 57e92c
Note
EV_MAX is also recognized.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_type_get_max()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_type_get_max 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type to return the maximum for (EV_ABS, EV_REL, etc.). No max is defined for EV_SYN.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The max value defined for the given event type, e.g. ABS_MAX for a type of EV_ABS, or -1 for an invalid type.
Packit 57e92c
Note
The max value is compiled into libevdev. If the kernel changes the max value, libevdev will not automatically pick these up.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_type_get_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          const char* libevdev_event_type_get_name 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type to return the name for.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The name of the given event type (e.g. EV_ABS) or NULL for an invalid type
Packit 57e92c
Note
The list of names is compiled into libevdev. If the kernel adds new defines for new event types, libevdev will not automatically pick these up.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_value_from_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_value_from_name 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          code, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          const char * 
Packit 57e92c
          name 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event value by its type, code and name.

Packit 57e92c

Event values start with a fixed prefix followed by their name (eg., "MT_TOOL_PALM"). The prefix must be included in the name. It returns the constant assigned to the event code or -1 if not found.

Packit 57e92c

You have to pass the event type and code where to look for the name. For instance, to resolve "MT_TOOL_PALM" you need to pass EV_ABS as type, ABS_MT_TOOL_TYPE as code and "MT_TOOL_PALM" as string.

Packit 57e92c

As of kernel 4.17, only EV_ABS/ABS_MT_TOOL_TYPE support name resolution.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type (EV_* constant) where to look for the name. 
Packit 57e92c
    codeThe event code (ABS_* constant) where to look for the name. 
Packit 57e92c
    nameA non-NULL string describing an input-event value ("MT_TOOL_TYPE", ...)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given value constant for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_value_from_name_n()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_event_value_from_name_n 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          code, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          const char * 
Packit 57e92c
          name, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          size_t 
Packit 57e92c
          len 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an event value by its type, code and name.

Packit 57e92c

Event values start with a fixed prefix followed by their name (eg., "MT_TOOL_PALM"). The prefix must be included in the name. It returns the constant assigned to the event code or -1 if not found.

Packit 57e92c

You have to pass the event type and code where to look for the name. For instance, to resolve "MT_TOOL_PALM" you need to pass EV_ABS as type, ABS_MT_TOOL_TYPE as code and "MT_TOOL_PALM" as string.

Packit 57e92c

As of kernel 4.17, only EV_ABS/ABS_MT_TOOL_TYPE support name resolution.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type (EV_* constant) where to look for the name. 
Packit 57e92c
    codeThe event code (ABS_* constant) where to look for the name. 
Packit 57e92c
    nameA non-NULL string describing an input-event value ("MT_TOOL_TYPE", ...) 
Packit 57e92c
    lenThe length of the string in name excluding any terminating 0 character.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given value constant for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_event_value_get_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          const char* libevdev_event_value_get_name 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          type, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          unsigned int 
Packit 57e92c
          code, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          int 
Packit 57e92c
          value 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

This function resolves the event value for a code.

Packit 57e92c

For almost all event codes this will return NULL as the value is just a numerical value. As of kernel 4.17, the only event code that will return a non-NULL value is EV_ABS/ABS_MT_TOOL_TYPE.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    typeThe event type for the value to query (EV_ABS, etc.) 
Packit 57e92c
    codeThe event code for the value to query (e.g. ABS_MT_TOOL_TYPE) 
Packit 57e92c
    valueThe event value to return the name for (e.g. MT_TOOL_PALM)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The name of the given event value (e.g. MT_TOOL_PALM) or NULL for an invalid type or code or NULL for an axis that has numerical values only.
Packit 57e92c
Note
The list of names is compiled into libevdev. If the kernel adds new defines for new event values, libevdev will not automatically pick these up.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_property_from_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_property_from_name 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an input property by its name.

Packit 57e92c

Properties start with the fixed prefix "INPUT_PROP_" followed by their name (eg., "INPUT_PROP_POINTER"). The prefix must be included in the name. It returns the constant assigned to the property or -1 if not found.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input property
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given code constant for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_property_from_name_n()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          int libevdev_property_from_name_n 
Packit 57e92c
          (
Packit 57e92c
          const char * 
Packit 57e92c
          name, 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          
Packit 57e92c
          size_t 
Packit 57e92c
          len 
Packit 57e92c
        
Packit 57e92c
        
Packit 57e92c
          
Packit 57e92c
          )
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Packit 57e92c

Look up an input property by its name.

Packit 57e92c

Properties start with the fixed prefix "INPUT_PROP_" followed by their name (eg., "INPUT_PROP_POINTER"). The prefix must be included in the name. It returns the constant assigned to the property or -1 if not found.

Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    nameA non-NULL string describing an input property 
Packit 57e92c
    lenThe length of the string in name excluding any terminating 0 character.
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The given code constant for the name or -1 if not found.
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

◆ libevdev_property_get_name()

Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
      
Packit 57e92c
        
Packit 57e92c
          const char* libevdev_property_get_name 
Packit 57e92c
          (
Packit 57e92c
          unsigned int 
Packit 57e92c
          prop)
Packit 57e92c
          
Packit 57e92c
        
Packit 57e92c
      
Packit 57e92c
Packit 57e92c
Parameters
Packit 57e92c
  
Packit 57e92c
    propThe input prop to return the name for (e.g. INPUT_PROP_BUTTONPAD)
Packit 57e92c
  
Packit 57e92c
  
Packit 57e92c
Packit 57e92c
Returns
The name of the given input prop (e.g. INPUT_PROP_BUTTONPAD) or NULL for an invalid property
Packit 57e92c
Note
The list of names is compiled into libevdev. If the kernel adds new defines for new properties libevdev will not automatically pick these up.
Packit 57e92c
Packit 57e92c
On older kernels input properties may not be defined and libevdev_property_get_name() will always return NULL 
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c
Packit 57e92c

<address class="footer"><small>
Packit 57e92c
Generated by  
Packit 57e92c
doxygen
Packit 57e92c
 1.8.15
Packit 57e92c
</small></address>
Packit 57e92c
</body>
Packit 57e92c
</html>