forked from AuroraMiddleware/gtk
f7d593c99d
2001-01-30 Havoc Pennington <hp@pobox.com>
* gtk/gtktreeitem.h, gtk/gtktree.h, gtk/gtktext.h: bracket in
#ifdef GTK_ENABLE_BROKEN.
* gtk/gtktreeitem.c, gtk/gtktree.c, gtk/gtktext.c: #define
GTK_ENABLE_BROKEN just before including the broken headers.
* gtk/gtktypeutils.c: #define GTK_ENABLE_BROKEN, so we can get the
deprecated types registered.
* gtk/testgtk.c, gtk/testselection.c: #define GTK_ENABLE_BROKEN,
we have to test the broken stuff.
* docs/Changes-2.0.txt: explain GTK_ENABLE_BROKEN
2001-01-30 Havoc Pennington <hp@pobox.com>
Also committed a bunch of automatic changes made by gtk-doc,
after reviewing for correctness.
* gtk/tmpl/gtktext.sgml: add warning about deprecation and note
about what to use instead
* gtk/tmpl/gtktree.sgml: ditto
* gtk/Makefile.am (scan): pass --deprecated-guards option to
gtk-doc; requires new version of gtk-doc from CVS
* gtk/gtk-docs.sgml: move GtkText to the deprecated section
instead of the GtkTextView section. Oops.
383 lines
8.1 KiB
Plaintext
383 lines
8.1 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/gdkkeys.sgml:See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_keymap_translate_keyboard_state ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keymap:
|
|
@hardware_keycode:
|
|
@state:
|
|
@group:
|
|
@keyval:
|
|
@effective_group:
|
|
@level:
|
|
@unused_modifiers:
|
|
@Returns:
|
|
|
|
<!-- ##### FUNCTION gdk_keymap_get_entries_for_keyval ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keymap:
|
|
@keyval:
|
|
@keys:
|
|
@n_keys:
|
|
@Returns:
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkkeys.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.
|
|
|
|
<!-- ##### FUNCTION gdk_drawable_get_visible_region ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@drawable:
|
|
@Returns:
|
|
|
|
<!-- ##### FUNCTION gdk_colormap_query_color ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@colormap:
|
|
@pixel:
|
|
@result:
|
|
|
|
<!-- ##### FUNCTION gdk_event_get_state ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@event:
|
|
@state:
|
|
@Returns:
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_window_get_decorations ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@window:
|
|
@decorations:
|
|
@Returns:
|
|
|
|
<!-- ##### FUNCTION gdk_keymap_get_entries_for_keycode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keymap:
|
|
@hardware_keycode:
|
|
@keys:
|
|
@keyvals:
|
|
@n_entries:
|
|
@Returns:
|
|
|
|
<!-- ##### FUNCTION gdk_drawable_get_clip_region ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@drawable:
|
|
@Returns:
|
|
|
|
<!-- ##### 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.
|
|
|
|
<!-- ##### STRUCT GdkKeymap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent_instance:
|
|
|
|
<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GDK_PIXBUF_ALPHA_BILEVEL:
|
|
@GDK_PIXBUF_ALPHA_FULL:
|
|
|
|
<!-- ##### 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.
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkkeys.sgml:Short_Description ##### -->
|
|
|
|
|
|
|
|
<!-- ##### 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.
|
|
|
|
<!-- ##### STRUCT GdkSpan ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@x:
|
|
@y:
|
|
@width:
|
|
|
|
<!-- ##### STRUCT GdkKeyInfo ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keycode:
|
|
@group:
|
|
@level:
|
|
|
|
<!-- ##### FUNCTION gdk_input_set_source ##### -->
|
|
<para>
|
|
Sets the source type for a device.
|
|
</para>
|
|
|
|
@deviceid: the device to configure
|
|
@source: the new source type.
|
|
|
|
<!-- ##### FUNCTION gdk_region_spans_intersect_foreach ##### -->
|
|
<para>
|
|
Intersects a set of spans with a region and call a user specified
|
|
function for each resulting spanline. This function is a lot more effective
|
|
if the spans are sorted.
|
|
</para>
|
|
|
|
@region: The region to intersect against.
|
|
@spans: Array of spans to intersect.
|
|
@n_spans: Number of spans.
|
|
@sorted: True if the spans are sorted in increasing y order.
|
|
@function: The function to call for each intersected spanline.
|
|
@data: Opaque user data passed to function.
|
|
|
|
<!-- ##### FUNCTION gdk_keymap_get_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
<!-- ##### 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_keymap_lookup_key ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keymap:
|
|
@key:
|
|
@Returns:
|
|
|
|
<!-- ##### USER_FUNCTION GdkSpanFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@span: The intersected part of the span.
|
|
@data: Opaque data passed by user.
|
|
|
|
<!-- ##### STRUCT GdkKeymapClass ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### SECTION ./tmpl/gdkkeys.sgml:Title ##### -->
|
|
Keyboard Handling
|
|
|
|
|
|
<!-- ##### STRUCT GdkKeymapKey ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keycode:
|
|
@group:
|
|
@level:
|
|
|
|
<!-- ##### 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>
|
|
|
|
|