forked from AuroraMiddleware/gtk
71337db92e
Thu Sep 7 14:15:03 2000 Owen Taylor <otaylor@redhat.com>
* gdk/* gtk/*: Move gtk-reference files into GTK+ tree proper.
* Update sections.txt files to correspond to current code,
tweak .sgml files and Makefiles to correspond.
* gtk/tmpl/gtkradiomenuitem.sgml (this): Remove extra <para>
196 lines
5.5 KiB
Plaintext
196 lines
5.5 KiB
Plaintext
<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_regions_xor ##### -->
|
|
<para>
|
|
Returns the difference between the union and the intersection of two regions.
|
|
This is a region containing the pixels that are in one of the source regions,
|
|
but which are not in both.
|
|
</para>
|
|
|
|
@source1: a #GdkRegion.
|
|
@source2: a #GdkRegion.
|
|
@Returns: the difference between the union and the intersection of @source1
|
|
and @source2.
|
|
|
|
<!-- ##### FUNCTION gdk_input_motion_events ##### -->
|
|
<para>
|
|
Retrieves the motion history for a given device/window pair.
|
|
</para>
|
|
|
|
@window: a #GdkWindow.
|
|
@deviceid: the device for which to retrieve motion history.
|
|
@start: the start time.
|
|
@stop: the stop time.
|
|
@nevents_return: location to store the number of events returned.
|
|
@Returns: a newly allocated array containing all the events
|
|
from @start to @stop. This array should be freed
|
|
with g_free() when you are finished using it.
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Short_Description ##### -->
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GdkDeviceInfo ##### -->
|
|
<para>
|
|
The #GdkDeviceInfo structure contains information about a
|
|
device. It has the following fields:
|
|
</para>
|
|
|
|
@deviceid: a unique integer ID for this device.
|
|
@name: the human-readable name for the device.
|
|
@source: the type of device.
|
|
@mode: a value indicating whether the device is enabled and
|
|
how the device coordinates map to the screen.
|
|
@has_cursor: if %TRUE, a cursor will be displayed indicating
|
|
the current on-screen location to the user. Otherwise,
|
|
the application is responsible for drawing a cursor
|
|
itself.
|
|
@num_axes: the number of axes for this device.
|
|
@axes: a pointer to an array of GdkAxisUse values which
|
|
give the mapping of axes onto the possible valuators
|
|
for a GDK device.
|
|
@num_keys: the number of macro buttons.
|
|
@keys: a pointer to an array of #GdkDeviceKey structures
|
|
which describe what key press events are generated
|
|
for each macro button.
|
|
|
|
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
|
|
Pango Interaction
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_regions_union ##### -->
|
|
<para>
|
|
Returns the union of two regions.
|
|
This is all pixels in either of @source1 or @source2.
|
|
</para>
|
|
|
|
@source1: a #GdkRegion.
|
|
@source2: a #GdkRegion.
|
|
@Returns: the union of @source1 and @source2.
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_input_set_key ##### -->
|
|
<para>
|
|
Sets the key event generated when a macro button is pressed.
|
|
</para>
|
|
|
|
@deviceid: the device to configure.
|
|
@index: the index of the macro button.
|
|
@keyval: the key value for the #GdkKeypressEvent to generate.
|
|
(a value of 0 means no event will be generated.)
|
|
@modifiers: the modifier field for the generated
|
|
#GdkKeyPressEvent.
|
|
|
|
<!-- ##### FUNCTION gdk_input_list_devices ##### -->
|
|
<para>
|
|
Lists all available input devices, along with their
|
|
configuration information.
|
|
</para>
|
|
|
|
@Returns: A #GList of #GdkDeviceInfo structures. This list
|
|
is internal data of GTK+ and should not be modified
|
|
or freed.
|
|
|
|
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_regions_subtract ##### -->
|
|
<para>
|
|
Subtracts one region from another.
|
|
The result is a region containing all the pixels which are in @source1, but
|
|
which are not in @source2.
|
|
</para>
|
|
|
|
@source1: a #GdkRegion.
|
|
@source2: a #GdkRegion to subtract from @source1.
|
|
@Returns: @source1 - @source2.
|
|
|
|
<!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
|
|
<para>
|
|
Returns information about the current position of the pointer
|
|
within a window, including extended device information.
|
|
Any of the return parameters may be %NULL, in which case,
|
|
they will be ignored.
|
|
</para>
|
|
|
|
@window: a #GdkWindow.
|
|
@deviceid: a device ID.
|
|
@x: location to store current x postion.
|
|
@y: location to store current y postion.
|
|
@pressure: location to store current pressure.
|
|
@xtilt: location to store current tilt in the x direction.
|
|
@ytilt: location to store current tilt in the y direction.
|
|
@mask: location to store the current modifier state.
|
|
|
|
<!-- ##### MACRO GDK_CORE_POINTER ##### -->
|
|
<para>
|
|
This macro contains an integer value representing
|
|
the device ID for the core pointer device.
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_input_set_axes ##### -->
|
|
<para>
|
|
Sets the mapping of the axes (valuators) of a device
|
|
onto the predefined valuator types that GTK+ understands.
|
|
</para>
|
|
|
|
@deviceid: the device to configure.
|
|
@axes: an array of GdkAxisUse. This length of this array
|
|
must match the number of axes for the device.
|
|
|
|
<!-- ##### FUNCTION gdk_input_set_source ##### -->
|
|
<para>
|
|
Sets the source type for a device.
|
|
</para>
|
|
|
|
@deviceid: the device to configure
|
|
@source: the new source type.
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
|
|
Points, Rectangles and Regions
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_regions_intersect ##### -->
|
|
<para>
|
|
Returns the intersection of two regions.
|
|
</para>
|
|
|
|
@source1: a #GdkRegion.
|
|
@source2: a #GdkRegion.
|
|
@Returns: the intersection of @source1 and @source2.
|
|
|
|
<!-- ##### FUNCTION gdk_input_set_mode ##### -->
|
|
<para>
|
|
Enables or disables a device, and determines how the
|
|
device maps onto the screen.
|
|
</para>
|
|
|
|
@deviceid: the device to configure.
|
|
@mode: the new mode.
|
|
@Returns: %TRUE if the device supports the given mode, otherwise
|
|
%FALSE and the device's mode is unchanged.
|
|
|
|
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|