Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkselection.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Selections
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Functions for handling inter-process communication via selections
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8
   9 <para>
  10 The selection mechanism provides the basis for different types
  11 of communication 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.
  15 </para>
  16 <para>
  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.
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28 <variablelist>
  29
  30 <varlistentry>
  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>
  38 </varlistentry>
  39
  40 </variablelist>
  41
  42 </para>
  43
  44 <!-- ##### STRUCT GtkTargetEntry ##### -->
  45 <para>
  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.
  55 </para>
  56
  57 @target:
  58 @flags:
  59 @info:
  60
  61 <!-- ##### STRUCT GtkTargetList ##### -->
  62 <para>
  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
  67 opaque.
  68 </para>
  69
  70 @list:
  71 @ref_count:
  72
  73 <!-- ##### STRUCT GtkTargetPair ##### -->
  74 <para>
  75 Internally used structure in the drag-and-drop and
  76 selection handling code.
  77 </para>
  78
  79 @target:
  80 @flags:
  81 @info:
  82
  83 <!-- ##### FUNCTION gtk_target_list_new ##### -->
  84 <para>
  85 Creates a new #GtkTargetList from an array of #GtkTargetEntry.
  86 </para>
  87
  88 @targets: Pointer to an array of #GtkTargetEntry
  89 @ntargets: number of entries in @targets.
  90 @Returns: the new #GtkTargetList.
  91
  92
  93 <!-- ##### FUNCTION gtk_target_list_ref ##### -->
  94 <para>
  95 Increases the reference count of a #GtkTargetList by one.
  96 </para>
  97
  98 @list: a #GtkTargetList
  99
 100
 101 <!-- ##### FUNCTION gtk_target_list_unref ##### -->
 102 <para>
 103 Decreases the reference count of a #GtkTargetList by one.
 104 If the resulting reference count is zero, frees the list.
 105 </para>
 106
 107 @list: a #GtkTargetList
 108
 109
 110 <!-- ##### FUNCTION gtk_target_list_add ##### -->
 111 <para>
 112 Adds another target to a #GtkTargetList.
 113 </para>
 114
 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
 119
 120
 121 <!-- ##### FUNCTION gtk_target_list_add_table ##### -->
 122 <para>
 123 Adds a table of #GtkTargetEntry into a target list.
 124 </para>
 125
 126 @list: a #GtkTargetList
 127 @targets: the table of #GtkTargetEntry
 128 @ntargets: number of targets in the table
 129
 130
 131 <!-- ##### FUNCTION gtk_target_list_add_text_targets ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @list:
 137
 138
 139 <!-- ##### FUNCTION gtk_target_list_remove ##### -->
 140 <para>
 141 Removes a target from a target list.
 142 </para>
 143
 144 @list: a #GtkTargetList
 145 @target: the interned atom representing the target
 146
 147
 148 <!-- ##### FUNCTION gtk_target_list_find ##### -->
 149 <para>
 150 Looks up a given target in a #GtkTargetList.
 151 </para>
 152
 153 @list: a #GtkTargetList
 154 @target: an interned atom representing the target to search for
 155 @info: a pointer to the location to store application info for target
 156 @Returns: %TRUE if the target was found, otherwise %FALSE
 157
 158
 159 <!-- ##### FUNCTION gtk_selection_owner_set ##### -->
 160 <para>
 161 </para>
 162
 163 @widget:
 164 @selection:
 165 @time_:
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION gtk_selection_owner_set_for_display ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @display:
 175 @widget:
 176 @selection:
 177 @time_:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION gtk_selection_add_target ##### -->
 182 <para>
 183 Adds specified target to the list of supported targets for a
 184 given widget and selection.
 185 </para>
 186
 187 @widget: a #GtkTarget
 188 @selection: the selection
 189 @target: target to add.
 190 @info: A unsigned integer which will be passed back to the application.
 191
 192
 193 <!-- ##### FUNCTION gtk_selection_add_targets ##### -->
 194 <para>
 195 Adds a table of targets to the list of supported targets
 196 for a given widget and selection.
 197 </para>
 198
 199 @widget: a #GtkWidget
 200 @selection: the selection
 201 @targets: a table of targets to add
 202 @ntargets: number of entries in @targets
 203
 204
 205 <!-- ##### FUNCTION gtk_selection_clear_targets ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @widget:
 211 @selection:
 212
 213
 214 <!-- ##### FUNCTION gtk_selection_convert ##### -->
 215 <para>
 216 Requests the contents of a selection. When received,
 217 a "selection_received" signal will be generated.
 218 </para>
 219
 220 @widget: The widget which acts as requestor
 221 @selection: Which selection to get
 222 @target: Form of information desired (e.g., STRING)
 223 @time_: Time of request (usually of triggering event)
 224        In emergency, you could use #GDK_CURRENT_TIME
 225 @Returns: %TRUE if requested succeeded. %FALSE if we could not process
 226           request. (e.g., there was already a request in process for
 227           this widget).
 228
 229
 230 <!-- ##### FUNCTION gtk_selection_data_set ##### -->
 231 <para>
 232 Stores new data into a #GtkSelectionData object. Should
 233 <emphasis>only</emphasis> be called from a selection handler callback.
 234 Zero-terminates the stored data.
 235 </para>
 236
 237 @selection_data:
 238 @type: the type of selection data
 239 @format: format (number of bits in a unit)
 240 @data: pointer to the data (will be copied)
 241 @length: length of the data
 242
 243
 244 <!-- ##### FUNCTION gtk_selection_data_set_text ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @selection_data:
 250 @str:
 251 @len:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION gtk_selection_data_get_text ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @selection_data:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gtk_selection_data_get_targets ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @selection_data:
 270 @targets:
 271 @n_atoms:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION gtk_selection_data_targets_include_text ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @selection_data:
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION gtk_selection_remove_all ##### -->
 285 <para>
 286 Removes all handlers and unsets ownership of all
 287 selections for a widget. Called when widget is being
 288 destroyed. This function will not generally be
 289 called by applications.
 290 </para>
 291
 292 @widget: a #GtkWidget
 293
 294
 295 <!-- ##### FUNCTION gtk_selection_clear ##### -->
 296 <para>
 297 </para>
 298
 299 @widget:
 300 @event:
 301 @Returns:
 302
 303
 304 <!-- ##### FUNCTION gtk_selection_data_copy ##### -->
 305 <para>
 306 Makes a copy of a #GtkSelectionData structure and its data.
 307 </para>
 308
 309 @data: a pointer to a #GtkSelectionData structure.
 310 @Returns: a pointer to a copy of @data.
 311
 312
 313 <!-- ##### FUNCTION gtk_selection_data_free ##### -->
 314 <para>
 315 Frees a #GtkSelectionData structure returned from
 316 gtk_selection_data_copy().
 317 </para>
 318
 319 @data: a pointer to a #GtkSelectionData structure.
 320
 321