XSendEvent

Syntax

Status XSendEvent(display, w, propagate, event_mask, event_send)
      Display *display;
      Window w;
      Bool propagate;
      long event_mask;
      XEvent *event_send;

Arguments

Description

• If w is PointerWindow, the destination window is the window that contains the pointer.
  w が PointerWindow である場合、 送り先ウィンドウはポインタを含んでいるウィンドウとなる。

• If w is InputFocus and if the focus window contains the pointer, the destination window is the window that contains the pointer; otherwise, the destination window is the focus window.
  w が InputFocus の場合、 フォーカスウィンドウがポインタを含んでいるならば、 送り先ウィンドウはポインタを含んでいるウィンドウとなる。 ポインタを含んでいなければ送り先ウィンドウはフォーカスウィンドウとなる。

To determine which clients should receive the specified events, XSendEvent() uses the propagate argument as follows:
指定されたイベントを受け取るクライアントを決めるため、 XSendEvent() は引き数 propagate を以下のように用いる:

• If event_mask is the empty set, the event is sent to the client that created the destination window. If that client no longer exists, no event is sent.
  event_mask が空集合ならば、 イベントは destination window を生成したクライアントに送られる。 そのクライアントが既に終了していればイベントは全く送られない。

• If propagate is False, the event is sent to every client selecting on destination any of the event types in the event_mask argument.
  propagate が False ならば、 イベントは引き数 event_mask に含まれる全てのイベント・タイプを destination に選択している 全てのクライアントに送られる。

• If propagate is True and no clients have selected on destination any of the event types in event-mask, the destination is replaced with the closest ancestor of destination for which some client has selected a type in event-mask and for which no intervening window has that type in its do-not-propagate-mask. If no such window exists or if the window is an ancestor of the focus window and InputFocus was originally specified as the destination, the event is not sent to any clients. Otherwise, the event is reported to every client selecting on the final destination any of the types specified in event_mask.
  propagate が True であり、 送り先ウィンドウにおいて 指定されたイベント・タイプを イベント・マスク で選択しているクライアントが全くなければ、 送り先ウィンドウは送り先ウィンドウの祖先ウィンドウのうち、 次の条件を満たす最も近いものに置き換えられる。 その条件とは、 何らかのクライアントがイベント型をイベントマスクで選択しており、 かつ間に挟まれているウィンドウの中にはそのイベント型を do-not-propagate-mask に含んでいるものが無いことである。 そのようなウィンドウが存在しない場合や、 そのウィンドウがフォーカスウィンドウの祖先であり、 かつ元々の送り先として InputFocus が指定されている場合には、 イベントはどのクライアントにも送られない。 そうでない場合には event_mask に指定されているイベント型のいずれかを 最終的な送り先ウィンドウにおいて選択している全てのクライアントに対して イベントが送られる。

The event in the XEvent structure must be one of the core events or one of the events defined by an extension (or a BadValue error results) so that the X server can correctly byte-swap the contents as necessary. The contents of the event are otherwise unaltered and unchecked by the X server except to force send_event to True in the forwarded event and to set the serial number in the event correctly; therefore these fields and the display field are ignored by XSendEvent().
XEvent 構造体が持つイベントはコアイベントのいずれか、 あるいは拡張によって定義されているイベントのいずれかでなければならない。 (さもなくば BadValue エラーとなる) これは X サーバが必要に応じて 構造体の内容を正しくバイト交換できるようにするためである。 これ以外の場合にはイベントの内容を X サーバが変更したり調べることはない。 ただし例外としてイベントを転送する時に send_event を True にすることや、 イベントのシリアル番号を正しく設定することがある。 したがって XSendEvent() はこれらのフィールドや display フィールドを無視する。

XSendEvent() returns zero if the conversion to wire protocol format failed and returns nonzero otherwise.
XSendEventは通信プロトコル形式への変換が失敗すると 0 を返し、それ以外の場合に は 0 でない値を返す。

XSendEvent() can generate BadValue and BadWindow errors.
XSendEventはエラー BadValue, BadWindow を起こすことがある。

Diagnostics

See also