XSetInputFocus man page

XSetInputFocus, XGetInputFocus — control input focus

Syntax

int XSetInputFocus(Display *display, Window focus, int revert_to, Time time);

int XGetInputFocus(Display *display, Window *focus_return, int *revert_to_return);

Arguments

display

Specifies the connection to the X server.

focus

Specifies the window, PointerRoot, or None.

focus_return

Returns the focus window, PointerRoot, or  None.

revert_to

Specifies where the input focus reverts to if the window becomes not viewable. You can pass  RevertToParent, RevertToPointerRoot, or  RevertToNone.

revert_to_return

Returns the current focus state (RevertToParent, RevertToPointerRoot, or  RevertToNone).

time

Specifies the time. You can pass either a timestamp or CurrentTime.

Description

The XSetInputFocus function changes the input focus and the last-focus-change time. It has no effect if the specified time is earlier than the current last-focus-change time or is later than the current X server time. Otherwise, the last-focus-change time is set to the specified time (CurrentTime is replaced by the current X server time). XSetInputFocus causes the X server to generate FocusIn and  FocusOut events.

Depending on the focus argument, the following occurs:

The specified focus window must be viewable at the time  XSetInputFocus is called, or a BadMatch error results. If the focus window later becomes not viewable,  the X server evaluates the revert_to argument to determine the new focus window as follows:

XSetInputFocus can generate BadMatch, BadValue, and BadWindow errors.

The XGetInputFocus function returns the focus window and the current focus state.

Diagnostics

BadValue

Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted.  Any argument defined as a set of alternatives can generate this error.

BadWindow

A value for a Window argument does not name a defined Window.

See Also

XWarpPointer(3)
Xlib - C Language X Interface

Referenced By

XWarpPointer(3).

The man page XGetInputFocus(3) is an alias of XSetInputFocus(3).

libX11 1.6.5 X Version 11 XLIB FUNCTIONS