<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="gdk4-X-Window-System-Interaction">
<refmeta>
<refentrytitle role="top_of_page" id="gdk4-X-Window-System-Interaction.top_of_page">X Window System Interaction</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GDK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>X Window System Interaction</refname>
<refpurpose>X backend-specific functions</refpurpose>
</refnamediv>

<refsect1 id="gdk4-X-Window-System-Interaction.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GDK-SURFACE-XID:CAPS">GDK_SURFACE_XID</link><phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GDK-DISPLAY-XDISPLAY:CAPS">GDK_DISPLAY_XDISPLAY</link><phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GDK-POINTER-TO-XID:CAPS">GDK_POINTER_TO_XID</link><phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GDK-XID-TO-POINTER:CAPS">GDK_XID_TO_POINTER</link><phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkDisplay"><returnvalue>GdkDisplay</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-lookup-xdisplay">gdk_x11_lookup_xdisplay</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-get-server-time">gdk_x11_get_server_time</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-device-get-id">gdk_x11_device_get_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkDevice"><returnvalue>GdkDevice</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-device-manager-lookup">gdk_x11_device_manager_lookup</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkDisplay"><returnvalue>GdkDisplay</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-display-open">gdk_x11_display_open</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-set-program-class">gdk_x11_display_set_program_class</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-user-time">gdk_x11_display_get_user_time</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-broadcast-startup-message">gdk_x11_display_broadcast_startup_message</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-startup-notification-id">gdk_x11_display_get_startup_notification_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-set-startup-notification-id">gdk_x11_display_set_startup_notification_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Display"><returnvalue>Display</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-xdisplay">gdk_x11_display_get_xdisplay</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Screen"><returnvalue>Screen</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-xscreen">gdk_x11_display_get_xscreen</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Window"><returnvalue>Window</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-xrootwindow">gdk_x11_display_get_xrootwindow</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Cursor"><returnvalue>Cursor</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-xcursor">gdk_x11_display_get_xcursor</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-grab">gdk_x11_display_grab</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-ungrab">gdk_x11_display_ungrab</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkSurface"><returnvalue>GdkSurface</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-default-group">gdk_x11_display_get_default_group</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-error-trap-push">gdk_x11_display_error_trap_push</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-error-trap-pop">gdk_x11_display_error_trap_pop</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-error-trap-pop-ignored">gdk_x11_display_error_trap_pop_ignored</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-set-cursor-theme">gdk_x11_display_set_cursor_theme</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-set-surface-scale">gdk_x11_display_set_surface_scale</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-get-glx-version">gdk_x11_display_get_glx_version</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-screen-get-screen-number">gdk_x11_screen_get_screen_number</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Screen"><returnvalue>Screen</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-screen-get-xscreen">gdk_x11_screen_get_xscreen</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-screen-get-window-manager-name">gdk_x11_screen_get_window_manager_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="XID:CAPS"><returnvalue>XID</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-screen-get-monitor-output">gdk_x11_screen_get_monitor_output</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkX11Visual"><returnvalue>GdkX11Visual</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-screen-lookup-visual">gdk_x11_screen_lookup_visual</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-screen-supports-net-wm-hint">gdk_x11_screen_supports_net_wm_hint</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-screen-get-number-of-desktops">gdk_x11_screen_get_number_of_desktops</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-screen-get-current-desktop">gdk_x11_screen_get_current_desktop</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkSurface"><returnvalue>GdkSurface</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-surface-lookup-for-display">gdk_x11_surface_lookup_for_display</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Window"><returnvalue>Window</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-get-xid">gdk_x11_surface_get_xid</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-set-theme-variant">gdk_x11_surface_set_theme_variant</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-set-user-time">gdk_x11_surface_set_user_time</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-move-to-current-desktop">gdk_x11_surface_move_to_current_desktop</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-move-to-desktop">gdk_x11_surface_move_to_desktop</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-get-desktop">gdk_x11_surface_get_desktop</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-set-utf8-property">gdk_x11_surface_set_utf8_property</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-set-frame-sync-enabled">gdk_x11_surface_set_frame_sync_enabled</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-surface-set-group">gdk_x11_surface_set_group</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GdkSurface"><returnvalue>GdkSurface</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-surface-get-group">gdk_x11_surface_get_group</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-keymap-get-group-for-state">gdk_x11_keymap_get_group_for_state</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-keymap-key-is-modifier">gdk_x11_keymap_key_is_modifier</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Visual"><returnvalue>Visual</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-visual-get-xvisual">gdk_x11_visual_get_xvisual</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="Atom"><returnvalue>Atom</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-get-xatom-by-name-for-display">gdk_x11_get_xatom_by_name_for_display</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gdk-x11-get-xatom-name-for-display">gdk_x11_get_xatom_name_for_display</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-set-sm-client-id">gdk_x11_set_sm_client_id</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-text-property-to-text-list">gdk_x11_display_text_property_to_text_list</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-free-text-list">gdk_x11_free_text_list</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-string-to-compound-text">gdk_x11_display_string_to_compound_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-display-utf8-to-compound-text">gdk_x11_display_utf8_to_compound_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gdk-x11-free-compound-text">gdk_x11_free_compound_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 id="gdk4-X-Window-System-Interaction.includes"><title>Includes</title><synopsis>#include &lt;gdk/x11/gdkx.h&gt;
</synopsis></refsect1>

<refsect1 id="gdk4-X-Window-System-Interaction.description" role="desc">
<title role="desc.title">Description</title>
<para>The functions in this section are specific to the GDK X11 backend.
To use them, you need to include the <literal>&lt;gdk/x11/gdkx.h&gt;</literal> header and use
the X11-specific pkg-config file <literal>gtk4-x11</literal> to build your application.</para>
<para>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 <link linkend="GDK-IS-X11-DISPLAY:CAPS"><function>GDK_IS_X11_DISPLAY()</function></link> macro).</para>
<informalexample><programlisting role="example"><![CDATA[
#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");
]]></programlisting></informalexample>
<para></para>

</refsect1>
<refsect1 id="gdk4-X-Window-System-Interaction.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="GDK-SURFACE-XID:CAPS" role="macro">
<title>GDK_SURFACE_XID()</title>
<indexterm zone="GDK-SURFACE-XID:CAPS"><primary>GDK_SURFACE_XID</primary></indexterm>
<programlisting language="C">#define             GDK_SURFACE_XID(win)</programlisting>
<para>Returns the X window belonging to a <link linkend="GdkSurface"><type>GdkSurface</type></link>.</para>
<refsect3 id="GDK-SURFACE-XID.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>win</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="GDK-SURFACE-XID.returns" role="returns">
<title>Returns</title>
<para> the Xlib Window of <parameter>win</parameter>
.</para>
</refsect3></refsect2>
<refsect2 id="GDK-DISPLAY-XDISPLAY:CAPS" role="macro">
<title>GDK_DISPLAY_XDISPLAY()</title>
<indexterm zone="GDK-DISPLAY-XDISPLAY:CAPS"><primary>GDK_DISPLAY_XDISPLAY</primary></indexterm>
<programlisting language="C">#define             GDK_DISPLAY_XDISPLAY(display)</programlisting>
<para>Returns the display of a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>.</para>
<refsect3 id="GDK-DISPLAY-XDISPLAY.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="GDK-DISPLAY-XDISPLAY.returns" role="returns">
<title>Returns</title>
<para> an Xlib Display*</para>
</refsect3></refsect2>
<refsect2 id="GDK-POINTER-TO-XID:CAPS" role="macro">
<title>GDK_POINTER_TO_XID()</title>
<indexterm zone="GDK-POINTER-TO-XID:CAPS"><primary>GDK_POINTER_TO_XID</primary></indexterm>
<programlisting language="C">#define GDK_POINTER_TO_XID(pointer) GPOINTER_TO_UINT(pointer)
</programlisting>
<para>Converts a <parameter>gpointer</parameter>
 back to an XID that was previously converted
using <link linkend="GDK-XID-TO-POINTER:CAPS"><function>GDK_XID_TO_POINTER()</function></link>.</para>
<refsect3 id="GDK-POINTER-TO-XID.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>pointer</para></entry>
<entry role="parameter_description"><para>pointer to extract an XID from</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="GDK-XID-TO-POINTER:CAPS" role="macro">
<title>GDK_XID_TO_POINTER()</title>
<indexterm zone="GDK-XID-TO-POINTER:CAPS"><primary>GDK_XID_TO_POINTER</primary></indexterm>
<programlisting language="C">#define GDK_XID_TO_POINTER(xid) GUINT_TO_POINTER(xid)
</programlisting>
<para>Converts an XID into a <parameter>gpointer</parameter>
. This is useful with data structures
that use pointer arguments such as <link linkend="GHashTable"><type>GHashTable</type></link>. Use <link linkend="GDK-POINTER-TO-XID:CAPS"><function>GDK_POINTER_TO_XID()</function></link>
to convert the argument back to an XID.</para>
<refsect3 id="GDK-XID-TO-POINTER.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>xid</para></entry>
<entry role="parameter_description"><para>XID to stuff into the pointer</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-lookup-xdisplay" role="function">
<title>gdk_x11_lookup_xdisplay&#160;()</title>
<indexterm zone="gdk-x11-lookup-xdisplay"><primary>gdk_x11_lookup_xdisplay</primary></indexterm>
<programlisting language="C"><link linkend="GdkDisplay"><returnvalue>GdkDisplay</returnvalue></link>&#160;*
gdk_x11_lookup_xdisplay (<parameter><link linkend="Display"><type>Display</type></link> *xdisplay</parameter>);</programlisting>
<para>Find the <link linkend="GdkDisplay"><type>GdkDisplay</type></link> corresponding to <parameter>xdisplay</parameter>
, if any exists.</para>
<refsect3 id="gdk-x11-lookup-xdisplay.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>xdisplay</para></entry>
<entry role="parameter_description"><para>a pointer to an X Display</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-lookup-xdisplay.returns" role="returns">
<title>Returns</title>
<para>the <link linkend="GdkDisplay"><type>GdkDisplay</type></link>, if found, otherwise <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>type</acronym> GdkX11Display]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-get-server-time" role="function">
<title>gdk_x11_get_server_time&#160;()</title>
<indexterm zone="gdk-x11-get-server-time"><primary>gdk_x11_get_server_time</primary></indexterm>
<programlisting language="C"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
gdk_x11_get_server_time (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>);</programlisting>
<para>Routine to get the current X server time stamp.</para>
<refsect3 id="gdk-x11-get-server-time.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>, used for communication
with the server.  The surface must have
GDK_PROPERTY_CHANGE_MASK in its events mask or a hang will
result. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-get-server-time.returns" role="returns">
<title>Returns</title>
<para> the time stamp.</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-device-get-id" role="function">
<title>gdk_x11_device_get_id&#160;()</title>
<indexterm zone="gdk-x11-device-get-id"><primary>gdk_x11_device_get_id</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gdk_x11_device_get_id (<parameter><link linkend="GdkDevice"><type>GdkDevice</type></link> *device</parameter>);</programlisting>
<para>Returns the device ID as seen by XInput2.</para>
<refsect3 id="gdk-x11-device-get-id.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>device</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDevice"><type>GdkDevice</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11DeviceXI2]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-device-get-id.returns" role="returns">
<title>Returns</title>
<para> the XInput2 device ID.</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-device-manager-lookup" role="function">
<title>gdk_x11_device_manager_lookup&#160;()</title>
<indexterm zone="gdk-x11-device-manager-lookup"><primary>gdk_x11_device_manager_lookup</primary></indexterm>
<programlisting language="C"><link linkend="GdkDevice"><returnvalue>GdkDevice</returnvalue></link>&#160;*
gdk_x11_device_manager_lookup (<parameter><link linkend="GdkX11DeviceManagerXI2"><type>GdkX11DeviceManagerXI2</type></link> *device_manager</parameter>,
                               <parameter><link linkend="int"><type>int</type></link> device_id</parameter>);</programlisting>
<para>Returns the <link linkend="GdkDevice"><type>GdkDevice</type></link> that wraps the given device ID.</para>
<refsect3 id="gdk-x11-device-manager-lookup.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>device_manager</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDeviceManager"><type>GdkDeviceManager</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11DeviceManagerXI2]</emphasis></entry></row>
<row><entry role="parameter_name"><para>device_id</para></entry>
<entry role="parameter_description"><para>a device ID, as understood by the XInput2 protocol</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-device-manager-lookup.returns" role="returns">
<title>Returns</title>
<para>The <link linkend="GdkDevice"><type>GdkDevice</type></link> wrapping the device ID,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the given ID doesn’t currently represent a device. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>allow-none</acronym>][<acronym>type</acronym> GdkX11DeviceXI2]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-open" role="function">
<title>gdk_x11_display_open&#160;()</title>
<indexterm zone="gdk-x11-display-open"><primary>gdk_x11_display_open</primary></indexterm>
<programlisting language="C"><link linkend="GdkDisplay"><returnvalue>GdkDisplay</returnvalue></link>&#160;*
gdk_x11_display_open (<parameter>const <link linkend="char"><type>char</type></link> *display_name</parameter>);</programlisting>
<para>Tries to open a new display to the X server given by
<parameter>display_name</parameter>
. If opening the display fails, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
returned.</para>
<refsect3 id="gdk-x11-display-open.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display_name</para></entry>
<entry role="parameter_description"><para>name of the X display.
See the <link linkend="XOpenDisplay"><function>XOpenDisplay()</function></link> for details. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-open.returns" role="returns">
<title>Returns</title>
<para>The new display or
<link linkend="NULL:CAPS"><literal>NULL</literal></link> on error. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-set-program-class" role="function">
<title>gdk_x11_display_set_program_class&#160;()</title>
<indexterm zone="gdk-x11-display-set-program-class"><primary>gdk_x11_display_set_program_class</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_set_program_class (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                   <parameter>const <link linkend="char"><type>char</type></link> *program_class</parameter>);</programlisting>
<para>Sets the program class.</para>
<para>The X11 backend uses the program class to set the class name part
of the <literal>WM_CLASS</literal> property on toplevel windows; see the ICCCM.</para>
<refsect3 id="gdk-x11-display-set-program-class.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>program_class</para></entry>
<entry role="parameter_description"><para>a string</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-user-time" role="function">
<title>gdk_x11_display_get_user_time&#160;()</title>
<indexterm zone="gdk-x11-display-get-user-time"><primary>gdk_x11_display_get_user_time</primary></indexterm>
<programlisting language="C"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
gdk_x11_display_get_user_time (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Returns the timestamp of the last user interaction on 
<parameter>display</parameter>
. The timestamp is taken from events caused
by user interaction such as key presses or pointer 
movements. See <link linkend="gdk-x11-surface-set-user-time"><function>gdk_x11_surface_set_user_time()</function></link>.</para>
<refsect3 id="gdk-x11-display-get-user-time.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-user-time.returns" role="returns">
<title>Returns</title>
<para> the timestamp of the last user interaction </para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-broadcast-startup-message" role="function">
<title>gdk_x11_display_broadcast_startup_message&#160;()</title>
<indexterm zone="gdk-x11-display-broadcast-startup-message"><primary>gdk_x11_display_broadcast_startup_message</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_broadcast_startup_message
                               (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                <parameter>const <link linkend="char"><type>char</type></link> *message_type</parameter>,
                                <parameter>...</parameter>);</programlisting>
<para>Sends a startup notification message of type <parameter>message_type</parameter>
 to
<parameter>display</parameter>
. </para>
<para>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
<ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">Startup Notification Protocol specification</ulink>
for definitions of the message types and keys that can be used.</para>
<refsect3 id="gdk-x11-display-broadcast-startup-message.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>message_type</para></entry>
<entry role="parameter_description"><para>startup notification message type ("new", "change",
or "remove")</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>...</para></entry>
<entry role="parameter_description"><para>a list of key/value pairs (as strings), terminated by a
<link linkend="NULL:CAPS"><literal>NULL</literal></link> key. (A <link linkend="NULL:CAPS"><literal>NULL</literal></link> value for a key will cause that key to be
skipped in the output.)</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-startup-notification-id" role="function">
<title>gdk_x11_display_get_startup_notification_id&#160;()</title>
<indexterm zone="gdk-x11-display-get-startup-notification-id"><primary>gdk_x11_display_get_startup_notification_id</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
gdk_x11_display_get_startup_notification_id
                               (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Gets the startup notification ID for a display.</para>
<refsect3 id="gdk-x11-display-get-startup-notification-id.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-startup-notification-id.returns" role="returns">
<title>Returns</title>
<para> the startup notification ID for <parameter>display</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-set-startup-notification-id" role="function">
<title>gdk_x11_display_set_startup_notification_id&#160;()</title>
<indexterm zone="gdk-x11-display-set-startup-notification-id"><primary>gdk_x11_display_set_startup_notification_id</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_set_startup_notification_id
                               (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                <parameter>const <link linkend="char"><type>char</type></link> *startup_id</parameter>);</programlisting>
<para>Sets the startup notification ID for a display.</para>
<para>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 <link linkend="exec"><function>exec()</function></link>) it can come from other sources.</para>
<para>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.</para>
<para>The startup ID is also what is used to signal that the startup is
complete (for example, when opening a window or when calling
<link linkend="gdk-display-notify-startup-complete"><function>gdk_display_notify_startup_complete()</function></link>).</para>
<refsect3 id="gdk-x11-display-set-startup-notification-id.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>startup_id</para></entry>
<entry role="parameter_description"><para>the startup notification ID (must be valid utf8)</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-xdisplay" role="function">
<title>gdk_x11_display_get_xdisplay&#160;()</title>
<indexterm zone="gdk-x11-display-get-xdisplay"><primary>gdk_x11_display_get_xdisplay</primary></indexterm>
<programlisting language="C"><link linkend="Display"><returnvalue>Display</returnvalue></link>&#160;*
gdk_x11_display_get_xdisplay (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Returns the X display of a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>.</para>
<refsect3 id="gdk-x11-display-get-xdisplay.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-xdisplay.returns" role="returns">
<title>Returns</title>
<para>an X display. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-xscreen" role="function">
<title>gdk_x11_display_get_xscreen&#160;()</title>
<indexterm zone="gdk-x11-display-get-xscreen"><primary>gdk_x11_display_get_xscreen</primary></indexterm>
<programlisting language="C"><link linkend="Screen"><returnvalue>Screen</returnvalue></link>&#160;*
gdk_x11_display_get_xscreen (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Returns the X Screen used by <link linkend="GdkDisplay"><type>GdkDisplay</type></link>.</para>
<refsect3 id="gdk-x11-display-get-xscreen.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-xscreen.returns" role="returns">
<title>Returns</title>
<para>an X Screen. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-xrootwindow" role="function">
<title>gdk_x11_display_get_xrootwindow&#160;()</title>
<indexterm zone="gdk-x11-display-get-xrootwindow"><primary>gdk_x11_display_get_xrootwindow</primary></indexterm>
<programlisting language="C"><link linkend="Window"><returnvalue>Window</returnvalue></link>
gdk_x11_display_get_xrootwindow (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Returns the root X window used by <link linkend="GdkDisplay"><type>GdkDisplay</type></link>.</para>
<refsect3 id="gdk-x11-display-get-xrootwindow.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-xrootwindow.returns" role="returns">
<title>Returns</title>
<para> an X Window</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-xcursor" role="function">
<title>gdk_x11_display_get_xcursor&#160;()</title>
<indexterm zone="gdk-x11-display-get-xcursor"><primary>gdk_x11_display_get_xcursor</primary></indexterm>
<programlisting language="C"><link linkend="Cursor"><returnvalue>Cursor</returnvalue></link>
gdk_x11_display_get_xcursor (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                             <parameter><link linkend="GdkCursor"><type>GdkCursor</type></link> *cursor</parameter>);</programlisting>
<para>Returns the X cursor belonging to a <link linkend="GdkCursor"><type>GdkCursor</type></link>, potentially
creating the cursor.</para>
<para>Be aware that the returned cursor may not be unique to <parameter>cursor</parameter>
.
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.</para>
<refsect3 id="gdk-x11-display-get-xcursor.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>cursor</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkCursor"><type>GdkCursor</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-xcursor.returns" role="returns">
<title>Returns</title>
<para> an Xlib Cursor.</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-grab" role="function">
<title>gdk_x11_display_grab&#160;()</title>
<indexterm zone="gdk-x11-display-grab"><primary>gdk_x11_display_grab</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_grab (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Call <link linkend="XGrabServer"><function>XGrabServer()</function></link> on <parameter>display</parameter>
. 
To ungrab the display again, use <link linkend="gdk-x11-display-ungrab"><function>gdk_x11_display_ungrab()</function></link>. </para>
<para>gdk_x11_display_grab()/<link linkend="gdk-x11-display-ungrab"><function>gdk_x11_display_ungrab()</function></link> calls can be nested.</para>
<refsect3 id="gdk-x11-display-grab.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-ungrab" role="function">
<title>gdk_x11_display_ungrab&#160;()</title>
<indexterm zone="gdk-x11-display-ungrab"><primary>gdk_x11_display_ungrab</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_ungrab (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Ungrab <parameter>display</parameter>
 after it has been grabbed with 
<link linkend="gdk-x11-display-grab"><function>gdk_x11_display_grab()</function></link>.</para>
<refsect3 id="gdk-x11-display-ungrab.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-default-group" role="function">
<title>gdk_x11_display_get_default_group&#160;()</title>
<indexterm zone="gdk-x11-display-get-default-group"><primary>gdk_x11_display_get_default_group</primary></indexterm>
<programlisting language="C"><link linkend="GdkSurface"><returnvalue>GdkSurface</returnvalue></link>&#160;*
gdk_x11_display_get_default_group (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Returns the default group leader surface for all toplevel surfaces
on <parameter>display</parameter>
. This surface is implicitly created by GDK.
See <link linkend="gdk-x11-surface-set-group"><function>gdk_x11_surface_set_group()</function></link>.</para>
<refsect3 id="gdk-x11-display-get-default-group.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-default-group.returns" role="returns">
<title>Returns</title>
<para>The default group leader surface
for <parameter>display</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-error-trap-push" role="function">
<title>gdk_x11_display_error_trap_push&#160;()</title>
<indexterm zone="gdk-x11-display-error-trap-push"><primary>gdk_x11_display_error_trap_push</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_error_trap_push (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Begins a range of X requests on <parameter>display</parameter>
 for which X error events
will be ignored. Unignored errors (when no trap is pushed) will abort
the application. Use <link linkend="gdk-x11-display-error-trap-pop"><function>gdk_x11_display_error_trap_pop()</function></link> or
<link linkend="gdk-x11-display-error-trap-pop-ignored"><function>gdk_x11_display_error_trap_pop_ignored()</function></link>to lift a trap pushed
with this function.</para>
<refsect3 id="gdk-x11-display-error-trap-push.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-error-trap-pop" role="function">
<title>gdk_x11_display_error_trap_pop&#160;()</title>
<indexterm zone="gdk-x11-display-error-trap-pop"><primary>gdk_x11_display_error_trap_pop</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gdk_x11_display_error_trap_pop (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Pops the error trap pushed by <link linkend="gdk-x11-display-error-trap-push"><function>gdk_x11_display_error_trap_push()</function></link>.
Will <link linkend="XSync"><function>XSync()</function></link> if necessary and will always block until
the error is known to have occurred or not occurred,
so the error code can be returned.</para>
<para>If you don’t need to use the return value,
<link linkend="gdk-x11-display-error-trap-pop-ignored"><function>gdk_x11_display_error_trap_pop_ignored()</function></link> would be more efficient.</para>
<refsect3 id="gdk-x11-display-error-trap-pop.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>the display. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-error-trap-pop.returns" role="returns">
<title>Returns</title>
<para> X error code or 0 on success</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-error-trap-pop-ignored" role="function">
<title>gdk_x11_display_error_trap_pop_ignored&#160;()</title>
<indexterm zone="gdk-x11-display-error-trap-pop-ignored"><primary>gdk_x11_display_error_trap_pop_ignored</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_error_trap_pop_ignored
                               (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>);</programlisting>
<para>Pops the error trap pushed by <link linkend="gdk-x11-display-error-trap-push"><function>gdk_x11_display_error_trap_push()</function></link>.
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.</para>
<refsect3 id="gdk-x11-display-error-trap-pop-ignored.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>the display. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-set-cursor-theme" role="function">
<title>gdk_x11_display_set_cursor_theme&#160;()</title>
<indexterm zone="gdk-x11-display-set-cursor-theme"><primary>gdk_x11_display_set_cursor_theme</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_set_cursor_theme (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                  <parameter>const <link linkend="char"><type>char</type></link> *theme</parameter>,
                                  <parameter>const <link linkend="int"><type>int</type></link> size</parameter>);</programlisting>
<para>Sets the cursor theme from which the images for cursor
should be taken.</para>
<para>If the windowing system supports it, existing cursors created
with <link linkend="gdk-cursor-new-from-name"><function>gdk_cursor_new_from_name()</function></link> are updated to reflect the theme
change. Custom cursors constructed with <link linkend="gdk-cursor-new-from-texture"><function>gdk_cursor_new_from_texture()</function></link>
will have to be handled by the application (GTK applications can learn
about cursor theme changes by listening for change notification
for the corresponding <link linkend="GtkSetting"><type>GtkSetting</type></link>).</para>
<refsect3 id="gdk-x11-display-set-cursor-theme.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>theme</para></entry>
<entry role="parameter_description"><para>the name of the cursor theme to use, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset
a previously set value. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>the cursor size to use, or 0 to keep the previous size</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-set-surface-scale" role="function">
<title>gdk_x11_display_set_surface_scale&#160;()</title>
<indexterm zone="gdk-x11-display-set-surface-scale"><primary>gdk_x11_display_set_surface_scale</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_display_set_surface_scale (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> scale</parameter>);</programlisting>
<para>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 <parameter>scale</parameter>
 to
1, or to programmatically set the window scale.</para>
<para>Once the scale is set by this call it will not change in response
to later user configuration changes.</para>
<refsect3 id="gdk-x11-display-set-surface-scale.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>the display. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>scale</para></entry>
<entry role="parameter_description"><para>The new scale value</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-get-glx-version" role="function">
<title>gdk_x11_display_get_glx_version&#160;()</title>
<indexterm zone="gdk-x11-display-get-glx-version"><primary>gdk_x11_display_get_glx_version</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gdk_x11_display_get_glx_version (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                 <parameter><link linkend="int"><type>int</type></link> *major</parameter>,
                                 <parameter><link linkend="int"><type>int</type></link> *minor</parameter>);</programlisting>
<para>Retrieves the version of the GLX implementation.</para>
<refsect3 id="gdk-x11-display-get-glx-version.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>major</para></entry>
<entry role="parameter_description"><para>return location for the GLX major version. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>minor</para></entry>
<entry role="parameter_description"><para>return location for the GLX minor version. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-get-glx-version.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if GLX is available</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-get-screen-number" role="function">
<title>gdk_x11_screen_get_screen_number&#160;()</title>
<indexterm zone="gdk-x11-screen-get-screen-number"><primary>gdk_x11_screen_get_screen_number</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gdk_x11_screen_get_screen_number (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>);</programlisting>
<para>Returns the index of a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link>.</para>
<refsect3 id="gdk-x11-screen-get-screen-number.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-get-screen-number.returns" role="returns">
<title>Returns</title>
<para> the position of <parameter>screen</parameter>
among the screens
of its display</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-get-xscreen" role="function">
<title>gdk_x11_screen_get_xscreen&#160;()</title>
<indexterm zone="gdk-x11-screen-get-xscreen"><primary>gdk_x11_screen_get_xscreen</primary></indexterm>
<programlisting language="C"><link linkend="Screen"><returnvalue>Screen</returnvalue></link>&#160;*
gdk_x11_screen_get_xscreen (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>);</programlisting>
<para>Returns the screen of a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link>.</para>
<refsect3 id="gdk-x11-screen-get-xscreen.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-get-xscreen.returns" role="returns">
<title>Returns</title>
<para>an Xlib Screen*. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-get-window-manager-name" role="function">
<title>gdk_x11_screen_get_window_manager_name&#160;()</title>
<indexterm zone="gdk-x11-screen-get-window-manager-name"><primary>gdk_x11_screen_get_window_manager_name</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
gdk_x11_screen_get_window_manager_name
                               (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>);</programlisting>
<para>Returns the name of the window manager for <parameter>screen</parameter>
.</para>
<refsect3 id="gdk-x11-screen-get-window-manager-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-get-window-manager-name.returns" role="returns">
<title>Returns</title>
<para> the name of the window manager screen <parameter>screen</parameter>
, or
"unknown" if the window manager is unknown. The string is owned by GDK
and should not be freed.</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-get-monitor-output" role="function">
<title>gdk_x11_screen_get_monitor_output&#160;()</title>
<indexterm zone="gdk-x11-screen-get-monitor-output"><primary>gdk_x11_screen_get_monitor_output</primary></indexterm>
<programlisting language="C"><link linkend="XID:CAPS"><returnvalue>XID</returnvalue></link>
gdk_x11_screen_get_monitor_output (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> monitor_num</parameter>);</programlisting>
<para>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.</para>
<refsect3 id="gdk-x11-screen-get-monitor-output.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>monitor_num</para></entry>
<entry role="parameter_description"><para>number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-get-monitor-output.returns" role="returns">
<title>Returns</title>
<para> the XID of the monitor</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-lookup-visual" role="function">
<title>gdk_x11_screen_lookup_visual&#160;()</title>
<indexterm zone="gdk-x11-screen-lookup-visual"><primary>gdk_x11_screen_lookup_visual</primary></indexterm>
<programlisting language="C"><link linkend="GdkX11Visual"><returnvalue>GdkX11Visual</returnvalue></link>&#160;*
gdk_x11_screen_lookup_visual (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>,
                              <parameter><link linkend="VisualID"><type>VisualID</type></link> xvisualid</parameter>);</programlisting>
<para>Looks up the <link linkend="GdkVisual"><type>GdkVisual</type></link> for a particular screen and X Visual ID.</para>
<refsect3 id="gdk-x11-screen-lookup-visual.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>xvisualid</para></entry>
<entry role="parameter_description"><para>an X Visual ID.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-lookup-visual.returns" role="returns">
<title>Returns</title>
<para>the <link linkend="GdkVisual"><type>GdkVisual</type></link> (owned by the screen
object), or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the visual ID wasn’t found. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>type</acronym> GdkX11Visual]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-supports-net-wm-hint" role="function">
<title>gdk_x11_screen_supports_net_wm_hint&#160;()</title>
<indexterm zone="gdk-x11-screen-supports-net-wm-hint"><primary>gdk_x11_screen_supports_net_wm_hint</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gdk_x11_screen_supports_net_wm_hint (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>,
                                     <parameter>const <link linkend="char"><type>char</type></link> *property_name</parameter>);</programlisting>
<para>This function is specific to the X11 backend of GDK, and indicates
whether the window manager supports a certain hint from the
<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification.</para>
<para>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
<link linkend="gdk-x11-screen-supports-net-wm-hint"><function>gdk_x11_screen_supports_net_wm_hint()</function></link> will return <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> for every property.
You can monitor the window_manager_changed signal on <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> to detect
a window manager change.</para>
<refsect3 id="gdk-x11-screen-supports-net-wm-hint.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>the relevant <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>property_name</para></entry>
<entry role="parameter_description"><para>name of the WM property</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-supports-net-wm-hint.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the window manager supports <parameter>property</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-get-number-of-desktops" role="function">
<title>gdk_x11_screen_get_number_of_desktops&#160;()</title>
<indexterm zone="gdk-x11-screen-get-number-of-desktops"><primary>gdk_x11_screen_get_number_of_desktops</primary></indexterm>
<programlisting language="C"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
gdk_x11_screen_get_number_of_desktops (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>);</programlisting>
<para>Returns the number of workspaces for <parameter>screen</parameter>
 when running under a
window manager that supports multiple workspaces, as described
in the
<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification.</para>
<refsect3 id="gdk-x11-screen-get-number-of-desktops.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-get-number-of-desktops.returns" role="returns">
<title>Returns</title>
<para> the number of workspaces, or 0 if workspaces are not supported</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-screen-get-current-desktop" role="function">
<title>gdk_x11_screen_get_current_desktop&#160;()</title>
<indexterm zone="gdk-x11-screen-get-current-desktop"><primary>gdk_x11_screen_get_current_desktop</primary></indexterm>
<programlisting language="C"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
gdk_x11_screen_get_current_desktop (<parameter><link linkend="GdkX11Screen"><type>GdkX11Screen</type></link> *screen</parameter>);</programlisting>
<para>Returns the current workspace for <parameter>screen</parameter>
 when running under a
window manager that supports multiple workspaces, as described
in the
<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification.</para>
<refsect3 id="gdk-x11-screen-get-current-desktop.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>screen</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Screen"><type>GdkX11Screen</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-screen-get-current-desktop.returns" role="returns">
<title>Returns</title>
<para> the current workspace, or 0 if workspaces are not supported</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-lookup-for-display" role="function">
<title>gdk_x11_surface_lookup_for_display&#160;()</title>
<indexterm zone="gdk-x11-surface-lookup-for-display"><primary>gdk_x11_surface_lookup_for_display</primary></indexterm>
<programlisting language="C"><link linkend="GdkSurface"><returnvalue>GdkSurface</returnvalue></link>&#160;*
gdk_x11_surface_lookup_for_display (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                    <parameter><link linkend="Window"><type>Window</type></link> window</parameter>);</programlisting>
<para>Looks up the <link linkend="GdkSurface"><type>GdkSurface</type></link> that wraps the given native window handle.</para>
<refsect3 id="gdk-x11-surface-lookup-for-display.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>the <link linkend="GdkDisplay"><type>GdkDisplay</type></link> corresponding to the
window handle. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>window</para></entry>
<entry role="parameter_description"><para>an Xlib Window</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-surface-lookup-for-display.returns" role="returns">
<title>Returns</title>
<para>the <link linkend="GdkSurface"><type>GdkSurface</type></link> wrapper for the native
window, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is none. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>type</acronym> GdkX11Surface]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-get-xid" role="function">
<title>gdk_x11_surface_get_xid&#160;()</title>
<indexterm zone="gdk-x11-surface-get-xid"><primary>gdk_x11_surface_get_xid</primary></indexterm>
<programlisting language="C"><link linkend="Window"><returnvalue>Window</returnvalue></link>
gdk_x11_surface_get_xid (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>);</programlisting>
<para>Returns the X resource (surface) belonging to a <link linkend="GdkSurface"><type>GdkSurface</type></link>.</para>
<refsect3 id="gdk-x11-surface-get-xid.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a native <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-surface-get-xid.returns" role="returns">
<title>Returns</title>
<para> the ID of <parameter>drawable</parameter>
’s X resource.</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-set-theme-variant" role="function">
<title>gdk_x11_surface_set_theme_variant&#160;()</title>
<indexterm zone="gdk-x11-surface-set-theme-variant"><primary>gdk_x11_surface_set_theme_variant</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_set_theme_variant (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                                   <parameter>const <link linkend="char"><type>char</type></link> *variant</parameter>);</programlisting>
<para>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.</para>
<para>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.</para>
<refsect3 id="gdk-x11-surface-set-theme-variant.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
<row><entry role="parameter_name"><para>variant</para></entry>
<entry role="parameter_description"><para>the theme variant to export</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-set-user-time" role="function">
<title>gdk_x11_surface_set_user_time&#160;()</title>
<indexterm zone="gdk-x11-surface-set-user-time"><primary>gdk_x11_surface_set_user_time</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_set_user_time (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                               <parameter><link linkend="guint32"><type>guint32</type></link> timestamp</parameter>);</programlisting>
<para>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.</para>
<para>Note that this property is automatically updated by GDK, so this
function should only be used by applications which handle input
events bypassing GDK.</para>
<refsect3 id="gdk-x11-surface-set-user-time.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>A toplevel <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
<row><entry role="parameter_name"><para>timestamp</para></entry>
<entry role="parameter_description"><para>An XServer timestamp to which the property should be set</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-move-to-current-desktop" role="function">
<title>gdk_x11_surface_move_to_current_desktop&#160;()</title>
<indexterm zone="gdk-x11-surface-move-to-current-desktop"><primary>gdk_x11_surface_move_to_current_desktop</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_move_to_current_desktop
                               (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>);</programlisting>
<para>Moves the surface to the correct workspace when running under a 
window manager that supports multiple workspaces, as described
in the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification.
Will not do anything if the surface is already on all workspaces.</para>
<refsect3 id="gdk-x11-surface-move-to-current-desktop.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-move-to-desktop" role="function">
<title>gdk_x11_surface_move_to_desktop&#160;()</title>
<indexterm zone="gdk-x11-surface-move-to-desktop"><primary>gdk_x11_surface_move_to_desktop</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_move_to_desktop (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                                 <parameter><link linkend="guint32"><type>guint32</type></link> desktop</parameter>);</programlisting>
<para>Moves the surface to the given workspace when running unde a
window manager that supports multiple workspaces, as described
in the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink> specification.</para>
<refsect3 id="gdk-x11-surface-move-to-desktop.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
<row><entry role="parameter_name"><para>desktop</para></entry>
<entry role="parameter_description"><para>the number of the workspace to move the surface to</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-get-desktop" role="function">
<title>gdk_x11_surface_get_desktop&#160;()</title>
<indexterm zone="gdk-x11-surface-get-desktop"><primary>gdk_x11_surface_get_desktop</primary></indexterm>
<programlisting language="C"><link linkend="guint32"><returnvalue>guint32</returnvalue></link>
gdk_x11_surface_get_desktop (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>);</programlisting>
<para>Gets the number of the workspace <parameter>surface</parameter>
 is on.</para>
<refsect3 id="gdk-x11-surface-get-desktop.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-surface-get-desktop.returns" role="returns">
<title>Returns</title>
<para> the current workspace of <parameter>surface</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-set-utf8-property" role="function">
<title>gdk_x11_surface_set_utf8_property&#160;()</title>
<indexterm zone="gdk-x11-surface-set-utf8-property"><primary>gdk_x11_surface_set_utf8_property</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_set_utf8_property (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                                   <parameter>const <link linkend="char"><type>char</type></link> *name</parameter>,
                                   <parameter>const <link linkend="char"><type>char</type></link> *value</parameter>);</programlisting>
<para>This function modifies or removes an arbitrary X11 window
property of type UTF8_STRING.  If the given <parameter>surface</parameter>
 is
not a toplevel surface, it is ignored.</para>
<refsect3 id="gdk-x11-surface-set-utf8-property.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
<row><entry role="parameter_name"><para>name</para></entry>
<entry role="parameter_description"><para>Property name, will be interned as an X atom</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>value</para></entry>
<entry role="parameter_description"><para>Property value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to delete. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-set-frame-sync-enabled" role="function">
<title>gdk_x11_surface_set_frame_sync_enabled&#160;()</title>
<indexterm zone="gdk-x11-surface-set-frame-sync-enabled"><primary>gdk_x11_surface_set_frame_sync_enabled</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_set_frame_sync_enabled
                               (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                                <parameter><link linkend="gboolean"><type>gboolean</type></link> frame_sync_enabled</parameter>);</programlisting>
<para>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.</para>
<refsect3 id="gdk-x11-surface-set-frame-sync-enabled.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a native <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
<row><entry role="parameter_name"><para>frame_sync_enabled</para></entry>
<entry role="parameter_description"><para>whether frame-synchronization should be enabled</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-set-group" role="function">
<title>gdk_x11_surface_set_group&#160;()</title>
<indexterm zone="gdk-x11-surface-set-group"><primary>gdk_x11_surface_set_group</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_surface_set_group (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>,
                           <parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *leader</parameter>);</programlisting>
<para>Sets the group leader of <parameter>surface</parameter>
 to be <parameter>leader</parameter>
.
See the ICCCM for details.</para>
<refsect3 id="gdk-x11-surface-set-group.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>a native <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
<row><entry role="parameter_name"><para>leader</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkSurface"><type>GdkSurface</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-surface-get-group" role="function">
<title>gdk_x11_surface_get_group&#160;()</title>
<indexterm zone="gdk-x11-surface-get-group"><primary>gdk_x11_surface_get_group</primary></indexterm>
<programlisting language="C"><link linkend="GdkSurface"><returnvalue>GdkSurface</returnvalue></link>&#160;*
gdk_x11_surface_get_group (<parameter><link linkend="GdkSurface"><type>GdkSurface</type></link> *surface</parameter>);</programlisting>
<para>Returns the group this surface belongs to.</para>
<refsect3 id="gdk-x11-surface-get-group.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>surface</para></entry>
<entry role="parameter_description"><para>The <link linkend="GdkSurface"><type>GdkSurface</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Surface]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-surface-get-group.returns" role="returns">
<title>Returns</title>
<para>The group of this surface;. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-keymap-get-group-for-state" role="function">
<title>gdk_x11_keymap_get_group_for_state&#160;()</title>
<indexterm zone="gdk-x11-keymap-get-group-for-state"><primary>gdk_x11_keymap_get_group_for_state</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gdk_x11_keymap_get_group_for_state (<parameter><link linkend="GdkKeymap"><type>GdkKeymap</type></link> *keymap</parameter>,
                                    <parameter><link linkend="guint"><type>guint</type></link> state</parameter>);</programlisting>
<para>Extracts the group from the state field sent in an X Key event.
This is only needed for code processing raw X events, since <link linkend="GdkEventKey"><type>GdkEventKey</type></link>
directly includes an is_modifier field.</para>
<refsect3 id="gdk-x11-keymap-get-group-for-state.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>keymap</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Keymap"><type>GdkX11Keymap</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Keymap]</emphasis></entry></row>
<row><entry role="parameter_name"><para>state</para></entry>
<entry role="parameter_description"><para>raw state returned from X</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-keymap-get-group-for-state.returns" role="returns">
<title>Returns</title>
<para> the index of the active keyboard group for the event</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-keymap-key-is-modifier" role="function">
<title>gdk_x11_keymap_key_is_modifier&#160;()</title>
<indexterm zone="gdk-x11-keymap-key-is-modifier"><primary>gdk_x11_keymap_key_is_modifier</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gdk_x11_keymap_key_is_modifier (<parameter><link linkend="GdkKeymap"><type>GdkKeymap</type></link> *keymap</parameter>,
                                <parameter><link linkend="guint"><type>guint</type></link> keycode</parameter>);</programlisting>
<para>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 <link linkend="GdkEventKey"><type>GdkEventKey</type></link> directly includes
an is_modifier field.</para>
<refsect3 id="gdk-x11-keymap-key-is-modifier.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>keymap</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkX11Keymap"><type>GdkX11Keymap</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Keymap]</emphasis></entry></row>
<row><entry role="parameter_name"><para>keycode</para></entry>
<entry role="parameter_description"><para>the hardware keycode from a key event</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-keymap-key-is-modifier.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the hardware keycode is a modifier key</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-visual-get-xvisual" role="function">
<title>gdk_x11_visual_get_xvisual&#160;()</title>
<indexterm zone="gdk-x11-visual-get-xvisual"><primary>gdk_x11_visual_get_xvisual</primary></indexterm>
<programlisting language="C"><link linkend="Visual"><returnvalue>Visual</returnvalue></link>&#160;*
gdk_x11_visual_get_xvisual (<parameter><link linkend="GdkX11Visual"><type>GdkX11Visual</type></link> *visual</parameter>);</programlisting>
<para>Returns the X visual belonging to a <link linkend="GdkVisual"><type>GdkVisual</type></link>.</para>
<refsect3 id="gdk-x11-visual-get-xvisual.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>visual</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkVisual"><type>GdkVisual</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Visual]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-visual-get-xvisual.returns" role="returns">
<title>Returns</title>
<para>an Xlib Visual*. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-get-xatom-by-name-for-display" role="function">
<title>gdk_x11_get_xatom_by_name_for_display&#160;()</title>
<indexterm zone="gdk-x11-get-xatom-by-name-for-display"><primary>gdk_x11_get_xatom_by_name_for_display</primary></indexterm>
<programlisting language="C"><link linkend="Atom"><returnvalue>Atom</returnvalue></link>
gdk_x11_get_xatom_by_name_for_display (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                       <parameter>const <link linkend="char"><type>char</type></link> *atom_name</parameter>);</programlisting>
<para>Returns the X atom for a <link linkend="GdkDisplay"><type>GdkDisplay</type></link> corresponding to <parameter>atom_name</parameter>
.
This function caches the result, so if called repeatedly it is much
faster than <link linkend="XInternAtom"><function>XInternAtom()</function></link>, which is a round trip to the server each time.</para>
<refsect3 id="gdk-x11-get-xatom-by-name-for-display.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>atom_name</para></entry>
<entry role="parameter_description"><para>a string</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-get-xatom-by-name-for-display.returns" role="returns">
<title>Returns</title>
<para> a X atom for a <link linkend="GdkDisplay"><type>GdkDisplay</type></link></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-get-xatom-name-for-display" role="function">
<title>gdk_x11_get_xatom_name_for_display&#160;()</title>
<indexterm zone="gdk-x11-get-xatom-name-for-display"><primary>gdk_x11_get_xatom_name_for_display</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
gdk_x11_get_xatom_name_for_display (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                    <parameter><link linkend="Atom"><type>Atom</type></link> xatom</parameter>);</programlisting>
<para>Returns the name of an X atom for its display. This
function is meant mainly for debugging, so for convenience, unlike
<link linkend="XAtomName"><function>XAtomName()</function></link> and the result doesn’t need to
be freed.</para>
<refsect3 id="gdk-x11-get-xatom-name-for-display.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>the <link linkend="GdkDisplay"><type>GdkDisplay</type></link> where <parameter>xatom</parameter>
is defined. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>xatom</para></entry>
<entry role="parameter_description"><para>an X atom </para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-get-xatom-name-for-display.returns" role="returns">
<title>Returns</title>
<para> name of the X atom; this string is owned by GDK,
so it shouldn’t be modified or freed. </para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-set-sm-client-id" role="function">
<title>gdk_x11_set_sm_client_id&#160;()</title>
<indexterm zone="gdk-x11-set-sm-client-id"><primary>gdk_x11_set_sm_client_id</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_set_sm_client_id (<parameter>const <link linkend="char"><type>char</type></link> *sm_client_id</parameter>);</programlisting>
<para>Sets the <literal>SM_CLIENT_ID</literal> 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.</para>
<para>See the X Session Management Library documentation for more information on
session management and the Inter-Client Communication Conventions Manual</para>
<refsect3 id="gdk-x11-set-sm-client-id.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>sm_client_id</para></entry>
<entry role="parameter_description"><para>the client id assigned by the session manager
when the connection was opened, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to remove the property. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-text-property-to-text-list" role="function">
<title>gdk_x11_display_text_property_to_text_list&#160;()</title>
<indexterm zone="gdk-x11-display-text-property-to-text-list"><primary>gdk_x11_display_text_property_to_text_list</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gdk_x11_display_text_property_to_text_list
                               (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                <parameter>const <link linkend="char"><type>char</type></link> *encoding</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> format</parameter>,
                                <parameter>const <link linkend="guchar"><type>guchar</type></link> *text</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> length</parameter>,
                                <parameter><link linkend="char"><type>char</type></link> ***list</parameter>);</programlisting>
<para>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.)</para>
<refsect3 id="gdk-x11-display-text-property-to-text-list.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>The <link linkend="GdkDisplay"><type>GdkDisplay</type></link> where the encoding is defined. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>encoding</para></entry>
<entry role="parameter_description"><para>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</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>format</para></entry>
<entry role="parameter_description"><para>the format of the property</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>text</para></entry>
<entry role="parameter_description"><para>The text data</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>length</para></entry>
<entry role="parameter_description"><para>The number of items to transform</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>list</para></entry>
<entry role="parameter_description"><para>location to store an  array of strings in
the encoding of the current locale. This array should be
freed using <link linkend="gdk-x11-free-text-list"><function>gdk_x11_free_text_list()</function></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-text-property-to-text-list.returns" role="returns">
<title>Returns</title>
<para> the number of strings stored in list, or 0,
if the conversion failed</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-free-text-list" role="function">
<title>gdk_x11_free_text_list&#160;()</title>
<indexterm zone="gdk-x11-free-text-list"><primary>gdk_x11_free_text_list</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_free_text_list (<parameter><link linkend="char"><type>char</type></link> **list</parameter>);</programlisting>
<para>Frees the array of strings created by
<link linkend="gdk-x11-display-text-property-to-text-list"><function>gdk_x11_display_text_property_to_text_list()</function></link>.</para>
<refsect3 id="gdk-x11-free-text-list.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>list</para></entry>
<entry role="parameter_description"><para>the value stored in the <parameter>list</parameter>
parameter by
a call to <link linkend="gdk-x11-display-text-property-to-text-list"><function>gdk_x11_display_text_property_to_text_list()</function></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-string-to-compound-text" role="function">
<title>gdk_x11_display_string_to_compound_text&#160;()</title>
<indexterm zone="gdk-x11-display-string-to-compound-text"><primary>gdk_x11_display_string_to_compound_text</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gdk_x11_display_string_to_compound_text
                               (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                <parameter>const <link linkend="char"><type>char</type></link> *str</parameter>,
                                <parameter>const <link linkend="char"><type>char</type></link> **encoding</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> *format</parameter>,
                                <parameter><link linkend="guchar"><type>guchar</type></link> **ctext</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> *length</parameter>);</programlisting>
<para>Convert a string from the encoding of the current
locale into a form suitable for storing in a window property.</para>
<refsect3 id="gdk-x11-display-string-to-compound-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>the <link linkend="GdkDisplay"><type>GdkDisplay</type></link> where the encoding is defined. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>str</para></entry>
<entry role="parameter_description"><para>a nul-terminated string</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>encoding</para></entry>
<entry role="parameter_description"><para>location to store the encoding
(to be used as the type for the property). </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>transfer none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>format</para></entry>
<entry role="parameter_description"><para>location to store the format of the property. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>ctext</para></entry>
<entry role="parameter_description"><para>location to store newly
allocated data for the property. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>array</acronym> length=length]</emphasis></entry></row>
<row><entry role="parameter_name"><para>length</para></entry>
<entry role="parameter_description"><para>the length of <parameter>ctext</parameter>
, in bytes</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-string-to-compound-text.returns" role="returns">
<title>Returns</title>
<para> 0 upon success, non-zero upon failure</para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-display-utf8-to-compound-text" role="function">
<title>gdk_x11_display_utf8_to_compound_text&#160;()</title>
<indexterm zone="gdk-x11-display-utf8-to-compound-text"><primary>gdk_x11_display_utf8_to_compound_text</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gdk_x11_display_utf8_to_compound_text (<parameter><link linkend="GdkDisplay"><type>GdkDisplay</type></link> *display</parameter>,
                                       <parameter>const <link linkend="char"><type>char</type></link> *str</parameter>,
                                       <parameter>const <link linkend="char"><type>char</type></link> **encoding</parameter>,
                                       <parameter><link linkend="int"><type>int</type></link> *format</parameter>,
                                       <parameter><link linkend="guchar"><type>guchar</type></link> **ctext</parameter>,
                                       <parameter><link linkend="int"><type>int</type></link> *length</parameter>);</programlisting>
<para>Converts from UTF-8 to compound text.</para>
<refsect3 id="gdk-x11-display-utf8-to-compound-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>display</para></entry>
<entry role="parameter_description"><para>a <link linkend="GdkDisplay"><type>GdkDisplay</type></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>type</acronym> GdkX11Display]</emphasis></entry></row>
<row><entry role="parameter_name"><para>str</para></entry>
<entry role="parameter_description"><para>a UTF-8 string</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>encoding</para></entry>
<entry role="parameter_description"><para>location to store resulting encoding. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>transfer none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>format</para></entry>
<entry role="parameter_description"><para>location to store format of the result. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>ctext</para></entry>
<entry role="parameter_description"><para>location to store the data of the result. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>array</acronym> length=length]</emphasis></entry></row>
<row><entry role="parameter_name"><para>length</para></entry>
<entry role="parameter_description"><para>location to store the length of the data
stored in <parameter>ctext</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gdk-x11-display-utf8-to-compound-text.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the conversion succeeded,
otherwise <link linkend="FALSE:CAPS"><literal>FALSE</literal></link></para>
</refsect3></refsect2>
<refsect2 id="gdk-x11-free-compound-text" role="function">
<title>gdk_x11_free_compound_text&#160;()</title>
<indexterm zone="gdk-x11-free-compound-text"><primary>gdk_x11_free_compound_text</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gdk_x11_free_compound_text (<parameter><link linkend="guchar"><type>guchar</type></link> *ctext</parameter>);</programlisting>
<para>Frees the data returned from <link linkend="gdk-x11-display-string-to-compound-text"><function>gdk_x11_display_string_to_compound_text()</function></link>.</para>
<refsect3 id="gdk-x11-free-compound-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>ctext</para></entry>
<entry role="parameter_description"><para>The pointer stored in <parameter>ctext</parameter>
from a call to
<link linkend="gdk-x11-display-string-to-compound-text"><function>gdk_x11_display_string_to_compound_text()</function></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>

</refentry>
