man/XSetICValues.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XSetICValues __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetICValues, XGetICValues \- set and obtain XIC values
 145 .SH SYNTAX
 146 .HP
 147 char * XSetICValues\^(\^XIC \fIic\fP, ...\^);
 148 .HP
 149 char * XGetICValues\^(\^XIC \fIic\fP, ...\^);
 150 .SH ARGUMENTS
 151 .IP \fIic\fP 1i
 152 Specifies the input context.
 153 .ds Al \ to set or get XIC values
 154 .IP ... 1i
 155 Specifies the variable length argument list\*(Al.
 156 .SH DESCRIPTION
 157 The
 158 .ZN XSetICValues
 159 function returns NULL if no error occurred;
 160 otherwise,
 161 it returns the name of the first argument that could not be set.
 162 An argument might not be set for any of the following reasons:
 163 .IP \(bu 5
 164 The argument is read-only (for example,
 165 .ZN XNFilterEvents ).
 166 .IP \(bu 5
 167 The argument name is not recognized.
 168 .IP \(bu 5
 169 An implementation-dependent error occurs.
 170 .LP
 171 Each value to be set must be an appropriate datum,
 172 matching the data type imposed by the semantics of the argument.
 173 .LP
 174 The
 175 .ZN XSetICValues
 176 can generate
 177 .ZN BadAtom ,
 178 .ZN BadColor ,
 179 .ZN BadCursor ,
 180 .ZN BadPixmap ,
 181 and
 182 .ZN BadWindow
 183 errors.
 184 .LP
 185 The
 186 .ZN XGetICValues
 187 function returns NULL if no error occurred; otherwise,
 188 it returns the name of the first argument that could not be obtained.
 189 An argument could not be obtained for any of the following reasons:
 190 .IP \(bu 5
 191 The argument name is not recognized.
 192 .IP \(bu 5
 193 The input method encountered an implementation-dependent error.
 194 .LP
 195 Each IC attribute value argument (following a name) must point to
 196 a location where the IC value is to be stored.
 197 That is, if the IC value is of type T,
 198 the argument must be of type T*.
 199 If T itself is a pointer type,
 200 then
 201 .ZN XGetICValues
 202 allocates memory to store the actual data,
 203 and the client is responsible for freeing this data by calling
 204 .ZN XFree
 205 with the returned pointer.
 206 The exception to this rule is for an IC value of type
 207 .ZN XNVaNestedList
 208 (for preedit and status attributes).
 209 In this case,  the argument must also be of type
 210 .ZN XVaNestedList .
 211 Then, the rule of changing type T to T* and freeing the allocated data
 212 applies to each element of the nested list.
 213 .SH DIAGNOSTICS
 214 .TP 1i
 215 .ZN BadAtom
 216 A value for an Atom argument does not name a defined Atom.
 217 .TP 1i
 218 .ZN BadColor
 219 A value for a Colormap argument does not name a defined Colormap.
 220 .TP 1i
 221 .ZN BadCursor
 222 A value for a Cursor argument does not name a defined Cursor.
 223 .TP 1i
 224 .ZN BadPixmap
 225 A value for a Pixmap argument does not name a defined Pixmap.
 226 .TP 1i
 227 .ZN BadWindow
 228 A value for a Window argument does not name a defined Window.
 229 .SH "SEE ALSO"
 230 XCreateIC(__libmansuffix__),
 231 XOpenIM(__libmansuffix__),
 232 XSetICFocus(__libmansuffix__),
 233 XmbResetIC(__libmansuffix__)
 234 .br
 235 \fI\*(xL\fP