From 6b98e89515ba0ee755bdc9c4783b84b464d2a10c Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Wed, 9 Jun 2010 10:50:23 -0700 Subject: Update docs to match headers - caddr_t is now XPointer - a number of char * arguments are now unsigned char * or constified - XmuLookup* functions are in Lookup.h, so split into new section There are still a bunch of headers with undocumented functions/#defines: - CvtCache.h - EditresP.h - ExtAgent.h - Misc.h - WhitePoint.h - Xmu.h - some of the functions in Converters.h Signed-off-by: Alan Coopersmith --- doc/Xmu.xml | 117 +++++++++++++++++++++++++++++++++++------------------------- 1 file changed, 68 insertions(+), 49 deletions(-) diff --git a/doc/Xmu.xml b/doc/Xmu.xml index 97135d8..10d1c11 100644 --- a/doc/Xmu.xml +++ b/doc/Xmu.xml @@ -176,7 +176,7 @@ another round-trip to the server. AtomPtr XmuMakeAtom - char *name + const char *name @@ -221,13 +221,13 @@ The function returns the name of an AtomPtr. Atom XmuInternAtom - Display *d + Display *dpy AtomPtr atom_ptr - d + dpy specifies the connection to the X server @@ -254,13 +254,13 @@ such that subsequent requests do not cause another round-trip to the server. char *XmuGetAtomName - Display *d + Display *dpy Atom atom - d + dpy specifies the connection to the X server @@ -283,7 +283,7 @@ requests do not cause another round-trip to the server. void XmuInternStrings - Display *d + Display *dpy String *names Cardinal count Atom *atoms @@ -291,7 +291,7 @@ requests do not cause another round-trip to the server. - d + dpy specifies the connection to the X server @@ -618,7 +618,7 @@ file int XmuCursorNameToIndex - char *name + const char *name @@ -1021,7 +1021,7 @@ interpretation as the return value for int XmuReadBitmapDataFromFile - char *filename + const char *filename unsigned int *width unsigned int *height unsigned char **datap @@ -1081,7 +1081,7 @@ interpretation as the return value for Pixmap XmuLocateBitmapFile Screen *screen - char *name + const char *name char *srcname int srcnamelen int *widthp @@ -1245,7 +1245,7 @@ file Atom *selection Atom *target Atom *type - caddr_t *value + XPointer value unsigned long *length int *format @@ -2112,10 +2112,9 @@ file -The functions in this section are deprecated because they don't work -in most locales now supported by X11; the function -XmbLookupString -provides a better alternative. +The functions in this section are deprecated +because they don't work in most locales now supported by X11; most platforms +provide alternatives in their system libraries. @@ -2123,7 +2122,7 @@ provides a better alternative. void XmuCopyISOLatin1Lowered char *dst - char *src + const char *src @@ -2151,7 +2150,7 @@ assumed to be encoded using ISO 8859-1. void XmuCopyISOLatin1Uppered char *dst - char *src + const char *src @@ -2178,8 +2177,8 @@ assumed to be encoded using ISO 8859-1. int XmuCompareISOLatin1 - char *first - char *second + const char *first + const char *second @@ -2203,13 +2202,30 @@ according to whether first is lexicographically greater than, equal to, or less than second. The two strings are assumed to be encoded using ISO 8859-1. + + + + Keyboard Event Translation Functions + + +To use the functions defined in this section, you should include the header +file +<X11/Xmu/Lookup.h>. + + + +The functions in this section are deprecated because they don't work +in most locales now supported by X11; the function +XmbLookupString +provides a better alternative. + int XmuLookupLatin1 XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2258,7 +2274,7 @@ and exists only for naming symmetry with other functions. int XmuLookupLatin2 XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2308,7 +2324,7 @@ to an Latin-2 (ISO 8859-2) string, or to an ASCII control string. int XmuLookupLatin3 XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2358,7 +2374,7 @@ to an Latin-3 (ISO 8859-3) string, or to an ASCII control string. int XmuLookupLatin4 XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2408,7 +2424,7 @@ to an Latin-4 (ISO 8859-4) string, or to an ASCII control string. int XmuLookupKana XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2461,7 +2477,7 @@ X201-1976. int XmuLookupJISX0201 XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2511,7 +2527,7 @@ to a string in the JIS X0201-1976 encoding, including ASCII control. int XmuLookupArabic XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2561,7 +2577,7 @@ to a Latin/Arabic (ISO 8859-6) string, or to an ASCII control string. int XmuLookupCyrillic XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2611,7 +2627,7 @@ to a Latin/Cyrillic (ISO 8859-5) string, or to an ASCII control string. int XmuLookupGreek XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2661,7 +2677,7 @@ to a Latin/Greek (ISO 8859-7) string, or to an ASCII control string. int XmuLookupHebrew XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2711,7 +2727,7 @@ to a Latin/Hebrew (ISO 8859-8) string, or to an ASCII control string. int XmuLookupAPL XKeyEvent *event - char *buffer + unsigned char *buffer int nbytes KeySym *keysym XComposeStatus *status @@ -2787,7 +2803,7 @@ A Compound Text string is represented as the following type: XctData XctCreate - XctString string + const XctString string int length XctFlags flags @@ -3111,8 +3127,8 @@ file CloseHook XmuAddCloseDisplayHook Display *dpy int ( *func ) - Display *, caddr_t - caddr_t arg + Display *, XPointer + XPointer arg @@ -3163,8 +3179,8 @@ returns an opaque handle that can be used to remove or lookup the callback. Display *dpy CloseHook handle int ( *func ) - Display *, caddr_t - caddr_t arg + Display *, XPointer + XPointer arg @@ -3212,8 +3228,8 @@ if a callback was removed, else returns Display *dpy CloseHook handle int ( *func ) - Display *, caddr_t - caddr_t arg + Display *, XPointer + XPointer arg @@ -3267,19 +3283,24 @@ header file It defines the following types: +typedef int (*XmuCloseDisplayQueueProc)(XmuDisplayQueue *queue, + XmuDisplayQueueEntry *entry); + +typedef int (*XmuFreeDisplayQueueProc)(XmuDisplayQueue *queue); + typedef struct _XmuDisplayQueueEntry { struct _XmuDisplayQueueEntry *prev, *next; Display *display; CloseHook closehook; - caddr_t data; + XPointer data; } XmuDisplayQueueEntry; typedef struct _XmuDisplayQueue { int nentries; XmuDisplayQueueEntry *head, *tail; - int (*closefunc)(); - int (*freefunc)(); - caddr_t data; + XmuCloseDisplayQueueProc closefunc; + XmuFreeDisplayQueueProc freefunc; + XPointer data; } XmuDisplayQueue; @@ -3288,11 +3309,9 @@ typedef struct _XmuDisplayQueue { XmuDisplayQueue *XmuDQCreate - int ( *closefunc ) - XmuDisplayQueue *, XmuDisplayQueueEntry * - int ( *freefunc ) - XmuDisplayQueue * - caddr_t data + XmuCloseDisplayQueueProc closefunc + XmuFreeDisplayQueueProc freefunc + XPointer data @@ -3355,7 +3374,7 @@ The application is responsible for actually freeing the queue, by calling XmuDisplayQueueEntry *XmuDQAddDisplay XmuDisplayQueue *q Display *dpy - caddr_t data + XPointer data @@ -3507,8 +3526,8 @@ file void XmuAddInitializer void ( *func ) - XtAppContext, caddr_t - caddr_t data + XtAppContext, XPointer + XPointer data -- cgit v1.2.1