'\" t
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
.\" Copyright \(co 2000  The XFree86 Project, Inc.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name of the X Consortium shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from the X Consortium.
.\"
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
.\" Digital Equipment Corporation
.\"
.\" Portions Copyright \(co 1990, 1991 by
.\" Tektronix, Inc.
.\"
.\" Permission to use, copy, modify and distribute this documentation for
.\" any purpose and without fee is hereby granted, provided that the above
.\" copyright notice appears in all copies and that both that copyright notice
.\" and this permission notice appear in all copies, and that the names of
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
.\" to this documentation without specific, written prior permission.
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided ``as is'' without express or implied warranty.
.\" 
.\" Copyright (c) 1998, 2000, 2001 The X Japanese Documentation Project.
.\" 
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish, dis-
.\" tribute, sublicense, and/or sell copies of the Software, and to permit
.\" persons to whom the Software is furnished to do so, subject to the fol-
.\" lowing conditions:
.\" 
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
.\" ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
.\" SHALL  THE X JAPANESE DOCUMENTATION PROJECT  BE  LIABLE  FOR  ANY CLAIM,
.\" DAMAGES OR OTHER LIABILITY,  WHETHER IN AN ACTION OF CONTRACT,  TORT OR
.\" OTHERWISE,  ARISING FROM,  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.\" 
.\" Except as contained in this notice, the name of The X Japanese
.\" Documentation Project shall not be used in advertising or otherwise to
.\" promote the sale, use or other dealings in this Software without prior
.\" written authorization from The X Japanese Documentation Project.
.\" 
.\" X Window System is a trademark of The Open Group.
.\"
.\" Translated Tue Oct 27 00:00:00 JST 1998
.\"           by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\" Corrected by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Updated Sun Dec 24 23:07:45 JST 2000 for XFree86 4.0.2
.\"           by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\" Updated Wed Oct 10 01:59:25 JST 2001 for XFree86 4.1.0
.\"           by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\"
.\" $XFree86: xc/doc/man/X11/XmbLStr.man,v 1.3 2001/01/27 18:20:08 dawes Exp $
.\" 
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.na
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
..
.de De
.ce 0
.if \\n(BD .DF
.nr BD 0
.in \\n(OIu
.if \\n(TM .ls 2
.sp \\n(DDu
.fi
..
.de FD
.LP
.KS
.TA .5i 3i
.ta .5i 3i
.nf
..
.de FN
.fi
.KE
.LP
..
.de IN		\" send an index entry to the stderr
..
.de C{
.KS
.nf
.D
.\"
.\"	choose appropriate monospace font
.\"	the imagen conditional, 480,
.\"	may be changed to L if LB is too
.\"	heavy for your eyes...
.\"
.ie "\\*(.T"480" .ft L
.el .ie "\\*(.T"300" .ft L
.el .ie "\\*(.T"202" .ft PO
.el .ie "\\*(.T"aps" .ft CW
.el .ft R
.ps \\n(PS
.ie \\n(VS>40 .vs \\n(VSu
.el .vs \\n(VSp
..
.de C}
.DE
.R
..
.de Pn
.ie t \\$1\fB\^\\$2\^\fR\\$3
.el \\$1\fI\^\\$2\^\fP\\$3
..
.de ZN
.ie t \fB\^\\$1\^\fR\\$2
.el \fI\^\\$1\^\fP\\$2
..
.de hN
.ie t <\fB\\$1\fR>\\$2
.el <\fI\\$1\fP>\\$2
..
.de NT
.ne 7
.ds NO Note
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
.ie n .sp
.el .sp 10p
.TB
.ce
\\*(NO
.ie n .sp
.el .sp 5p
.if '\\$1'C' .ce 99
.if '\\$2'C' .ce 99
.in +5n
.ll -5n
.R
..
.		\" Note End -- doug kraft 3/85
.de NE
.ce 0
.in -5n
.ll +5n
.ie n .sp
.el .sp 10p
..
.ny0
'\" t
.TH XmbLookupString 3X11 "Release 6.5" "X Version 11" "XLIB FUNCTIONS"
.SH 名前
.\"0 XmbLookupString, XwcLookupString, Xutf8LookupString \- obtain composed input from an input method
XmbLookupString, XwcLookupString, Xutf8LookupString \- 変換処理された入力を入力メソッドから得る
.SH 書式
int XmbLookupString\^(\^\fIic\fP\^, \fIevent\fP\^, \fIbuffer_return\fP\^, \fIbytes_buffer\fP\^, \fIkeysym_return\fP\^, \fIstatus_return\fP\^)
.br
      XIC \fIic\fP\^;
.br
      XKeyPressedEvent *\fIevent\fP;
.br
      char *\fIbuffer_return\fP\^;
.br
      int \fIbytes_buffer\fP\^;
.br
      KeySym *\fIkeysym_return\fP\^;
.br
      Status *\fIstatus_return\fP\^;
.LP
int XwcLookupString\^(\^\fIic\fP\^, \fIevent\fP\^, \fIbuffer_return\fP\^, \fIbytes_buffer\fP\^, \fIkeysym_return\fP\^, \fIstatus_return\fP\^)
.br
      XIC \fIic\fP\^;
.br
      XKeyPressedEvent *\fIevent\fP\^;
.br
      wchar_t *\fIbuffer_return\fP\^;
.br
      int \fIwchars_buffer\fP\^;
.br
      KeySym *\fIkeysym_return\fP\^;
.br
      Status *\fIstatus_return\fP\^;
.LP
int Xutf8LookupString\^(\^\fIic\fP\^, \fIevent\fP\^, \fIbuffer_return\fP\^, \fIbytes_buffer\fP\^, \fIkeysym_return\fP\^, \fIstatus_return\fP\^)
.br
      XIC \fIic\fP\^;
.br
      XKeyPressedEvent *\fIevent\fP;
.br
      char *\fIbuffer_return\fP\^;
.br
      int \fIbytes_buffer\fP\^;
.br
      KeySym *\fIkeysym_return\fP\^;
.br
      Status *\fIstatus_return\fP\^;
.SH 引き数
.IP \fIbuffer_return\fP 1i
.\"0 Returns a multibyte string or wide character string (if any)
.\"0 from the input method.
(存在するならば)マルチバイト文字列かワイド文字文字列が
入力メソッドから返される。
.IP \fIbytes_buffer\fP 1i
.br
.ns
.IP \fIwchars_buffer\fP 1i
.\"0 Specifies space available in the return buffer.
返却バッファの容量を指定する。
.\"0 .ds Ev key event to be used
.ds Ev 使われるキーイベント
.IP \fIevent\fP 1i
.\"0 Specifies the \*(Ev.
使われるキーイベントを指定する。
.IP \fIic\fP 1i
.\"0 Specifies the input context.
入力コンテクストを指定する。
.IP \fIkeysym_return\fP 1i
.\"0 Returns the KeySym computed from the event if this argument is not NULL.
この引き数が NULL でない場合には、イベントから計算したキーシンボルが返される。
.IP \fIstatus_return\fP 1i
.\"0 Returns a value indicating what kind of data is returned.
返されるデータの種類を示す値が返される。
.SH 説明
.\"0 The
.\"0 .ZN XmbLookupString ,
.\"0 .ZN XwcLookupString
.\"0 and
.\"0 .ZN Xutf8LookupString
.\"0 functions return the string from the input method specified
.\"0 in the buffer_return argument.
.\"0 If no string is returned,
.\"0 the buffer_return argument is unchanged.
関数
.ZN XmbLookupString ,
.ZN XwcLookupString ,
.ZN Xutf8LookupString
は、指定した入力メソッドから返された文字列を引き数 buffer_return に与え
る。文字列が返されなければ、引き数 buffer_return の内容は変化しない。
.LP
.\"0 The KeySym into which the KeyCode from the event was mapped is returned
.\"0 in the keysym_return argument if it is non-NULL and the status_return
.\"0 argument indicates that a KeySym was returned.
引き数 keysym_return が NULL でなく、かつ、引き数 status_return が
キーシンボルが返されたことを示している場合には、引き数 keysym_return
にはキーシンボルが返され、そのキーシンボルにはイベントから得られた
キーコードがマッピングされている。
.\"0 If both a string and a KeySym are returned,
.\"0 the KeySym value does not necessarily correspond to the string returned.
文字列とキーシンボルの両方が返されている場合、キーシンボルの値が必ず
文字列に対応しているとは限らない。
.LP
.\"0 .ZN XmbLookupString
.\"0 and
.\"0 .ZN Xutf8LookupString
.\"0 return the length of the string in bytes, and
.\"0 .ZN XwcLookupString
.\"0 returns the length of the string in characters.
.ZN XmbLookupString
と
.ZN Xutf8LookupString
は文字列の長さをバイト数で返し、
.ZN XwcLookupString
は文字列の長さを文字数で返す。
.\"0 Both
.\"0 .ZN XmbLookupString
.\"0 and
.\"0 .ZN XwcLookupString
.\"0 return text in the encoding of the locale bound to the input method
.\"0 of the specified input context, and
.\"0 .ZN Xutf8LookupString
.\"0 returns text in UTF-8 encoding.
.ZN XmbLookupString
と
.ZN XwcLookupString
は指定した入力コンテクストの入力メソッドに割り当てられた
ロケールのエンコーディングで文字列を返し、
.ZN Xutf8LookupString
は UTF-8 エンコーディングで文字列を返す。
.LP
.\"0 Each string returned by
.\"0 .ZN XmbLookupString
.\"0 and
.\"0 .ZN XwcLookupString
.\"0 begins in the initial state of the encoding of the locale
.\"0 (if the encoding of the locale is state-dependent).
.ZN XmbLookupString
と
.ZN XwcLookupString
によって返された文字列は、ロケールのエンコーディングの初期状態で始まる
(ロケールのエンコーディングが状態依存の場合)。
.NT
.\"0 To ensure proper input processing,
.\"0 it is essential that the client pass only 
.\"0 .ZN KeyPress
.\"0 events to
.\"0 .ZN XmbLookupString ,
.\"0 .ZN XwcLookupString
.\"0 and
.\"0 .ZN Xutf8LookupString .
正しい入力処理を保証するためには、クライアントは
.ZN KeyPress
イベントのみを
.ZN XmbLookupString ,
.ZN XwcLookupString ,
.ZN Xutf8LookupString
に送ることが重要である。
.\"0 Their behavior when a client passes a 
.\"0 .ZN KeyRelease
.\"0 event is undefined.
クライアントが
.ZN KeyRelease
イベントを送った場合、これらの関数の動作は未定義である。
.NE
.LP
.\"0 Clients should check the status_return argument before
.\"0 using the other returned values.
クライアントは、まず引き数 status_return をチェックしてから他の返り値を
使用すべきである。
.\"0 These three functions each return a value to status_return 
.\"0 that indicates what has been returned in the other arguments.
どの関数も、他の引き数に何が返されたかを示す引き数 status_return に値
を返す。
.\"0 The possible values returned are:
返される可能性がある値を以下に示す:
.TS
lw(1.5i) lw(4.3i).
T{
.ZN XBufferOverflow
T}	T{
.\"0 The input string to be returned is too large for the supplied buffer_return.
.\"0 The required size (for
.\"0 .ZN XmbLookupString ,
.\"0 .ZN Xutf8LookupString
.\"0 in bytes; for
.\"0 .ZN XwcLookupString
.\"0 in characters) is returned as the value of the function,
.\"0 and the contents of buffer_return and keysym_return are not modified.
.\"0 The client should recall the function with the same event
.\"0 and a buffer of adequate size to obtain the string.
返されるべき入力文字列が、与えられた buffer_return よりも大きい。
必要なサイズ(
.ZN XmbLookupString ,
.ZN Xutf8LookupString
の場合はバイト数、
.ZN XwcLookupString
の場合は文字数)は、関数の値として返され、buffer_return および
keysym_return の内容は変更されない。
文字列を得るためには、クライアントは適切な大きさのバッファを用意してか
ら、同じイベントに対してこれらの関数を再び呼び出さなければならない。
T}
T{
.ZN XLookupNone
T}	T{
.\"0 No consistent input has been composed so far.
.\"0 The contents of buffer_return and keysym_return are not modified, 
.\"0 and the function returns zero.
正しい入力が今のところ構成されていない。
buffer_return および keysym_return の内容は変更されず、関数は 0 を返す。
T}
T{
.ZN XLookupChars
T}	T{
.\"0 Some input characters have been composed.
入力文字列が構成されている。
.\"0 They are placed in the buffer_return argument, using the encoding
.\"0 described above,
.\"0 and the string length is returned as the value of the function.
これらは引き数 buffer_return に格納される。
使われるエンコーディングは前述の通りで、文字列の長さが関数の値として返
される。
.\"0 The content of the keysym_return argument is not modified.
引き数 keysym_return の内容は変更されない。
T}
T{
.ZN XLookupKeySym
T}	T{
.\"0 A KeySym has been returned instead of a string
.\"0 and is returned in keysym_return.
.\"0 The content of the buffer_return argument is not modified,
.\"0 and the function returns zero.
文字列ではなく KeySym が返され、この KeySym は keysym_return に返され
る。
引き数 buffer_return の内容は変更されず、関数は 0 を返す。
T}
T{
.ZN XLookupBoth
T}	T{
.\"0 Both a KeySym and a string are returned;
.\"0 .ZN XLookupChars
.\"0 and
.\"0 .ZN XLookupKeySym
.\"0 occur simultaneously.
KeySym と文字列の両方が返された。
.ZN XLookupChars
と
.ZN XLookupKeySym
が同時に起こる。
T}
.TE
.LP
.\"0 It does not make any difference if the input context passed as an argument to
.\"0 .ZN XmbLookupString ,
.\"0 .ZN XwcLookupString
.\"0 and
.\"0 .ZN Xutf8LookupString
.\"0 is the one currently in possession of the focus or not.
.ZN XmbLookupString ,
.ZN XwcLookupString ,
.ZN Xutf8LookupString
に引き数として渡された入力コンテクストが現在フォーカスを所有していても、
あるいはそうでなくても、結果に違いは生じない。
.\"0 Input may have been composed within an input context before it lost the focus,
.\"0 and that input may be returned on subsequent calls to
.\"0 .ZN XmbLookupString ,
.\"0 .ZN XwcLookupString
.\"0 or
.\"0 .ZN Xutf8LookupString
.\"0 even though it does not have any more keyboard focus.
入力はフォーカスを失った時点では既に入力コンテクストの内部に構築
されているので、キーボードフォーカスが失われてしまっても、後から
.ZN XmbLookupString ,
.ZN XwcLookupString ,
.ZN Xutf8LookupString
を呼び出して入力を受け取ることができる。
.LP
.\"0 The function
.\"0 .ZN Xutf8LookupString
.\"0 is an XFree86 extension introduced in XFree86 4.0.2. Its presence is
.\"0 indicated by the macro
.\"0 .ZN X_HAVE_UTF8_STRING .
関数
.ZN Xutf8LookupString
は XFree86 4.0.2 から導入された XFree86 独自の拡張である。
この関数が存在するかどうかはマクロ
.ZN X_HAVE_UTF8_STRING 
で判定できる。
.SH 関連項目
XLookupKeysym(3X11)
.br
\fI\*(xL\fP