1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 Functions for handling inter-process communication via selections.
7 <!-- ##### SECTION Long_Description ##### -->
10 The selection mechanism provides the basis for different types
11 of IPC between processes. In particular, drag and drop and
12 #GtkClipboard work via selections. You will very seldom or
13 never need to use most of the functions in this section directly;
14 #GtkClipboard provides a nicer interface to the same functionality.
17 Some of the datatypes defined this section are used in
18 the #GtkClipboard and drag-and-drop API's as well. The
19 #GtkTargetEntry structure and #GtkTargetList objects represent
20 lists of data types that are supported when sending or
21 receiving data. The #GtkSelectionData object is used to
22 store a chunk of data along with the data type and other
23 associated information.
26 <!-- ##### SECTION See_Also ##### -->
31 <term>#GtkWidget</term>
32 <listitem><para>Much of the operation of selections happens via
33 signals for #GtkWidget. In particular, if you are
34 using the functions in this section, you may need
35 to pay attention to ::selection_get,
36 ::selection_received, and :selection_clear_event
37 signals.</para></listitem>
44 <!-- ##### STRUCT GtkTargetEntry ##### -->
46 A #GtkTargetEntry structure represents a single type of
47 data than can be supplied for by a widget for a selection
48 or for supplied or received during drag-and-drop. It
49 contains a string representing the drag type, a flags
50 field (used only for drag and drop - see #GtkTargetFlags),
51 and an application assigned integer ID. The integer
52 ID will later be passed as a signal parameter for signals
53 like "selection_get". It allows the application to identify
54 the target type without extensive string compares.
61 <!-- ##### STRUCT GtkTargetList ##### -->
63 A #GtkTargetList structure is a reference counted list
64 of #GtkTargetPair. It is used to represent the same
65 information as a table of #GtkTargetEntry, but in
66 an efficient form. This structure should be treated as
73 <!-- ##### STRUCT GtkTargetPair ##### -->
75 Internally used structure in the drag-and-drop and
76 selection handling code.
83 <!-- ##### FUNCTION gtk_target_list_new ##### -->
85 Create a new #GtkTargetList from an array of #GtkTargetEntry.
88 @targets: Pointer to an array of #GtkTargetEntry
89 @ntargets: number of entries in @targets.
90 @Returns: the new #GtkTargetList.
93 <!-- ##### FUNCTION gtk_target_list_ref ##### -->
95 Increase the reference count of a #GtkTargetList by one.
98 @list: a #GtkTargetList
101 <!-- ##### FUNCTION gtk_target_list_unref ##### -->
103 Decrease the reference count of a #GtkTargetList by one.
104 If the resulting reference count is zero, free the list.
107 @list: a #GtkTargetList
110 <!-- ##### FUNCTION gtk_target_list_add ##### -->
112 Add another target to a #GtkTargetList
115 @list: a #GtkTargetList
116 @target: the interned atom representing the target
117 @flags: the flags for this target
118 @info: an ID that will be passed back to the application
121 <!-- ##### FUNCTION gtk_target_list_add_table ##### -->
123 Add a table of #GtkTargetEntry into a target list
126 @list: a #GtkTargetList
127 @targets: the table of #GtkTargetEntry
128 @ntargets: number of targets in the table
131 <!-- ##### FUNCTION gtk_target_list_remove ##### -->
133 Remove a target from a target list
136 @list: a #GtkTargetList
137 @target: the interned atom representing the target
140 <!-- ##### FUNCTION gtk_target_list_find ##### -->
142 Look up a given target in a #GtkTargetList
145 @list: a #GtkTargetList
146 @target: an interned atom representing the target to search for
147 @info: a pointer to the location to store application info for target
148 @Returns: %TRUE if the target was found, otherwise %FALSE
151 <!-- ##### FUNCTION gtk_selection_owner_set ##### -->
153 Claim ownership of a given selection for a particular widget,
154 or, if @widget is %NULL, release ownership of the selection.
157 @widget: a #GtkWidget, or %NULL.
158 @selection: an interned atom representing the selection to claim
159 @time: the time stamp for claiming the selection
160 @Returns: %TRUE if the operation succeeded
163 <!-- ##### FUNCTION gtk_selection_add_target ##### -->
165 Add specified target to the list of supported targets for a
166 given widget and selection.
169 @widget: a #GtkTarget
170 @selection: the selection
171 @target: target to add.
172 @info: A unsigned integer which will be passed back to the application.
175 <!-- ##### FUNCTION gtk_selection_add_targets ##### -->
177 Add a table of targets to the list of supported targets
178 for a given widget and selection.
181 @widget: a #GtkWidget
182 @selection: the selection
183 @targets: a table of targets to add
184 @ntargets: number of entries in @targets
187 <!-- ##### FUNCTION gtk_selection_convert ##### -->
189 Request the contents of a selection. When received,
190 a "selection_received" signal will be generated.
193 @widget: The widget which acts as requestor
194 @selection: Which selection to get
195 @target: Form of information desired (e.g., STRING)
196 @time: Time of request (usually of triggering event)
197 In emergency, you could use GDK_CURRENT_TIME
198 @Returns: TRUE if requested succeeded. FALSE if we could not process
199 request. (e.g., there was already a request in process for
203 <!-- ##### FUNCTION gtk_selection_data_set ##### -->
205 Store new data into a GtkSelectionData object. Should
206 _only_ by called from a selection handler callback.
207 Null terminates the stored data.
211 @type: the type of selection data
212 @format: format (number of bits in a unit)
213 @data: pointer to the data (will be copied)
214 @length: length of the data
217 <!-- ##### FUNCTION gtk_selection_remove_all ##### -->
219 Removes all handlers and unsets ownership of all
220 selections for a widget. Called when widget is being
221 destroyed. This function will not generally be
222 called by applications.
225 @widget: a #GtkWidget
228 <!-- ##### FUNCTION gtk_selection_data_copy ##### -->
230 Make a copy of a #GtkSelection data structure and its
234 @data: a pointer to a #GtkSelectionData structure.
235 @Returns: a pointer to a copy of @data.
238 <!-- ##### FUNCTION gtk_selection_data_free ##### -->
240 Free a #GtkSelectionData structure returned from
241 gtk_selection_data_copy().
244 @data: a pointer to a #GtkSelectionData structure.
247 <!-- ##### FUNCTION gtk_selection_clear ##### -->
257 <!-- ##### FUNCTION gtk_selection_incr_event ##### -->
267 <!-- ##### FUNCTION gtk_selection_notify ##### -->
277 <!-- ##### FUNCTION gtk_selection_property_notify ##### -->
287 <!-- ##### FUNCTION gtk_selection_request ##### -->