mirror of
https://github.com/libratbag/libratbag.git
synced 2026-11-07 23:23:52 +01:00
updating documentation: linux/input.h -> linux/input-event-codes.h
This commit is contained in:
committed by
Yaroslav Chvanov
parent
f5e2259da5
commit
0b5a95f09e
@@ -1515,7 +1515,7 @@ ratbag_button_set_special(struct ratbag_button *button,
|
||||
*
|
||||
* @param button A previously initialized ratbag button
|
||||
* @param[out] modifiers Will be filled with the modifiers required for this
|
||||
* action. The modifiers are as defined in linux/input.h.
|
||||
* action. The modifiers are as defined in linux/input-event-codes.h.
|
||||
* @param[in,out] sz Takes the size of the modifiers array and returns the
|
||||
* number of modifiers filled in. sz may be 0 if no modifiers are required.
|
||||
*
|
||||
@@ -1534,10 +1534,10 @@ ratbag_button_get_key(const struct ratbag_button *button,
|
||||
*
|
||||
* @param button A previously initialized ratbag button
|
||||
* @param key The button number to assign to this button, one of BTN_* as
|
||||
* defined in linux/input.h
|
||||
* defined in linux/input-event-codes.h
|
||||
* @param modifiers The modifiers required for this action. The
|
||||
* modifiers are as defined in linux/input.h, in the order they should be
|
||||
* pressed.
|
||||
* modifiers are as defined in linux/input-event-codes.h, in the order they
|
||||
* should be pressed.
|
||||
* @param sz The size of the modifiers array. sz may be 0 if no modifiers
|
||||
* are required.
|
||||
*
|
||||
|
||||
@@ -780,8 +780,8 @@ class RatbagdButton(metaclass=MetaRatbag):
|
||||
|
||||
class RatbagdMacro(metaclass=MetaRatbag):
|
||||
"""Represents a button macro. Note that it uses keycodes as defined by
|
||||
linux/input.h and not those used by X.Org or any other higher layer such as
|
||||
Gdk."""
|
||||
linux/input-event-codes.h and not those used by X.Org or any other higher
|
||||
layer such as Gdk."""
|
||||
|
||||
# Both a key press and release.
|
||||
_MACRO_KEY = 1000
|
||||
|
||||
@@ -1280,7 +1280,7 @@ active profile if none is given.""",
|
||||
|
||||
Macro syntax:
|
||||
A macro is a series of key events or waiting periods.
|
||||
Keys must be specified in linux/input.h key names.
|
||||
Keys must be specified in linux/input-event-codes.h key names.
|
||||
KEY_A Press and release 'a'
|
||||
+KEY_A Press 'a'
|
||||
-KEY_A Release 'a'
|
||||
|
||||
@@ -994,8 +994,8 @@ class RatbagdButton(_RatbagdDBus):
|
||||
|
||||
class RatbagdMacro(GObject.Object):
|
||||
"""Represents a button macro. Note that it uses keycodes as defined by
|
||||
linux/input.h and not those used by X.Org or any other higher layer such as
|
||||
Gdk."""
|
||||
linux/input-event-codes.h and not those used by X.Org or any other higher
|
||||
layer such as Gdk."""
|
||||
|
||||
# Both a key press and release.
|
||||
_MACRO_KEY = 1000
|
||||
|
||||
Reference in New Issue
Block a user