mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-11-07 09:10:11 +00:00
b56118cf13
Wed Nov 21 15:57:29 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtk-sections.txt: Updates
* gtk/tmpl/gtkstock.sgml: Close end tags.
* gtk/gtk.types: Remove interface types which gtk-doc
can't handle currently.
* gtk/tmpl/gtknotebook.sgml: Fix some garbage in file.
* gdk/tmpl/x_interaction.sgml: Fix SGML errors.
* gdk/gdk-overrides.txt gdk/gdk-sections.txt: Updates.
486 lines
8.8 KiB
Plaintext
486 lines
8.8 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
X Window System Interaction
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### MACRO GDK_ROOT_WINDOW ##### -->
|
|
<para>
|
|
Obtains the Xlib window id of the root window of the current screen.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GDK_ROOT_PARENT ##### -->
|
|
<para>
|
|
Obtains the Xlib window id of the root window of the default screen.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GDK_DISPLAY ##### -->
|
|
<para>
|
|
The current display.
|
|
</para>
|
|
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_WINDOW_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkWindow.
|
|
</para>
|
|
|
|
@win: a #GdkWindow.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_WINDOW_XID ##### -->
|
|
<para>
|
|
Returns the X window belonging to a #GdkWindow.
|
|
</para>
|
|
|
|
@win: a #GdkWindow.
|
|
@Returns: the Xlib <type>Window</type> of @win.
|
|
|
|
|
|
<!-- ##### MACRO GDK_PIXMAP_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkPixmap.
|
|
</para>
|
|
|
|
@win: a #GdkPixmap.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_PIXMAP_XID ##### -->
|
|
<para>
|
|
Returns the X pixmap belonging to a #GdkPixmap.
|
|
</para>
|
|
|
|
@win: a #GdkPixmap.
|
|
@Returns: the Xlib <type>XPixmap</type> of @win.
|
|
|
|
|
|
<!-- ##### MACRO GDK_DRAWABLE_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkDrawable.
|
|
</para>
|
|
|
|
@win: a #GdkDrawable.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_DRAWABLE_XID ##### -->
|
|
<para>
|
|
Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
|
|
</para>
|
|
|
|
@win: a #GdkDrawable.
|
|
@Returns: the ID of @win's X resource.
|
|
|
|
|
|
<!-- ##### MACRO GDK_IMAGE_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkImage.
|
|
</para>
|
|
|
|
@image: a #GdkImage.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_IMAGE_XIMAGE ##### -->
|
|
<para>
|
|
Returns the X image belonging to a #GdkImage.
|
|
</para>
|
|
|
|
@image: a #GdkImage.
|
|
@Returns: an <type>XImage*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_GC_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkGC.
|
|
</para>
|
|
|
|
@gc: a #GdkGC.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_COLORMAP_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkColormap.
|
|
</para>
|
|
|
|
@cmap: a #GdkColormap.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_COLORMAP_XCOLORMAP ##### -->
|
|
<para>
|
|
Returns the X colormap belonging to a #GdkColormap.
|
|
</para>
|
|
|
|
@cmap: a #GdkColormap.
|
|
@Returns: an Xlib <type>Colormap</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_VISUAL_XVISUAL ##### -->
|
|
<para>
|
|
Returns the X visual belonging to a #GdkVisual.
|
|
</para>
|
|
|
|
@vis: a #GdkVisual.
|
|
@Returns: an Xlib <type>Visual*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_FONT_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkFont.
|
|
</para>
|
|
|
|
@font: a #GdkFont.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_FONT_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>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_CURSOR_XCURSOR ##### -->
|
|
<para>
|
|
Returns the X cursor belonging to a #GdkCursor.
|
|
</para>
|
|
|
|
@cursor: a #GdkCursor.
|
|
@Returns: an Xlib <type>Cursor</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_CURSOR_XDISPLAY ##### -->
|
|
<para>
|
|
Returns the display of a #GdkCursor.
|
|
</para>
|
|
|
|
@cursor: a #GdkCursor.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_GC_XGC ##### -->
|
|
<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>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_GC_GET_XGC ##### -->
|
|
<para>
|
|
Returns the X GC of a #GdkGC.
|
|
</para>
|
|
|
|
@gc: a #GdkGC.
|
|
@Returns: an Xlib <type>GC</type>.
|
|
|
|
|
|
<!-- ##### MACRO GDK_WINDOW_XWINDOW ##### -->
|
|
<para>
|
|
Another name for GDK_DRAWABLE_XID().
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdkx_visual_get ##### -->
|
|
<para>
|
|
Returns a #GdkVisual corresponding to a X visual.
|
|
</para>
|
|
|
|
@xvisualid: a X visual id.
|
|
@Returns: the #GdkVisual.
|
|
|
|
|
|
<!-- ##### FUNCTION gdkx_colormap_get ##### -->
|
|
<para>
|
|
Returns a #GdkColormap corresponding to a X colormap.
|
|
</para>
|
|
|
|
@xcolormap: a X colormap.
|
|
@Returns: the #GdkColormap.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_pixmap_foreign_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@anid:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_window_foreign_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@anid:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_xid_table_lookup ##### -->
|
|
<para>
|
|
Returns the Gdk object associated with the given X id.
|
|
</para>
|
|
|
|
@xid: an X id.
|
|
@Returns: the associated Gdk object, which may be a #GdkPixmap,
|
|
a #GdkWindow or a #GdkFont.
|
|
|
|
|
|
<!-- ##### 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_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
|
|
|
|
|
|
<!-- ##### MACRO gdk_font_lookup ##### -->
|
|
<para>
|
|
Obtains the #GdkFont for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has
|
|
been created for @xid.
|
|
</para>
|
|
|
|
@xid:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_get_server_time ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@window:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_net_wm_supports ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@property:
|
|
@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>.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_colormap_get_xdisplay ##### -->
|
|
<para>
|
|
Returns the display of a #GdkColormap.
|
|
</para>
|
|
|
|
@colormap: a #GdkColormap.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_cursor_get_xcursor ##### -->
|
|
<para>
|
|
Returns the X cursor belonging to a #GdkCursor.
|
|
</para>
|
|
|
|
@cursor: a #GdkCursor.
|
|
@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>.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_drawable_get_xdisplay ##### -->
|
|
<para>
|
|
Returns the display of a #GdkDrawable.
|
|
</para>
|
|
|
|
@drawable: a #GdkDrawable.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### 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.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_font_get_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@font:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_font_get_xdisplay ##### -->
|
|
<para>
|
|
Returns the display of a #GdkFont.
|
|
</para>
|
|
|
|
@font: a #GdkFont.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### 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>.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_gc_get_xdisplay ##### -->
|
|
<para>
|
|
Returns the display of a #GdkGC.
|
|
</para>
|
|
|
|
@gc: a #GdkGC.
|
|
@Returns: an Xlib <type>Display*</type>.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_gc_get_xgc ##### -->
|
|
<para>
|
|
Returns the X GC of a #GdkGC.
|
|
</para>
|
|
|
|
@gc: a #GdkGC.
|
|
@Returns: an Xlib <type>GC</type>.
|
|
|
|
|
|
<!-- ##### 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>.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_get_default_screen ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### 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.
|
|
|
|
|
|
<!-- ##### 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.
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_x11_image_get_ximage ##### -->
|
|
<para>
|
|
Returns the X image belonging to a #GdkImage.
|
|
</para>
|
|
|
|
@image: a #GdkImage.
|
|
@Returns: an <type>XImage*</type>.
|
|
|
|
|
|
<!-- ##### 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>.
|
|
|
|
|