struct GtkTargetEntry

struct GtkTargetEntry {
  gchar *target;
  guint  flags;
  guint  info;
};

A GtkTargetEntry structure represents a single type of data than can be supplied for by a widget for a selection or for supplied or received during drag-and-drop. It contains a string representing the drag type, a flags field (used only for drag and drop - see GtkTargetFlags), and an application assigned integer ID. The integer ID will later be passed as a signal parameter for signals like "selection_get". It allows the application to identify the target type without extensive string compares.

struct GtkTargetList

struct 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 opaque.

struct GtkTargetPair

struct GtkTargetPair {
  GdkAtom   target;
  guint     flags;
  guint     info;
};

Internally used structure in the drag-and-drop and selection handling code.

gtk_target_list_new ()

GtkTargetList *     gtk_target_list_new                 (const GtkTargetEntry *targets,
                                                         guint ntargets);

Creates a new GtkTargetList from an array of GtkTargetEntry.

gtk_target_list_ref ()

GtkTargetList *     gtk_target_list_ref                 (GtkTargetList *list);

Increases the reference count of a GtkTargetList by one.

gtk_target_list_unref ()

void                gtk_target_list_unref               (GtkTargetList *list);

Decreases the reference count of a GtkTargetList by one. If the resulting reference count is zero, frees the list.

gtk_target_list_add ()

void                gtk_target_list_add                 (GtkTargetList *list,
                                                         GdkAtom target,
                                                         guint flags,
                                                         guint info);

Appends another target to a GtkTargetList.

gtk_target_list_add_table ()

void                gtk_target_list_add_table           (GtkTargetList *list,
                                                         const GtkTargetEntry *targets,
                                                         guint ntargets);

Prepends a table of GtkTargetEntry to a target list.

gtk_target_list_add_text_targets ()

void                gtk_target_list_add_text_targets    (GtkTargetList *list,
                                                         guint info);

Appends the text targets supported by GtkSelection to the target list. All targets are added with the same info.

Since 2.6

gtk_target_list_add_image_targets ()

void                gtk_target_list_add_image_targets   (GtkTargetList *list,
                                                         guint info,
                                                         gboolean writable);

Appends the image targets supported by GtkSelection to the target list. All targets are added with the same info.

Since 2.6

gtk_target_list_add_uri_targets ()

void                gtk_target_list_add_uri_targets     (GtkTargetList *list,
                                                         guint info);

Appends the URI targets supported by GtkSelection to the target list. All targets are added with the same info.

Since 2.6

gtk_target_list_add_rich_text_targets ()

void                gtk_target_list_add_rich_text_targets
                                                        (GtkTargetList *list,
                                                         guint info,
                                                         gboolean deserializable,
                                                         GtkTextBuffer *buffer);

Appends the rich text targets registered with gtk_text_buffer_register_serialize_format() or gtk_text_buffer_register_deserialize_format() to the target list. All targets are added with the same info.

Since 2.10

gtk_target_list_remove ()

void                gtk_target_list_remove              (GtkTargetList *list,
                                                         GdkAtom target);

Removes a target from a target list.

gtk_target_list_find ()

gboolean            gtk_target_list_find                (GtkTargetList *list,
                                                         GdkAtom target,
                                                         guint *info);

Looks up a given target in a GtkTargetList.

gtk_target_table_free ()

void                gtk_target_table_free               (GtkTargetEntry *targets,
                                                         gint n_targets);

This function frees a target table as returned by gtk_target_table_new_from_list()

Since 2.10

gtk_target_table_new_from_list ()

GtkTargetEntry *    gtk_target_table_new_from_list      (GtkTargetList *list,
                                                         gint *n_targets);

This function creates an GtkTargetEntry array that contains the same targets as the passed list. The returned table is newly allocated and should be freed using gtk_target_table_free() when no longer needed.

Since 2.10

gtk_selection_owner_set ()

gboolean            gtk_selection_owner_set             (GtkWidget *widget,
                                                         GdkAtom selection,
                                                         guint32 time_);

Claims ownership of a given selection for a particular widget, or, if widget is NULL, release ownership of the selection.

gtk_selection_owner_set_for_display ()

gboolean            gtk_selection_owner_set_for_display (GdkDisplay *display,
                                                         GtkWidget *widget,
                                                         GdkAtom selection,
                                                         guint32 time_);

Claim ownership of a given selection for a particular widget, or, if widget is NULL, release ownership of the selection.

Since 2.2

gtk_selection_add_target ()

void                gtk_selection_add_target            (GtkWidget *widget,
                                                         GdkAtom selection,
                                                         GdkAtom target,
                                                         guint info);

Appends a specified target to the list of supported targets for a given widget and selection.

gtk_selection_add_targets ()

void                gtk_selection_add_targets           (GtkWidget *widget,
                                                         GdkAtom selection,
                                                         const GtkTargetEntry *targets,
                                                         guint ntargets);

Prepends a table of targets to the list of supported targets for a given widget and selection.

gtk_selection_clear_targets ()

void                gtk_selection_clear_targets         (GtkWidget *widget,
                                                         GdkAtom selection);

Remove all targets registered for the given selection for the widget.

gtk_selection_convert ()

gboolean            gtk_selection_convert               (GtkWidget *widget,
                                                         GdkAtom selection,
                                                         GdkAtom target,
                                                         guint32 time_);

Requests the contents of a selection. When received, a "selection-received" signal will be generated.

gtk_selection_data_set ()

void                gtk_selection_data_set              (GtkSelectionData *selection_data,
                                                         GdkAtom type,
                                                         gint format,
                                                         const guchar *data,
                                                         gint length);

Stores new data into a GtkSelectionData object. Should only be called from a selection handler callback. Zero-terminates the stored data.

gtk_selection_data_set_text ()

gboolean            gtk_selection_data_set_text         (GtkSelectionData *selection_data,
                                                         const gchar *str,
                                                         gint len);

Sets the contents of the selection from a UTF-8 encoded string. The string is converted to the form determined by selection_data->target.

gtk_selection_data_get_text ()

guchar *            gtk_selection_data_get_text         (GtkSelectionData *selection_data);

Gets the contents of the selection data as a UTF-8 string.

gtk_selection_data_set_pixbuf ()

gboolean            gtk_selection_data_set_pixbuf       (GtkSelectionData *selection_data,
                                                         GdkPixbuf *pixbuf);

Sets the contents of the selection from a GdkPixbuf The pixbuf is converted to the form determined by selection_data->target.

Since 2.6

gtk_selection_data_get_pixbuf ()

GdkPixbuf *         gtk_selection_data_get_pixbuf       (GtkSelectionData *selection_data);

Gets the contents of the selection data as a GdkPixbuf.

Since 2.6

gtk_selection_data_set_uris ()

gboolean            gtk_selection_data_set_uris         (GtkSelectionData *selection_data,
                                                         gchar **uris);

Sets the contents of the selection from a list of URIs. The string is converted to the form determined by selection_data->target.

Since 2.6

gtk_selection_data_get_uris ()

gchar **            gtk_selection_data_get_uris         (GtkSelectionData *selection_data);

Gets the contents of the selection data as array of URIs.

Since 2.6

gtk_selection_data_get_targets ()

gboolean            gtk_selection_data_get_targets      (GtkSelectionData *selection_data,
                                                         GdkAtom **targets,
                                                         gint *n_atoms);

Gets the contents of selection_data as an array of targets. This can be used to interpret the results of getting the standard TARGETS target that is always supplied for any selection.

gtk_selection_data_targets_include_image ()

gboolean            gtk_selection_data_targets_include_image
                                                        (GtkSelectionData *selection_data,
                                                         gboolean writable);

Given a GtkSelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a GdkPixbuf.

Since 2.6

gtk_selection_data_targets_include_text ()

gboolean            gtk_selection_data_targets_include_text
                                                        (GtkSelectionData *selection_data);

Given a GtkSelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide text.

gtk_selection_data_targets_include_uri ()

gboolean            gtk_selection_data_targets_include_uri
                                                        (GtkSelectionData *selection_data);

Given a GtkSelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a list or URIs.

Since 2.10

gtk_selection_data_targets_include_rich_text ()

gboolean            gtk_selection_data_targets_include_rich_text
                                                        (GtkSelectionData *selection_data,
                                                         GtkTextBuffer *buffer);

Given a GtkSelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide rich text.

Since 2.10

gtk_selection_data_get_selection ()

GdkAtom             gtk_selection_data_get_selection    (GtkSelectionData *selection_data);

Retrieves the selection GdkAtom of the selection data.

Since 2.16

gtk_selection_data_get_data ()

const guchar *      gtk_selection_data_get_data         (GtkSelectionData *selection_data);

Retrieves the raw data of the selection.

Since 2.14

gtk_selection_data_get_length ()

gint                gtk_selection_data_get_length       (GtkSelectionData *selection_data);

Retrieves the length of the raw data of the selection.

Since 2.14

gtk_selection_data_get_data_type ()

GdkAtom             gtk_selection_data_get_data_type    (GtkSelectionData *selection_data);

Retrieves the data type of the selection.

Since 2.14

gtk_selection_data_get_display ()

GdkDisplay *        gtk_selection_data_get_display      (GtkSelectionData *selection_data);

Retrieves the display of the selection.

Since 2.14

gtk_selection_data_get_format ()

gint                gtk_selection_data_get_format       (GtkSelectionData *selection_data);

Retrieves the format of the selection.

Since 2.14

gtk_selection_data_get_target ()

GdkAtom             gtk_selection_data_get_target       (GtkSelectionData *selection_data);

Retrieves the target of the selection.

Since 2.14

gtk_targets_include_image ()

gboolean            gtk_targets_include_image           (GdkAtom *targets,
                                                         gint n_targets,
                                                         gboolean writable);

Determines if any of the targets in targets can be used to provide a GdkPixbuf.

Since 2.10

gtk_targets_include_text ()

gboolean            gtk_targets_include_text            (GdkAtom *targets,
                                                         gint n_targets);

Determines if any of the targets in targets can be used to provide text.

Since 2.10

gtk_targets_include_uri ()

gboolean            gtk_targets_include_uri             (GdkAtom *targets,
                                                         gint n_targets);

Determines if any of the targets in targets can be used to provide an uri list.

Since 2.10

gtk_targets_include_rich_text ()

gboolean            gtk_targets_include_rich_text       (GdkAtom *targets,
                                                         gint n_targets,
                                                         GtkTextBuffer *buffer);

Determines if any of the targets in targets can be used to provide rich text.

Since 2.10

gtk_selection_remove_all ()

void                gtk_selection_remove_all            (GtkWidget *widget);

Removes all handlers and unsets ownership of all selections for a widget. Called when widget is being destroyed. This function will not generally be called by applications.

gtk_selection_clear ()

gboolean            gtk_selection_clear                 (GtkWidget *widget,
                                                         GdkEventSelection *event);

The default handler for the "selection-clear-event" signal.

Since 2.2

gtk_selection_data_copy ()

GtkSelectionData *  gtk_selection_data_copy             (GtkSelectionData *data);

Makes a copy of a GtkSelectionData structure and its data.

gtk_selection_data_free ()

void                gtk_selection_data_free             (GtkSelectionData *data);

Frees a GtkSelectionData structure returned from gtk_selection_data_copy().