Blame doc/man/man3/XmImSetValues.3

Packit b099d7
'\" t
Packit b099d7
...\" ImSetVal.sgm /main/13 1996/09/08 20:48:16 rws $
Packit b099d7
.de P!
Packit b099d7
.fl
Packit b099d7
\!!1 setgray
Packit b099d7
.fl
Packit b099d7
\\&.\"
Packit b099d7
.fl
Packit b099d7
\!!0 setgray
Packit b099d7
.fl			\" force out current output buffer
Packit b099d7
\!!save /psv exch def currentpoint translate 0 0 moveto
Packit b099d7
\!!/showpage{}def
Packit b099d7
.fl			\" prolog
Packit b099d7
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
Packit b099d7
\!!psv restore
Packit b099d7
.
Packit b099d7
.de pF
Packit b099d7
.ie     ?\\*(f1?? .ds f1 \\n(.f
Packit b099d7
.el .ie ?\\*(f2?? .ds f2 \\n(.f
Packit b099d7
.el .ie ?\\*(f3?? .ds f3 \\n(.f
Packit b099d7
.el .ie ?\\*(f4?? .ds f4 \\n(.f
Packit b099d7
.el .tm ? font overflow
Packit b099d7
.ft \\$1
Packit b099d7
..
Packit b099d7
.de fP
Packit b099d7
.ie     !?\\*(f4?? \{\
Packit b099d7
.	ft \\*(f4
Packit b099d7
.	ds f4\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f3?? \{\
Packit b099d7
.	ft \\*(f3
Packit b099d7
.	ds f3\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f2?? \{\
Packit b099d7
.	ft \\*(f2
Packit b099d7
.	ds f2\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f1?? \{\
Packit b099d7
.	ft \\*(f1
Packit b099d7
.	ds f1\"
Packit b099d7
'	br \}
Packit b099d7
.el .tm ? font underflow
Packit b099d7
..
Packit b099d7
.ds f1\"
Packit b099d7
.ds f2\"
Packit b099d7
.ds f3\"
Packit b099d7
.ds f4\"
Packit b099d7
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
Packit b099d7
.TH "XmImSetValues" "library call"
Packit b099d7
.SH "NAME"
Packit b099d7
\fBXmImSetValues\fP \(em An input manager function that updates attributes of
Packit b099d7
an input context
Packit b099d7
.iX "XmImSetValues"
Packit b099d7
.iX "input manager functions" "XmImSetValues"
Packit b099d7
.SH "SYNOPSIS"
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
#include <Xm/XmIm\&.h>
Packit b099d7
\fBvoid \fBXmImSetValues\fP\fR(
Packit b099d7
\fBWidget \fBwidget\fR\fR,
Packit b099d7
\fBArgList \fBarglist\fR\fR,
Packit b099d7
\fBCardinal \fBargcount\fR\fR,
Packit b099d7
\fB\fR);
Packit b099d7
.fi
Packit b099d7
.SH "DESCRIPTION"
Packit b099d7
.PP
Packit b099d7
\fBXmImSetValues\fP updates attributes of the input context associated with
Packit b099d7
the specified widget\&. The \fIarglist\fP argument is a list of
Packit b099d7
attribute/value pairs for the input context\&. This function passes the
Packit b099d7
attributes and values to \fBXICSetValues\fP\&. The initial call to
Packit b099d7
this routine should pass in all of the input context attributes\&.
Packit b099d7
Thereafter, the application programmer calls \fBXmImSetValues\fP, for
Packit b099d7
an XIC,
Packit b099d7
only if a value has changed\&.
Packit b099d7
.PP
Packit b099d7
If the previous parameters for the widget\&'s XIC do not allow
Packit b099d7
the previously registered XIC to be reused, that XIC will be
Packit b099d7
unregistered, and a new one will be created and registered with the
Packit b099d7
widget\&. Note that sharing of data is preserved\&.
Packit b099d7
.PP
Packit b099d7
Note that the Text and TextField widgets call the
Packit b099d7
\fBXmImSetValues\fP function when they receive focus\&. Therefore,
Packit b099d7
further calls to the \fBXmImSetValues\fP function for these
Packit b099d7
widgets are unnecessary\&.
Packit b099d7
.IP "\fIwidget\fP" 10
Packit b099d7
Specifies the ID of the widget registered with the input manager
Packit b099d7
.IP "\fIarglist\fP" 10
Packit b099d7
Specifies the list of attribute/value pairs to be passed to \fBXICSetValues\fP;
Packit b099d7
the following attributes are accepted:
Packit b099d7
\fBXmNpreeditStartCallback\fP
Packit b099d7
\fBXmNpreeditDoneCallback\fP
Packit b099d7
\fBXmNpreeditDrawCallback\fP
Packit b099d7
and
Packit b099d7
\fBXmNpreeditCaretCallback\fP\&. These attributes accept an accompanying
Packit b099d7
value of type pointer
Packit b099d7
to structure of type \fBXIMCallback\fP\&.
Packit b099d7
.IP "" 10
Packit b099d7
These callbacks are used only when the \fBXmNpreeditType\fP
Packit b099d7
resource of the relevant \fBVendorShell\fP has the "onthespot" value,
Packit b099d7
and that the XIM supports \fBXIMPreeditCallbacks\fP input style\&. These
Packit b099d7
values are ignored if the condition is not met\&.
Packit b099d7
.IP "" 10
Packit b099d7
For each of these callbacks, if the callback value is not set by this
Packit b099d7
function, no action will be taken when the Input Method tries to call this callback\&.
Packit b099d7
Refer to the "Xlib - C Language X Interface, X Version 11, Release 6,"
Packit b099d7
Chapter 13 for the detail of these callbacks\&.
Packit b099d7
.IP "\fIargcount\fP" 10
Packit b099d7
Specifies the number of attribute/values pairs in the argument
Packit b099d7
list (\fIarglist)\fP
Packit b099d7
.PP
Packit b099d7
Resources that can be set for the input context include:
Packit b099d7
.IP "\fBXmNbackground\fP" 10
Packit b099d7
Specifies the pixel value for the background color\&.
Packit b099d7
.IP "\fBXmNbackgroundPixmap\fP" 10
Packit b099d7
Specifies a pixmap for tiling the background\&.
Packit b099d7
.IP "\fBXmNfontList\fP" 10
Packit b099d7
Specifies the font list used by the widget\&. The input method
Packit b099d7
uses the first occurrence of a font set tagged with
Packit b099d7
\fBXmFONTLIST_DEFAULT_TAG\fP\&. If no such instance is
Packit b099d7
found, the first font set in the font list is used\&. If
Packit b099d7
the font list does not contain a font set, a value is not
Packit b099d7
passed to \fBXICSetValues\fP\&.
Packit b099d7
.IP "\fBXmNforeground\fP" 10
Packit b099d7
Specifies the pixel value for the foreground color\&.
Packit b099d7
.IP "\fBXmNlineSpace\fP" 10
Packit b099d7
Specifies the line spacing used in the pre-edit window\&.
Packit b099d7
.IP "\fBXmNrenderTable\fP" 10
Packit b099d7
Specifies the render table used by the widget\&.
Packit b099d7
.IP "\fBXmNspotLocation\fP" 10
Packit b099d7
Specifies the \fIx\fP and \fIy\fP coordinates of the position
Packit b099d7
where text will be inserted in the widget handling
Packit b099d7
input, whose input method style is \fB"OverTheSpot"\fP\&. The \fIy\fP
Packit b099d7
coordinate is the position of the baseline used by the current text line\&.
Packit b099d7
.PP
Packit b099d7
The caller may also pass any other vendor-defined resources to this
Packit b099d7
function\&. For additional information on the internationalization
Packit b099d7
interface, see the Xlib documentation\&.
Packit b099d7
.SH "RELATED"
Packit b099d7
.PP
Packit b099d7
\fBXmImSetFocusValues\fP(3),
Packit b099d7
\fBXmImVaSetFocusValues\fP(3), and
Packit b099d7
\fBXmImVaSetValues\fP(3)\&.
Packit b099d7
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:25