From 50e1589a191f767da5a90520dfdd72f04a5f45f9 Mon Sep 17 00:00:00 2001
From: Benjamin Otte <otte@redhat.com>
Date: Fri, 28 Jan 2011 10:56:40 +0100
Subject: [PATCH] plug/socket: Clarify docs about availablility of widgets

---
 gtk/gtkplug.c   | 11 +++++++++--
 gtk/gtksocket.c |  5 +++--
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c
index 8fbcfbd820..512d234b12 100644
--- a/gtk/gtkplug.c
+++ b/gtk/gtkplug.c
@@ -59,9 +59,16 @@
  * Any widgets contained in the #GtkPlug then will appear
  * inside the first application's window.
  *
+ * The communication between a #GtkSocket and a #GtkPlug follows the
+ * <ulink url="http://www.freedesktop.org/Standards/xembed-spec">XEmbed</ulink>
+ * protocol. This protocol has also been implemented in other toolkits, e.g.
+ * <application>Qt</application>, allowing the same level of integration
+ * when embedding a <application>Qt</application> widget in GTK or vice versa.
+ *
  * <note>
- * The #GtkPlug and #GtkSocket widgets are currently not available
- * on all platforms supported by GTK+.
+ * The #GtkPlug and #GtkSocket widgets are only available when GTK is
+ * compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
+ * They can only be used on a #GdkX11Display.
  * </note>
  */
 
diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c
index 016c6073b4..263972de7e 100644
--- a/gtk/gtksocket.c
+++ b/gtk/gtksocket.c
@@ -109,8 +109,9 @@
  * when embedding a <application>Qt</application> widget in GTK or vice versa.
  *
  * <note>
- * The #GtkPlug and #GtkSocket widgets are currently not available
- * on all platforms supported by GTK+.
+ * The #GtkPlug and #GtkSocket widgets are only available when GTK is
+ * compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
+ * They can only be used on a #GdkX11Display.
  * </note>
  */