diff options
Diffstat (limited to 'docs/reference/gdk/tmpl')
| -rw-r--r-- | docs/reference/gdk/tmpl/colors.sgml | 10 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/drawing.sgml | 18 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/events.sgml | 10 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/gdk-unused.sgml | 196 | ||||
| -rw-r--r-- | docs/reference/gdk/tmpl/keys.sgml | 130 |
5 files changed, 256 insertions, 108 deletions
diff --git a/docs/reference/gdk/tmpl/colors.sgml b/docs/reference/gdk/tmpl/colors.sgml index e307e1a4d2..3f47ec8260 100644 --- a/docs/reference/gdk/tmpl/colors.sgml +++ b/docs/reference/gdk/tmpl/colors.sgml @@ -121,6 +121,16 @@ Colormaps and Colors @ncolors: +<!-- ##### FUNCTION gdk_colormap_query_color ##### --> +<para> + +</para> + +@colormap: +@pixel: +@result: + + <!-- ##### FUNCTION gdk_colormap_get_visual ##### --> <para> diff --git a/docs/reference/gdk/tmpl/drawing.sgml b/docs/reference/gdk/tmpl/drawing.sgml index 55adf506c7..f0270aea20 100644 --- a/docs/reference/gdk/tmpl/drawing.sgml +++ b/docs/reference/gdk/tmpl/drawing.sgml @@ -111,6 +111,24 @@ Drawing Primitives @height: +<!-- ##### FUNCTION gdk_drawable_get_clip_region ##### --> +<para> + +</para> + +@drawable: +@Returns: + + +<!-- ##### FUNCTION gdk_drawable_get_visible_region ##### --> +<para> + +</para> + +@drawable: +@Returns: + + <!-- ##### FUNCTION gdk_draw_point ##### --> <para> diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml index 1b3ba85e6a..117f6f8ce4 100644 --- a/docs/reference/gdk/tmpl/events.sgml +++ b/docs/reference/gdk/tmpl/events.sgml @@ -226,6 +226,16 @@ Gets the timestamp from a #GdkEvent. no timestamp. +<!-- ##### FUNCTION gdk_event_get_state ##### --> +<para> + +</para> + +@event: +@state: +@Returns: + + <!-- ##### FUNCTION gdk_event_get_axis ##### --> <para> diff --git a/docs/reference/gdk/tmpl/gdk-unused.sgml b/docs/reference/gdk/tmpl/gdk-unused.sgml index 184224fc37..1a71c10b42 100644 --- a/docs/reference/gdk/tmpl/gdk-unused.sgml +++ b/docs/reference/gdk/tmpl/gdk-unused.sgml @@ -1,34 +1,8 @@ -<!-- ##### 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 ##### --> +<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### --> <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> @@ -42,32 +16,33 @@ but which are not in both. @Returns: the difference between the union and the intersection of @source1 and @source2. -<!-- ##### FUNCTION gdk_regions_subtract ##### --> +<!-- ##### FUNCTION gdk_input_motion_events ##### --> <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. +Retrieves the motion history for a given device/window pair. </para> -@source1: a #GdkRegion. -@source2: a #GdkRegion to subtract from @source1. -@Returns: @source1 - @source2. +@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 ##### --> +<!-- ##### SECTION ./tmpl/gdkkeys.sgml:See_Also ##### --> <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/gdkregion.sgml:Long_Description ##### --> +<para> +</para> -<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/gdkkeys.sgml:Long_Description ##### --> <para> </para> @@ -77,23 +52,6 @@ configuration information. -<!-- ##### 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 GdkDeviceInfo ##### --> <para> The #GdkDeviceInfo structure contains information about a @@ -118,63 +76,70 @@ device. It has the following fields: which describe what key press events are generated for each macro button. -<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### --> -Points, Rectangles and Regions +<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### --> +Pango Interaction -<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### --> +<!-- ##### 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. -<!-- ##### ENUM GdkPixbufAlphaMode ##### --> -<para> +<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### --> -</para> -@GDK_PIXBUF_ALPHA_BILEVEL: -@GDK_PIXBUF_ALPHA_FULL: -<!-- ##### FUNCTION gdk_input_motion_events ##### --> +<!-- ##### FUNCTION gdk_input_set_key ##### --> <para> -Retrieves the motion history for a given device/window pair. +Sets the key event generated when a macro button is pressed. </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. +@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. -<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### --> +<!-- ##### 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:Title ##### --> -Pango Interaction +<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### --> +<para> + +</para> -<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### --> +<!-- ##### ENUM GdkPixbufAlphaMode ##### --> <para> </para> +@GDK_PIXBUF_ALPHA_BILEVEL: +@GDK_PIXBUF_ALPHA_FULL: -<!-- ##### FUNCTION gdk_regions_union ##### --> +<!-- ##### FUNCTION gdk_regions_subtract ##### --> <para> -Returns the union of two regions. -This is all pixels in either of @source1 or @source2. +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. -@Returns: the union of @source1 and @source2. +@source2: a #GdkRegion to subtract from @source1. +@Returns: @source1 - @source2. <!-- ##### FUNCTION gdk_input_window_get_pointer ##### --> <para> @@ -193,6 +158,27 @@ they will be ignored. @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. + <!-- ##### FUNCTION gdk_input_set_source ##### --> <para> Sets the source type for a device. @@ -201,3 +187,37 @@ 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. + +<!-- ##### SECTION ./tmpl/gdkkeys.sgml:Title ##### --> +Keyboard Handling + + +<!-- ##### 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> + + diff --git a/docs/reference/gdk/tmpl/keys.sgml b/docs/reference/gdk/tmpl/keys.sgml index 4bd4cfcbc6..006d562a48 100644 --- a/docs/reference/gdk/tmpl/keys.sgml +++ b/docs/reference/gdk/tmpl/keys.sgml @@ -29,6 +29,96 @@ using gdk_keyval_to_upper() and gdk_keyval_to_lower(). </para> +<!-- ##### STRUCT GdkKeymap ##### --> +<para> + +</para> + +@parent_instance: + +<!-- ##### STRUCT GdkKeymapClass ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GdkKeymapKey ##### --> +<para> + +</para> + +@keycode: +@group: +@level: + +<!-- ##### STRUCT GdkKeyInfo ##### --> +<para> + +</para> + +@keycode: +@group: +@level: + +<!-- ##### FUNCTION gdk_keymap_get_default ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gdk_keymap_lookup_key ##### --> +<para> + +</para> + +@keymap: +@key: +@Returns: + + +<!-- ##### 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: + + +<!-- ##### FUNCTION gdk_keymap_get_entries_for_keycode ##### --> +<para> + +</para> + +@keymap: +@hardware_keycode: +@keys: +@keyvals: +@n_entries: +@Returns: + + <!-- ##### FUNCTION gdk_keyval_name ##### --> <para> Converts a key value into a symbolic name. @@ -51,26 +141,6 @@ Converts a key name to a key value. not a valid key. -<!-- ##### FUNCTION gdk_keyval_is_upper ##### --> -<para> -Returns TRUE if the given key value is in upper case. -</para> - -@keyval: a key value. -@Returns: TRUE if @keyval is in upper case, or if @keyval is not subject to -case conversion. - - -<!-- ##### FUNCTION gdk_keyval_is_lower ##### --> -<para> -Returns TRUE if the given key value is in lower case. -</para> - -@keyval: a key value. -@Returns: TRUE if @keyval is in lower case, or if @keyval is not subject to -case conversion. - - <!-- ##### FUNCTION gdk_keyval_convert_case ##### --> <para> @@ -101,6 +171,26 @@ Converts a key value to lower case, if applicable. in lower case or it is not subject to case conversion. +<!-- ##### FUNCTION gdk_keyval_is_upper ##### --> +<para> +Returns TRUE if the given key value is in upper case. +</para> + +@keyval: a key value. +@Returns: TRUE if @keyval is in upper case, or if @keyval is not subject to +case conversion. + + +<!-- ##### FUNCTION gdk_keyval_is_lower ##### --> +<para> +Returns TRUE if the given key value is in lower case. +</para> + +@keyval: a key value. +@Returns: TRUE if @keyval is in lower case, or if @keyval is not subject to +case conversion. + + <!-- ##### FUNCTION gdk_keyval_to_unicode ##### --> <para> |