Function

Gdktest_simulate_key

since: 2.14

Declaration [src]

gboolean
gdk_test_simulate_key (
  GdkWindow* window,
  gint x,
  gint y,
  guint keyval,
  GdkModifierType modifiers,
  GdkEventType key_pressrelease
)

Description [src]

This function is intended to be used in GTK+ test programs. If (x,y) are > (-1,-1), it will warp the mouse pointer to the given (x,y) coordinates within window and simulate a key press or release event.

When the mouse pointer is warped to the target location, use of this function outside of test programs that run in their own virtual windowing system (e.g. Xvfb) is not recommended. If (x,y) are passed as (-1,-1), the mouse pointer will not be warped and window origin will be used as mouse pointer location for the event.

Also, gdk_test_simulate_key() is a fairly low level function, for most testing purposes, gtk_test_widget_send_key() is the right function to call which will generate a key press event followed by its accompanying key release event.

Available since: 2.14

Parameters

window

Type: GdkWindow

A GdkWindow to simulate a key event for.

The data is owned by the caller of the function.

x

Type: gint

X coordinate within window for the key event.

y

Type: gint

Y coordinate within window for the key event.

keyval

Type: guint

A GDK keyboard value.

modifiers

Type: GdkModifierType

Keyboard modifiers the event is setup with.

key_pressrelease

Type: GdkEventType

Either GDK_KEY_PRESS or GDK_KEY_RELEASE.

Return value

Type: gboolean

Whether all actions necessary for a key event simulation were carried out successfully.