Returns the X cursor belonging to a #GdkCursor.
a #GdkCursor.
Returns the display of a #GdkCursor.
a #GdkCursor.
Converts a @gpointer back to an XID that was previously converted
using GDK_XID_TO_POINTER().
pointer to extract an XID from
Obtains the Xlib window id of the root window of the current screen.
Returns the display of a X11 #GdkScreen.
a #GdkScreen
Returns the index of a X11 #GdkScreen.
a #GdkScreen
Returns the screen of a X11 #GdkScreen.
a #GdkScreen
Returns the display of a #GdkWindow.
a #GdkWindow.
Returns the X window belonging to a #GdkWindow.
a #GdkWindow.
Returns the X cursor belonging to a #GdkCursor.
an Xlib Cursor.
a #GdkCursor.
Returns the display of a #GdkCursor.
an Xlib Display*.
a #GdkCursor.
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
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.
See gdk_error_trap_pop() for the all-displays-at-once
equivalent.
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.
See gdk_error_trap_pop_ignored() for the all-displays-at-once
equivalent.
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.
See also gdk_error_trap_push() to push a trap on all displays.
a #GdkDisplay
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_window_set_user_time().
the timestamp of the last user interaction
a #GdkDisplay
Returns the X display of a #GdkDisplay.
an X display
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 gdk_cursor_new(), gdk_cursor_new_for_display() and
gdk_cursor_new_from_name() are updated to reflect the theme
change. Custom cursors constructed with
gdk_cursor_new_from_pixbuf() 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).
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_notify_startup_complete()).
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 atom
(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
an atom 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_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
Extracts the group from the state field sent in an X Key event.
This is only needed for code processing raw X events, since #GdkEventKey
directly includes an is_modifier field.
the index of the active keyboard group for the event
a #GdkX11Keymap
raw state returned from X
Determines whether a particular key code represents a key that
is a modifier. That is, it’s a key that normally just affects
the keyboard state and the behavior of other keys rather than
producing a direct effect itself. This is only needed for code
processing raw X events, since #GdkEventKey directly includes
an is_modifier field.
%TRUE if the hardware keycode is a modifier key
a #GdkX11Keymap
the hardware keycode from a key event
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 #GdkScreen
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 #GdkScreen
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 #GdkScreen
Returns the index of a #GdkScreen.
the position of @screen among the screens
of its display
a #GdkScreen
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 #GdkScreen
Returns the screen of a #GdkScreen.
an Xlib Screen*
a #GdkScreen
Looks up the #GdkVisual for a particular screen and X Visual ID.
the #GdkVisual (owned by the screen
object), or %NULL if the visual ID wasn’t found.
a #GdkScreen.
an X Visual ID.
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 #GdkScreen to detect
a window manager change.
%TRUE if the window manager supports @property
the relevant #GdkScreen.
a property atom.
Returns the X visual belonging to a #GdkVisual.
an Xlib Visual*.
a #GdkVisual.
Wraps a native window in a #GdkWindow. The function will try to
look up the window using gdk_x11_window_lookup_for_display() first.
If it does not find it there, it will create a new window.
This may fail if the window has been destroyed. If the window
was already known to GDK, a new reference to the existing
#GdkWindow is returned.
a #GdkWindow wrapper for the native
window, or %NULL if the window has been destroyed. The wrapper
will be newly created, if one doesn’t exist already.
the #GdkDisplay where the window handle comes from.
an Xlib Window
Looks up the #GdkWindow that wraps the given native window handle.
the #GdkWindow wrapper for the native
window, or %NULL if there is none.
the #GdkDisplay corresponding to the
window handle
an Xlib Window
Gets the number of the workspace @window is on.
the current workspace of @window
a #GdkWindow
Returns the X resource (window) belonging to a #GdkWindow.
the ID of @drawable’s X resource.
a native #GdkWindow.
Moves the window 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 window is already on all workspaces.
a #GdkWindow
Moves the window 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 #GdkWindow
the number of the workspace to move the window to
This is the same as gdk_window_set_shadow_width() but it only works
on GdkX11Window.
Use gdk_window_set_shadow_width() instead.
a #GdkWindow
The left extent
The right extent
The top extent
The bottom extent
This function can be used to disable frame synchronization for a window.
Normally frame synchronziation will be enabled or disabled based on whether
the system has a compositor that supports frame synchronization, but if
the window is not directly managed by the window manager, then frame
synchronziation may need to be disabled. This is the case for a window
embedded via the XEMBED protocol.
a native #GdkWindow
whether frame-synchronization should be enabled
Set a hint for the window manager, requesting that the titlebar
should be hidden when the window is maximized.
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 windows.
a #GdkWindow
whether to hide the titlebar when
maximized
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 windows.
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 windows.
a #GdkWindow
the theme variant to export
The application can use this call to update the _NET_WM_USER_TIME
property on a toplevel window. This property stores an Xserver
time which represents the time of the last user input event
received for this window. This property may be used by the window
manager to alter the focus, stacking, and/or placement behavior of
windows when they are mapped depending on whether the new window
was created by a user action or is a "pop-up" window 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 #GdkWindow
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 @window is
not a toplevel window, it is ignored.
a #GdkWindow
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
Converts from a #GdkAtom to the X atom for the default GDK display
with the same string value.
the X atom corresponding to @atom.
A #GdkAtom
Converts from a #GdkAtom to the X atom for a #GdkDisplay
with the same string value. The special value %GDK_NONE
is converted to %None.
the X atom corresponding to @atom, or %None
A #GdkDisplay
A #GdkAtom, or %GDK_NONE
Returns the device ID as seen by XInput2.
> If gdk_disable_multidevice() has been called, this function
> will respectively return 2/3 for the core pointer and keyboard,
> (matching the IDs for the Virtual Core Pointer and Keyboard in
> XInput 2), but calling this function on any slave devices (i.e.
> those managed via XInput 1.x), will return 0.
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().
Gets the root window of the default screen
(see gdk_x11_get_default_screen()).
an Xlib Window.
Gets the default GTK+ screen number.
returns the screen number specified by
the --display command line option or the DISPLAY environment
variable when gdk_init() calls XOpenDisplay().
Gets the default GTK+ display.
the Xlib Display* for
the display specified in the `--display` command
line option or the `DISPLAY` environment variable.
Used with gdk_window_set_background_pattern() to inherit background from
parent window. Useful for imitating transparency when compositing is not
available. Otherwise behaves like a transparent pattern.
Don't use this function
Routine to get the current X server time stamp.
the time stamp.
a #GdkWindow, used for communication
with the server. The window must have
GDK_PROPERTY_CHANGE_MASK in its events mask or a hang will
result.
Returns the X atom for GDK’s default display 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 GDK’s default display.
a string
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 GDK’s default display. This
function is meant mainly for debugging, so for convenience, unlike
XAtomName() and gdk_atom_name(), the result
doesn’t need to be freed. Also, this function will never return %NULL,
even if @xatom is invalid.
name of the X atom; this string is owned by GTK+,
so it shouldn’t be modifed or freed.
an X atom for GDK’s default display
Returns the name of an X atom for its display. This
function is meant mainly for debugging, so for convenience, unlike
XAtomName() and gdk_atom_name(), the result doesn’t need to
be freed.
name of the X atom; this string is owned by GDK,
so it shouldn’t be modifed or freed.
the #GdkDisplay where @xatom is defined
an X atom
Call gdk_x11_display_grab() on the default display.
To ungrab the server again, use gdk_x11_ungrab_server().
gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
Find the #GdkDisplay corresponding to @xdisplay, if any exists.
the #GdkDisplay, if found, otherwise %NULL.
a pointer to an X Display
Registers interest in receiving extension events with type codes
between @event_base and `event_base + n_events - 1`.
The registered events must have the window field in the same place
as core X events (this is not the case for e.g. XKB extension events).
If an event type is registered, events of this type will go through
global and window-specific filters (see gdk_window_add_filter()).
Unregistered events will only go through global filters.
GDK may register the events of some X extensions on its own.
This function should only be needed in unusual circumstances, e.g.
when filtering XInput extension events on the root window.
a #GdkDisplay
first event type code to register
number of event type codes to register
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.
Ungrab the default display after it has been grabbed with
gdk_x11_grab_server().
Convert from an X atom for the default display to the corresponding
#GdkAtom.
the corresponding G#dkAtom.
an X atom for the default GDK display
Convert from an X atom for a #GdkDisplay to the corresponding
#GdkAtom.
the corresponding #GdkAtom.
A #GdkDisplay
an X atom
The functions in this section are specific to the GDK X11 backend.
To use them, you need to include the `<gdk/gdkx.h>` header and use
the X11-specific pkg-config files to build your application (either
`gdk-x11-3.0` or `gtk+-x11-3.0`).
To make your code compile with other GDK backends, guard backend-specific
calls by an ifdef as follows. Since GDK may be built with multiple
backends, you should also check for the backend that is in use (e.g. by
using the GDK_IS_X11_DISPLAY() macro).
|[
#ifdef GDK_WINDOWING_X11
if (GDK_IS_X11_DISPLAY (display))
{
// make X11-specific calls here
}
else
#endif
#ifdef GDK_WINDOWING_QUARTZ
if (GDK_IS_QUARTZ_DISPLAY (display))
{
// make Quartz-specific calls here
}
else
#endif
g_error ("Unsupported GDK backend");
]|