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

   1 <!-- ##### FUNCTION gdk_input_set_mode ##### -->
   2 <para>
   3 Enables or disables a device, and determines how the
   4 device maps onto the screen.
   5 </para>
   6
   7 @deviceid: the device to configure.
   8 @mode: the new mode.
   9 @Returns: %TRUE if the device supports the given mode, otherwise
  10           %FALSE and the device's mode is unchanged.
  11
  12 <!-- ##### FUNCTION gdk_input_set_key ##### -->
  13 <para>
  14 Sets the key event generated when a macro button is pressed.
  15 </para>
  16
  17 @deviceid: the device to configure.
  18 @index: the index of the macro button.
  19 @keyval: the key value for the #GdkKeypressEvent to generate.
  20          (a value of 0 means no event will be generated.)
  21 @modifiers: the modifier field for the generated
  22             #GdkKeyPressEvent.
  23
  24 <!-- ##### FUNCTION gdk_regions_intersect ##### -->
  25 <para>
  26 Returns the intersection of two regions.
  27 </para>
  28
  29 @source1: a #GdkRegion.
  30 @source2: a #GdkRegion.
  31 @Returns: the intersection of @source1 and @source2.
  32
  33 <!-- ##### FUNCTION gdk_regions_xor ##### -->
  34 <para>
  35 Returns the difference between the union and the intersection of two regions.
  36 This is a region containing the pixels that are in one of the source regions,
  37 but which are not in both.
  38 </para>
  39
  40 @source1: a #GdkRegion.
  41 @source2: a #GdkRegion.
  42 @Returns: the difference between the union and the intersection of @source1
  43 and @source2.
  44
  45 <!-- ##### FUNCTION gdk_regions_subtract ##### -->
  46 <para>
  47 Subtracts one region from another.
  48 The result is a region containing all the pixels which are in @source1, but
  49 which are not in @source2.
  50 </para>
  51
  52 @source1: a #GdkRegion.
  53 @source2: a #GdkRegion to subtract from @source1.
  54 @Returns: @source1 - @source2.
  55
  56 <!-- ##### FUNCTION gdk_input_list_devices ##### -->
  57 <para>
  58 Lists all available input devices, along with their
  59 configuration information.
  60 </para>
  61
  62 @Returns: A #GList of #GdkDeviceInfo structures. This list
  63           is internal data of GTK+ and should not be modified
  64           or freed.
  65
  66 <!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
  67
  68
  69
  70 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
  71 <para>
  72
  73 </para>
  74
  75
  76 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Short_Description ##### -->
  77
  78
  79
  80 <!-- ##### MACRO GDK_CORE_POINTER ##### -->
  81 <para>
  82 This macro contains an integer value representing
  83 the device ID for the core pointer device.
  84 </para>
  85
  86
  87 <!-- ##### VARIABLE gdk_threads_mutex ##### -->
  88 <para>
  89
  90 </para>
  91
  92
  93 <!-- ##### FUNCTION gdk_input_set_axes ##### -->
  94 <para>
  95 Sets the mapping of the axes (valuators) of a device
  96 onto the predefined valuator types that GTK+ understands.
  97 </para>
  98
  99 @deviceid: the device to configure.
 100 @axes: an array of GdkAxisUse. This length of this array
 101        must match the number of axes for the device.
 102
 103 <!-- ##### STRUCT GdkDeviceInfo ##### -->
 104 <para>
 105 The #GdkDeviceInfo structure contains information about a
 106 device. It has the following fields:
 107 </para>
 108
 109 @deviceid: a unique integer ID for this device.
 110 @name: the human-readable name for the device.
 111 @source: the type of device.
 112 @mode: a value indicating whether the device is enabled and
 113        how the device coordinates map to the screen.
 114 @has_cursor: if %TRUE, a cursor will be displayed indicating
 115              the current on-screen location to the user. Otherwise,
 116              the application is responsible for drawing a cursor
 117              itself.
 118 @num_axes: the number of axes for this device.
 119 @axes: a pointer to an array of GdkAxisUse values which
 120        give the mapping of axes onto the possible valuators
 121        for a GDK device.
 122 @num_keys: the number of macro buttons.
 123 @keys: a pointer to an array of #GdkDeviceKey structures
 124        which describe what key press events are generated
 125        for each macro button.
 126
 127 <!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
 128 Points, Rectangles and Regions
 129
 130
 131 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
 132 <para>
 133
 134 </para>
 135
 136
 137 <!-- ##### ENUM GdkPixbufAlphaMode ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @GDK_PIXBUF_ALPHA_BILEVEL:
 143 @GDK_PIXBUF_ALPHA_FULL:
 144
 145 <!-- ##### FUNCTION gdk_input_motion_events ##### -->
 146 <para>
 147 Retrieves the motion history for a given device/window pair.
 148 </para>
 149
 150 @window: a #GdkWindow.
 151 @deviceid: the device for which to retrieve motion history.
 152 @start: the start time.
 153 @stop: the stop time.
 154 @nevents_return: location to store the number of events returned.
 155 @Returns: a newly allocated array containing all the events
 156           from @start to @stop. This array should be freed
 157           with g_free() when you are finished using it.
 158
 159 <!-- ##### VARIABLE gdk_core_pointer ##### -->
 160 <para>
 161
 162 </para>
 163
 164
 165 <!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
 166 <para>
 167
 168 </para>
 169
 170
 171 <!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
 172 Pango Interaction
 173
 174
 175 <!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
 176 <para>
 177
 178 </para>
 179
 180
 181 <!-- ##### FUNCTION gdk_regions_union ##### -->
 182 <para>
 183 Returns the union of two regions.
 184 This is all pixels in either of @source1 or @source2.
 185 </para>
 186
 187 @source1: a #GdkRegion.
 188 @source2: a #GdkRegion.
 189 @Returns: the union of @source1 and @source2.
 190
 191 <!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
 192 <para>
 193 Returns information about the current position of the pointer
 194 within a window, including extended device information.
 195 Any of the return parameters may be %NULL, in which case,
 196 they will be ignored.
 197 </para>
 198
 199 @window: a #GdkWindow.
 200 @deviceid: a device ID.
 201 @x: location to store current x postion.
 202 @y: location to store current y postion.
 203 @pressure: location to store current pressure.
 204 @xtilt: location to store current tilt in the x direction.
 205 @ytilt: location to store current tilt in the y direction.
 206 @mask: location to store the current modifier state.
 207
 208 <!-- ##### FUNCTION gdk_input_set_source ##### -->
 209 <para>
 210 Sets the source type for a device.
 211 </para>
 212
 213 @deviceid: the device to configure
 214 @source: the new source type.
 215