summaryrefslogtreecommitdiff
path: root/gdk/gdkselection.h
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2010-11-15 17:20:51 +0100
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2010-11-16 16:20:48 +0900
commit7090aa1e1bf666cb68cafb6173ebd7c80861f157 (patch)
tree419096c46aec35eb4d15a780642a73bc580983e1 /gdk/gdkselection.h
parent4593df1ef5a440577f0add13e86e623b3854eb6e (diff)
downloadgtk+-7090aa1e1bf666cb68cafb6173ebd7c80861f157.tar.gz
docs: Move documentation to inline comments: gdkselection
Diffstat (limited to 'gdk/gdkselection.h')
-rw-r--r--gdk/gdkselection.h109
1 files changed, 109 insertions, 0 deletions
diff --git a/gdk/gdkselection.h b/gdk/gdkselection.h
index fc5d4b40e8..897e0c77cf 100644
--- a/gdk/gdkselection.h
+++ b/gdk/gdkselection.h
@@ -38,21 +38,116 @@ G_BEGIN_DECLS
/* Predefined atoms relating to selections. In general, one will need to use
* gdk_intern_atom
*/
+/**
+ * GDK_SELECTION_PRIMARY:
+ *
+ * A #GdkAtom representing the <literal>PRIMARY</literal> selection.
+ */
#define GDK_SELECTION_PRIMARY _GDK_MAKE_ATOM (1)
+
+/**
+ * GDK_SELECTION_SECONDARY:
+ *
+ * A #GdkAtom representing the <literal>SECONDARY</literal> selection.
+ */
#define GDK_SELECTION_SECONDARY _GDK_MAKE_ATOM (2)
+
+/**
+ * GDK_SELECTION_CLIPBOARD:
+ *
+ * A #GdkAtom representing the <literal>CLIPBOARD</literal> selection.
+ */
#define GDK_SELECTION_CLIPBOARD _GDK_MAKE_ATOM (69)
+
+/**
+ * GDK_TARGET_BITMAP:
+ *
+ * A #GdkAtom representing the <literal>BITMAP</literal> selection target.
+ */
#define GDK_TARGET_BITMAP _GDK_MAKE_ATOM (5)
+
+/**
+ * GDK_TARGET_COLORMAP:
+ *
+ * A #GdkAtom representing the <literal>COLORMAP</literal> selection target.
+ */
#define GDK_TARGET_COLORMAP _GDK_MAKE_ATOM (7)
+
+/**
+ * GDK_TARGET_DRAWABLE:
+ *
+ * A #GdkAtom representing the <literal>DRAWABLE</literal> selection target.
+ */
#define GDK_TARGET_DRAWABLE _GDK_MAKE_ATOM (17)
+
+/**
+ * GDK_TARGET_PIXMAP:
+ *
+ * A #GdkAtom representing the <literal>PIXMAP</literal> selection target.
+ */
#define GDK_TARGET_PIXMAP _GDK_MAKE_ATOM (20)
+
+/**
+ * GDK_TARGET_STRING:
+ *
+ * A #GdkAtom representing the <literal>STRING</literal> selection target.
+ */
#define GDK_TARGET_STRING _GDK_MAKE_ATOM (31)
+
+/**
+ * GDK_SELECTION_TYPE_ATOM:
+ *
+ * A #GdkAtom representing the <literal>ATOM</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_ATOM _GDK_MAKE_ATOM (4)
+
+/**
+ * GDK_SELECTION_TYPE_BITMAP:
+ *
+ * A #GdkAtom representing the <literal>BITMAP</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_BITMAP _GDK_MAKE_ATOM (5)
+
+/**
+ * GDK_SELECTION_TYPE_COLORMAP:
+ *
+ * A #GdkAtom representing the <literal>COLORMAP</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_COLORMAP _GDK_MAKE_ATOM (7)
+
+/**
+ * GDK_SELECTION_TYPE_DRAWABLE:
+ *
+ * A #GdkAtom representing the <literal>DRAWABLE</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_DRAWABLE _GDK_MAKE_ATOM (17)
+
+/**
+ * GDK_SELECTION_TYPE_INTEGER:
+ *
+ * A #GdkAtom representing the <literal>INTEGER</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_INTEGER _GDK_MAKE_ATOM (19)
+
+/**
+ * GDK_SELECTION_TYPE_PIXMAP:
+ *
+ * A #GdkAtom representing the <literal>PIXMAP</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_PIXMAP _GDK_MAKE_ATOM (20)
+
+/**
+ * GDK_SELECTION_TYPE_WINDOW:
+ *
+ * A #GdkAtom representing the <literal>WINDOW</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_WINDOW _GDK_MAKE_ATOM (33)
+
+/**
+ * GDK_SELECTION_TYPE_STRING:
+ *
+ * A #GdkAtom representing the <literal>STRING</literal> selection type.
+ */
#define GDK_SELECTION_TYPE_STRING _GDK_MAKE_ATOM (31)
/* Selections
@@ -74,6 +169,20 @@ gboolean gdk_selection_owner_set_for_display (GdkDisplay *display,
GdkWindow *gdk_selection_owner_get_for_display (GdkDisplay *display,
GdkAtom selection);
+/**
+ * gdk_selection_convert:
+ * @requestor: a #GdkWindow.
+ * @selection: an atom identifying the selection to get the
+ * contents of.
+ * @target: the form in which to retrieve the selection.
+ * @time_: the timestamp to use when retrieving the
+ * selection. The selection owner may refuse the
+ * request if it did not own the selection at
+ * the time indicated by the timestamp.
+ *
+ * Retrieves the contents of a selection in a given
+ * form.
+ */
void gdk_selection_convert (GdkWindow *requestor,
GdkAtom selection,
GdkAtom target,