]> Pileus Git - ~andy/gtk/blobdiff - gdk/gdkselection.h
Add gdk_frame_timings_get/set_slept_before()
[~andy/gtk] / gdk / gdkselection.h
index 1a96214425827a952b42c7f63c0a33f58e247a02..ae964e78f5d47b125b699646cf37d1b257c24334 100644 (file)
@@ -12,9 +12,7 @@
  * 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, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
-#error "Only <gdk/gdk.h> can be included directly."
-#endif
-
 #ifndef __GDK_SELECTION_H__
 #define __GDK_SELECTION_H__
 
+#if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
+#error "Only <gdk/gdk.h> can be included directly."
+#endif
+
 #include <gdk/gdktypes.h>
 
 G_BEGIN_DECLS
@@ -38,30 +36,117 @@ 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)
-#define GDK_SELECTION_TYPE_PIXMAP      _GDK_MAKE_ATOM (20)
-#define GDK_SELECTION_TYPE_WINDOW      _GDK_MAKE_ATOM (33)
-#define GDK_SELECTION_TYPE_STRING      _GDK_MAKE_ATOM (31)
 
-#ifndef GDK_DISABLE_DEPRECATED
+/**
+ * GDK_SELECTION_TYPE_PIXMAP:
+ *
+ * A #GdkAtom representing the <literal>PIXMAP</literal> selection type.
+ */
+#define GDK_SELECTION_TYPE_PIXMAP      _GDK_MAKE_ATOM (20)
 
-typedef GdkAtom GdkSelection;
-typedef GdkAtom GdkTarget;
-typedef GdkAtom GdkSelectionType;
+/**
+ * GDK_SELECTION_TYPE_WINDOW:
+ *
+ * A #GdkAtom representing the <literal>WINDOW</literal> selection type.
+ */
+#define GDK_SELECTION_TYPE_WINDOW      _GDK_MAKE_ATOM (33)
 
-#endif /* GDK_DISABLE_DEPRECATED */
+/**
+ * GDK_SELECTION_TYPE_STRING:
+ *
+ * A #GdkAtom representing the <literal>STRING</literal> selection type.
+ */
+#define GDK_SELECTION_TYPE_STRING      _GDK_MAKE_ATOM (31)
 
 /* Selections
  */
@@ -82,6 +167,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,
@@ -91,16 +190,14 @@ gint       gdk_selection_property_get (GdkWindow  *requestor,
                                       GdkAtom    *prop_type,
                                       gint       *prop_format);
 
-#ifndef GDK_MULTIHEAD_SAFE
-void      gdk_selection_send_notify (GdkNativeWindow requestor,
+void      gdk_selection_send_notify (GdkWindow      *requestor,
                                      GdkAtom         selection,
                                      GdkAtom         target,
                                      GdkAtom         property,
                                      guint32         time_);
-#endif /* GDK_MULTIHEAD_SAFE */
 
 void       gdk_selection_send_notify_for_display (GdkDisplay      *display,
-                                                 GdkNativeWindow  requestor,
+                                                 GdkWindow       *requestor,
                                                  GdkAtom          selection,
                                                  GdkAtom          target,
                                                  GdkAtom          property,