[gtk+] docs: add docs for GtkTargetPair
- From: William Jon McCann <mccann src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] docs: add docs for GtkTargetPair
- Date: Mon, 20 Jan 2014 20:19:02 +0000 (UTC)
commit 29f2578cca2d929280c112ddd90a754930ec9729
Author: William Jon McCann <william jon mccann gmail com>
Date: Mon Jan 20 15:18:21 2014 -0500
docs: add docs for GtkTargetPair
gtk/gtkselection.h | 26 +++++++++++++++++++++++---
gtk/gtkselectionprivate.h | 11 ++---------
2 files changed, 25 insertions(+), 12 deletions(-)
---
diff --git a/gtk/gtkselection.h b/gtk/gtkselection.h
index 2bc5fe0..af474f3 100644
--- a/gtk/gtkselection.h
+++ b/gtk/gtkselection.h
@@ -34,13 +34,33 @@
G_BEGIN_DECLS
+typedef struct _GtkTargetPair GtkTargetPair;
+
+/**
+ * GtkTargetPair:
+ * @target: #GdkAtom representation of the target type
+ * @flags: #GtkTargetFlags for DND
+ * @info: an application-assigned integer ID which will
+ * get passed as a parameter to e.g the #GtkWidget::selection-get
+ * signal. It allows the application to identify the target
+ * type without extensive string compares.
+ *
+ * A #GtkTargetPair structure is used to represent the same
+ * information as a table of #GtkTargetEntry, but in
+ * an efficient form.
+ */
+struct _GtkTargetPair
+{
+ GdkAtom target;
+ guint flags;
+ guint info;
+};
+
/**
* GtkTargetList:
*
* A #GtkTargetList structure is a reference counted list
- * of #GtkTargetPair. It is used to represent the same
- * information as a table of #GtkTargetEntry, but in
- * an efficient form. This structure should be treated as
+ * of #GtkTargetPair. This structure should be treated as
* opaque.
*/
typedef struct _GtkTargetList GtkTargetList;
diff --git a/gtk/gtkselectionprivate.h b/gtk/gtkselectionprivate.h
index 0b965f5..8d557e8 100644
--- a/gtk/gtkselectionprivate.h
+++ b/gtk/gtkselectionprivate.h
@@ -37,6 +37,7 @@ G_BEGIN_DECLS
struct _GtkSelectionData
{
+ /*< private >*/
GdkAtom selection;
GdkAtom target;
GdkAtom type;
@@ -48,19 +49,11 @@ struct _GtkSelectionData
struct _GtkTargetList
{
+ /*< private >*/
GList *list;
guint ref_count;
};
-typedef struct _GtkTargetPair GtkTargetPair;
-struct _GtkTargetPair
-{
- GdkAtom target;
- guint flags;
- guint info;
-};
-
-
gboolean _gtk_selection_clear (GtkWidget *widget,
GdkEventSelection *event);
gboolean _gtk_selection_request (GtkWidget *widget,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]