man/XCreateIC.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 XCreateIC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XCreateIC, XDestroyIC, XIMOfIC \- create, destroy, and obtain the input method of an input context
 145 .SH SYNTAX
 146 .HP
 147 XIC XCreateIC\^(\^XIM \fIim\fP\^, ...\^);
 148 .HP
 149 void XDestroyIC\^(\^XIC \fIic\fP\^);
 150 .HP
 151 XIM XIMOfIC\^(\^XIC \fIic\fP\^);
 152 .SH ARGUMENTS
 153 .IP \fIic\fP 1i
 154 Specifies the input context.
 155 .IP \fIim\fP 1i
 156 Specifies the input method.
 157 .ds Al \ to set XIC values
 158 .IP ... 1i
 159 Specifies the variable length argument list\*(Al.
 160 .SH DESCRIPTION
 161 The
 162 .ZN XCreateIC
 163 function creates a context within the specified input method.
 164 .LP
 165 Some of the arguments are mandatory at creation time, and
 166 the input context will not be created if those arguments are not provided.
 167 The mandatory arguments are the input style and the set of text callbacks
 168 (if the input style selected requires callbacks).
 169 All other input context values can be set later.
 170 .LP
 171 .ZN XCreateIC
 172 returns a NULL value if no input context could be created.
 173 A NULL value could be returned for any of the following reasons:
 174 .IP \(bu 5
 175 A required argument was not set.
 176 .IP \(bu 5
 177 A read-only argument was set (for example,
 178 .ZN XNFilterEvents ).
 179 .IP \(bu 5
 180 The argument name is not recognized.
 181 .IP \(bu 5
 182 The input method encountered an input method implementation-dependent error.
 183 .LP
 184 The
 185 .ZN XCreateIC
 186 can generate
 187 .ZN BadAtom ,
 188 .ZN BadColor ,
 189 .ZN BadPixmap ,
 190 and
 191 .ZN BadWindow
 192 errors.
 193 .LP
 194 .ZN XDestroyIC
 195 destroys the specified input context.
 196 .LP
 197 The
 198 .ZN XIMOfIC
 199 function returns the input method associated with the specified input context.
 200 .SH DIAGNOSTICS
 201 .TP 1i
 202 .ZN BadAtom
 203 A value for an Atom argument does not name a defined Atom.
 204 .TP 1i
 205 .ZN BadColor
 206 A value for a Colormap argument does not name a defined Colormap.
 207 .TP 1i
 208 .ZN BadPixmap
 209 A value for a Pixmap argument does not name a defined Pixmap.
 210 .TP 1i
 211 .ZN BadWindow
 212 A value for a Window argument does not name a defined Window.
 213 .SH "SEE ALSO"
 214 XOpenIM(__libmansuffix__),
 215 XSetICFocus(__libmansuffix__),
 216 XSetICValues(__libmansuffix__),
 217 XmbResetIC(__libmansuffix__)
 218 .br
 219 \fI\*(xL\fP