Methods

Appends gdk option entries to the passed in option group. This is not public API and must not be used by applications.

Emits a short beep on the default display.

Creates a Cairo context for drawing to window.

Note that calling cairo_reset_clip() on the resulting Context will produce undefined results, so avoid it at all costs.

Typically, this function is used to draw on a Window out of the paint cycle of the toolkit; this should be avoided, as it breaks various assumptions and optimizations.

If you are drawing on a native Window in response to a EventTypeExpose event you should use windowBeginDrawFrame and drawingContextGetCairoContext instead. GTK will automatically do this for you when drawing a widget.

Since: 2.8

This is the main way to draw GL content in GTK+. It takes a render buffer ID (sourceType == GL_RENDERBUFFER) or a texture id (sourceType == GL_TEXTURE) and draws it onto cr with an OVER operation, respecting the current clip. The top left corner of the rectangle specified by x, y, width and height will be drawn at the current (0,0) position of the cairo_t.

This will work for *all* cairo_t, as long as window is realized, but the fallback implementation that reads back the pixels from the buffer may be used in the general case. In the case of direct drawing to a window with no special effects applied to cr it will however use a more efficient approach.

For GL_RENDERBUFFER the code will always fall back to software for buffers with alpha components, so make sure you use GL_TEXTURE if using alpha.

Calling this may change the current GL context.

Since: 3.16

This is a convenience function around cairo_clip_extents(). It rounds the clip extents to integer coordinates and returns a boolean indicating if a clip area exists.

Retrieves the DrawingContext that created the Cairo context cr.

Since: 3.22

Adds the given rectangle to the current path of cr.

Since: 2.8

Adds the given region to the current path of cr.

Since: 2.8

Creates region that describes covers the area where the given surface is more than 50% opaque.

This function takes into account device offsets that might be set with cairo_surface_set_device_offset().

Sets the specified Color as the source color of cr.

Since: 2.8

Sets the given pixbuf as the source pattern for cr.

The pattern has an extend mode of ExtendNone and is aligned so that the origin of pixbuf is pixbufX, pixbufY.

Since: 2.8

Sets the specified RGBA as the source color of cr.

Since: 3.0

Sets the given window as the source pattern for cr.

The pattern has an extend mode of ExtendNone and is aligned so that the origin of window is x, y. The window contains all its subwindows when rendering.

Note that the contents of window are undefined outside of the visible part of window, so use this function with care.

Since: 2.24

Creates an image surface with the same contents as the pixbuf.

Since: 3.10

Disables multidevice support in GDK. This call must happen prior to displayOpen, gtk_init(), gtk_init_with_args() or gtk_init_check() in order to take effect.

Most common GTK+ applications won’t ever need to call this. Only applications that do mixed GDK/Xlib calls could want to disable multidevice support if such Xlib code deals with input devices in any way and doesn’t observe the presence of XInput 2.

Since: 3.0

Aborts a drag without dropping.

This function is called by the drag source.

This function does not need to be called in managed drag and drop operations. See dragContextManageDnd for more information.

Starts a drag and creates a new drag context for it. This function assumes that the drag is controlled by the client pointer device, use dragBeginForDevice to begin a drag with a different device.

This function is called by the drag source.

Starts a drag and creates a new drag context for it.

This function is called by the drag source.

Starts a drag and creates a new drag context for it.

This function is called by the drag source.

Since: 3.20

Drops on the current destination.

This function is called by the drag source.

This function does not need to be called in managed drag and drop operations. See dragContextManageDnd for more information.

Inform GDK if the drop ended successfully. Passing False for success may trigger a drag cancellation animation.

This function is called by the drag source, and should be the last call before dropping the reference to the context.

The DragContext will only take the first dragDropDone call as effective, if this function is called multiple times, all subsequent calls will be ignored.

Since: 3.20

Returns whether the dropped data has been successfully transferred. This function is intended to be used while handling a EventTypeDropFinished event, its return value is meaningless at other times.

Since: 2.6

Finds the destination window and DND protocol to use at the given pointer position.

This function is called by the drag source to obtain the destWindow and protocol parameters for dragMotion.

Since: 2.2

Returns the selection atom for the current source window.

Updates the drag context when the pointer moves or the set of actions changes.

This function is called by the drag source.

This function does not need to be called in managed drag and drop operations. See dragContextManageDnd for more information.

Selects one of the actions offered by the drag source.

This function is called by the drag destination in response to dragMotion called by the drag source.

Ends the drag operation after a drop.

This function is called by the drag destination.

Accepts or rejects a drop.

This function is called by the drag destination in response to a drop initiated by the drag source.

Removes an error trap pushed with errorTrapPush. May block until an error has been definitively received or not received from the X server. errorTrapPopIgnored is preferred if you don’t need to know whether an error occurred, because it never has to block. If you don't need the return value of errorTrapPop, use errorTrapPopIgnored.

Prior to GDK 3.0, this function would not automatically sync for you, so you had to flush if your last call to Xlib was not a blocking round trip.

Removes an error trap pushed with errorTrapPush, but without bothering to wait and see whether an error occurred. If an error arrives later asynchronously that was triggered while the trap was pushed, that error will be ignored.

Since: 3.0

This function allows X errors to be trapped instead of the normal behavior of exiting the application. It should only be used if it is not possible to avoid the X error in any other way. Errors are ignored on all Display currently known to the DisplayManager. If you don’t care which error happens and just want to ignore everything, pop with errorTrapPopIgnored. If you need the error code, use errorTrapPop which may have to block and wait for the error to arrive from the X server.

This API exists on all platforms but only does anything on X.

You can use gdk_x11_display_error_trap_push() to ignore errors on only a single display.

Trapping an X error

C code

gdk_error_trap_push ();

 // ... Call the X function which may cause an error here ...


if (gdk_error_trap_pop ())
 {
   // ... Handle the error here ...
 }

If both events contain X/Y information, this function will return True and return in angle the relative angle from event1 to event2. The rotation direction for positive angles is from the positive X axis towards the positive Y axis.

Since: 3.0

If both events contain X/Y information, the center of both coordinates will be returned in x and y.

Since: 3.0

If both events have X/Y information, the distance between both coordinates (as in a straight line going from event1 to event2) will be returned.

Since: 3.0

Checks if any events are ready to be processed for any display.

Flushes the output buffers of all display connections and waits until all requests have been processed. This is rarely needed by applications.

Obtains the root window (parent all other windows are inside) for the default display and screen.

Gets the name of the display, which usually comes from the DISPLAY environment variable or the --display command line option.

Gets the display name specified in the command line arguments passed to init or parseArgs, if any.

Since: 2.2

Gets the program class. Unless the program class has explicitly been set with setProgramClass or with the --class commandline option, the default value is the program name (determined with getPrgname) with the first character converted to uppercase.

Gets whether event debugging output is enabled.

Initializes the GDK library and connects to the windowing system. If initialization fails, a warning message is output and the application terminates with a call to exit(1).

Any arguments used by GDK are removed from the array and argc and argv are updated accordingly.

GTK+ initializes GDK in gtk_init() and so this function is not usually needed by GTK+ applications.

Initializes the GDK library and connects to the windowing system, returning True on success.

Any arguments used by GDK are removed from the array and argc and argv are updated accordingly.

GTK+ initializes GDK in gtk_init() and so this function is not usually needed by GTK+ applications.

Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with keyboardUngrab. This overrides any previous keyboard grab by this client.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the EventGrabBroken events that are emitted when the grab ends unvoluntarily.

Ungrabs the keyboard on the default display, if it is grabbed by this application.

Obtains the upper- and lower-case versions of the keyval symbol. Examples of keyvals are KEY_a, GDK_KEY_Enter, KEY_F1, etc.

Converts a key name to a key value.

The names are the same as those in the gdk/gdkkeysyms.h header file but without the leading “GDK_KEY_”.

Returns True if the given key value is in lower case.

Returns True if the given key value is in upper case.

Converts a key value into a symbolic name.

The names are the same as those in the gdk/gdkkeysyms.h header file but without the leading “GDK_KEY_”.

Converts a key value to lower case, if applicable.

Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) character.

Converts a key value to upper case, if applicable.

Lists the available visuals for the default screen. (See screenListVisuals) A visual describes a hardware image data format. For example, a visual might support 24-bit color, or 8-bit color, and might expect pixels to be in a certain format.

Call g_list_free() on the return value when you’re finished with it.

Indicates to the GUI environment that the application has finished loading. If the applications opens windows, this function is normally called after opening the application’s initial set of windows.

GTK+ will call this function automatically after opening the first GtkWindow unless gtk_window_set_auto_startup_notification() is called to disable that feature.

Since: 2.2

Indicates to the GUI environment that the application has finished loading, using a given identifier.

GTK+ will call this function automatically for GtkWindow with custom startup-notification identifier unless gtk_window_set_auto_startup_notification() is called to disable that feature.

Since: 2.12

Gets the window that window is embedded in.

Since: 2.18

Gets the offscreen surface that an offscreen window renders into. If you need to keep this around over window resizes, you need to add a reference to it.

Sets window to be embedded in embedder.

To fully embed an offscreen window, in addition to calling this function, it is also necessary to handle the pickEmbeddedChild signal on the embedder and the toEmbedder and fromEmbedder signals on window.

Since: 2.18

Creates a Context for the default GDK screen.

The context must be freed when you’re finished with it.

When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for the widget you intend to render text onto.

The newly created context will have the default font options (see FontOptions) for the default screen; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track changes to the screen’s font rendering settings.

Creates a Context for display.

The context must be freed when you’re finished with it.

When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for the widget you intend to render text onto.

The newly created context will have the default font options (see FontOptions) for the display; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track changes to the font rendering settings.

Since: 3.22

Creates a Context for screen.

The context must be freed when you’re finished with it.

When using GTK+, normally you should use gtk_widget_get_pango_context() instead of this function, to get the appropriate context for the widget you intend to render text onto.

The newly created context will have the default font options (see FontOptions) for the screen; if these options change it will not be updated. Using gtk_widget_get_pango_context() is more convenient if you want to keep a context around and track changes to the screen’s font rendering settings.

Since: 2.2

Parse command line arguments, and store for future use by calls to displayOpen.

Any arguments used by GDK are removed from the array and argc and argv are updated accordingly.

You shouldn’t call this function explicitly if you are using gtk_init(), gtk_init_check(), init, or initCheck.

Since: 2.2

Transfers image data from a Surface and converts it to an RGB(A) representation inside a Pixbuf. This allows you to efficiently read individual pixels from cairo surfaces. For GdkWindows, use pixbufGetFromWindow instead.

This function will create an RGB pixbuf with 8 bits per channel. The pixbuf will contain an alpha channel if the surface contains one.

Transfers image data from a Window and converts it to an RGB(A) representation inside a Pixbuf. In other words, copies image data from a server-side drawable to a client-side RGB(A) buffer. This allows you to efficiently read individual pixels on the client side.

This function will create an RGB pixbuf with 8 bits per channel with the size specified by the width and height arguments scaled by the scale factor of window. The pixbuf will contain an alpha channel if the window contains one.

If the window is off the screen, then there is no image data in the obscured/offscreen regions to be placed in the pixbuf. The contents of portions of the pixbuf corresponding to the offscreen region are undefined.

If the window you’re obtaining data from is partially obscured by other windows, then the contents of the pixbuf areas corresponding to the obscured regions are undefined.

If the window is not mapped (typically because it’s iconified/minimized or not on the current workspace), then Nothing will be returned.

If memory can’t be allocated for the return value, Nothing will be returned instead.

(In short, there are several ways this function can fail, and if it fails it returns Nothing; so check the return value.)

Grabs the pointer (usually a mouse) so that all events are passed to this application until the pointer is ungrabbed with pointerUngrab, or the grab window becomes unviewable. This overrides any previous pointer grab by this client.

Pointer grabs are used for operations which need complete control over mouse events, even if the mouse leaves the application. For example in GTK+ it is used for Drag and Drop, for dragging the handle in the GtkHPaned and GtkVPaned widgets.

Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with ownerEvents set to True.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the EventGrabBroken events that are emitted when the grab ends unvoluntarily.

Returns True if the pointer on the default display is currently grabbed by this application.

Note that this does not take the inmplicit pointer grab on button presses into account.

Ungrabs the pointer on the default display, if it is grabbed by this application.

Prepare for parsing command line arguments for GDK. This is not public API and should not be used in application code.

Deletes a property from a window.

This function returns the available bit depths for the default screen. It’s equivalent to listing the visuals (listVisuals) and then looking at the depth field in each visual, removing duplicates.

The array returned by this function should not be freed.

This function returns the available visual types for the default screen. It’s equivalent to listing the visuals (listVisuals) and then looking at the type field in each visual, removing duplicates.

The array returned by this function should not be freed.

Retrieves the contents of a selection in a given form.

Determines the owner of the given selection.

Determine the owner of the given selection.

Note that the return value may be owned by a different process if a foreign window was previously created for that window, but a new foreign window will never be created by this call.

Since: 2.2

Sets the owner of the given selection.

Sets the Window owner as the current owner of the selection selection.

Since: 2.2

Sends a response to SelectionRequest event.

Send a response to SelectionRequest event.

Since: 2.2

Sets a list of backends that GDK should try to use.

This can be be useful if your application does not work with certain GDK backends.

By default, GDK tries all included backends.

For example,

C code

gdk_set_allowed_backends ("wayland,quartz,*");

instructs GDK to try the Wayland backend first, followed by the Quartz backend, and then all others.

If the GDK_BACKEND environment variable is set, it determines what backends are tried in what order, while still respecting the set of allowed backends that are specified by this function.

The possible backend names are x11, win32, quartz, broadway, wayland. You can also include a * in the list to try all remaining backends.

This call must happen prior to displayOpen, gtk_init(), gtk_init_with_args() or gtk_init_check() in order to take effect.

Since: 3.10

Set the double click time for the default display. See displaySetDoubleClickTime. See also displaySetDoubleClickDistance. Applications should not set this, it is a global user-configured setting.

Sets the program class. The X11 backend uses the program class to set the class name part of the WM_CLASS property on toplevel windows; see the ICCCM.

The program class can still be overridden with the --class command line option.

Sets whether a trace of received events is output. Note that GTK+ must be compiled with debugging (that is, configured using the --enable-debug option) to use this option.

Obtains a desktop-wide setting, such as the double-click time, for the default screen. See screenGetSetting.

No description available in the introspection data.

Retrieves a pixel from window to force the windowing system to carry out any pending rendering commands.

This function is intended to be used to synchronize with rendering pipelines, to benchmark windowing system rendering operations.

Since: 2.14

This function is intended to be used in GTK+ test programs. It will warp the mouse pointer to the given (x,y) coordinates within window and simulate a button press or release event. Because the mouse pointer needs to be 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.

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

Since: 2.14

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, testSimulateKey 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.

Since: 2.14

Converts a text property in the given encoding to a list of UTF-8 strings.

Since: 2.2

Adds a function to be called whenever there are no higher priority events pending. If the function returns False it is automatically removed from the list of event sources and will not be called again.

This variant of idleAdd calls function with the GDK lock held. It can be thought of a MT-safe version for GTK+ widgets for the following use case, where you have to worry about idle_callback() running in thread A and accessing self after it has been finalized in thread B:

C code

static gboolean
idle_callback (gpointer data)
{
   // gdk_threads_enter(); would be needed for g_idle_add()

   SomeWidget *self = data;
   // do stuff with self

   self->idle_id = 0;

   // gdk_threads_leave(); would be needed for g_idle_add()
   return FALSE;
}

static void
some_widget_do_stuff_later (SomeWidget *self)
{
   self->idle_id = gdk_threads_add_idle (idle_callback, self)
   // using g_idle_add() here would require thread protection in the callback
}

static void
some_widget_finalize (GObject *object)
{
   SomeWidget *self = SOME_WIDGET (object);
   if (self->idle_id)
     g_source_remove (self->idle_id);
   G_OBJECT_CLASS (parent_class)->finalize (object);
}

Since: 2.12

Sets a function to be called at regular intervals holding the GDK lock, with the given priority. The function is called repeatedly until it returns False, at which point the timeout is automatically destroyed and the function will not be called again. The notify function is called when the timeout is destroyed. The first call to the function will be at the end of the first interval.

Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to “catch up” time lost in delays).

This variant of timeoutAdd can be thought of a MT-safe version for GTK+ widgets for the following use case:

C code

static gboolean timeout_callback (gpointer data)
{
   SomeWidget *self = data;
   
   // do stuff with self
   
   self->timeout_id = 0;
   
   return G_SOURCE_REMOVE;
}
 
static void some_widget_do_stuff_later (SomeWidget *self)
{
   self->timeout_id = g_timeout_add (timeout_callback, self)
}
 
static void some_widget_finalize (GObject *object)
{
   SomeWidget *self = SOME_WIDGET (object);
   
   if (self->timeout_id)
     g_source_remove (self->timeout_id);
   
   G_OBJECT_CLASS (parent_class)->finalize (object);
}

Since: 2.12

A variant of threadsAddTimeout with second-granularity. See timeoutAddSeconds for a discussion of why it is a good idea to use this function if you don’t need finer granularity.

Since: 2.14

This function marks the beginning of a critical section in which GDK and GTK+ functions can be called safely and without causing race conditions. Only one thread at a time can be in such a critial section.

Initializes GDK so that it can be used from multiple threads in conjunction with threadsEnter and threadsLeave.

This call must be made before any use of the main loop from GTK+; to be safe, call it before gtk_init().

Leaves a critical region begun with threadsEnter.

Convert from a ISO10646 character to a key symbol.

Converts an UTF-8 string into the best possible representation as a STRING. The representation of characters not in STRING is not specified; it may be as pseudo-escape sequences \x{ABCD}, or it may be in some other form of approximation.