GDK_SURFACE_XID()

#define GDK_SURFACE_XID(win)           (gdk_x11_surface_get_xid (win))

Returns the X window belonging to a GdkSurface.

GDK_DISPLAY_XDISPLAY()

#define GDK_DISPLAY_XDISPLAY(display) (gdk_x11_display_get_xdisplay (display))

Returns the display of a GdkDisplay.

GDK_POINTER_TO_XID()

#define GDK_POINTER_TO_XID(pointer) GPOINTER_TO_UINT(pointer)

Converts a gpointer back to an XID that was previously converted using GDK_XID_TO_POINTER().

GDK_XID_TO_POINTER()

#define GDK_XID_TO_POINTER(xid) GUINT_TO_POINTER(xid)

Converts an XID into a gpointer . This is useful with data structures that use pointer arguments such as GHashTable. Use GDK_POINTER_TO_XID() to convert the argument back to an XID.

gdk_x11_lookup_xdisplay ()

GdkDisplay *
gdk_x11_lookup_xdisplay (Display *xdisplay);

Find the GdkDisplay corresponding to xdisplay , if any exists.

gdk_x11_get_server_time ()

guint32
gdk_x11_get_server_time (GdkSurface *surface);

Routine to get the current X server time stamp.

gdk_x11_device_get_id ()

int
gdk_x11_device_get_id (GdkDevice *device);

Returns the device ID as seen by XInput2.

gdk_x11_device_manager_lookup ()

GdkDevice *
gdk_x11_device_manager_lookup (GdkX11DeviceManagerXI2 *device_manager,
                               int device_id);

Returns the GdkDevice that wraps the given device ID.

gdk_x11_display_open ()

GdkDisplay *
gdk_x11_display_open (const char *display_name);

Tries to open a new display to the X server given by display_name . If opening the display fails, NULL is returned.

gdk_x11_display_set_program_class ()

void
gdk_x11_display_set_program_class (GdkDisplay *display,
                                   const char *program_class);

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.

gdk_x11_display_get_user_time ()

guint32
gdk_x11_display_get_user_time (GdkDisplay *display);

Returns the timestamp of the last user interaction on display . The timestamp is taken from events caused by user interaction such as key presses or pointer movements. See gdk_x11_surface_set_user_time().

gdk_x11_display_broadcast_startup_message ()

void
gdk_x11_display_broadcast_startup_message
                               (GdkDisplay *display,
                                const char *message_type,
                                ...);

Sends a startup notification message of type message_type to display .

This is a convenience function for use by code that implements the freedesktop startup notification specification. Applications should not normally need to call it directly. See the Startup Notification Protocol specification for definitions of the message types and keys that can be used.

gdk_x11_display_get_startup_notification_id ()

const char *
gdk_x11_display_get_startup_notification_id
                               (GdkDisplay *display);

Gets the startup notification ID for a display.

gdk_x11_display_set_startup_notification_id ()

void
gdk_x11_display_set_startup_notification_id
                               (GdkDisplay *display,
                                const char *startup_id);

Sets the startup notification ID for a display.

This is usually taken from the value of the DESKTOP_STARTUP_ID environment variable, but in some cases (such as the application not being launched using exec()) it can come from other sources.

If the ID contains the string "_TIME" then the portion following that string is taken to be the X11 timestamp of the event that triggered the application to be launched and the GDK current event time is set accordingly.

The startup ID is also what is used to signal that the startup is complete (for example, when opening a window or when calling gdk_display_notify_startup_complete()).

gdk_x11_display_get_xdisplay ()

Display *
gdk_x11_display_get_xdisplay (GdkDisplay *display);

Returns the X display of a GdkDisplay.

gdk_x11_display_get_xscreen ()

Screen *
gdk_x11_display_get_xscreen (GdkDisplay *display);

Returns the X Screen used by GdkDisplay.

gdk_x11_display_get_xrootwindow ()

Window
gdk_x11_display_get_xrootwindow (GdkDisplay *display);

Returns the root X window used by GdkDisplay.

gdk_x11_display_get_xcursor ()

Cursor
gdk_x11_display_get_xcursor (GdkDisplay *display,
                             GdkCursor *cursor);

Returns the X cursor belonging to a GdkCursor, potentially creating the cursor.

Be aware that the returned cursor may not be unique to cursor . It may for example be shared with its fallback cursor. On old X servers that don't support the XCursor extension, all cursors may even fall back to a few default cursors.

gdk_x11_display_grab ()

void
gdk_x11_display_grab (GdkDisplay *display);

Call XGrabServer() on display . To ungrab the display again, use gdk_x11_display_ungrab().

gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.

gdk_x11_display_ungrab ()

void
gdk_x11_display_ungrab (GdkDisplay *display);

Ungrab display after it has been grabbed with gdk_x11_display_grab().

gdk_x11_display_get_default_group ()

GdkSurface *
gdk_x11_display_get_default_group (GdkDisplay *display);

Returns the default group leader surface for all toplevel surfaces on display . This surface is implicitly created by GDK. See gdk_x11_surface_set_group().

gdk_x11_display_error_trap_push ()

void
gdk_x11_display_error_trap_push (GdkDisplay *display);

Begins a range of X requests on display for which X error events will be ignored. Unignored errors (when no trap is pushed) will abort the application. Use gdk_x11_display_error_trap_pop() or gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed with this function.

gdk_x11_display_error_trap_pop ()

int
gdk_x11_display_error_trap_pop (GdkDisplay *display);

Pops the error trap pushed by gdk_x11_display_error_trap_push(). Will XSync() if necessary and will always block until the error is known to have occurred or not occurred, so the error code can be returned.

If you don’t need to use the return value, gdk_x11_display_error_trap_pop_ignored() would be more efficient.

gdk_x11_display_error_trap_pop_ignored ()

void
gdk_x11_display_error_trap_pop_ignored
                               (GdkDisplay *display);

Pops the error trap pushed by gdk_x11_display_error_trap_push(). Does not block to see if an error occurred; merely records the range of requests to ignore errors for, and ignores those errors if they arrive asynchronously.

gdk_x11_display_set_cursor_theme ()

void
gdk_x11_display_set_cursor_theme (GdkDisplay *display,
                                  const char *theme,
                                  const int size);

Sets the cursor theme from which the images for cursor should be taken.

If the windowing system supports it, existing cursors created with gdk_cursor_new_from_name() are updated to reflect the theme change. Custom cursors constructed with gdk_cursor_new_from_texture() will have to be handled by the application (GTK applications can learn about cursor theme changes by listening for change notification for the corresponding GtkSetting).

gdk_x11_display_set_surface_scale ()

void
gdk_x11_display_set_surface_scale (GdkDisplay *display,
                                   int scale);

Forces a specific window scale for all windows on this display, instead of using the default or user configured scale. This is can be used to disable scaling support by setting scale to 1, or to programmatically set the window scale.

Once the scale is set by this call it will not change in response to later user configuration changes.

gdk_x11_display_get_glx_version ()

gboolean
gdk_x11_display_get_glx_version (GdkDisplay *display,
                                 int *major,
                                 int *minor);

Retrieves the version of the GLX implementation.

gdk_x11_display_get_primary_monitor ()

GdkMonitor *
gdk_x11_display_get_primary_monitor (GdkDisplay *display);

Gets the primary monitor for the display.

The primary monitor is considered the monitor where the “main desktop” lives. While normal application surfaces typically allow the window manager to place the surfaces, specialized desktop applications such as panels should place themselves on the primary monitor.

If no monitor is the designated primary monitor, any monitor (usually the first) may be returned.

gdk_x11_display_get_screen ()

GdkX11Screen *
gdk_x11_display_get_screen (GdkDisplay *display);

Retrieves the GdkX11Screen of the display .

gdk_x11_monitor_get_output ()

XID
gdk_x11_monitor_get_output (GdkMonitor *monitor);

Returns the XID of the Output corresponding to monitor .

gdk_x11_monitor_get_workarea ()

void
gdk_x11_monitor_get_workarea (GdkMonitor *monitor,
                              GdkRectangle *workarea);

Retrieves the size and position of the “work area” on a monitor within the display coordinate space. The returned geometry is in ”application pixels”, not in ”device pixels” (see gdk_monitor_get_scale_factor()).

gdk_x11_screen_get_screen_number ()

int
gdk_x11_screen_get_screen_number (GdkX11Screen *screen);

Returns the index of a GdkX11Screen.

gdk_x11_screen_get_xscreen ()

Screen *
gdk_x11_screen_get_xscreen (GdkX11Screen *screen);

Returns the screen of a GdkX11Screen.

gdk_x11_screen_get_window_manager_name ()

const char *
gdk_x11_screen_get_window_manager_name
                               (GdkX11Screen *screen);

Returns the name of the window manager for screen .

gdk_x11_screen_get_monitor_output ()

XID
gdk_x11_screen_get_monitor_output (GdkX11Screen *screen,
                                   int monitor_num);

Gets the XID of the specified output/monitor. If the X server does not support version 1.2 of the RANDR extension, 0 is returned.

gdk_x11_screen_supports_net_wm_hint ()

gboolean
gdk_x11_screen_supports_net_wm_hint (GdkX11Screen *screen,
                                     const char *property_name);

This function is specific to the X11 backend of GDK, and indicates whether the window manager supports a certain hint from the Extended Window Manager Hints specification.

When using this function, keep in mind that the window manager can change over time; so you shouldn’t use this function in a way that impacts persistent application state. A common bug is that your application can start up before the window manager does when the user logs in, and before the window manager starts gdk_x11_screen_supports_net_wm_hint() will return FALSE for every property. You can monitor the window_manager_changed signal on GdkX11Screen to detect a window manager change.

gdk_x11_screen_get_number_of_desktops ()

guint32
gdk_x11_screen_get_number_of_desktops (GdkX11Screen *screen);

Returns the number of workspaces for screen when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints specification.

gdk_x11_screen_get_current_desktop ()

guint32
gdk_x11_screen_get_current_desktop (GdkX11Screen *screen);

Returns the current workspace for screen when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints specification.

gdk_x11_surface_lookup_for_display ()

GdkSurface *
gdk_x11_surface_lookup_for_display (GdkDisplay *display,
                                    Window window);

Looks up the GdkSurface that wraps the given native window handle.

gdk_x11_surface_get_xid ()

Window
gdk_x11_surface_get_xid (GdkSurface *surface);

Returns the X resource (surface) belonging to a GdkSurface.

gdk_x11_surface_set_theme_variant ()

void
gdk_x11_surface_set_theme_variant (GdkSurface *surface,
                                   const char *variant);

GTK applications can request a dark theme variant. In order to make other applications - namely window managers using GTK for themeing - aware of this choice, GTK uses this function to export the requested theme variant as _GTK_THEME_VARIANT property on toplevel surfaces.

Note that this property is automatically updated by GTK, so this function should only be used by applications which do not use GTK to create toplevel surfaces.

gdk_x11_surface_set_user_time ()

void
gdk_x11_surface_set_user_time (GdkSurface *surface,
                               guint32 timestamp);

The application can use this call to update the _NET_WM_USER_TIME property on a toplevel surface. This property stores an Xserver time which represents the time of the last user input event received for this surface. This property may be used by the window manager to alter the focus, stacking, and/or placement behavior of surfaces when they are mapped depending on whether the new surface was created by a user action or is a "pop-up" surface activated by a timer or some other event.

Note that this property is automatically updated by GDK, so this function should only be used by applications which handle input events bypassing GDK.

gdk_x11_surface_move_to_current_desktop ()

void
gdk_x11_surface_move_to_current_desktop
                               (GdkSurface *surface);

Moves the surface to the correct workspace when running under a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints specification. Will not do anything if the surface is already on all workspaces.

gdk_x11_surface_move_to_desktop ()

void
gdk_x11_surface_move_to_desktop (GdkSurface *surface,
                                 guint32 desktop);

Moves the surface to the given workspace when running unde a window manager that supports multiple workspaces, as described in the Extended Window Manager Hints specification.

gdk_x11_surface_get_desktop ()

guint32
gdk_x11_surface_get_desktop (GdkSurface *surface);

Gets the number of the workspace surface is on.

gdk_x11_surface_set_utf8_property ()

void
gdk_x11_surface_set_utf8_property (GdkSurface *surface,
                                   const char *name,
                                   const char *value);

This function modifies or removes an arbitrary X11 window property of type UTF8_STRING. If the given surface is not a toplevel surface, it is ignored.

gdk_x11_surface_set_frame_sync_enabled ()

void
gdk_x11_surface_set_frame_sync_enabled
                               (GdkSurface *surface,
                                gboolean frame_sync_enabled);

This function can be used to disable frame synchronization for a surface. Normally frame synchronziation will be enabled or disabled based on whether the system has a compositor that supports frame synchronization, but if the surface is not directly managed by the window manager, then frame synchronziation may need to be disabled. This is the case for a surface embedded via the XEMBED protocol.

gdk_x11_surface_set_group ()

void
gdk_x11_surface_set_group (GdkSurface *surface,
                           GdkSurface *leader);

Sets the group leader of surface to be leader . See the ICCCM for details.

gdk_x11_surface_get_group ()

GdkSurface *
gdk_x11_surface_get_group (GdkSurface *surface);

Returns the group this surface belongs to.

gdk_x11_surface_set_skip_pager_hint ()

void
gdk_x11_surface_set_skip_pager_hint (GdkSurface *surface,
                                     gboolean skips_pager);

Sets a hint on surface that pagers should not display it. See the EWMH for details.

gdk_x11_surface_set_skip_taskbar_hint ()

void
gdk_x11_surface_set_skip_taskbar_hint (GdkSurface *surface,
                                       gboolean skips_taskbar);

Sets a hint on surface that taskbars should not display it. See the EWMH for details.

gdk_x11_surface_set_urgency_hint ()

void
gdk_x11_surface_set_urgency_hint (GdkSurface *surface,
                                  gboolean urgent);

Sets a hint on surface that it needs user attention. See the ICCCM for details.

gdk_x11_get_xatom_by_name_for_display ()

Atom
gdk_x11_get_xatom_by_name_for_display (GdkDisplay *display,
                                       const char *atom_name);

Returns the X atom for a GdkDisplay corresponding to atom_name . This function caches the result, so if called repeatedly it is much faster than XInternAtom(), which is a round trip to the server each time.

gdk_x11_get_xatom_name_for_display ()

const char *
gdk_x11_get_xatom_name_for_display (GdkDisplay *display,
                                    Atom xatom);

Returns the name of an X atom for its display. This function is meant mainly for debugging, so for convenience, unlike XAtomName() and the result doesn’t need to be freed.

gdk_x11_set_sm_client_id ()

void
gdk_x11_set_sm_client_id (const char *sm_client_id);

Sets the SM_CLIENT_ID property on the application’s leader window so that the window manager can save the application’s state using the X11R6 ICCCM session management protocol.

See the X Session Management Library documentation for more information on session management and the Inter-Client Communication Conventions Manual

gdk_x11_display_text_property_to_text_list ()

int
gdk_x11_display_text_property_to_text_list
                               (GdkDisplay *display,
                                const char *encoding,
                                int format,
                                const guchar *text,
                                int length,
                                char ***list);

Convert a text string from the encoding as it is stored in a property into an array of strings in the encoding of the current locale. (The elements of the array represent the nul-separated elements of the original text string.)

gdk_x11_free_text_list ()

void
gdk_x11_free_text_list (char **list);

Frees the array of strings created by gdk_x11_display_text_property_to_text_list().

gdk_x11_display_string_to_compound_text ()

int
gdk_x11_display_string_to_compound_text
                               (GdkDisplay *display,
                                const char *str,
                                const char **encoding,
                                int *format,
                                guchar **ctext,
                                int *length);

Convert a string from the encoding of the current locale into a form suitable for storing in a window property.

gdk_x11_display_utf8_to_compound_text ()

gboolean
gdk_x11_display_utf8_to_compound_text (GdkDisplay *display,
                                       const char *str,
                                       const char **encoding,
                                       int *format,
                                       guchar **ctext,
                                       int *length);

Converts from UTF-8 to compound text.

gdk_x11_free_compound_text ()

void
gdk_x11_free_compound_text (guchar *ctext);

Frees the data returned from gdk_x11_display_string_to_compound_text().