annotate include/InputConv.h @ 0:92745d501b9a

initial import from kinput2-v3.1

/* $Id: InputConv.h,v 1.20 1999/01/13 08:41:54 ishisone Exp $ */
/*
 * Copyright (c) 1990  Software Research Associates, Inc.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of Software Research Associates not be
 * used in advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.  Software Research
 * Associates makes no representations about the suitability of this software
 * for any purpose.  It is provided "as is" without express or implied
 * warranty.
 *
 * Author:  Makoto Ishisone, Software Research Associates, Inc., Japan
 */

#ifndef _InputConv_h
#define _InputConv_h

#include "ICtypes.h"
#include <X11/Object.h>

/*
  InputConv new resources:

  name			class		type		default		access
  ----------------------------------------------------------------------------
  selectionControl	Callback	Callback	NULL		C
  textChangeNotify	Callback	Callback	NULL		C
  modeChangeNotify	Callback	Callback	NULL		C
  endNotify		Callback	Callback	NULL		C
  fixNotify		Callback	Callback	NULL		C
  auxControl		Callback	Callback	NULL		C
  displayObjectClass	Class		Pointer		NULL		CG
*/

/* new resources */
#define XtNselectionControl "selectionControl"
#define XtNtextChangeNotify "textChangeNotify"
#define XtNmodeChangeNotify "modeChangeNotify"
#define XtNfixNotify "fixNotify"
#define XtNendNotify "endNotify"
#define XtNauxControl "auxControl"
#define XtNdisplayObjectClass "displayObjectClass"
#define XtCClass "Class"

typedef struct _InputConvClassRec *InputConvObjectClass;
typedef struct _InputConvRec *InputConvObject;

extern WidgetClass inputConvObjectClass;


/*
 * XtNselectionControl $B%3!<%k%P%C%/$N(B call_data $B9=B$BN(B
 */

typedef struct {

    int command;	/* $B%3%^%s%I(B
			 *	Start: $B9`L\A*Br3+;O%j%/%(%9%H(B
			 *	End: $B9`L\A*Br=*N;%j%/%(%9%H(B
			 *	Set: $B%+%l%s%H9`L\@_Dj%j%/%(%9%H(B
			 *	Move: $B%+%l%s%H9`L\0\F0%j%/%(%9%H(B
			 *	Get: $B%+%l%s%H9`L\<hF@%j%/%(%9%H(B
			 */
#define ICSelectionStart	1
#define ICSelectionEnd		2
#define ICSelectionSet		3
#define ICSelectionMove		4
#define ICSelectionGet		5

    union {
	int selection_kind;	/* ICSelectionStart $B$N;~(B */
#define ICSelectionCandidates	1
#define ICSelectionSymbols	2

	int current_item;	/* ICSelectionSet/ICSelectionEnd/
				 * ICSelectionGet $B$N;~(B
			         * ICSelectionEnd/ICSelectionGet $B$N(B
				 * $B>l9g$O%3!<%k%P%C%/4X?tB&$G8=:_$N(B
				 * $B%+%l%s%H8uJdHV9f$rBeF~$9$k(B
				 * ($B%+%l%s%H$,$J$1$l$P(B -1 $B$rBeF~$9$k(B)
				 */

	int dir;		/* ICSelectionMove $B$N;~(B */
    } u;

} ICSelectionControlArg;


/*
 * ICCompareSegment $B$GJV$5$l$kCM(B
 */

#define ICSame		0	/* $BA4$/F1$8(B */
#define ICAttrChanged	1	/* attr $B$N$_0[$J$k(B */
#define ICStringChanged	2	/* data $B$,0[$J$k(B */
				/* attribute $B$H(B data $B$H$b$K0[$J$l$P(B
				 * (ICAttrChanged | ICStringChanged) $B$,JV$k(B
				 */


/*
 * XtNauxControl $B%3!<%k%P%C%/$N(B call_data $B9=B$BN(B
 */

typedef struct {

    int command;	/* $B%3%^%s%I(B
			 *	Start: $B9`L\A*Br3+;O%j%/%(%9%H(B
			 *	End: $B9`L\A*Br=*N;%j%/%(%9%H(B
			 *	Change: $B%+%l%s%H9`L\@_Dj%j%/%(%9%H(B
			 */
#define ICAuxStart		1
#define ICAuxEnd		2
#define ICAuxChange		3

} ICAuxControlArg;

/*
 * GetTriggerKeys $B$K;H$o$l$k(B keys $B$N$?$a$N9=B$BN(B
 */

typedef struct {
  KeySym keysym;
  long modifiers;
  long modifiermask;
} ICTriggerKey;

/*
 * $B%Q%V%j%C%/%$%s%?!<%U%'%$%9%U%!%s%/%7%g%s(B
 */

/*
 * Boolean ICSupportMultipleObjects(WidgetClass objectclass)
 *	$B;XDj$5$l$?%*%V%8%'%/%H%/%i%9$+$iJ#?t$N%$%s%9%?%s%9$,@8@.$G$-$k$+(B
 *	$B$I$&$+$rJV$9(B
 *	True $B$J$i2DG=$@$7!"(BFalse $B$J$i$?$@0l$D$N%$%s%9%?%s%9$7$+@8@.$G$-$J$$(B
 *	$B0z?t$,(B Widget $B$G$O$J$/(B WidgetClass $B$G$"$k$3$H$KCm0U(B
 */
extern Boolean ICSupportMultipleObjects(
#if NeedFunctionPrototypes
	WidgetClass	/* objectclass */
#endif
);

/*
 * int ICInputEvent(Widget ojbect, XEvent *event)
 *	$B%*%V%8%'%/%H$KF~NO%$%Y%s%H$rM?$($k(B
 *	$B%(%i!<$,5/$3$C$?>l9g$O(B -1 $B$,JV$k(B
 *	$B%(%i!<$G$J$1$l$P(B 0 $B$+(B 1 $B$,JV$k(B
 *	$BDL>o$O(B 0 $B$,JV$k$,!"$b$7(B 1 $B$,JV$C$F$-$?$i!"$=$l$O$G$-$k$J$i$P(B
 *	$B$=$NF~NO%$%Y%s%H$r%"%W%j%1!<%7%g%s$KAw$jJV$7$?J}$,$h$$$H$$$&(B
 *	$B%*%V%8%'%/%H$+$i$N%R%s%H$G$"$k(B
 */
extern int ICInputEvent(
#if NeedFunctionPrototypes
	Widget		/* object */,
	XEvent *	/* event */
#endif
);

/*
 * ICString *ICGetMode(Widget object)
 *	$B8=:_$NF~NO%b!<%I$r(B ICString $B$N7A<0$GJV$9(B
 *	$B%G!<%?$O(B InputConvObject $B$N$b$N$J$N$G>!<j$KCM$rJQ99$7$?$j(B
 *	free() $B$7$F$O$J$i$J$$(B
 */
extern ICString *ICGetMode(
#if NeedFunctionPrototypes
	Widget		/* object */
#endif
);

/*
 * int ICCursorPos(Widget object, Cardinal *segidx, Cardinal *offset)
 *	$B8=:_$N%$%s%5!<%H%+!<%=%k0LCV$rJV$9(B
 *	$B8=:_%+!<%=%k$,$J$$;~$K$O(B 0 $B$"$k;~$K$O(B 1 $B$,JV$k(B
 *	1 $B$,JV$5$l$?;~$K$O!"(Bsegidx $B$K%+!<%=%k$N$"$k%;%0%a%s%HHV9f!"(B
 *	offset $B$K%;%0%a%s%HFb$N0LCV(B($B@hF,$+$i2?J8;zL\$+(B) $B$,JV$5$l$k(B
 */
extern int ICCursorPos(
#if NeedFunctionPrototypes
	Widget		/* object */,
	Cardinal *	/* segidx */,
	Cardinal *	/* offset */
#endif
);

/*
 * int ICNumSegments(Widget object)
 *	$B%;%0%a%s%H?t$rJV$9(B
 */
extern int ICNumSegments(
#if NeedFunctionPrototypes
	Widget		/* object */
#endif
);

/*
 * ICString *ICGetSegment(Widget object, Cardinal n)
 *	n $BHVL\$N%;%0%a%s%H$rJV$9(B ($B@hF,$N%;%0%a%s%H$O(B n=0)
 *	$B;XDj$5$l$?%;%0%a%s%H$,B8:_$7$J$1$l$P(B NULL $B$rJV$9(B
 *	$B%G!<%?$O(B InputConvObject $B$N$b$N$J$N$G>!<j$KCM$rJQ99$7$?$j(B
 *	free() $B$7$F$O$J$i$J$$(B
 */
extern ICString *ICGetSegment(
#if NeedFunctionPrototypes
	Widget		/* object */,
	Cardinal	/* n */
#endif
);

/*
 * int ICCompareSegment(Widget object, ICString *seg1, ICString *seg2,
 *			Cardinal *nchar)
 *	$BFs$D$N%;%0%a%s%H$rHf3S$9$k(B
 *	$BHf3S7k2L$O4X?t$NCM$H$7$FJV$5$l$k(B
 *	nchar $B$K%;%0%a%s%H$N@hF,$+$i$N0lCW$9$kJ8;z?t$,JV$5$l$k(B
 */
extern int ICCompareSegment(
#if NeedFunctionPrototypes
	Widget		/* object */,
	ICString *	/* seg1 */,
	ICString *	/* seg2 */,
	Cardinal *	/* nchar */
#endif
);

/*
 * ICString *ICGetItemList(Widget object, Cardinal *num_items)
 *	$BA*Br9`L\$N%j%9%H$rJV$9(B
 *	$B9`L\A*BrCf$G$J$1$l$P(B NULL $B$rJV$9(B
 *	num_items $B$K9`L\?t$,JV$5$l$k(B
 *	$B%G!<%?$O(B InputConvObject $B$N$b$N$J$N$G>!<j$KCM$rJQ99$7$?$j(B
 *	free() $B$7$F$O$J$i$J$$(B
 *	$B$3$N4X?t$NJV$9%j%9%H$OA*BrCf(B (ICSelectionStart $B$N%3!<%k%P%C%/$+$i(B
 *	ICSelectionEnd $B$N%3!<%k%P%C%/$^$?$O(B ICSelectItem() $B$,%3!<%k$5$l$k$^$G(B)
 *	$BM-8z$G$"$k(B
 */
extern ICString *ICGetItemList(
#if NeedFunctionPrototypes
	Widget		/* object */,
	Cardinal *	/* num_items */
#endif
);

/*
 * int ICSelectItem(Widget object, int n)
 *	n $BHVL\$N9`L\$,A*Br$5$l$?$3$H$r%*%V%8%'%/%H$KCN$i$;$k(B
 *	n < 0 $B$J$i$I$N9`L\$bA*Br$5$l$J$+$C$?$3$H$r<($9(B
 *	$B9`L\A*BrCf$G$J$+$C$?$j;XDj$7$?9`L\$,B8:_$7$J$1$l$P(B -1 $B$rJV$9(B
 *	$B$=$l0J30$O(B 0 $B$rJV$9(B
 *	XtNselectionControl $B%3!<%k%P%C%/Cf$G$3$N4X?t$r8F$VI,MW$O$J$$(B
 *	(ICSelectionControlArg.u.current_item $B$K%+%l%s%H$N9`L\HV9f$r(B
 *	$BBeF~$9$k$@$1$G$h$$(B)
 */
extern int ICSelectItem(
#if NeedFunctionPrototypes
	Widget		/* object */,
	int		/* n */
#endif
);

/*
 * int ICGetConvertedString(Widget object, Atom *encoding, int *format,
 *			    int *length, XtPointer *string)
 *	$BJQ49$5$l$?%F%-%9%H$r(B string $B$KJV$9(B
 *	encoding $B$K$O!"%F%-%9%H$N%(%s%3!<%G%#%s%0$r;XDj$7$F$*$/(B
 *	$B$?$@$7$3$l$OC1$J$k%j%/%(%9%H$G$"$C$F!"JQ49%*%V%8%'%/%H$O(B
 *	$BJL$N%(%s%3!<%G%#%s%0$GJV$7$F$b$h$$(B
 *	encoding $B$K$O<B:]$N%(%s%3!<%G%#%s%0$,JV$5$l$k(B
 *	$BJQ49%*%V%8%'%/%H$O>/$J$/$H$b(B COMPOUND_TEXT $B%(%s%3!<%G%#%s%0$O(B
 *	$B%5%]!<%H$7$J$/$F$O$J$i$J$$(B
 *	format $B$K$O(B 8/16/32 $B$N$$$:$l$+!"(Blength $B$O(B string $B$N%(%l%a%s%H?t$,(B
 *	$B$=$l$>$lJV$5$l$k(B
 *	$B%F%-%9%H$NNN0h$O(B malloc $B$5$l$F$$$k$N$G$3$N4X?t$r8F$s$@B&$G(B
 *	free $B$7$J$1$l$P$J$i$J$$(B
 *	$BJQ49%F%-%9%H$,$J$$;~$d%(%i!<$N>l9g$K$O(B -1$B!"$=$&$G$J$1$l$P(B 0 $B$,(B
 *	$B4X?t$NCM$H$7$FJV$5$l$k(B
 *
 *	$B$3$N4X?t$O(B XtNfixNotify $B%3!<%k%P%C%/$NCf$G;H$o$l$k$3$H$rA[Dj$7$F$$$k(B
 */
extern int ICGetConvertedString(
#if NeedFunctionPrototypes
	Widget		/* object */,
	Atom *		/* encoding */,
	int *		/* format */,
	int *		/* length */,
	XtPointer *	/* string */
#endif
);

/*
 * int ICClearConversion(Widget object)
 *	$B6/@)E*$K(B ($BJQ49ESCf$G$"$C$F$b(B) $BJQ49%F%-%9%H$r%/%j%"$9$k(B
 *	$B2?$i$+$NM}M3$G%/%j%"$G$-$J$+$C$?;~$K$O(B -1$B!"$=$&$G$J$1$l$P(B 0 $B$,(B
 *	$BJV$5$l$k(B
 */
extern int ICClearConversion(
#if NeedFunctionPrototypes
	Widget		/* object */
#endif
);

/*
 * ICString *ICGetAuxSegments(Widget object, Cardinal *n,
 *                            Cardinal *ns, Cardinal *nc)
 *	AUX$BNN0h$N%;%0%a%s%H$rJV$9!#(B
 *	$B;XDj$5$l$?%;%0%a%s%H$,B8:_$7$J$1$l$P(B NULL $B$rJV$9(B
 *	$B%G!<%?$O(B InputConvObject $B$N$b$N$J$N$G>!<j$KCM$rJQ99$7$?$j(B
 *	free() $B$7$F$O$J$i$J$$(B
 *      $BF@$i$l$?%;%0%a%s%H?t!"%+%l%s%H%;%0%a%s%H!"%+%l%s%H%;%0%a%s%H(B
 *      $BFb$N%+!<%=%k%]%8%7%g%s$,$=$l$>$l(B n, ns, nc $B$K$FJV$k!#(B
 */
extern ICString *ICGetAuxSegments(
#if NeedFunctionPrototypes
	Widget		/* object */,
	Cardinal *	/* n */,
	Cardinal *	/* ns */,
	Cardinal *	/* nc */
#endif
);

/*
 * int ICRegisterTriggerKeys(Widget object)
 *	$B;XDj$5$l$?%*%V%8%'%/%H$NF|K\8lF~NO3+;O%-!<$r<h$j=P$7!"(B
 *	$B%/%i%9JQ?t$K3JG<$9$k!#(B
 */
extern int ICRegisterTriggerKeys(
#if NeedFunctionPrototypes
	Widget		/* object */
#endif
);

/*
 * int ICGetTriggerKeysOfInputObjectClass(WidgetClass objectclass,
 *					  ICTriggerKey *keys_return)
 *	$B;XDj$5$l$?F~NO%*%V%8%'%/%H%/%i%9$KEPO?$5$l$F$$$kF|K\8l(B
 *	$BF~NO3+;O%-!<$r<h$j=P$9!#(B
 */
extern int ICGetTriggerKeysOfInputObjectClass(
#if NeedFunctionPrototypes
	WidgetClass	/* objectclass */,
	ICTriggerKey **	/* keys_return */
#endif
);

/*
 * int ICGetPreeditString(Widget object, int segn, int offset,
 *			  Atom *encoding, int *format,
 *			  int *length, XtPointer *string)
 *	$BJQ49ESCf$N(B segn $BHVL\$N(B $B%;%0%a%s%H$N(B offset $BJ8;z$+$i$N%F%-%9%H$r(B
 *	string $B$KJV$9(B
 *	encoding $B$K$O!"%F%-%9%H$N%(%s%3!<%G%#%s%0$r;XDj$7$F$*$/(B
 *	$B$?$@$7$3$l$OC1$J$k%j%/%(%9%H$G$"$C$F!"JQ49%*%V%8%'%/%H$O(B
 *	$BJL$N%(%s%3!<%G%#%s%0$GJV$7$F$b$h$$(B
 *	encoding $B$K$O<B:]$N%(%s%3!<%G%#%s%0$,JV$5$l$k(B
 *	$BJQ49%*%V%8%'%/%H$O>/$J$/$H$b(B COMPOUND_TEXT $B%(%s%3!<%G%#%s%0$O(B
 *	$B%5%]!<%H$7$J$/$F$O$J$i$J$$(B
 *	format $B$K$O(B 8/16/32 $B$N$$$:$l$+!"(Blength $B$O(B string $B$N%(%l%a%s%H?t$,(B
 *	$B$=$l$>$lJV$5$l$k(B
 *	$B%F%-%9%H$NNN0h$O(B malloc $B$5$l$F$$$k$N$G$3$N4X?t$r8F$s$@B&$G(B
 *	free $B$7$J$1$l$P$J$i$J$$(B
 *	$BJQ49%F%-%9%H$,$J$$;~$d%(%i!<$N>l9g$K$O(B -1$B!"$=$&$G$J$1$l$P(B 0 $B$,(B
 *	$B4X?t$NCM$H$7$FJV$5$l$k(B
 */
extern int ICGetPreeditString(
#if NeedFunctionPrototypes
	Widget		/* object */,
	int		/* segn */,
	int		/* offset */,
	Atom *		/* encoding */,
	int *		/* format */,
	int *		/* length */,
	XtPointer *	/* string */
#endif
);

/*
 * int ICGetStatusString(Widget object, Atom *encoding, int *format,
 *			 int *length, XtPointer *string, int *nchars)
 *	$B%9%F!<%?%9%F%-%9%H$r(B string $B$KJV$9(B
 *	encoding $B$K$O!"%F%-%9%H$N%(%s%3!<%G%#%s%0$r;XDj$7$F$*$/(B
 *	$B$?$@$7$3$l$OC1$J$k%j%/%(%9%H$G$"$C$F!"JQ49%*%V%8%'%/%H$O(B
 *	$BJL$N%(%s%3!<%G%#%s%0$GJV$7$F$b$h$$(B
 *	encoding $B$K$O<B:]$N%(%s%3!<%G%#%s%0$,JV$5$l$k(B
 *	$BJQ49%*%V%8%'%/%H$O>/$J$/$H$b(B COMPOUND_TEXT $B%(%s%3!<%G%#%s%0$O(B
 *	$B%5%]!<%H$7$J$/$F$O$J$i$J$$(B
 *	format $B$K$O(B 8/16/32 $B$N$$$:$l$+!"(Blength $B$O(B string $B$N%(%l%a%s%H?t$,(B
 *	$B$=$l$>$lJV$5$l$k(B
 *	nchars $B$K$O(B string $B$NJ8;z?t$,JV$5$l$k(B
 *	$B%F%-%9%H$NNN0h$O(B malloc $B$5$l$F$$$k$N$G$3$N4X?t$r8F$s$@B&$G(B
 *	free $B$7$J$1$l$P$J$i$J$$(B
 *	$BJQ49%F%-%9%H$,$J$$;~$d%(%i!<$N>l9g$K$O(B -1$B!"$=$&$G$J$1$l$P(B 0 $B$,(B
 *	$B4X?t$NCM$H$7$FJV$5$l$k(B
 */
extern int ICGetStatusString(
#if NeedFunctionPrototypes
	Widget		/* object */,
	Atom *		/* encoding */,
	int *		/* format */,
	int *		/* length */,
	XtPointer *	/* string */,
	int *		/* nchars */
#endif
);

#endif /* _InputConv_h */