gtk/gdk/x11/gdkx11utils.h

/* GDK - The GIMP Drawing Kit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * 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/. 
 */

#ifndef __GDK_X11_UTILS_H__
#define __GDK_X11_UTILS_H__

#if !defined (__GDKX_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gdk/x11/gdkx.h> can be included directly."
#endif

#include <gdk/gdk.h>

#include <X11/Xlib.h>
#include <X11/Xutil.h>

G_BEGIN_DECLS

/**
 * GDK_XID_TO_POINTER:
 * @xid: XID to stuff into the pointer
 *
 * Converts an XID into a @gpointer. This is useful with data structures
 * that use pointer arguments such as `GHashTable`. Use GDK_POINTER_TO_XID()
 * to convert the argument back to an XID.
 */
#define GDK_XID_TO_POINTER(xid) GUINT_TO_POINTER(xid)

/**
 * GDK_POINTER_TO_XID:
 * @pointer: pointer to extract an XID from
 *
 * Converts a @gpointer back to an XID that was previously converted
 * using GDK_XID_TO_POINTER().
 */
#define GDK_POINTER_TO_XID(pointer) GPOINTER_TO_UINT(pointer)


G_END_DECLS

#endif /* __GDK_X11_UTILS_H__ */
x11: Move remaining APIs into gdkx11utils.h Now gdkx.h is a clean header equivalent to gdk.h. 2010-12-20 14:55:16 +00:00			`/* GDK - The GIMP Drawing Kit`
			`* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald`
			`*`
			`* This library is free software; you can redistribute it and/or`
			`* modify it under the terms of the GNU Lesser General Public`
			`* License as published by the Free Software Foundation; either`
			`* version 2 of the License, or (at your option) any later version.`
			`*`
			`* This library is distributed in the hope that it will be useful,`
			`* but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU`
			`* Lesser General Public License for more details.`
			`*`
			`* You should have received a copy of the GNU Lesser General Public`
Change FSF Address 2012-02-27 13:01:10 +00:00			`* License along with this library. If not, see <http://www.gnu.org/licenses/>.`
x11: Move remaining APIs into gdkx11utils.h Now gdkx.h is a clean header equivalent to gdk.h. 2010-12-20 14:55:16 +00:00			`*/`

			`/*`
			`* 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/.`
			`*/`

Move single-include guards inside include guards gcc has optimizations for include guards that only work if they are outermost in the the header. https://bugzilla.gnome.org/show_bug.cgi?id=689810 2012-12-28 14:57:34 +00:00			`#ifndef __GDK_X11_UTILS_H__`
			`#define __GDK_X11_UTILS_H__`

Use a single compilation symbol We use a compilation symbol in our build to allow the inclusion of specific headers while building GTK, to avoid the need to include only the global header. Each namespace has its own compilation symbol because we used to have different libraries, and strict symbol visibility between libraries; now that we have a single library, and we can use private symbols across namespaces while building GTK, we should have a single compilation symbol, and simplify the build rules. 2019-11-27 13:33:43 +00:00			`#if !defined (__GDKX_H_INSIDE__) && !defined (GTK_COMPILATION)`
Correct GdkX11 import path in docs and include guards Update the include directives in the documentation, as well as the include guards in headers, to point to gdk/x11/gdkx.h. closes #2254 2019-11-15 21:13:26 +00:00			`#error "Only <gdk/x11/gdkx.h> can be included directly."`
x11: Move remaining APIs into gdkx11utils.h Now gdkx.h is a clean header equivalent to gdk.h. 2010-12-20 14:55:16 +00:00			`#endif`

			`#include <gdk/gdk.h>`

			`#include <X11/Xlib.h>`
			`#include <X11/Xutil.h>`

			`G_BEGIN_DECLS`

API: x11: Add GDK_POINTER_TO_XID() and GDK_XID_TO_POINTER() Previously people used GDK_GPOINTER_TO_NATIVE_WINDOW() for this, but native windows are going away, so we need a replacement. 2011-01-28 14:11:44 +00:00			`/**`
			`* GDK_XID_TO_POINTER:`
docs: fix docs for GDK_XID_TO_POINTER and GDK_POINTER_TO_XID 2014-01-20 20:41:31 +00:00			`* @xid: XID to stuff into the pointer`
API: x11: Add GDK_POINTER_TO_XID() and GDK_XID_TO_POINTER() Previously people used GDK_GPOINTER_TO_NATIVE_WINDOW() for this, but native windows are going away, so we need a replacement. 2011-01-28 14:11:44 +00:00			`*`
			`* Converts an XID into a @gpointer. This is useful with data structures`
gdk: Clean up docs syntax Replace leftover gtk-doc syntax (#Type) with backquotes. 2021-05-20 03:39:18 +00:00			* that use pointer arguments such as `GHashTable`. Use GDK_POINTER_TO_XID()
API: x11: Add GDK_POINTER_TO_XID() and GDK_XID_TO_POINTER() Previously people used GDK_GPOINTER_TO_NATIVE_WINDOW() for this, but native windows are going away, so we need a replacement. 2011-01-28 14:11:44 +00:00			`* to convert the argument back to an XID.`
			`*/`
docs: fix docs for GDK_XID_TO_POINTER and GDK_POINTER_TO_XID 2014-01-20 20:41:31 +00:00			`#define GDK_XID_TO_POINTER(xid) GUINT_TO_POINTER(xid)`
API: x11: Add GDK_POINTER_TO_XID() and GDK_XID_TO_POINTER() Previously people used GDK_GPOINTER_TO_NATIVE_WINDOW() for this, but native windows are going away, so we need a replacement. 2011-01-28 14:11:44 +00:00
			`/**`
			`* GDK_POINTER_TO_XID:`
docs: fix docs for GDK_XID_TO_POINTER and GDK_POINTER_TO_XID 2014-01-20 20:41:31 +00:00			`* @pointer: pointer to extract an XID from`
API: x11: Add GDK_POINTER_TO_XID() and GDK_XID_TO_POINTER() Previously people used GDK_GPOINTER_TO_NATIVE_WINDOW() for this, but native windows are going away, so we need a replacement. 2011-01-28 14:11:44 +00:00			`*`
			`* Converts a @gpointer back to an XID that was previously converted`
			`* using GDK_XID_TO_POINTER().`
			`*/`
			`#define GDK_POINTER_TO_XID(pointer) GPOINTER_TO_UINT(pointer)`

x11: Move remaining APIs into gdkx11utils.h Now gdkx.h is a clean header equivalent to gdk.h. 2010-12-20 14:55:16 +00:00
			`G_END_DECLS`

			`#endif /* __GDK_X11_UTILS_H__ */`