XOpenIM(3X11)

名前
XOpenIM, XCloseIM, XSetIMValues, XGetIMValues, XDisplayOfIM, XLocaleOfIM, XRegisterIMInstantiateCallback, XUnregisterIMInstantiateCallback - 入力メソッド(input method)のオープン、クローズと情報の取得を行なう

書式
XIM XOpenIM(display, db, res_name, res_class)
      Display *display;
      XrmDatabase db;
      char *res_name;
      char *res_class;

Status XCloseIM(im)
      XIM im;

char * XSetIMValues(im, ...)
      XIM im;

char * XGetIMValues(im, ...)
      XIM im;

Display * XDisplayOfIM(im)
    XIM im;

char * XLocaleOfIM(im)
      XIM im;

Bool XRegisterIMInstantiateCallback(display, db, res_name, res_class, callback, client_data)
      Display *display;
      XrmDatabase db;
      char *res_name;
      char *res_class;
      XIMProc callback;
      XPointer *client_data;

Bool XUnregisterIMInstantiateCallback(display, db, res_name, res_class, callback, client_data)
      Display *display;
      XrmDatabase db;
      char *res_name;
      char *res_class;
      XIMProc callback;
      XPointer *client_data;

引き数

callback
    入力メソッドのインスタンス化コールバックへのポインタを指定する。

client_data
    付加的なクライアントデータを指定する。

db  リソースデータベースへのポインタを指定する。

display
    X サーバへの接続を指定する。

im  入力メソッドを指定する。

res_class
    アプリケーションの完全なクラス名(full class name)を指定する。

res_name
    アプリケーションの完全なリソース名(full resource name)を指定する。

... to XIM の値を取得あるいは設定するための可変長引き数リストを指定する。

説明
関数 は現在のロケールとモディファイア指定に一致する入力メソッドをオープンす る。 現在のロケールとモディファイアはオープン時に入力メソッドと関連づけられ る。 入力メソッドに関連付けられたロケールを動的に変更することはできない。 すなわち、与えられた入力メソッドと関連付けられている任意の 入力コンテクストに対して や が返す文字列は、入力メソッドがオープンされた時点のロケールでエンコード される。

この呼び出しが送られる、指定された入力メソッドは、現在のロケールに 基づいて識別される。 は現在のロケールに対応するデフォルトの入力メソッドを認識する。 このデフォルトは入力メソッドモディファイアに対する を用いて変更することができる。

引き数 db は、入力メソッドが自分のプライベートなリソースを調べるために使 用するリソースデータベースである。 このデータベースを用いる意図は、入力コンテクストから IC 値に設定できる 値を検索することにあるのではない。 もし db が NULL ならば、データベースは入力メソッドに渡されない。

引き数 res_name と res_class ではアプリケーションのリソース名とクラスを 指定する。 これらは、入力メソッドに対して生成される全ての入力コンテクストに共通 のリソースを調べる際に、入力メソッドがプレフィックスとして使用するもの である。 リソース名とクラスに使われる文字は、X ポータブル文字集合に含まれるもの でなければならない。 res_name か res_class が NULL であれば、調べられるリソースの指定は完全 にはできない。

引き数 res_name と res_class は、 の呼び出しの後には存在するとは想定できない。 指定したリソースデータベースは、入力メソッドが存在する間存在するものと 想定できる。

は、入力メソッドを開くことができなければ NULL を返す。

関数 は指定した入力メソッドを閉じる。

関数 は、指定した入力メソッドの属性を設定するために、可変長引き数リスト プログラミングインタフェースを持っている。 この関数は成功の場合に NULL を返す。そうでない場合には、 設定できなかった最初の引き数の名前を返す。 Xlib は、与えられたリストのうち、設定に失敗した引き数より後ろの 引き数は設定しない。 リスト中で失敗した引き数より前にある全ての引き数は正しく設定される。

The 関数 は指定した入力メソッドのプロパティやフィーチャを問い合わせるために、可 変長引き数リストプログラミングインタフェースを与える。 この関数は成功時には NULL を返す。 そうでない場合には、取得に失敗した最初の引き数の名前を返す。

それぞれの XIM 値の引き数(名前に続く)は、XIM 値が保存される領域を指さな ければならない。 つまり、XIM 値の型が T であれば、引き数の型は T* でなければならない。 もし、T そのものがポインタ型であれば、 は実際のデータを保存するメモリを割り当て、そのデータへのポインタを 返す。 を使ってこのデータを解放のはクライアントの責任である。

関数 は指定した入力メソッドに関連付けられたディスプレイを返す。

関数 は指定した入力メソッドに関連付けられたロケールを返す。

関数 は、指定したディスプレイに対する現在のロケールとモディファイアに適合す る新しい入力メソッドが利用可能になったときに必ず呼び出されるコールバッ クを登録する。

この関数は成功時には を、そうでない時には を返す。

関数 は、以前に登録した入力メソッドのインスタンス化時のコールバックを削除す る。 この関数は成功時には を、そうでない場合には を返す。

関連項目
XCreateIC(3X11), XSetICFocus(3X11), XSetICValues(3X11), XmbResetIC(3X11)
Xlib - C Language X Interface