diff options
author | Stuart Kreitman <stuart.kreitman@sun.com> | 2004-08-16 15:02:59 +0000 |
---|---|---|
committer | Stuart Kreitman <stuart.kreitman@sun.com> | 2004-08-16 15:02:59 +0000 |
commit | 55fbed1b939b712afb682629eda68d5b9343f498 (patch) | |
tree | 309ff0ae5fe5100f529418fd01ea08264d720a44 /man | |
parent | a1f75fe2713520c0bfeb790bbebf322a6807ba70 (diff) |
Move Xevie client side to its own lib.
Modified Files: xc/lib/Imakefile xc/lib/Xext/Imakefile Added Files:
xc/lib/Xevie/AUTHORS xc/lib/Xevie/Imakefile xc/lib/Xevie/Xevie.c
xc/lib/Xevie/Xevie.man Removed Files: xc/lib/Xext/Xevie.c
Diffstat (limited to 'man')
-rw-r--r-- | man/Xevie.man | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/man/Xevie.man b/man/Xevie.man new file mode 100644 index 0000000..6cb5767 --- /dev/null +++ b/man/Xevie.man @@ -0,0 +1,92 @@ +.\" +.\" $XdotOrg: xc/lib/Xevie/Xevie.man,v +.\" +.\" +.de TQ +.br +.ns +.TP \\$1 +.. +.TH XEVIE __libmansuffix__ __vendorversion__ + +.SH NAME + Xevie \- X Event Interceptor extension. +.SH SYNTAX +\&#include <X11/extensions/Xevie.h> +.nf +.sp +Status XevieQueryVersion \^(\^Display *\fIdpy\fP, + int *\fImajor_versionp\fP, + int *\fIminor_versionp\fP\^); +.sp +Status XevieStart \^(\^Display *\fIdpy\fp\^); +.sp +Status XevieSelectInput \^(\^Display *\fIdpy\fP, + long \fIevent_mask\fP\^); +.sp +Status XevieSendEvent \^(\^ + \^(\^Display *\fIdpy\fP, + XEvent *\fIevent\fP, + char *fIdataType\fP\^); +.sp +Status XevieEnd \^(\^Display *\fIdpy\fp\^); +.sp + +.SH ARGUMENTS +.IP \fIdisplay\fP 1i +Specifies the connection to the X server. +.IP \fIevent_mask\fP 1i +Specifies the mask of events to redirect. +.IP \fIdatatype\fP 1i + +XEVIE_MODIFIED or XEVIE_UNMODIFIED - whether the Xevie client +has changed or synthesised this event. + +.SH DATATYPES + + +.SH DESCRIPTION +.B Xevie +X Event Interception Extension (XEvIE) is designed for users +who need to intercept all the Keyboard and Mouse events. +The requirement for XEvIE is directly from GNOME Accessibility project. +AT Accessibility API needs to have full keyboard/mouse control. +XEvIE provides a set of API to allow AT Accessibility API to get +and consume Keyboard/Mouse events. +.PP + +.SH FUNCTIONS + +.B XevieQueryVersion +The XevieQueryVersion function returns the major and minor protocol version +numbers supported by the server. +XevieQueryVersion returns True if success, otherwise, it returns False. + +.B XevieStart +The XevieStart function requests that the X server enable the XEvIE extension. +Once XEvIE is successfully enabled, all the XevieSelectInput specified events +will be sent to the client which has enabled XEvIE. +If XKB or AccessX is enabled, the events that are sent to the XEvIE clients +are XKB/AccessX processed (filtered) ones. + + +.B XevieSend +Events are sent back to the X server through XevieSendEvent. + +.B XevieEnd +The XevieEnd function requests that the X server disables the XEvIE extension. +Once XEvIE is disabled successfully, the X server stops sending events to the +XEvIE client. + +.B XevieSelectInput +The XevieSelectInput function requests that the X server reports the keyboard +and pointer events associated with the specified event mask. +By default, X will report KeyPress, KeyRelease, ButtonPress, ButtonRelease +and MotionNotify events. + +SH RESTRICTIONS +.B Xevie +will remain upward compatible after the current 1.0 release. +.SH AUTHOR +Derek Wang, Stuart Kreitman, SUN + |