Functions
GDK_ROOT_WINDOW
#define GDK_ROOT_WINDOW() (gdk_x11_get_default_root_xwindow ())
Obtains the Xlib window id of the root window of the current screen.
GDK_WINDOW_XID()
#define GDK_WINDOW_XID(win)
Returns the X window belonging to a GdkWindow.
Returns
the Xlib Window of win
.
GDK_DISPLAY_XDISPLAY()
#define GDK_DISPLAY_XDISPLAY(display)
GDK_SCREEN_XDISPLAY()
#define GDK_SCREEN_XDISPLAY(screen)
Returns the display of a X11 GdkScreen.
Returns
an Xlib Display*.
GDK_SCREEN_XNUMBER()
#define GDK_SCREEN_XNUMBER(screen) (gdk_x11_screen_get_screen_number (screen))
Returns the index of a X11 GdkScreen.
Returns
the position of screen
among the screens of its display
GDK_SCREEN_XSCREEN()
#define GDK_SCREEN_XSCREEN(screen) (gdk_x11_screen_get_xscreen (screen))
Returns the screen of a X11 GdkScreen.
GDK_CURSOR_XCURSOR()
#define GDK_CURSOR_XCURSOR(cursor) (gdk_x11_cursor_get_xcursor (cursor))
Returns the X cursor belonging to a GdkCursor.
GDK_CURSOR_XDISPLAY()
#define GDK_CURSOR_XDISPLAY(cursor) (gdk_x11_cursor_get_xdisplay (cursor))
Returns the display of a GdkCursor.
Returns
an Xlib Display*.
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.
Returns
the GdkDisplay, if found, otherwise NULL.
[transfer none][type GdkX11Display]
Since: 2.2
gdk_x11_get_server_time ()
guint32
gdk_x11_get_server_time (GdkWindow *window);
Routine to get the current X server time stamp.
gdk_x11_device_get_id ()
gint
gdk_x11_device_get_id (GdkDevice *device);
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.
Returns
the XInput2 device ID.
Since: 3.2
gdk_x11_device_manager_lookup ()
GdkDevice *
gdk_x11_device_manager_lookup (GdkDeviceManager *device_manager,
gint device_id);
Returns the GdkDevice that wraps the given device ID.
Returns
The GdkDevice wrapping the device ID,
or NULL if the given ID doesn’t currently represent a device.
[transfer none][allow-none][type GdkX11DeviceCore]
Since: 3.2
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_window_set_user_time().
Returns
the timestamp of the last user interaction
Since: 2.8
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.
Since: 2.12
gdk_x11_display_get_startup_notification_id ()
const gchar *
gdk_x11_display_get_startup_notification_id
(GdkDisplay *display);
Gets the startup notification ID for a display.
Returns
the startup notification ID for display
Since: 2.12
gdk_x11_display_set_startup_notification_id ()
void
gdk_x11_display_set_startup_notification_id
(GdkDisplay *display,
const gchar *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_notify_startup_complete()).
Since: 3.0
gdk_x11_display_get_xdisplay ()
Display *
gdk_x11_display_get_xdisplay (GdkDisplay *display);
Returns the X display of a GdkDisplay.
Returns
an X display.
[transfer none]
Since: 2.2
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.
See gdk_error_trap_pop_ignored() for the all-displays-at-once
equivalent.
Since: 3.0
gdk_x11_display_set_cursor_theme ()
void
gdk_x11_display_set_cursor_theme (GdkDisplay *display,
const gchar *theme,
const gint 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(), 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).
Since: 2.8
gdk_x11_display_set_window_scale ()
void
gdk_x11_display_set_window_scale (GdkDisplay *display,
gint 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.
Since: 3.10
gdk_x11_display_get_glx_version ()
gboolean
gdk_x11_display_get_glx_version (GdkDisplay *display,
gint *major,
gint *minor);
Retrieves the version of the GLX implementation.
Returns
TRUE if GLX is available
Since: 3.16
gdk_x11_register_standard_event_type ()
void
gdk_x11_register_standard_event_type (GdkDisplay *display,
gint event_base,
gint n_events);
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.
Since: 2.4
gdk_x11_screen_get_screen_number ()
int
gdk_x11_screen_get_screen_number (GdkScreen *screen);
Returns the index of a GdkScreen.
Returns
the position of screen
among the screens
of its display
Since: 2.2
gdk_x11_screen_get_xscreen ()
Screen *
gdk_x11_screen_get_xscreen (GdkScreen *screen);
Returns the screen of a GdkScreen.
Returns
an Xlib Screen*.
[transfer none]
Since: 2.2
gdk_x11_screen_get_window_manager_name ()
const char *
gdk_x11_screen_get_window_manager_name
(GdkScreen *screen);
Returns the name of the window manager for screen
.
Returns
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.
Since: 2.2
gdk_x11_screen_get_monitor_output ()
XID
gdk_x11_screen_get_monitor_output (GdkScreen *screen,
gint 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.
Returns
the XID of the monitor
Since: 2.14
gdk_x11_screen_lookup_visual ()
GdkVisual *
gdk_x11_screen_lookup_visual (GdkScreen *screen,
VisualID xvisualid);
Looks up the GdkVisual for a particular screen and X Visual ID.
Returns
the GdkVisual (owned by the screen
object), or NULL if the visual ID wasn’t found.
[transfer none][type GdkX11Visual]
Since: 2.2
gdk_x11_screen_supports_net_wm_hint ()
gboolean
gdk_x11_screen_supports_net_wm_hint (GdkScreen *screen,
GdkAtom property);
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 GdkScreen to detect
a window manager change.
Returns
TRUE if the window manager supports property
Since: 2.2
gdk_x11_screen_get_number_of_desktops ()
guint32
gdk_x11_screen_get_number_of_desktops (GdkScreen *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.
Returns
the number of workspaces, or 0 if workspaces are not supported
Since: 3.10
gdk_x11_screen_get_current_desktop ()
guint32
gdk_x11_screen_get_current_desktop (GdkScreen *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.
Returns
the current workspace, or 0 if workspaces are not supported
Since: 3.10
gdk_x11_window_foreign_new_for_display ()
GdkWindow *
gdk_x11_window_foreign_new_for_display
(GdkDisplay *display,
Window window);
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.
Returns
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.
[transfer full]
Since: 2.24
gdk_x11_window_lookup_for_display ()
GdkWindow *
gdk_x11_window_lookup_for_display (GdkDisplay *display,
Window window);
Looks up the GdkWindow that wraps the given native window handle.
Returns
the GdkWindow wrapper for the native
window, or NULL if there is none.
[transfer none][type GdkX11Window]
Since: 2.24
gdk_x11_window_get_xid ()
Window
gdk_x11_window_get_xid (GdkWindow *window);
Returns the X resource (window) belonging to a GdkWindow.
Returns
the ID of drawable
’s X resource.
gdk_x11_window_set_hide_titlebar_when_maximized ()
void
gdk_x11_window_set_hide_titlebar_when_maximized
(GdkWindow *window,
gboolean hide_titlebar_when_maximized);
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.
Since: 3.4
gdk_x11_window_set_theme_variant ()
void
gdk_x11_window_set_theme_variant (GdkWindow *window,
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 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.
Since: 3.2
gdk_x11_window_set_user_time ()
void
gdk_x11_window_set_user_time (GdkWindow *window,
guint32 timestamp);
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.
Since: 2.6
gdk_x11_window_move_to_current_desktop ()
void
gdk_x11_window_move_to_current_desktop
(GdkWindow *window);
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 specification.
Will not do anything if the window is already on all workspaces.
Since: 2.8
gdk_x11_window_move_to_desktop ()
void
gdk_x11_window_move_to_desktop (GdkWindow *window,
guint32 desktop);
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 specification.
Since: 3.10
gdk_x11_window_get_desktop ()
guint32
gdk_x11_window_get_desktop (GdkWindow *window);
Gets the number of the workspace window
is on.
Returns
the current workspace of window
Since: 3.10
gdk_x11_window_set_utf8_property ()
void
gdk_x11_window_set_utf8_property (GdkWindow *window,
const gchar *name,
const gchar *value);
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.
Since: 3.4
gdk_x11_window_set_frame_extents ()
void
gdk_x11_window_set_frame_extents (GdkWindow *window,
int left,
int right,
int top,
int bottom);
gdk_x11_window_set_frame_extents has been deprecated since version 3.12 and should not be used in newly-written code.
Use gdk_window_set_shadow_width() instead.
This is the same as gdk_window_set_shadow_width() but it only works
on GdkX11Window.
Since: 3.10
gdk_x11_window_set_frame_sync_enabled ()
void
gdk_x11_window_set_frame_sync_enabled (GdkWindow *window,
gboolean frame_sync_enabled);
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.
Since: 3.8
gdk_x11_get_default_root_xwindow ()
Window
gdk_x11_get_default_root_xwindow (void);
Gets the root window of the default screen
(see gdk_x11_get_default_screen()).
gdk_x11_get_default_screen ()
gint
gdk_x11_get_default_screen (void);
Gets the default GTK+ screen number.
Returns
returns the screen number specified by
the --display command line option or the DISPLAY environment
variable when gdk_init() calls XOpenDisplay().
gdk_x11_get_default_xdisplay ()
Display *
gdk_x11_get_default_xdisplay (void);
Gets the default GTK+ display.
Returns
the Xlib Display* for
the display specified in the --display command
line option or the DISPLAY environment variable.
[transfer none]
gdk_x11_ungrab_server ()
void
gdk_x11_ungrab_server (void);
Ungrab the default display after it has been grabbed with
gdk_x11_grab_server().
gdk_x11_get_parent_relative_pattern ()
cairo_pattern_t *
gdk_x11_get_parent_relative_pattern (void);
gdk_x11_get_parent_relative_pattern has been deprecated since version 3.24 and should not be used in newly-written code.
Don't use this function
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.
Since: 3.24.2
gdk_x11_cursor_get_xcursor ()
Cursor
gdk_x11_cursor_get_xcursor (GdkCursor *cursor);
Returns the X cursor belonging to a GdkCursor.
gdk_x11_cursor_get_xdisplay ()
Display *
gdk_x11_cursor_get_xdisplay (GdkCursor *cursor);
Returns the display of a GdkCursor.
Returns
an Xlib Display*.
[transfer none]
gdk_x11_keymap_get_group_for_state ()
gint
gdk_x11_keymap_get_group_for_state (GdkKeymap *keymap,
guint state);
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.
Returns
the index of the active keyboard group for the event
Since: 3.6
gdk_x11_keymap_key_is_modifier ()
gboolean
gdk_x11_keymap_key_is_modifier (GdkKeymap *keymap,
guint keycode);
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.
Returns
TRUE if the hardware keycode is a modifier key
Since: 3.6
gdk_x11_visual_get_xvisual ()
Visual *
gdk_x11_visual_get_xvisual (GdkVisual *visual);
Returns the X visual belonging to a GdkVisual.
Returns
an Xlib Visual*.
[transfer none]
gdk_x11_atom_to_xatom ()
Atom
gdk_x11_atom_to_xatom (GdkAtom atom);
Converts from a GdkAtom to the X atom for the default GDK display
with the same string value.
Returns
the X atom corresponding to atom
.
gdk_x11_atom_to_xatom_for_display ()
Atom
gdk_x11_atom_to_xatom_for_display (GdkDisplay *display,
GdkAtom atom);
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.
Returns
the X atom corresponding to atom
, or None
Since: 2.2
gdk_x11_xatom_to_atom ()
GdkAtom
gdk_x11_xatom_to_atom (Atom xatom);
Convert from an X atom for the default display to the corresponding
GdkAtom.
Returns
the corresponding GdkAtom.
[transfer none]
gdk_x11_xatom_to_atom_for_display ()
GdkAtom
gdk_x11_xatom_to_atom_for_display (GdkDisplay *display,
Atom xatom);
Convert from an X atom for a GdkDisplay to the corresponding
GdkAtom.
Returns
the corresponding GdkAtom.
[transfer none]
Since: 2.2
gdk_x11_get_xatom_by_name ()
Atom
gdk_x11_get_xatom_by_name (const gchar *atom_name);
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.
Returns
a X atom for GDK’s default display.
gdk_x11_get_xatom_by_name_for_display ()
Atom
gdk_x11_get_xatom_by_name_for_display (GdkDisplay *display,
const gchar *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.
Since: 2.2
gdk_x11_get_xatom_name ()
const gchar *
gdk_x11_get_xatom_name (Atom xatom);
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.
Returns
name of the X atom; this string is owned by GTK+,
so it shouldn’t be modifed or freed.
gdk_x11_get_xatom_name_for_display ()
const gchar *
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 gdk_atom_name(), the result doesn’t need to
be freed.
Returns
name of the X atom; this string is owned by GDK,
so it shouldn’t be modifed or freed.
Since: 2.2
gdk_x11_set_sm_client_id ()
void
gdk_x11_set_sm_client_id (const gchar *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
Since: 2.24
gdk_x11_display_text_property_to_text_list ()
gint
gdk_x11_display_text_property_to_text_list
(GdkDisplay *display,
GdkAtom encoding,
gint format,
const guchar *text,
gint length,
gchar ***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.)
Returns
the number of strings stored in list, or 0,
if the conversion failed
Since: 2.24
gdk_x11_display_string_to_compound_text ()
gint
gdk_x11_display_string_to_compound_text
(GdkDisplay *display,
const gchar *str,
GdkAtom *encoding,
gint *format,
guchar **ctext,
gint *length);
Convert a string from the encoding of the current
locale into a form suitable for storing in a window property.
Returns
0 upon success, non-zero upon failure
Since: 2.24
gdk_x11_display_utf8_to_compound_text ()
gboolean
gdk_x11_display_utf8_to_compound_text (GdkDisplay *display,
const gchar *str,
GdkAtom *encoding,
gint *format,
guchar **ctext,
gint *length);
Converts from UTF-8 to compound text.
Returns
TRUE if the conversion succeeded,
otherwise FALSE
Since: 2.24