xgeticvalues(3) [hpux man page]

XGetICValues() XGetICValues()

Name
XGetICValues - get input context attributes.

Synopsis
char *XGetICValues(ic, ...)
XIC ic;

Arguments
ic Specifies the input context.

... Specifies the variable length argument list to set or get XIC values.

Returns
NULL if no error occurred; otherwise, the name of the first attribute that could not be obtained.

Availability
Release 5 and later.

Description
XGetICValues() queries the values of input context attributes. The first argument is the input context, and it is followed by a NULL-ter-
minated variable-length argument list of attribute name/value pairs. The standard attributes and their types are listed in the tables
below.
Input Context Attributes

Name Type Notes
XNInputStyle XIMStyle Required at IC creation; may not be
changed.
XNClientWindow Window Must be set before IC use; may not be
changed.
XNFocusWindow Window Changes may cause geometry negotiation.
XNResourceName char *
XNResourceClass char *
XNGeometryCallback XIMCallback *
XNFilterEvents unsigned long Read-only attribute; may not be set.
XNPreeditAttributes XVaNestedList See sub-attributes below.
XNStatusAttributes XVaNestedList See sub-attributes below.

Pre-edit and Status Area Sub-attributes

Name Type Notes
XNArea XRectangle *
XNAreaNeeded XRectangle *
XNSpotLocation XPoint * Required at IC
creation for
XIMPreeditPosi-
tion style.
XNColormap Colormap
XNStdColormap Atom
XNForeground unsigned long
XNBackground unsigned long
XNBackgroundPixmap Pixmap
XNFontSet XFontSet Required at IC
creation;
changes may
cause geometry
negotiation.
XNLineSpacing int Changes may
cause geometry
negotiation.

XNCursor Cursor
XNPreeditStartCallback XIMCallback * Required at IC
creation for
XIMPreeditCall-
backs style.
XNPreeditDoneCallback XIMCallback * Required at IC
creation for
XIMPreeditCall-
backs style.
XNPreeditDrawCallback XIMCallback * Required at IC
creation for
XIMPreeditCall-
backs style.
XNPreeditCaretCallback XIMCallback * Required at IC
creation for
XIMPreeditCall-
backs style.
XNStatusStartCallback XIMCallback * Required at IC
creation for
XIMStatusCall-
backs style.
XNStatusDoneCallback XIMCallback * Required at IC
creation for
XIMStatusCall-
backs style.
XNStatusDrawCallback XIMCallback * Required at IC
creation for
XIMStatusCall-
backs style.

In addition to the attribute names above, the special name XNVaNestedList indicates that the following argument is a XVaNestedList of attribute
name/value pairs. When a nested list is encountered in an argument list, the contents of the nested list are processed as if they appeared in the
original argument list at that point.

The XGetICValues() function returns NULL if no error occurred; otherwise, it returns the name of the first attribute that could not be
obtained. An attribute could be not obtained for any of the following reasons:

o The attribute name is not recognized.

o The input method encountered an implementation-dependent error.

Each attribute value argument to XGetICValues() (the argument that follows the attribute name) must be the address of a location into which
the value is to be stored. For attributes that are pointer types (XNArea, for example), XGetICValues() returns a pointer to a copy of the
attribute value. In this case, the client must free the memory allocated for that copy with XFree().

See Also
XCreateIC(), XOpenIM(), XSetICFocus(), XSetICValues(), XmbResetIC(), XwcResetIC().

Xlib - Input Contexts XGetICValues()

Check Out this Related Man Page

XSetICValues(3) 						  XLIB FUNCTIONS						   XSetICValues(3)

NAME

       XSetICValues, XGetICValues - set and obtain XIC values

SYNTAX

       char * XSetICValues(XIC ic, ...);

       char * XGetICValues(XIC ic, ...);

ARGUMENTS

       ic	 Specifies the input context.

       ...	 Specifies the variable length argument list to set or get XIC values.

DESCRIPTION

       The XSetICValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be set.
       An argument might not be set for any of the following reasons:

       o    The argument is read-only (for example, XNFilterEvents).

       o    The argument name is not recognized.

       o    An implementation-dependent error occurs.

       Each value to be set must be an appropriate datum, matching the data type imposed by the semantics of the argument.

       The XSetICValues can generate BadAtom, BadColor, BadCursor, BadPixmap, and BadWindow errors.

       The XGetICValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be
       obtained.  An argument could not be obtained for any of the following reasons:

       o    The argument name is not recognized.

       o    The input method encountered an implementation-dependent error.

       Each IC attribute value argument (following a name) must point to a location where the IC value is to be stored.  That is, if the IC value
       is of type T, the argument must be of type T*.  If T itself is a pointer type, then XGetICValues allocates memory to store the actual data,
       and the client is responsible for freeing this data by calling XFree with the returned pointer.	The exception to this rule is for an IC
       value of type XNVaNestedList (for preedit and status attributes).  In this case,  the argument must also be of type XVaNestedList.  Then,
       the rule of changing type T to T* and freeing the allocated data applies to each element of the nested list.

DIAGNOSTICS

       BadAtom	 A value for an Atom argument does not name a defined Atom.

       BadColor  A value for a Colormap argument does not name a defined Colormap.

       BadCursor A value for a Cursor argument does not name a defined Cursor.

       BadPixmap A value for a Pixmap argument does not name a defined Pixmap.

       BadWindow A value for a Window argument does not name a defined Window.

SEE ALSO

       XCreateIC(3), XOpenIM(3), XSetICFocus(3), XmbResetIC(3)
       Xlib - C Language X Interface

X Version 11							   libX11 1.6.0 						   XSetICValues(3)

Linux and UNIX Man Pages

xgeticvalues(3) [hpux man page]

Check Out this Related Man Page