diff options
Diffstat (limited to 'docs/reference/gdk/tmpl/gdk-unused.sgml')
| -rw-r--r-- | docs/reference/gdk/tmpl/gdk-unused.sgml | 196 |
1 files changed, 104 insertions, 92 deletions
diff --git a/docs/reference/gdk/tmpl/gdk-unused.sgml b/docs/reference/gdk/tmpl/gdk-unused.sgml index f455390216..830db8f65e 100644 --- a/docs/reference/gdk/tmpl/gdk-unused.sgml +++ b/docs/reference/gdk/tmpl/gdk-unused.sgml @@ -1,8 +1,34 @@ -<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### --> +<!-- ##### 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. + +<!-- ##### 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_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_regions_xor ##### --> <para> @@ -16,21 +42,32 @@ but which are not in both. @Returns: the difference between the union and the intersection of @source1 and @source2. -<!-- ##### FUNCTION gdk_input_motion_events ##### --> +<!-- ##### FUNCTION gdk_regions_subtract ##### --> <para> -Retrieves the motion history for a given device/window pair. +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> -@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. +@source1: a #GdkRegion. +@source2: a #GdkRegion to subtract from @source1. +@Returns: @source1 - @source2. -<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### --> +<!-- ##### 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/gdkregion.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### --> <para> </para> @@ -40,6 +77,29 @@ Retrieves the motion history for a given device/window pair. +<!-- ##### MACRO GDK_CORE_POINTER ##### --> +<para> +This macro contains an integer value representing +the device ID for the core pointer device. +</para> + + +<!-- ##### VARIABLE gdk_threads_mutex ##### --> +<para> + +</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 GdkDeviceInfo ##### --> <para> The #GdkDeviceInfo structure contains information about a @@ -64,70 +124,69 @@ device. It has the following fields: which describe what key press events are generated for each macro button. -<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### --> -Pango Interaction +<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### --> +Points, Rectangles and Regions -<!-- ##### FUNCTION gdk_regions_union ##### --> +<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### --> <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 ##### --> +<!-- ##### ENUM GdkPixbufAlphaMode ##### --> +<para> +</para> +@GDK_PIXBUF_ALPHA_BILEVEL: +@GDK_PIXBUF_ALPHA_FULL: -<!-- ##### FUNCTION gdk_input_set_key ##### --> +<!-- ##### FUNCTION gdk_input_motion_events ##### --> <para> -Sets the key event generated when a macro button is pressed. +Retrieves the motion history for a given device/window pair. </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. +@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. -<!-- ##### FUNCTION gdk_input_list_devices ##### --> +<!-- ##### VARIABLE gdk_core_pointer ##### --> <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 ##### --> +<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### --> <para> </para> -<!-- ##### ENUM GdkPixbufAlphaMode ##### --> +<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### --> +Pango Interaction + + +<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### --> <para> </para> -@GDK_PIXBUF_ALPHA_BILEVEL: -@GDK_PIXBUF_ALPHA_FULL: -<!-- ##### FUNCTION gdk_regions_subtract ##### --> +<!-- ##### FUNCTION gdk_regions_union ##### --> <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. +Returns the union of two regions. +This is all pixels in either of @source1 or @source2. </para> @source1: a #GdkRegion. -@source2: a #GdkRegion to subtract from @source1. -@Returns: @source1 - @source2. +@source2: a #GdkRegion. +@Returns: the union of @source1 and @source2. <!-- ##### FUNCTION gdk_input_window_get_pointer ##### --> <para> @@ -146,23 +205,6 @@ they will be ignored. @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. @@ -171,33 +213,3 @@ Sets the source type for a device. @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> - - |