aboutsummaryrefslogtreecommitdiff
path: root/libX11/man/xkb/XkbSASetPtrDfltValue.man
blob: 284e466da80633542c1bf62a55209c45c990e145 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
'\" t
.\" Copyright (c) 1999 - Sun Microsystems, Inc.
.\" 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, and/or sell copies of the Software, and to permit persons
.\" to whom the Software is furnished to do so, provided that the above
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\" 
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.TH XkbSASetPtrDfltValue __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbSASetPtrDfltValue \- Sets the valueXXX field of act from val
.SH SYNOPSIS
.B void XkbSASetPtrDfltValue macro
(
.I act,
.I val
)
.br
      XkbAction \fIact\fP\^;
.br
      int \fIval\fP\^;      
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I \- act
action in which to set valueXXX
.TP
.I \- val
value to set in valueXXX
.SH DESCRIPTION
.LP
Actions associated with the XkbPtrDfltAction structure change the mk_dflt_btn 
attribute of the MouseKeys control.

If the MouseKeys control is not enabled, KeyPress and KeyRelease events are 
treated as though the action is XkbSA_NoAction. Otherwise, this action changes 
the 
.I mk_dflt_btn 
attribute of the MouseKeys control.

The 
.I type 
field of the XkbPtrDfltAction structure should always be XkbSA_SetPtrDflt.

The 
.I flags 
field is composed of the bitwise inclusive OR of the values shown in Table 1 
(currently there is only one value defined).

.TS
c s
l l
l lw(4i).
Table 1 Pointer Default Flags
_
Flag	Meaning
_
XkbSA_DfltBtnAbsolute	T{
If set, the value field represents an absolute pointer button. Otherwise, the 
value field represents the amount to be added to the current default button.
T}
.TE

The 
.I affect 
field specifies what changes as a result of this action. The only valid value 
for the 
.I affect 
field is XkbSA_AffectDfltBtn.

The 
.I valueXXX 
field is a signed character that represents the new button value for the
.I mk_dflt_btn 
attribute of the MouseKeys control. If XkbSA_DfltBtnAbsolute is set in 
.I flags, valueXXX 
specifies the button to be used; otherwise, 
.I valueXXX 
specifies the amount to be added to the current default button. In either case, 
illegal button choices are wrapped back around into range. Xkb provides macros, 
to convert between the integer and signed character values in XkbPtrDfltAction 
structures.
.SH STRUCTURES
.LP
.nf

    typedef struct _XkbPtrDfltAction {
        unsigned char    type;      /\(** XkbSA_SetPtrDflt */
        unsigned char    flags;     /\(** controls the pointer button number */
        unsigned char    affect;    /\(** XkbSA_AffectDfltBtn */
        char             valueXXX;  /\(** new default button member */
    } XkbPtrDfltAction;

.fi