書式

XWarpPointer(display, src_w, dest_w, src_x, src_y, src_width, src_height, dest_x,

                dest_y)

        Display *display;

        Window src_w, dest_w;

        int src_x, src_y;

        unsigned int src_width, src_height;

        int dest_x, dest_y;

引き数

dest_w

移動先のウィンドウか None を指定する。

dest_x

dest_y

移動先ウィンドウ内での x, y 座標を指定する。

display

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

src_x

src_y

src_width

src_height

移動元のウィンドウ内部の長方形を指定する。

src_w

移動元のウィンドウあるいは None を指定する。

説明

引き数 dest_w が None の場合、 XWarpPointer はポインタを現在の位置から相対的にオフセット(dest_x, dest_y)だけ移動さ せる。 dest_w がウィンドウの場合、 XWarpPointer は dest_w の原点からオフセット(dest_x, dest_y)の位置にポインタを移動させる。 しかし src_w がウィンドウの場合は、移動が行われるのはウィンドウ src_w 内にポインタがあり、かつ src_w 内の指定した長方形の内部にポインタがあ る場合だけである。

座標 src_x と src_y は src_w の原点からの相対座標である。 src_height が 0 の場合、これは現在の src_w の高さから src_y を引いた 値に置き換えられる。 src_width が 0 の場合、これは現在の src_w の幅から src_x を引いた値に 置き換えられる。

この関数を使うべき場合はほとんどない。 ポインタ操作は通常はユーザに委ねられるべきである。 それにもかかわらずこの関数を使う場合、ユーザがポインタをある位置から他 の位置に瞬間的に移動させたようなイベントが生成される。 XWarpPointer を使っても、ポインタをポインタのアクティブなグラブの 制限ウィンドウ(confine_to window)の外に移動させることはできない点に 注意すること。 これを試みても、制限ウィンドウのもっとも近い外辺にポインタが 移動するだけである。

XWarpPointer はエラー BadWindow を起こすことがある。

返り値

BadWindow

引き数 Window の値が、定義されている Window を指していない。