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