Returns the display of a `GdkDisplay`.
a `GdkDisplay`
Converts a @gpointer back to an XID that was previously converted
using GDK_XID_TO_POINTER().
pointer to extract an XID from
Returns the display of a `GdkSurface`.
a `GdkSurface`
Returns the X window belonging to a `GdkSurface`.
a `GdkSurface`
Tries to open a new display to the X server given by
@display_name. If opening the display fails, %NULL is
returned.
The new display
name of the X display.
See the XOpenDisplay() for details.
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.
a `GdkDisplay`
a string
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](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt)
for definitions of the message types and keys that can be used.
a `GdkDisplay`
startup notification message type ("new", "change",
or "remove")
a list of key/value pairs (as strings), terminated by a
%NULL key. (A %NULL value for a key will cause that key to be
skipped in the output.)
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.
X error code or 0 on success
the 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.
the 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.
a `GdkDisplay`
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().
The default group leader surface
for @display
a `GdkDisplay`
Retrieves the EGL display connection object for the given GDK display.
This function returns `NULL` if GDK is using GLX.
the EGL display object
an X11 display
Retrieves the version of the EGL implementation.
%TRUE if EGL is available
a `GdkDisplay`
return location for the EGL major version
return location for the EGL minor version
Retrieves the version of the GLX implementation.
%TRUE if GLX is available
a `GdkDisplay`
return location for the GLX major version
return location for the GLX minor version
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.
the primary monitor, or any monitor if no
primary monitor is configured by the user
a `GdkDisplay`
Retrieves the `GdkX11Screen` of the @display.
the `GdkX11Screen`
a `GdkX11Display`
Gets the startup notification ID for a display.
the startup notification ID for @display
a `GdkDisplay`
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().
the timestamp of the last user interaction
a `GdkDisplay`
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.
an Xlib Cursor.
a `GdkDisplay`
a `GdkCursor`
Returns the X display of a `GdkDisplay`.
an X display
a `GdkDisplay`
Returns the root X window used by `GdkDisplay`.
an X Window
a `GdkDisplay`
Returns the X Screen used by `GdkDisplay`.
an X Screen
a `GdkDisplay`
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.
a `GdkDisplay`
Sets the cursor theme from which the images for cursor
should be taken.
If the windowing system supports it, existing cursors created
with [ctor@Gdk.Cursor.new_from_name] are updated to reflect the theme
change. Custom cursors constructed with [ctor@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`).
Use the cursor-related properties of
[GtkSettings](../gtk4/class.Settings.html) to set the cursor theme
a `GdkDisplay`
the name of the cursor theme to use, or %NULL
to unset a previously set value
the cursor size to use, or 0 to keep the previous size
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()).
Using [method@Gdk.Toplevel.set_startup_id] is sufficient
a `GdkDisplay`
the startup notification ID (must be valid utf8)
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.
the display
The new scale value
Convert a string from the encoding of the current
locale into a form suitable for storing in a window property.
0 upon success, non-zero upon failure
the `GdkDisplay` where the encoding is defined
a nul-terminated string
location to store the encoding
(to be used as the type for the property)
location to store the format of the property
location to store newly
allocated data for the property
the length of @ctext, in bytes
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.)
the number of strings stored in list, or 0,
if the conversion failed
The `GdkDisplay` where the encoding is defined
a string representing the encoding. The most
common values for this are "STRING", or "COMPOUND_TEXT".
This is value used as the type for the property
the format of the property
The text data
The number of items to transform
location to store an array of strings in
the encoding of the current locale. This array should be
freed using gdk_x11_free_text_list().
Ungrab @display after it has been grabbed with
gdk_x11_display_grab().
a `GdkDisplay`
Converts from UTF-8 to compound text.
%TRUE if the conversion succeeded, otherwise %FALSE
a `GdkDisplay`
a UTF-8 string
location to store resulting encoding
location to store format of the result
location to store the data of the result
location to store the length of the data stored in @ctext
The ::xevent signal is a low level signal that is emitted
whenever an XEvent has been received.
When handlers to this signal return %TRUE, no other handlers will be
invoked. In particular, the default handler for this function is
GDK's own event handling mechanism, so by returning %TRUE for an event
that GDK expects to translate, you may break GDK and/or GTK+ in
interesting ways. You have been warned.
If you want this signal handler to queue a `GdkEvent`, you can use
gdk_display_put_event().
If you are interested in X GenericEvents, bear in mind that
XGetEventData() has been already called on the event, and
XFreeEventData() will be called afterwards.
%TRUE to stop other handlers from being invoked for the event.
%FALSE to propagate the event further.
a pointer to the XEvent to process
Returns the XID of the Output corresponding to @monitor.
the XID of @monitor
a `GdkMonitor`
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 [method@Gdk.Monitor.get_scale_factor]).
a `GdkMonitor`
a `GdkRectangle` to be filled with the monitor workarea
Returns the current workspace for @screen when running under a
window manager that supports multiple workspaces, as described
in the
[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
the current workspace, or 0 if workspaces are not supported
a `GdkX11Screen`
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.
the XID of the monitor
a `GdkX11Screen`
number of the monitor, between 0 and gdk_screen_get_n_monitors (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](http://www.freedesktop.org/Standards/wm-spec) specification.
the number of workspaces, or 0 if workspaces are not supported
a `GdkX11Screen`
Returns the index of a `GdkX11Screen`.
the position of @screen among the screens
of its display
a `GdkX11Screen`
Returns the name of the window manager for @screen.
the name of the window manager screen @screen, or
"unknown" if the window manager is unknown. The string is owned by GDK
and should not be freed.
a `GdkX11Screen`
Returns the screen of a `GdkX11Screen`.
an Xlib Screen*
a `GdkX11Screen`
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](http://www.freedesktop.org/Standards/wm-spec) 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.
%TRUE if the window manager supports @property
the relevant `GdkX11Screen`.
name of the WM property
Looks up the `GdkSurface` that wraps the given native window handle.
the `GdkSurface` wrapper
for the native window
the `GdkDisplay` corresponding to the
window handle
an Xlib Window
Gets the number of the workspace @surface is on.
the current workspace of @surface
a `GdkSurface`
Returns the group this surface belongs to.
The group of this surface;
The `GdkSurface`
Returns the X resource (surface) belonging to a `GdkSurface`.
the ID of @drawable’s X resource.
a native `GdkSurface`.
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](http://www.freedesktop.org/Standards/wm-spec) specification.
Will not do anything if the surface is already on all workspaces.
a `GdkSurface`
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](http://www.freedesktop.org/Standards/wm-spec) specification.
a `GdkSurface`
the number of the workspace to move the surface to
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.
a native `GdkSurface`
whether frame-synchronization should be enabled
Sets the group leader of @surface to be @leader.
See the ICCCM for details.
a native `GdkSurface`
a `GdkSurface`
Sets a hint on @surface that pagers should not
display it. See the EWMH for details.
a `GdkSurface`
%TRUE to skip pagers
Sets a hint on @surface that taskbars should not
display it. See the EWMH for details.
a native `GdkSurface`
%TRUE to skip taskbars
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.
a `GdkSurface`
the theme variant to export
Sets a hint on @surface that it needs user attention.
See the ICCCM for details.
a native `GdkSurface`
%TRUE to indicate urgenct attention needed
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.
A toplevel `GdkSurface`
An XServer timestamp to which the property should be set
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.
a `GdkSurface`
Property name, will be interned as an X atom
Property value, or %NULL to delete
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.
XID to stuff into the pointer
Returns the device ID as seen by XInput2.
the XInput2 device ID
a `GdkDevice`
Returns the `GdkDevice` that wraps the given device ID.
The
`GdkDevice` wrapping the device ID, or %NULL if the given ID
doesn’t currently represent a device.
a `GdkDeviceManager`
a device ID, as understood by the XInput2 protocol
Frees the data returned from gdk_x11_display_string_to_compound_text().
The pointer stored in @ctext from a call to
gdk_x11_display_string_to_compound_text().
Frees the array of strings created by
gdk_x11_display_text_property_to_text_list().
the value stored in the @list parameter by
a call to gdk_x11_display_text_property_to_text_list().
Routine to get the current X server time stamp.
the time stamp
a `GdkSurface`, used for communication
with the server. The surface must have `GDK_PROPERTY_CHANGE_MASK` in
its events mask or a hang will result.
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.
a X atom for a `GdkDisplay`
a `GdkDisplay`
a string
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.
name of the X atom; this string is owned by GDK,
so it shouldn’t be modified or freed.
the `GdkDisplay` where @xatom is defined
an X atom
Find the `GdkDisplay` corresponding to @xdisplay, if any exists.
the `GdkDisplay`, if found, otherwise %NULL.
a pointer to an X Display
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
the client id assigned by the session manager
when the connection was opened, or %NULL to remove the property.