Fix up GDK docs

This commit is contained in:
Matthias Clasen
2010-12-25 00:02:39 -05:00
parent 436e75c34c
commit 27ce9421d0
19 changed files with 412 additions and 274 deletions

View File

@ -48,7 +48,41 @@
#include <X11/XKBlib.h>
#endif
typedef struct _GdkPredicate GdkPredicate;
/**
* SECTION:x_interaction
* @Short_description: X backend-specific functions
* @Title: X Window System Interaction
*
* The functions in this section are specific to the GDK X11 backend.
* To use them, you need to include the <literal>&lt;gdk/gdkx.h&gt;</literal>
* header and use the X11-specific pkg-config files to build your
* application (either <literal>gdk-x11-3.0</literal> or
* <literal>gtk+-x11-3.0</literal>).
*
* To make your code compile with other GDK backends, guard backend-specific
* calls by an ifdef as follows. Since GDK may be built with multiple
* backends, you should also check for the backend that is in use (e.g. by
* using the GDK_IS_X11_DISPLAY() macro).
* |[
* #ifdef GDK_WINDOWING_X11
* if (GDK_IS_X11_DISPLAY (display))
* {
* /&ast; make X11-specific calls here &ast;/
* }
* else
* #endif
* #ifdef GDK_WINDOWING_QUARTZ
* if (GDK_IS_QUARTZ_DISPLAY (display))
* {
* /&ast; make Quartz-specific calls here &ast/
* }
* else
* #endif
* g_error ("Unsupported GDK backend");
* ]|
*/
typedef struct _GdkPredicate GdkPredicate;
struct _GdkPredicate
{

View File

@ -21,7 +21,7 @@
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#ifndef __GDK_X_H__
@ -32,27 +32,6 @@
#include <X11/Xlib.h>
#include <X11/Xutil.h>
/**
* SECTION:x_interaction
* @Short_description: X backend-specific functions
* @Title: X Window System Interaction
*
* The functions in this section are specific to the GDK X11 backend.
* To use them, you need to include the <literal>&lt;gdk/gdkx.h&gt;</literal>
* header and use the X11-specific pkg-config files to build your
* application (either <literal>gdk-x11-3.0</literal> or
* <literal>gtk+-x11-3.0</literal>).
*
* To make your code compile with other GDK backends, guard backend-specific
* calls by an ifdef as follows:
* <informalexample><programlisting>
* #ifdef GDK_WINDOWING_X11
* /<!---->* X11-specific calls here... *<!---->/
* #endif
* </programlisting></informalexample>
*/
#define __GDKX_H_INSIDE__
#include <gdk/x11/gdkx11applaunchcontext.h>

View File

@ -64,37 +64,35 @@ gint gdk_x11_get_default_screen (void);
#endif
/**
* GDK_DISPLAY_XDISPLAY:
* @display: a #GdkDisplay.
* GDK_SCREEN_XDISPLAY:
* @screen: a #GdkScreen
*
* Returns the display of a #GdkDisplay.
* Returns the display of a X11 #GdkScreen.
*
* Returns: an Xlib <type>Display*</type>
*/
#define GDK_SCREEN_XDISPLAY(screen) (gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen)))
#define GDK_SCREEN_XDISPLAY(screen) (gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen)))
/**
* GDK_SCREEN_XSCREEN:
* @screen: a #GdkScreen
*
* Returns the screen of a #GdkScreen.
* Returns the screen of a X11 #GdkScreen.
*
* Returns: an Xlib <type>Screen*</type>.
* Returns: an Xlib <type>Screen*</type>
*/
#define GDK_SCREEN_XSCREEN(screen) (gdk_x11_screen_get_xscreen (screen))
#define GDK_SCREEN_XSCREEN(screen) (gdk_x11_screen_get_xscreen (screen))
/**
* GDK_SCREEN_XNUMBER:
* @screen: a #GdkScreen
*
* Returns the index of a #GdkScreen.
* Returns the index of a X11 #GdkScreen.
*
* Returns: the position of @screen among the screens of
* its display.
* Returns: the position of @screen among the screens of its display
*/
#define GDK_SCREEN_XNUMBER(screen) (gdk_x11_screen_get_screen_number (screen))
#define GDK_SCREEN_XNUMBER(screen) (gdk_x11_screen_get_screen_number (screen))
/* returns TRUE if we support the given WM spec feature */
gboolean gdk_x11_screen_supports_net_wm_hint (GdkScreen *screen,
GdkAtom property);