2.9.0

[~andy/gtk] / docs / reference / gdk / tmpl / x_interaction.sgml

diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml
index 7f964cc8d709d7bb37ba4280a99a8e59dd813dce..b31eb7764bcc066e8a3f70025a2f3328e4b281cb 100644 (file)
--- a/docs/reference/gdk/tmpl/x_interaction.sgml
+++ b/docs/reference/gdk/tmpl/x_interaction.sgml
@@ -2,7 +2,7 @@
 X Window System Interaction
 
 <!-- ##### SECTION Short_Description ##### -->
-
+X backend-specific functions
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -14,6 +14,9 @@ X Window System Interaction
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### MACRO GDK_ROOT_WINDOW ##### -->
 <para>
 Obtains the Xlib window id of the root window of the current screen. 
@@ -59,10 +62,8 @@ Returns the X window belonging to a #GdkWindow.
 Returns the display of a #GdkPixmap.
 </para>
 
-@pix: 
+@pix: a #GdkPixmap.
 @Returns: an Xlib <type>Display*</type>.
-<!-- # Unused Parameters # -->
-@win: a #GdkPixmap.
 
 
 <!-- ##### MACRO GDK_PIXMAP_XID ##### -->
@@ -70,10 +71,16 @@ Returns the display of a #GdkPixmap.
 Returns the X pixmap belonging to a #GdkPixmap.
 </para>
 
-@pix: 
+@pix: a #GdkPixmap.
 @Returns: the Xlib <type>XPixmap</type> of @win.
-<!-- # Unused Parameters # -->
-@win: a #GdkPixmap.
+
+
+<!-- ##### MACRO GDK_DISPLAY_XDISPLAY ##### -->
+<para>
+Returns the display of a #GdkDisplay.
+</para>
+
+@display: a #GdkDisplay.
 
 
 <!-- ##### MACRO GDK_DRAWABLE_XDISPLAY ##### -->
@@ -139,6 +146,34 @@ Returns the X colormap belonging to a #GdkColormap.
 @Returns: an Xlib <type>Colormap</type>.
 
 
+<!-- ##### MACRO GDK_SCREEN_XDISPLAY ##### -->
+<para>
+Returns the display of a #GdkScreen.
+</para>
+
+@screen: a #GdkScreen.
+@Returns: an Xlib <type>Display*</type>.
+
+
+<!-- ##### MACRO GDK_SCREEN_XNUMBER ##### -->
+<para>
+Returns the index of a #GdkScreen.
+</para>
+
+@screen: a #GdkScreen
+@Returns: the position of @screen among the screens of
+  its display.
+
+
+<!-- ##### MACRO GDK_SCREEN_XSCREEN ##### -->
+<para>
+Returns the screen of a #GdkScreen.
+</para>
+
+@screen: a #GdkScreen
+@Returns: an Xlib <type>Screen*</type>.
+
+
 <!-- ##### MACRO GDK_VISUAL_XVISUAL ##### -->
 <para>
 Returns the X visual belonging to a #GdkVisual.
@@ -188,11 +223,6 @@ Returns the display of a #GdkCursor.
 <para>
 Returns the X GC of a #GdkGC.
 </para>
-<note><para>
-Note that the clip origin, clip region and tile/stipple origin fields of the
-returned GC may not be in sync with @gc. If you need that, 
-use GDK_GC_GET_XGC().  
-</para></note>
 
 @gc: a #GdkGC.
 @Returns: an Xlib <type>GC</type>.
@@ -216,20 +246,19 @@ Another name for GDK_DRAWABLE_XID().
 
 <!-- ##### FUNCTION gdkx_visual_get ##### -->
 <para>
-Returns a #GdkVisual corresponding to a X visual.
+
 </para>
 
-@xvisualid: a X visual id.
-@Returns: the #GdkVisual.
+@xvisualid: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdkx_colormap_get ##### -->
 <para>
-Returns a #GdkColormap corresponding to a X colormap.
 </para>
 
-@xcolormap: a X colormap.
-@Returns: the #GdkColormap.
+@xcolormap: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_pixmap_foreign_new ##### -->
@@ -241,6 +270,29 @@ Returns a #GdkColormap corresponding to a X colormap.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_pixmap_foreign_new_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@anid: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_pixmap_foreign_new_for_screen ##### -->
+<para>
+
+</para>
+
+@screen: 
+@anid: 
+@width: 
+@height: 
+@depth: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_window_foreign_new ##### -->
 <para>
 
@@ -250,47 +302,98 @@ Returns a #GdkColormap corresponding to a X colormap.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_window_foreign_new_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@anid: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_xid_table_lookup ##### -->
 <para>
-Returns the Gdk object associated with the given X id.
+
+</para>
+
+@xid: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_xid_table_lookup_for_display ##### -->
+<para>
+
 </para>
 
-@xid: an X id.
-@Returns: the associated Gdk object, which may be a #GdkPixmap,
-a #GdkWindow or a #GdkFont.
+@display: 
+@xid: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_window_lookup ##### -->
 <para>
-Obtains the #GdkWindow for the given Xlib window ID, or %NULL if no #GdkWindow has
-been created for @xid.
 </para>
 
 @anid: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@xid: Xlib window ID
+
+
+<!-- ##### FUNCTION gdk_window_lookup_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@anid: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_pixmap_lookup ##### -->
 <para>
-Obtains the #GdkPixmap for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has
-been created for @xid.
 </para>
 
 @anid: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@xid: Xlib pixmap ID
+
+
+<!-- ##### FUNCTION gdk_pixmap_lookup_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@anid: 
+@Returns: 
 
 
 <!-- ##### MACRO gdk_font_lookup ##### -->
 <para>
-Obtains the #GdkFont for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has
+Obtains the #GdkFont for the given Xlib font ID, or %NULL if no #GdkFont has
 been created for @xid.
 </para>
 
-@xid: 
+@xid: an Xlib font ID
+
+
+<!-- ##### MACRO gdk_font_lookup_for_display ##### -->
+<para>
+Obtains the #GdkFont for the given Xlib font ID on @display, or %NULL if no
+#GdkFont has been created for @xid.
+</para>
+
+@display: a #GdkDisplay
+@xid: an Xlib font ID
+Since: 2.2
+
+
+<!-- ##### FUNCTION gdk_x11_lookup_xdisplay ##### -->
+<para>
+
+</para>
+
+@xdisplay: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_get_server_time ##### -->
@@ -311,60 +414,168 @@ been created for @xid.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_x11_screen_supports_net_wm_hint ##### -->
+<para>
+
+</para>
+
+@screen: 
+@property: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_screen_get_window_manager_name ##### -->
+<para>
+
+</para>
+
+@screen: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_screen_lookup_visual ##### -->
+<para>
+
+</para>
+
+@screen: 
+@xvisualid: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_window_set_user_time ##### -->
+<para>
+
+</para>
+
+@window: 
+@timestamp: 
+
+
+<!-- ##### FUNCTION gdk_x11_window_move_to_current_desktop ##### -->
+<para>
+
+</para>
+
+@window: 
+
+
+<!-- ##### FUNCTION gdk_x11_display_get_user_time ##### -->
+<para>
+
+</para>
+
+@display: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_colormap_foreign_new ##### -->
+<para>
+
+</para>
+
+@visual: 
+@xcolormap: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_x11_colormap_get_xcolormap ##### -->
 <para>
-Returns the X colormap belonging to a #GdkColormap.
+
 </para>
 
-@colormap: a #GdkColormap.
-@Returns: an Xlib <type>Colormap</type>.
+@colormap: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_colormap_get_xdisplay ##### -->
 <para>
-Returns the display of a #GdkColormap.
+
 </para>
 
-@colormap: a #GdkColormap.
-@Returns: an Xlib <type>Display*</type>.
+@colormap: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_cursor_get_xcursor ##### -->
 <para>
-Returns the X cursor belonging to a #GdkCursor.
+
 </para>
 
-@cursor: a #GdkCursor.
+@cursor: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@Retursn: an Xlib <type>Cursor</type.
 
 
 <!-- ##### FUNCTION gdk_x11_cursor_get_xdisplay ##### -->
 <para>
-Returns the display of a #GdkCursor.
+
 </para>
 
-@cursor: a #GdkCursor.
-@Returns: an Xlib <type>Display*</type>.
+@cursor: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_display_get_xdisplay ##### -->
+<para>
+
+</para>
+
+@display: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_display_grab ##### -->
+<para>
+
+</para>
+
+@display: 
+
+
+<!-- ##### FUNCTION gdk_x11_display_ungrab ##### -->
+<para>
+
+</para>
+
+@display: 
+
+
+<!-- ##### FUNCTION gdk_x11_display_set_cursor_theme ##### -->
+<para>
+
+</para>
+
+@display: 
+@theme: 
+@size: 
+
+
+<!-- ##### FUNCTION gdk_x11_register_standard_event_type ##### -->
+<para>
+
+</para>
+
+@display: 
+@event_base: 
+@n_events: 
 
 
 <!-- ##### FUNCTION gdk_x11_drawable_get_xdisplay ##### -->
 <para>
-Returns the display of a #GdkDrawable.
+
 </para>
 
-@drawable: a #GdkDrawable.
-@Returns: an Xlib <type>Display*</type>.
+@drawable: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_drawable_get_xid ##### -->
 <para>
-Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
+
 </para>
 
-@drawable: a #GdkDrawable.
-@Returns: the ID of @win's X resource.
+@drawable: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_font_get_name ##### -->
@@ -378,47 +589,46 @@ Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
 
 <!-- ##### FUNCTION gdk_x11_font_get_xdisplay ##### -->
 <para>
-Returns the display of a #GdkFont.
+
 </para>
 
-@font: a #GdkFont.
-@Returns: an Xlib <type>Display*</type>.
+@font: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_font_get_xfont ##### -->
 <para>
-Returns the X font belonging to a #GdkFont.
+
 </para>
 
-@font: a #GdkFont.
-@Returns: an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
+@font: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_gc_get_xdisplay ##### -->
 <para>
-Returns the display of a #GdkGC.
+
 </para>
 
-@gc: a #GdkGC.
-@Returns: an Xlib <type>Display*</type>.
+@gc: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_gc_get_xgc ##### -->
 <para>
-Returns the X GC of a #GdkGC.
+
 </para>
 
-@gc: a #GdkGC.
-@Returns: an Xlib <type>GC</type>.
+@gc: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_get_default_root_xwindow ##### -->
 <para>
-Gets the root window of the default screen 
-(see gdk_x11_get_default_screen()).  
+
 </para>
 
-@Returns: an Xlib <type>Window</type>.
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_get_default_screen ##### -->
@@ -431,60 +641,69 @@ Gets the root window of the default screen
 
 <!-- ##### FUNCTION gdk_x11_get_default_xdisplay ##### -->
 <para>
-Gets the default GTK+ display.
+
 </para>
 
-@Returns: the Xlib <type>Display*</type> for the display
-  specified in the <option>--display</option> command line option 
-  or the <envar>DISPLAY</envar> environment variable.
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_grab_server ##### -->
 <para>
-Call <function>XGrabServer()</function> on the default display. 
-To ungrab the server again, use gdk_x11_ungrab_server(). 
-</para>
-<para>
-gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
+
 </para>
 
 
 
 <!-- ##### FUNCTION gdk_x11_image_get_xdisplay ##### -->
 <para>
-Returns the display of a #GdkImage.
+
 </para>
 
 @image: 
-@Returns: an Xlib <type>Display*</type>.
-<!-- # Unused Parameters # -->
-@drawable: a #GdkImage.
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_image_get_ximage ##### -->
 <para>
-Returns the X image belonging to a #GdkImage.
+
 </para>
 
-@image: a #GdkImage.
-@Returns: an <type>XImage*</type>.
+@image: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_screen_get_screen_number ##### -->
+<para>
+
+</para>
+
+@screen: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_x11_screen_get_xscreen ##### -->
+<para>
+
+</para>
+
+@screen: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_ungrab_server ##### -->
 <para>
-Ungrab the default display after it has been grabbed with 
-gdk_x11_grab_server(). 
+
 </para>
 
 
 
 <!-- ##### FUNCTION gdk_x11_visual_get_xvisual ##### -->
 <para>
-Returns the X visual belonging to a #GdkVisual.
+
 </para>
 
-@visual: a #GdkVisual.
-@Returns: an Xlib <type>Visual*</type>.
+@visual: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_x11_atom_to_xatom ##### -->
@@ -496,6 +715,16 @@ Returns the X visual belonging to a #GdkVisual.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_x11_atom_to_xatom_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@atom: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_x11_xatom_to_atom ##### -->
 <para>
 
@@ -505,6 +734,16 @@ Returns the X visual belonging to a #GdkVisual.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_x11_xatom_to_atom_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@xatom: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_x11_get_xatom_by_name ##### -->
 <para>
 
@@ -514,6 +753,16 @@ Returns the X visual belonging to a #GdkVisual.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_x11_get_xatom_by_name_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@atom_name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gdk_x11_get_xatom_name ##### -->
 <para>
 
@@ -523,3 +772,13 @@ Returns the X visual belonging to a #GdkVisual.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_x11_get_xatom_name_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@xatom: 
+@Returns: 
+
+