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

   1 <!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
   2 <para>
   3
   4 </para>
   5
   6
   7 <!-- ##### FUNCTION gdk_regions_xor ##### -->
   8 <para>
   9 Returns the difference between the union and the intersection of two regions.
  10 This is a region containing the pixels that are in one of the source regions,
  11 but which are not in both.
  12 </para>
  13
  14 @source1: a #GdkRegion.
  15 @source2: a #GdkRegion.
  16 @Returns: the difference between the union and the intersection of @source1
  17 and @source2.
  18
  19 <!-- ##### FUNCTION gdk_input_motion_events ##### -->
  20 <para>
  21 Retrieves the motion history for a given device/window pair.
  22 </para>
  23
  24 @window: a #GdkWindow.
  25 @deviceid: the device for which to retrieve motion history.
  26 @start: the start time.
  27 @stop: the stop time.
  28 @nevents_return: location to store the number of events returned.
  29 @Returns: a newly allocated array containing all the events
  30           from @start to @stop. This array should be freed
  31           with g_free() when you are finished using it.
  32
  33 <!-- ##### SECTION ./tmpl/gdkkeys.sgml:See_Also ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39 <!-- ##### FUNCTION gdk_keymap_translate_keyboard_state ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @keymap:
  45 @hardware_keycode:
  46 @state:
  47 @group:
  48 @keyval:
  49 @effective_group:
  50 @level:
  51 @unused_modifiers:
  52 @Returns:
  53
  54 <!-- ##### FUNCTION gdk_keymap_get_entries_for_keyval ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @keymap:
  60 @keyval:
  61 @keys:
  62 @n_keys:
  63 @Returns:
  64
  65 <!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
  66 <para>
  67
  68 </para>
  69
  70
  71 <!-- ##### SECTION ./tmpl/gdkkeys.sgml:Long_Description ##### -->
  72 <para>
  73
  74 </para>
  75
  76
  77 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Short_Description ##### -->
  78
  79
  80
  81 <!-- ##### STRUCT GdkDeviceInfo ##### -->
  82 <para>
  83 The #GdkDeviceInfo structure contains information about a
  84 device. It has the following fields:
  85 </para>
  86
  87 @deviceid: a unique integer ID for this device.
  88 @name: the human-readable name for the device.
  89 @source: the type of device.
  90 @mode: a value indicating whether the device is enabled and
  91        how the device coordinates map to the screen.
  92 @has_cursor: if %TRUE, a cursor will be displayed indicating
  93              the current on-screen location to the user. Otherwise,
  94              the application is responsible for drawing a cursor
  95              itself.
  96 @num_axes: the number of axes for this device.
  97 @axes: a pointer to an array of GdkAxisUse values which
  98        give the mapping of axes onto the possible valuators
  99        for a GDK device.
 100 @num_keys: the number of macro buttons.
 101 @keys: a pointer to an array of #GdkDeviceKey structures
 102        which describe what key press events are generated
 103        for each macro button.
 104
 105 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
 106 Pango Interaction
 107
 108
 109 <!-- ##### FUNCTION gdk_regions_union ##### -->
 110 <para>
 111 Returns the union of two regions.
 112 This is all pixels in either of @source1 or @source2.
 113 </para>
 114
 115 @source1: a #GdkRegion.
 116 @source2: a #GdkRegion.
 117 @Returns: the union of @source1 and @source2.
 118
 119 <!-- ##### FUNCTION gdk_drawable_get_visible_region ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @drawable:
 125 @Returns:
 126
 127 <!-- ##### FUNCTION gdk_colormap_query_color ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @colormap:
 133 @pixel:
 134 @result:
 135
 136 <!-- ##### FUNCTION gdk_event_get_state ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @event:
 142 @state:
 143 @Returns:
 144
 145 <!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
 146
 147
 148
 149 <!-- ##### FUNCTION gdk_window_get_decorations ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @window:
 155 @decorations:
 156 @Returns:
 157
 158 <!-- ##### FUNCTION gdk_keymap_get_entries_for_keycode ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @keymap:
 164 @hardware_keycode:
 165 @keys:
 166 @keyvals:
 167 @n_entries:
 168 @Returns:
 169
 170 <!-- ##### FUNCTION gdk_drawable_get_clip_region ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @drawable:
 176 @Returns:
 177
 178 <!-- ##### FUNCTION gdk_input_set_key ##### -->
 179 <para>
 180 Sets the key event generated when a macro button is pressed.
 181 </para>
 182
 183 @deviceid: the device to configure.
 184 @index: the index of the macro button.
 185 @keyval: the key value for the #GdkKeypressEvent to generate.
 186          (a value of 0 means no event will be generated.)
 187 @modifiers: the modifier field for the generated
 188             #GdkKeyPressEvent.
 189
 190 <!-- ##### FUNCTION gdk_input_list_devices ##### -->
 191 <para>
 192 Lists all available input devices, along with their
 193 configuration information.
 194 </para>
 195
 196 @Returns: A #GList of #GdkDeviceInfo structures. This list
 197           is internal data of GTK+ and should not be modified
 198           or freed.
 199
 200 <!-- ##### STRUCT GdkKeymap ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @parent_instance:
 206
 207 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
 208 <para>
 209
 210 </para>
 211
 212
 213 <!-- ##### ENUM GdkPixbufAlphaMode ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @GDK_PIXBUF_ALPHA_BILEVEL:
 219 @GDK_PIXBUF_ALPHA_FULL:
 220
 221 <!-- ##### FUNCTION gdk_regions_subtract ##### -->
 222 <para>
 223 Subtracts one region from another.
 224 The result is a region containing all the pixels which are in @source1, but
 225 which are not in @source2.
 226 </para>
 227
 228 @source1: a #GdkRegion.
 229 @source2: a #GdkRegion to subtract from @source1.
 230 @Returns: @source1 - @source2.
 231
 232 <!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
 233 <para>
 234 Returns information about the current position of the pointer
 235 within a window, including extended device information.
 236 Any of the return parameters may be %NULL, in which case,
 237 they will be ignored.
 238 </para>
 239
 240 @window: a #GdkWindow.
 241 @deviceid: a device ID.
 242 @x: location to store current x postion.
 243 @y: location to store current y postion.
 244 @pressure: location to store current pressure.
 245 @xtilt: location to store current tilt in the x direction.
 246 @ytilt: location to store current tilt in the y direction.
 247 @mask: location to store the current modifier state.
 248
 249 <!-- ##### SECTION ./tmpl/gdkkeys.sgml:Short_Description ##### -->
 250
 251
 252
 253 <!-- ##### MACRO GDK_CORE_POINTER ##### -->
 254 <para>
 255 This macro contains an integer value representing
 256 the device ID for the core pointer device.
 257 </para>
 258
 259
 260 <!-- ##### FUNCTION gdk_input_set_axes ##### -->
 261 <para>
 262 Sets the mapping of the axes (valuators) of a device
 263 onto the predefined valuator types that GTK+ understands.
 264 </para>
 265
 266 @deviceid: the device to configure.
 267 @axes: an array of GdkAxisUse. This length of this array
 268        must match the number of axes for the device.
 269
 270 <!-- ##### STRUCT GdkSpan ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @x:
 276 @y:
 277 @width:
 278
 279 <!-- ##### STRUCT GdkKeyInfo ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @keycode:
 285 @group:
 286 @level:
 287
 288 <!-- ##### FUNCTION gdk_input_set_source ##### -->
 289 <para>
 290 Sets the source type for a device.
 291 </para>
 292
 293 @deviceid: the device to configure
 294 @source: the new source type.
 295
 296 <!-- ##### FUNCTION gdk_region_spans_intersect_foreach ##### -->
 297 <para>
 298 Intersects a set of spans with a region and call a user specified
 299 function for each resulting spanline. This function is a lot more effective
 300 if the spans are sorted.
 301 </para>
 302
 303 @region: The region to intersect against.
 304 @spans: Array of spans to intersect.
 305 @n_spans: Number of spans.
 306 @sorted: True if the spans are sorted in increasing y order.
 307 @function: The function to call for each intersected spanline.
 308 @data: Opaque user data passed to function.
 309
 310 <!-- ##### FUNCTION gdk_keymap_get_default ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @Returns:
 316
 317 <!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
 318 Points, Rectangles and Regions
 319
 320
 321 <!-- ##### FUNCTION gdk_regions_intersect ##### -->
 322 <para>
 323 Returns the intersection of two regions.
 324 </para>
 325
 326 @source1: a #GdkRegion.
 327 @source2: a #GdkRegion.
 328 @Returns: the intersection of @source1 and @source2.
 329
 330 <!-- ##### FUNCTION gdk_keymap_lookup_key ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @keymap:
 336 @key:
 337 @Returns:
 338
 339 <!-- ##### USER_FUNCTION GdkSpanFunc ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @span: The intersected part of the span.
 345 @data: Opaque data passed by user.
 346
 347 <!-- ##### STRUCT GdkKeymapClass ##### -->
 348 <para>
 349
 350 </para>
 351
 352
 353 <!-- ##### SECTION ./tmpl/gdkkeys.sgml:Title ##### -->
 354 Keyboard Handling
 355
 356
 357 <!-- ##### STRUCT GdkKeymapKey ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @keycode:
 363 @group:
 364 @level:
 365
 366 <!-- ##### FUNCTION gdk_input_set_mode ##### -->
 367 <para>
 368 Enables or disables a device, and determines how the
 369 device maps onto the screen.
 370 </para>
 371
 372 @deviceid: the device to configure.
 373 @mode: the new mode.
 374 @Returns: %TRUE if the device supports the given mode, otherwise
 375           %FALSE and the device's mode is unchanged.
 376
 377 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
 378 <para>
 379
 380 </para>
 381
 382