XkbSetPtrActionY (3)

Leading comments

Copyright 1999 Oracle and/or its affiliates. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following condition...

(The comments found at the beginning of the groff file "man3/XkbSetPtrActionY.3".)

NAME

XkbSetPtrActionY - Sets the high_YYY and low_YYY fields of act from the signed integer value y

SYNOPSIS

void XkbSetPtrActionY (XkbPtrAction act, int y);
     

ARGUMENTS

- act

action in which to set Y

- y

new value to set

DESCRIPTION

Actions associated with the XkbPtrAction structure move the pointer when keys are pressed and released.
If the MouseKeys control is not enabled, KeyPress and KeyRelease events are treated as though the action is XkbSA_NoAction.
If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr instructs the server to generate core pointer MotionNotify events rather than the usual KeyPress event, and the corresponding KeyRelease event disables any mouse keys timers that were created as a result of handling the XkbSA_MovePtr action.
The type field of the XkbPtrAction structure is always XkbSA_MovePtr.
The flags field is a bitwise inclusive OR of the masks shown in Table 1.

Table 1 Pointer Action Types
Action Type	Meaning
XkbSA_NoAcceleration	If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves.
XkbSA_MoveAbsoluteX	If set, the X portion of the structure specifies the new pointer X coordinate. Otherwise, the X portion is added to the current pointer X coordinate to determine the new pointer X coordinate.
XkbSA_MoveAbsoluteY	If set, the Y portion of the structure specifies the new pointer Y coordinate. Otherwise, the Y portion is added to the current pointer Y coordinate to determine the new pointer Y coordinate.

Each of the X and Y coordinates of the XkbPtrAction structure is composed of two signed 16-bit values, that is, the X coordinate is composed of high_XXX and low_XXX, and similarly for the Y coordinate. Xkb provides the following macros, to convert between a signed integer and two signed 16-bit values in XkbPtrAction structures.

STRUCTURES

    typedef struct _XkbPtrAction {
        unsigned char    type;         /* XkbSA_MovePtr */
        unsigned char    flags;        /* determines type of pointer motion */
        unsigned char    high_XXX;     /* x coordinate, high bits*/
        unsigned char    low_XXX;      /* y coordinate, low bits */
        unsigned char    high_YYY;     /* x coordinate, high bits */
        unsigned char    low_YYY;      /* y coordinate, low bits */
    } XkbPtrAction;