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_remove ##### -->
 132 <para>
 133 Removes a target from a target list.
 134 </para>
 135
 136 @list: a #GtkTargetList
 137 @target: the interned atom representing the target
 138
 139
 140 <!-- ##### FUNCTION gtk_target_list_find ##### -->
 141 <para>
 142 Looks up a given target in a #GtkTargetList.
 143 </para>
 144
 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
 149
 150
 151 <!-- ##### FUNCTION gtk_selection_owner_set ##### -->
 152 <para>
 153 Claims ownership of a given selection for a particular widget,
 154 or, if @widget is %NULL, release ownership of the selection.
 155 </para>
 156
 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
 161
 162
 163 <!-- ##### FUNCTION gtk_selection_add_target ##### -->
 164 <para>
 165 Adds specified target to the list of supported targets for a
 166 given widget and selection.
 167 </para>
 168
 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.
 173
 174
 175 <!-- ##### FUNCTION gtk_selection_add_targets ##### -->
 176 <para>
 177 Adds a table of targets to the list of supported targets
 178 for a given widget and selection.
 179 </para>
 180
 181 @widget: a #GtkWidget
 182 @selection: the selection
 183 @targets: a table of targets to add
 184 @ntargets: number of entries in @targets
 185
 186
 187 <!-- ##### FUNCTION gtk_selection_clear_targets ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @widget:
 193 @selection:
 194
 195
 196 <!-- ##### FUNCTION gtk_selection_convert ##### -->
 197 <para>
 198 Requests the contents of a selection. When received,
 199 a "selection_received" signal will be generated.
 200 </para>
 201
 202 @widget: The widget which acts as requestor
 203 @selection: Which selection to get
 204 @target: Form of information desired (e.g., STRING)
 205 @time: Time of request (usually of triggering event)
 206        In emergency, you could use #GDK_CURRENT_TIME
 207 @Returns: %TRUE if requested succeeded. %FALSE if we could not process
 208           request. (e.g., there was already a request in process for
 209           this widget).
 210
 211
 212 <!-- ##### FUNCTION gtk_selection_data_set ##### -->
 213 <para>
 214 Stores new data into a #GtkSelectionData object. Should
 215 <emphasis>only</emphasis> be called from a selection handler callback.
 216 Zero-terminates the stored data.
 217 </para>
 218
 219 @selection_data:
 220 @type: the type of selection data
 221 @format: format (number of bits in a unit)
 222 @data: pointer to the data (will be copied)
 223 @length: length of the data
 224
 225
 226 <!-- ##### FUNCTION gtk_selection_data_set_text ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @selection_data:
 232 @str:
 233 @len:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION gtk_selection_data_get_text ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @selection_data:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gtk_selection_data_get_targets ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @selection_data:
 252 @targets:
 253 @n_atoms:
 254 @Returns:
 255
 256
 257 <!-- ##### FUNCTION gtk_selection_data_targets_include_text ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @selection_data:
 263 @Returns:
 264
 265
 266 <!-- ##### FUNCTION gtk_selection_remove_all ##### -->
 267 <para>
 268 Removes all handlers and unsets ownership of all
 269 selections for a widget. Called when widget is being
 270 destroyed. This function will not generally be
 271 called by applications.
 272 </para>
 273
 274 @widget: a #GtkWidget
 275
 276
 277 <!-- ##### FUNCTION gtk_selection_data_copy ##### -->
 278 <para>
 279 Makes a copy of a #GtkSelectionData structure and its data.
 280 </para>
 281
 282 @data: a pointer to a #GtkSelectionData structure.
 283 @Returns: a pointer to a copy of @data.
 284
 285
 286 <!-- ##### FUNCTION gtk_selection_data_free ##### -->
 287 <para>
 288 Frees a #GtkSelectionData structure returned from
 289 gtk_selection_data_copy().
 290 </para>
 291
 292 @data: a pointer to a #GtkSelectionData structure.
 293
 294