man/xkb/XkbSetPtrActionY.man

   1 '\" t
   2 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a
   5 .\" copy of this software and associated documentation files (the "Software"),
   6 .\" to deal in the Software without restriction, including without limitation
   7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 .\" and/or sell copies of the Software, and to permit persons to whom the
   9 .\" Software is furnished to do so, subject to the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice (including the next
  12 .\" paragraph) shall be included in all copies or substantial portions of the
  13 .\" Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 .\" DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .TH XkbSetPtrActionY __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbSetPtrActionY \- Sets the high_YYY and low_YYY fields of act from the signed
  26 integer value y
  27 .SH SYNOPSIS
  28 .HP
  29 .B void XkbSetPtrActionY
  30 .BI "(\^XkbPtrAction " "act" "\^,"
  31 .BI "int " "y" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- act
  37 action in which to set Y
  38 .TP
  39 .I \- y
  40 new value to set
  41 .SH DESCRIPTION
  42 .LP
  43 Actions associated with the XkbPtrAction structure move the pointer when keys
  44 are pressed and released.
  45
  46 If the MouseKeys control is not enabled, KeyPress and KeyRelease events are
  47 treated as though the action is XkbSA_NoAction.
  48
  49 If the MouseKeys control is enabled, a server action of type XkbSA_MovePtr
  50 instructs the server to generate core pointer MotionNotify events rather than
  51 the usual KeyPress event, and the corresponding KeyRelease event disables any
  52 mouse keys timers that were created as a result of handling the XkbSA_MovePtr
  53 action.
  54
  55 The
  56 .I type
  57 field of the XkbPtrAction structure is always XkbSA_MovePtr.
  58
  59 The
  60 .I flags
  61 field is a bitwise inclusive OR of the masks shown in Table 1.
  62
  63 .TS
  64 c s
  65 l l
  66 l lw(4i).
  67 Table 1 Pointer Action Types
  68 _
  69 Action Type     Meaning
  70 _
  71 XkbSA_NoAcceleration    T{
  72 If not set, and the MouseKeysAccel control is enabled, the KeyPress initiates a
  73 mouse keys timer for this key; every time the timer expires, the cursor moves.
  74 T}
  75 XkbSA_MoveAbsoluteX     T{
  76 If set, the X portion of the structure specifies the new pointer X coordinate.
  77 Otherwise, the X portion is added to the current pointer X coordinate to
  78 determine the new pointer X coordinate.
  79 T}
  80 XkbSA_MoveAbsoluteY     T{
  81 If set, the Y portion of the structure specifies the new pointer Y coordinate.
  82 Otherwise, the Y portion is added to the current pointer Y coordinate to
  83 determine the new pointer Y coordinate.
  84 T}
  85 .TE
  86
  87 Each of the X and Y coordinates of the XkbPtrAction structure is composed of
  88 two signed 16-bit values, that is, the X coordinate is composed of
  89 .I high_XXX
  90 and
  91 .I low_XXX,
  92 and similarly for the Y coordinate. Xkb provides the following macros, to
  93 convert between a signed integer and two signed 16-bit values in XkbPtrAction
  94 structures.
  95 .SH STRUCTURES
  96 .LP
  97 .nf
  98
  99     typedef struct _XkbPtrAction {
 100         unsigned char    type;         /\(** XkbSA_MovePtr */
 101         unsigned char    flags;        /\(** determines type of pointer motion */
 102         unsigned char    high_XXX;     /\(** x coordinate, high bits*/
 103         unsigned char    low_XXX;      /\(** y coordinate, low bits */
 104         unsigned char    high_YYY;     /\(** x coordinate, high bits */
 105         unsigned char    low_YYY;      /\(** y coordinate, low bits */
 106     } XkbPtrAction;
 107
 108 .fi