diff options
| author | Owen Taylor <otaylor@redhat.com> | 2001-01-09 16:41:17 +0000 |
|---|---|---|
| committer | Owen Taylor <otaylor@src.gnome.org> | 2001-01-09 16:41:17 +0000 |
| commit | c26e3eeebc1a9bd9e8b3a5a10f4e29383589fb4d (patch) | |
| tree | d62194ef1e0fad10afa2a0a034ad008ad700a77e /docs/reference | |
| parent | a801ea7bf04ab77c30b2ab9dbb487095575f1a3e (diff) | |
| download | gdk-pixbuf-c26e3eeebc1a9bd9e8b3a5a10f4e29383589fb4d.tar.gz | |
Restore build.
Mon Jan 8 15:21:15 2001 Owen Taylor <otaylor@redhat.com>
* Makefile.am (SUBDIRS): Restore build.
* gdk/gdk-sections.txt gdk/gdk-docs.sgml
gdk-pixbuf/gdk-pixbuf-sections.txt
gtk/gtk-sections.txt gtk/gtk-docs.sgml: : Update.
* */tmpl/*: Changes from update.
Diffstat (limited to 'docs/reference')
65 files changed, 2333 insertions, 1416 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index e2bbb8bce..5dfdf2c94 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,13 @@ +Mon Jan 8 15:21:15 2001 Owen Taylor <otaylor@redhat.com> + + * Makefile.am (SUBDIRS): Restore build. + + * gdk/gdk-sections.txt gdk/gdk-docs.sgml + gdk-pixbuf/gdk-pixbuf-sections.txt + gtk/gtk-sections.txt gtk/gtk-docs.sgml: : Update. + + * */tmpl/*: Changes from update. + Wed Oct 25 15:19:40 2000 Owen Taylor <otaylor@redhat.com> * gtk/tmpl/gtknotebook.sgml: Moved function docs into .c diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index c581de296..26da15420 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1,4 +1,4 @@ ## Process this file with automake to produce Makefile.in -# SUBDIRS = gdk-pixbuf gdk gtk +SUBDIRS = gdk-pixbuf gdk gtk diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt index 10bbe8f9f..7f8ec01e8 100644 --- a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt @@ -88,6 +88,8 @@ gdk_pixbuf_animation_get_frames gdk_pixbuf_animation_get_width gdk_pixbuf_animation_get_num_frames gdk_pixbuf_animation_get_height +gdk_pixbuf_frame_copy +gdk_pixbuf_frame_free gdk_pixbuf_frame_get_pixbuf gdk_pixbuf_frame_get_action gdk_pixbuf_frame_get_y_offset @@ -98,8 +100,10 @@ gdk_pixbuf_frame_get_x_offset GDK_PIXBUF_ANIMATION GDK_TYPE_PIXBUF_ANIMATION GDK_IS_PIXBUF_ANIMATION +GDK_TYPE_PIXBUF_FRAME <SUBSECTION Private> +gdk_pixbuf_frame_get_type gdk_pixbuf_animation_get_type </SECTION> diff --git a/docs/reference/gdk-pixbuf/tmpl/animation.sgml b/docs/reference/gdk-pixbuf/tmpl/animation.sgml index 8253cb491..4df2090cb 100644 --- a/docs/reference/gdk-pixbuf/tmpl/animation.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/animation.sgml @@ -98,6 +98,27 @@ animation @Returns: +<!-- ##### FUNCTION gdk_pixbuf_frame_copy ##### --> +<para> + +</para> + +@src: +@Returns: +<!-- # Unused Parameters # --> +@frame: + + +<!-- ##### FUNCTION gdk_pixbuf_frame_free ##### --> +<para> + +</para> + +@frame: +<!-- # Unused Parameters # --> +@src: + + <!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### --> <para> diff --git a/docs/reference/gdk-pixbuf/tmpl/creating.sgml b/docs/reference/gdk-pixbuf/tmpl/creating.sgml index fe52df5bb..f3d9f9aaf 100644 --- a/docs/reference/gdk-pixbuf/tmpl/creating.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/creating.sgml @@ -85,5 +85,7 @@ creating @pixbuf: @Returns: +<!-- # Unused Parameters # --> +@src: diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml index f403bf522..0d6a1219d 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml @@ -1,133 +1,275 @@ -<!-- ##### ARG GnomeCanvasPixbuf:width_in_pixels ##### --> - <para> - If this argument is %TRUE, then the width of the pixbuf will be - considered to be in pixels, that is, it will not be visually - scaled even if the item's affine transformation changes. If this - is %FALSE, then the width of the pixbuf will be considered to be - in canvas units, and so will be scaled normally by affine - transformations. The default is %FALSE. - </para> +<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### --> +Drawables to Pixbufs -<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:See_Also ##### --> +<!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### --> <para> - GdkRGB + A function of this type can be used to override the default + operation when a pixbuf loses its last reference, i.e. when + gdk_pixbuf_unref() is called on a #GdkPixbuf structure that has a + reference count of 1. This function should determine whether to + finalize the pixbuf by calling gdk_pixbuf_finalize(), or whether + to just resume normal execution. The last unref handler for a + #GdkPixbuf can be set using the + gdk_pixbuf_set_last_unref_handler() function. By default, pixbufs + will be finalized automatically if no last unref handler has been + defined. </para> +@pixbuf: The pixbuf that is losing its last reference. +@data: User closure data. -<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/rendering.sgml:See_Also ##### --> <para> - #GnomeCanvas, #GdkPixbuf + GdkRGB </para> -<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### --> +<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Title ##### --> +X Drawables to Pixbufs +<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### --> +<para> -<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Short_Description ##### --> -Canvas item to display #GdkPixbuf images. +</para> +@pixbuf: +@pixmap_return: +@mask_return: +@alpha_threshold: <!-- +Local variables: +mode: sgml +sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") +End: +--> -<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Long_Description ##### --> +<!-- ##### ARG GnomeCanvasPixbuf:width ##### --> <para> - The &gdk-pixbuf; Xlib library provides several convenience - functions to render pixbufs to X drawables. It uses XlibRGB to - render the image data. + Indicates the width the pixbuf will be scaled to. This argument + will only be used if the <link + linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument + is %TRUE. If the <link + linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link> + argument is %FALSE, the width will be taken to be in canvas units, + and thus will be scaled along with the canvas item's affine + transformation. If width_in_pixels is %TRUE, the width will be + taken to be in pixels, and will visually remain a constant size + even if the item's affine transformation changes. </para> - <para> - These functions are analogous to those for the Gdk version of - &gdk-pixbuf;. - </para> + +<!-- ##### ARG GnomeCanvasPixbuf:x-pixels ##### --> +<para> + +</para> -<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### --> +<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### --> <para> </para> @pixbuf: -@bitmap: +@drawable: +@gc: @src_x: @src_y: @dest_x: @dest_y: @width: @height: -@alpha_threshold: +@dither: +@x_dither: +@y_dither: -<!-- ##### SECTION ./tmpl/rendering.sgml:Long_Description ##### --> +<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### --> +<para> + +</para> + +@dest: +@src: +@cmap: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: +@Returns: <!-- +Local variables: +mode: sgml +sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") +End: +--> + +<!-- ##### ARG GnomeCanvasPixbuf:x ##### --> <para> - The &gdk-pixbuf; library provides several convenience functions to - render pixbufs to GDK drawables. It uses the GdkRGB to render the - image data. + Indicates the horizontal translation offset of the pixbuf item's + image. This offset may not actually appear horizontal, since it + will be affected by the item's affine transformation. The default + is 0.0. </para> + +<!-- ##### ARG GnomeCanvasPixbuf:y ##### --> <para> - At this point there is not a standard alpha channel extension for - the X Window System, so it is not possible to use full opacity - information when painting images to arbitrary drawables. The - &gdk-pixbuf; convenience functions will threshold the opacity - information to create a bi-level clipping mask (black and white), - and use that to draw the image onto a drawable. + Indicates the vertical translation offset of the pixbuf item's + image. Works in the same way as the <link + linkend="GnomeCanvasPixbuf--x">x</link> argument. The default is + 0.0. </para> - <important> - <para> - Since these functions use GdkRGB for rendering, you must - initialize GdkRGB before using any of them. You can do this by - calling gdk_rgb_init() near the beginning of your program. - </para> - </important> +<!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### --> +Initializing the &gdk-pixbuf; Xlib library. -<!-- ##### SECTION ./tmpl/xlib-init.sgml:Title ##### --> -&gdk-pixbuf; Xlib initialization +<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Long_Description ##### --> + <para> + The functions in this section allow you to take the image data + from an X drawable and dump it into a #GdkPixbuf. This can be + used for screenshots and other special effects. Note that these + operations can be expensive, since the image data has to be + transferred from the X server to the client program and converted. + </para> -<!-- ##### ARG GnomeCanvasPixbuf:height_in_pixels ##### --> <para> - Works in the same way as the <link - linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link> - argument. The default is %FALSE. + These functions are analogous to those for the Gdk version of + &gdk-pixbuf;. </para> -<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### --> +<!-- ##### FUNCTION gdk_pixbuf_new_from_art_pixbuf ##### --> <para> </para> +@art_pixbuf: +@Returns: -<!-- ##### SECTION ./tmpl/rendering.sgml:Title ##### --> -Rendering +<!-- ##### SECTION ./tmpl/xlib-init.sgml:See_Also ##### --> + <para> + XlibRGB + </para> -<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Short_Description ##### --> -Getting parts of an X drawable's image data into a pixbuf. +<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:See_Also ##### --> + <para> + #GnomeCanvas, #GdkPixbuf + </para> -<!-- ##### SECTION ./tmpl/from-drawables.sgml:Short_Description ##### --> -Getting parts of a drawable's image data into a pixbuf. +<!-- ##### ARG GnomeCanvasPixbuf:pixbuf ##### --> + <para> + Contains a pointer to a #GdkPixbuf structure that will be used by + the pixbuf canvas item as an image source. When a pixbuf is set + its reference count is incremented; if the pixbuf item kept a + pointer to another #GdkPixbuf structure, the reference count of + this structure will be decremented. Also, the GdkPixbuf's + reference count will automatically be decremented when the + #GnomeCanvasPixbuf item is destroyed. When a pixbuf is queried, a + reference count will not be added to the return value; you must do + this yourself if you intend to keep the pixbuf structure around. + </para> -<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### --> +<!-- ##### ARG GnomeCanvasPixbuf:width-pixels ##### --> <para> </para> -@pixbuf: -@pixmap_return: -@mask_return: -@alpha_threshold: <!-- -Local variables: -mode: sgml -sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") -End: ---> -<!-- ##### ARG GnomeCanvasPixbuf:y_in_pixels ##### --> +<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:See_Also ##### --> + <para> + GdkRGB + </para> + + +<!-- ##### ARG GnomeCanvasPixbuf:x-set ##### --> + <para> + Determines whether the <link + linkend="GnomeCanvasPixbuf--x">x</link> argument is used to + translate the pixbuf from its logical origin in item-relative + coordinates. + </para> + + +<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Long_Description ##### --> + <para> + The &gdk-pixbuf; Xlib library provides several convenience + functions to render pixbufs to X drawables. It uses XlibRGB to + render the image data. + </para> + + <para> + These functions are analogous to those for the Gdk version of + &gdk-pixbuf;. + </para> + + +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Short_Description ##### --> +Canvas item to display #GdkPixbuf images. + + +<!-- ##### SECTION ./tmpl/from-drawables.sgml:Long_Description ##### --> + <para> + The functions in this section allow you to take the image data + from a GDK drawable and dump it into a #GdkPixbuf. This can be + used for screenshots and other special effects. Note that these + operations can be expensive, since the image data has to be + transferred from the X server to the client program and converted. + </para> + + +<!-- ##### ARG GnomeCanvasPixbuf:width-set ##### --> + <para> + Determines whether the <link + linkend="GnomeCanvasPixbuf--width">width</link> argument is taken + into account when scaling the pixbuf item. If this argument is + %FALSE, then the width value of the pixbuf will be used instead. + This argument is %FALSE by default. + </para> + + +<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Long_Description ##### --> + <para> + The XlibRGB set of functions is a port of the GdkRGB library to + use plain Xlib and X drawables. You can use these functions to + render RGB buffers into drawables very quickly with high-quality + dithering. + </para> + + +<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Short_Description ##### --> +Functions for rendering RGB buffers to X drawables. + + +<!-- ##### MACRO GNOME_CANVAS_PIXBUF ##### --> + <para> + Casts a #GtkOjbect to a #GnomeCanvasPixbuf. + </para> + +@obj: A GTK+ object. + +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### ARG GnomeCanvasPixbuf:height-pixels ##### --> +<para> + +</para> + + +<!-- ##### ARG GnomeCanvasPixbuf:y-in-pixels ##### --> <para> Works in the same way as the <link linkend="GnomeCanvasPixbuf--x-in-pixels">x_in_pixels</link> @@ -144,8 +286,84 @@ End: --> -<!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### --> -Initializing the &gdk-pixbuf; Xlib library. +<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Short_Description ##### --> +Rendering a pixbuf to an X drawable. + + +<!-- ##### FUNCTION gdk_pixbuf_finalize ##### --> +<para> + +</para> + +@pixbuf: <!-- +Local variables: +mode: sgml +sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") +End: +--> + +<!-- ##### ARG GnomeCanvasPixbuf:x-in-pixels ##### --> + <para> + If this argument is %TRUE, the pixbuf's translation with respect + to its logical origin in item-relative coordinates will be in + pixels, that is, the visible offset will not change even if the + item's affine transformation changes. If it is %FALSE, the + pixbuf's translation will be taken to be in canvas units, and thus + will change along with the item's affine transformation. The + default is %FALSE. + </para> + + +<!-- ##### SECTION ./tmpl/rendering.sgml:Short_Description ##### --> +Rendering a pixbuf to a GDK drawable. + + +<!-- ##### FUNCTION gdk_pixbuf_set_last_unref_handler ##### --> +<para> + +</para> + +@pixbuf: +@last_unref_fn: +@last_unref_fn_data: + +<!-- ##### ARG GnomeCanvasPixbuf:y-set ##### --> + <para> + Determines whether the <link + linkend="GnomeCanvasPixbuf--y">y</link> argument is used to + translate the pixbuf from its logical origin in item-relative + coordinates. Works in the same way as the <link + linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The + default is %FALSE. + </para> + + +<!-- ##### SECTION ./tmpl/xlib-init.sgml:Long_Description ##### --> + <para> + In addition to the normal Gdk-specific functions, the &gdk-pixbuf; + package provides a small library that lets Xlib-only applications + use #GdkPixbuf structures and render them to X drawables. The + functions in this section are used to initialize the &gdk-pixbuf; + Xlib library. This library must be initialized near the beginning + or the program or before calling any of the other &gdk-pixbuf; + Xlib functions; it cannot be initialized automatically since + Xlib-only applications do not call gdk_rgb_init() like GNOME + applications do. + </para> + + +<!-- ##### FUNCTION gdk_pixbuf_get_format ##### --> +<para> + +</para> + +@pixbuf: +@Returns: + +<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:See_Also ##### --> +<para> + +</para> <!-- ##### FUNCTION gdk_pixbuf_render_to_drawable_alpha ##### --> @@ -167,14 +385,152 @@ Initializing the &gdk-pixbuf; Xlib library. @x_dither: @y_dither: -<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Long_Description ##### --> +<!-- ##### ARG GnomeCanvasPixbuf:y-pixels ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/xlib-init.sgml:Title ##### --> +&gdk-pixbuf; Xlib initialization + + +<!-- ##### ARG GnomeCanvasPixbuf:height-set ##### --> <para> - The XlibRGB set of functions is a port of the GdkRGB library to - use plain Xlib and X drawables. You can use these functions to - render RGB buffers into drawables very quickly with high-quality - dithering. + Determines whether the <link + linkend="GnomeCanvasPixbuf--height">height</link> argument is + taken into account when scaling the pixbuf item. Works in the + same way as the <link + linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument. + The default is %FALSE. + </para> + + +<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Short_Description ##### --> +Getting parts of an X drawable's image data into a pixbuf. + + +<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### --> +XlibRGB + + +<!-- ##### ARG GnomeCanvasPixbuf:width-in-pixels ##### --> + <para> + If this argument is %TRUE, then the width of the pixbuf will be + considered to be in pixels, that is, it will not be visually + scaled even if the item's affine transformation changes. If this + is %FALSE, then the width of the pixbuf will be considered to be + in canvas units, and so will be scaled normally by affine + transformations. The default is %FALSE. + </para> + + +<!-- ##### ARG GnomeCanvasPixbuf:height ##### --> + <para> + Indicates the height the pixbuf will be scaled to. This argument + will only be used if the <link + linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument + is %TRUE. Works in the same way as the <link + linkend="GnomeCanvasPixbuf--width">width</link> argument. + </para> + + +<!-- ##### ARG GnomeCanvasPixbuf:height-in-pixels ##### --> + <para> + Works in the same way as the <link + linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link> + argument. The default is %FALSE. + </para> + + +<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### --> + <para> + gdk_image_get(). + </para> + + +<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GdkPixbufAnimationClass ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/rendering.sgml:Title ##### --> +Rendering + + +<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Title ##### --> +GnomeCanvasPixbuf + + +<!-- ##### MACRO GDK_PIXBUF_LOADER ##### --> + <para> + Casts a #GtkObject to a #GdkPixbufLoader. </para> +@obj: A GTK+ object. + +<!-- ##### SECTION ./tmpl/rendering.sgml:Long_Description ##### --> + <para> + The &gdk-pixbuf; library provides several convenience functions to + render pixbufs to GDK drawables. It uses the GdkRGB to render the + image data. + </para> + + <para> + At this point there is not a standard alpha channel extension for + the X Window System, so it is not possible to use full opacity + information when painting images to arbitrary drawables. The + &gdk-pixbuf; convenience functions will threshold the opacity + information to create a bi-level clipping mask (black and white), + and use that to draw the image onto a drawable. + </para> + + <important> + <para> + Since these functions use GdkRGB for rendering, you must + initialize GdkRGB before using any of them. You can do this by + calling gdk_rgb_init() near the beginning of your program. + </para> + </important> + + +<!-- ##### SECTION ./tmpl/from-drawables.sgml:Short_Description ##### --> +Getting parts of a drawable's image data into a pixbuf. + + +<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### --> +<para> + +</para> + +@pixbuf: +@bitmap: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: +@alpha_threshold: + +<!-- ##### STRUCT GdkPixbufClass ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### --> +<para> + +</para> + <!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Long_Description ##### --> <para> @@ -345,367 +701,11 @@ Initializing the &gdk-pixbuf; Xlib library. </refsect2> -<!-- ##### SECTION ./tmpl/rendering.sgml:Short_Description ##### --> -Rendering a pixbuf to a GDK drawable. - - -<!-- ##### MACRO GDK_PIXBUF_LOADER ##### --> - <para> - Casts a #GtkObject to a #GdkPixbufLoader. - </para> - -@obj: A GTK+ object. - -<!-- ##### STRUCT GdkPixbufAnimationClass ##### --> -<para> - -</para> - - -<!-- ##### ARG GnomeCanvasPixbuf:x_set ##### --> - <para> - Determines whether the <link - linkend="GnomeCanvasPixbuf--x">x</link> argument is used to - translate the pixbuf from its logical origin in item-relative - coordinates. - </para> - - -<!-- ##### MACRO GNOME_CANVAS_PIXBUF ##### --> - <para> - Casts a #GtkOjbect to a #GnomeCanvasPixbuf. - </para> - -@obj: A GTK+ object. - -<!-- ##### ARG GnomeCanvasPixbuf:width_set ##### --> - <para> - Determines whether the <link - linkend="GnomeCanvasPixbuf--width">width</link> argument is taken - into account when scaling the pixbuf item. If this argument is - %FALSE, then the width value of the pixbuf will be used instead. - This argument is %FALSE by default. - </para> - - -<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Long_Description ##### --> - <para> - The functions in this section allow you to take the image data - from an X drawable and dump it into a #GdkPixbuf. This can be - used for screenshots and other special effects. Note that these - operations can be expensive, since the image data has to be - transferred from the X server to the client program and converted. - </para> - - <para> - These functions are analogous to those for the Gdk version of - &gdk-pixbuf;. - </para> - - -<!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### --> - <para> - A function of this type can be used to override the default - operation when a pixbuf loses its last reference, i.e. when - gdk_pixbuf_unref() is called on a #GdkPixbuf structure that has a - reference count of 1. This function should determine whether to - finalize the pixbuf by calling gdk_pixbuf_finalize(), or whether - to just resume normal execution. The last unref handler for a - #GdkPixbuf can be set using the - gdk_pixbuf_set_last_unref_handler() function. By default, pixbufs - will be finalized automatically if no last unref handler has been - defined. - </para> - -@pixbuf: The pixbuf that is losing its last reference. -@data: User closure data. - -<!-- ##### SECTION ./tmpl/xlib-init.sgml:See_Also ##### --> - <para> - XlibRGB - </para> - - -<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gdk_pixbuf_new_from_art_pixbuf ##### --> -<para> - -</para> - -@art_pixbuf: -@Returns: - -<!-- ##### ARG GnomeCanvasPixbuf:height ##### --> - <para> - Indicates the height the pixbuf will be scaled to. This argument - will only be used if the <link - linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument - is %TRUE. Works in the same way as the <link - linkend="GnomeCanvasPixbuf--width">width</link> argument. - </para> - - <!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Title ##### --> Xlib Rendering -<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### --> - <para> - gdk_image_get(). - </para> - - -<!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### --> -<para> - -</para> - - -<!-- ##### ARG GnomeCanvasPixbuf:pixbuf ##### --> - <para> - Contains a pointer to a #GdkPixbuf structure that will be used by - the pixbuf canvas item as an image source. When a pixbuf is set - its reference count is incremented; if the pixbuf item kept a - pointer to another #GdkPixbuf structure, the reference count of - this structure will be decremented. Also, the GdkPixbuf's - reference count will automatically be decremented when the - #GnomeCanvasPixbuf item is destroyed. When a pixbuf is queried, a - reference count will not be added to the return value; you must do - this yourself if you intend to keep the pixbuf structure around. - </para> - - -<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Short_Description ##### --> -Functions for rendering RGB buffers to X drawables. - - -<!-- ##### ARG GnomeCanvasPixbuf:x ##### --> - <para> - Indicates the horizontal translation offset of the pixbuf item's - image. This offset may not actually appear horizontal, since it - will be affected by the item's affine transformation. The default - is 0.0. - </para> - - -<!-- ##### ARG GnomeCanvasPixbuf:y ##### --> - <para> - Indicates the vertical translation offset of the pixbuf item's - image. Works in the same way as the <link - linkend="GnomeCanvasPixbuf--x">x</link> argument. The default is - 0.0. - </para> - - -<!-- ##### ARG GnomeCanvasPixbuf:width ##### --> - <para> - Indicates the width the pixbuf will be scaled to. This argument - will only be used if the <link - linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument - is %TRUE. If the <link - linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link> - argument is %FALSE, the width will be taken to be in canvas units, - and thus will be scaled along with the canvas item's affine - transformation. If width_in_pixels is %TRUE, the width will be - taken to be in pixels, and will visually remain a constant size - even if the item's affine transformation changes. - </para> - - -<!-- ##### FUNCTION gdk_pixbuf_set_last_unref_handler ##### --> -<para> - -</para> - -@pixbuf: -@last_unref_fn: -@last_unref_fn_data: - -<!-- ##### ARG GnomeCanvasPixbuf:height_set ##### --> - <para> - Determines whether the <link - linkend="GnomeCanvasPixbuf--height">height</link> argument is - taken into account when scaling the pixbuf item. Works in the - same way as the <link - linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument. - The default is %FALSE. - </para> - - -<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### --> -<para> - -</para> - -@pixbuf: -@drawable: -@gc: -@src_x: -@src_y: -@dest_x: -@dest_y: -@width: -@height: -@dither: -@x_dither: -@y_dither: - -<!-- ##### SECTION ./tmpl/xlib-init.sgml:Long_Description ##### --> - <para> - In addition to the normal Gdk-specific functions, the &gdk-pixbuf; - package provides a small library that lets Xlib-only applications - use #GdkPixbuf structures and render them to X drawables. The - functions in this section are used to initialize the &gdk-pixbuf; - Xlib library. This library must be initialized near the beginning - or the program or before calling any of the other &gdk-pixbuf; - Xlib functions; it cannot be initialized automatically since - Xlib-only applications do not call gdk_rgb_init() like GNOME - applications do. - </para> - - -<!-- ##### ARG GnomeCanvasPixbuf:y_pixels ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:See_Also ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/rendering.sgml:See_Also ##### --> - <para> - GdkRGB - </para> - - -<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Short_Description ##### --> -Rendering a pixbuf to an X drawable. - - -<!-- ##### FUNCTION gdk_pixbuf_finalize ##### --> -<para> - -</para> - -@pixbuf: <!-- -Local variables: -mode: sgml -sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") -End: ---> - -<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### --> -<para> - -</para> - -@dest: -@src: -@cmap: -@src_x: -@src_y: -@dest_x: -@dest_y: -@width: -@height: -@Returns: <!-- -Local variables: -mode: sgml -sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "") -End: ---> - <!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Title ##### --> gdk-pixbuf-io -<!-- ##### ARG GnomeCanvasPixbuf:y_set ##### --> - <para> - Determines whether the <link - linkend="GnomeCanvasPixbuf--y">y</link> argument is used to - translate the pixbuf from its logical origin in item-relative - coordinates. Works in the same way as the <link - linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The - default is %FALSE. - </para> - - -<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Title ##### --> -GnomeCanvasPixbuf - - -<!-- ##### ARG GnomeCanvasPixbuf:x_pixels ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION gdk_pixbuf_get_format ##### --> -<para> - -</para> - -@pixbuf: -@Returns: - -<!-- ##### SECTION ./tmpl/from-drawables.sgml:Long_Description ##### --> - <para> - The functions in this section allow you to take the image data - from a GDK drawable and dump it into a #GdkPixbuf. This can be - used for screenshots and other special effects. Note that these - operations can be expensive, since the image data has to be - transferred from the X server to the client program and converted. - </para> - - -<!-- ##### ARG GnomeCanvasPixbuf:width_pixels ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Title ##### --> -X Drawables to Pixbufs - - -<!-- ##### STRUCT GdkPixbufClass ##### --> -<para> - -</para> - - -<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### --> -Drawables to Pixbufs - - -<!-- ##### ARG GnomeCanvasPixbuf:x_in_pixels ##### --> - <para> - If this argument is %TRUE, the pixbuf's translation with respect - to its logical origin in item-relative coordinates will be in - pixels, that is, the visible offset will not change even if the - item's affine transformation changes. If it is %FALSE, the - pixbuf's translation will be taken to be in canvas units, and thus - will change along with the item's affine transformation. The - default is %FALSE. - </para> - - -<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### --> -XlibRGB - - diff --git a/docs/reference/gdk/gdk-docs.sgml b/docs/reference/gdk/gdk-docs.sgml index 51d744473..80764d2ed 100644 --- a/docs/reference/gdk/gdk-docs.sgml +++ b/docs/reference/gdk/gdk-docs.sgml @@ -13,12 +13,13 @@ <!entity gdk-Selections SYSTEM "sgml/selections.sgml"> <!entity gdk-Properties-and-Atoms SYSTEM "sgml/properties.sgml"> <!entity gdk-Input-Methods SYSTEM "sgml/input_methods.sgml"> -<!entity gdk-Input-Contexts SYSTEM "sgml/input_contexts.sgml"> <!entity gdk-Pango-Interaction SYSTEM "sgml/pango_interaction.sgml"> +<!entity gdk-Input-Contexts SYSTEM "sgml/input_contexts.sgml"> <!entity gdk-Color-Contexts SYSTEM "sgml/color_contexts.sgml"> <!entity gdk-Points-Rectangles-and-Regions SYSTEM "sgml/regions.sgml"> <!entity gdk-Threads SYSTEM "sgml/threads.sgml"> <!entity gdk-Key-Values SYSTEM "sgml/keys.sgml"> +<!entity gdk-Keyboard-Handling SYSTEM "sgml/gdkkeys.sgml"> <!entity gdk-Input-Devices SYSTEM "sgml/input_devices.sgml"> <!entity gdk-Events SYSTEM "sgml/events.sgml"> <!entity gdk-Event-Structures SYSTEM "sgml/event_structs.sgml"> @@ -69,7 +70,7 @@ &gdk-Input-Devices; - &gdk-Key-Values; + &gdk-Keyboard-Handling; &gdk-Pango-Interaction; &gdk-Input-Methods; diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index 119b1c1d4..68d7c80a8 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -177,6 +177,7 @@ gdk_colormap_change gdk_colormap_alloc_colors gdk_colormap_alloc_color gdk_colormap_free_colors +gdk_colormap_query_color gdk_colormap_get_visual gdk_colors_store gdk_color_copy @@ -257,6 +258,8 @@ gdk_drawable_set_colormap gdk_drawable_get_colormap gdk_drawable_get_depth gdk_drawable_get_size +gdk_drawable_get_clip_region +gdk_drawable_get_visible_region <SUBSECTION> gdk_draw_point @@ -640,23 +643,40 @@ gdk_threads_mutex </SECTION> <SECTION> -<TITLE>Key Values</TITLE> +<TITLE>Keyboard Handling</TITLE> <FILE>keys</FILE> -gdk_keyval_name -gdk_keyval_from_name +GdkKeymap +GdkKeymapClass +GdkKeymapKey +GdkKeyInfo +gdk_keymap_get_default +gdk_keymap_lookup_key +gdk_keymap_translate_keyboard_state +gdk_keymap_get_entries_for_keyval +gdk_keymap_get_entries_for_keycode <SUBSECTION> -gdk_keyval_is_upper -gdk_keyval_is_lower +gdk_keyval_name +gdk_keyval_from_name <SUBSECTION> gdk_keyval_convert_case gdk_keyval_to_upper gdk_keyval_to_lower +gdk_keyval_is_upper +gdk_keyval_is_lower <SUBSECTION> gdk_keyval_to_unicode gdk_unicode_to_keyval +<SUBSECTION Standard> +GDK_KEYMAP +GDK_IS_KEYMAP +GDK_TYPE_KEYMAP +gdk_keymap_get_type +GDK_KEYMAP_CLASS +GDK_IS_KEYMAP_CLASS +GDK_KEYMAP_GET_CLASS </SECTION> <SECTION> @@ -709,6 +729,7 @@ gdk_event_put gdk_event_copy gdk_event_free gdk_event_get_time +gdk_event_get_state gdk_event_get_axis <SUBSECTION> @@ -862,7 +883,6 @@ GDK_GC_X11_CLASS GDK_IS_GC_X11_CLASS GdkGCX11 GdkGCX11Class -GdkGCXData GdkColormapPrivateX11 GdkCursorPrivate GdkFontPrivateX diff --git a/docs/reference/gdk/tmpl/colors.sgml b/docs/reference/gdk/tmpl/colors.sgml index e307e1a4d..3f47ec826 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 55adf506c..f0270aea2 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 1b3ba85e6..117f6f8ce 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 184224fc3..1a71c10b4 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 4bd4cfcbc..006d562a4 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> diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index 547edb3fe..b39fa718d 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -100,7 +100,7 @@ <!entity gtk-GtkTreeStore SYSTEM "sgml/gtktreestore.sgml"> <!entity gtk-GtkTreeViewColumn SYSTEM "sgml/gtktreeviewcolumn.sgml"> <!entity gtk-GtkTreeView SYSTEM "sgml/gtktreeview.sgml"> -<!entity gtk-GtkModelSimple SYSTEM "sgml/gtkmodelsimple.sgml"> +<!entity gtk-GtkTreeModelSimple SYSTEM "sgml/gtktreemodelsimple.sgml"> <!entity gtk-GtkCellRenderer SYSTEM "sgml/gtkcellrenderer.sgml"> <!entity gtk-GtkCellRendererPixbuf SYSTEM "sgml/gtkcellrendererpixbuf.sgml"> <!entity gtk-GtkCellRendererText SYSTEM "sgml/gtkcellrenderertext.sgml"> @@ -276,7 +276,7 @@ An advanced widget set. >k-GtkTreeStore; >k-GtkTreeViewColumn; >k-GtkTreeView; - >k-GtkModelSimple; + >k-GtkTreeModelSimple; >k-GtkTreeModelSort; >k-GtkCellRenderer; >k-GtkCellRendererPixbuf; diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt index 01814ee0e..8206ca5d9 100644 --- a/docs/reference/gtk/gtk-sections.txt +++ b/docs/reference/gtk/gtk-sections.txt @@ -251,7 +251,6 @@ GTK_CLIST_UNSET_FLAG GTK_CLIST_IN_DRAG GTK_CLIST_ROW_HEIGHT_SET GTK_CLIST_SHOW_TITLES -GTK_CLIST_CHILD_HAS_FOCUS GTK_CLIST_ADD_MODE GTK_CLIST_AUTO_SORT GTK_CLIST_AUTO_RESIZE_BLOCKED @@ -276,7 +275,6 @@ GtkCell GtkCListCellInfo GtkCListDestInfo GtkCListDragPos -gtk_clist_construct gtk_clist_new gtk_clist_new_with_titles gtk_clist_set_shadow_type @@ -490,7 +488,6 @@ GtkCTreeCompareDragFunc <TITLE>GtkCTree</TITLE> GtkCTreeRow GtkCTreeNode -gtk_ctree_construct gtk_ctree_new_with_titles gtk_ctree_new gtk_ctree_insert_node @@ -1389,7 +1386,6 @@ GTK_MISC_GET_CLASS <FILE>gtknotebook</FILE> <TITLE>GtkNotebook</TITLE> GtkNotebook -GTK_NOTEBOOK_PAGE GtkNotebookPage gtk_notebook_new gtk_notebook_append_page @@ -1445,17 +1441,11 @@ GTK_OBJECT_FLAGS GTK_OBJECT_DESTROYED GTK_OBJECT_FLOATING GTK_OBJECT_CONNECTED -GTK_OBJECT_CONSTRUCTED GTK_OBJECT_SET_FLAGS GTK_OBJECT_UNSET_FLAGS GtkArgFlags <TITLE>GtkObject</TITLE> -gtk_object_class_user_signal_new -gtk_object_class_user_signal_newv gtk_object_new -gtk_object_newv -gtk_object_constructed -gtk_object_default_construct gtk_object_sink gtk_object_ref gtk_object_unref @@ -1463,10 +1453,7 @@ gtk_object_weakref gtk_object_weakunref gtk_object_destroy gtk_object_get -gtk_object_getv gtk_object_set -gtk_object_setv -gtk_object_query_args gtk_object_set_data gtk_object_set_data_full gtk_object_remove_data @@ -1474,7 +1461,6 @@ gtk_object_get_data gtk_object_remove_no_notify gtk_object_set_user_data gtk_object_get_user_data -gtk_object_class_add_signals gtk_object_add_arg_type gtk_object_set_data_by_id gtk_object_set_data_by_id_full @@ -1483,10 +1469,6 @@ gtk_object_remove_data_by_id gtk_object_remove_no_notify_by_id gtk_object_data_try_key gtk_object_data_force_id -gtk_object_arg_set -gtk_object_arg_get -gtk_object_args_collect -gtk_object_arg_get_info <SUBSECTION Standard> GTK_OBJECT GTK_IS_OBJECT @@ -1495,6 +1477,10 @@ gtk_object_get_type GTK_OBJECT_CLASS GTK_IS_OBJECT_CLASS GTK_OBJECT_GET_CLASS + +<SUBSECTION Private> +GTK_ARG_MASK +GTK_ARG_READWRITE </SECTION> <SECTION> @@ -2052,6 +2038,8 @@ gtk_text_buffer_copy_clipboard gtk_text_buffer_cut_clipboard gtk_text_buffer_paste_primary gtk_text_buffer_get_selection_bounds +gtk_text_buffer_begin_user_action +gtk_text_buffer_end_user_action <SUBSECTION Standard> GTK_TEXT_BUFFER GTK_IS_TEXT_BUFFER @@ -2060,6 +2048,8 @@ gtk_text_buffer_get_type GTK_TEXT_BUFFER_CLASS GTK_IS_TEXT_BUFFER_CLASS GTK_TEXT_BUFFER_GET_CLASS +<SUBSECTION Private> +GtkTextLogAttrCache </SECTION> <SECTION> @@ -2089,14 +2079,20 @@ gtk_text_iter_toggles_tag gtk_text_iter_has_tag gtk_text_iter_get_tags gtk_text_iter_editable +gtk_text_iter_starts_word +gtk_text_iter_ends_word +gtk_text_iter_inside_word gtk_text_iter_starts_line gtk_text_iter_ends_line +gtk_text_iter_is_cursor_position gtk_text_iter_get_chars_in_line +gtk_text_iter_get_bytes_in_line gtk_text_iter_get_attributes +gtk_text_iter_get_language gtk_text_iter_is_last gtk_text_iter_is_first -gtk_text_iter_next_char -gtk_text_iter_prev_char +gtk_text_iter_forward_char +gtk_text_iter_backward_char gtk_text_iter_forward_chars gtk_text_iter_backward_chars gtk_text_iter_forward_line @@ -2107,12 +2103,16 @@ gtk_text_iter_forward_word_ends gtk_text_iter_backward_word_starts gtk_text_iter_forward_word_end gtk_text_iter_backward_word_start +gtk_text_iter_forward_cursor_position +gtk_text_iter_backward_cursor_position +gtk_text_iter_forward_cursor_positions +gtk_text_iter_backward_cursor_positions gtk_text_iter_set_offset gtk_text_iter_set_line gtk_text_iter_set_line_offset gtk_text_iter_set_line_index gtk_text_iter_forward_to_end -gtk_text_iter_forward_to_newline +gtk_text_iter_forward_to_line_end gtk_text_iter_forward_to_tag_toggle gtk_text_iter_backward_to_tag_toggle GtkTextCharPredicate @@ -2135,6 +2135,7 @@ gtk_text_mark_set_visible gtk_text_mark_get_visible gtk_text_mark_get_deleted gtk_text_mark_get_name +gtk_text_mark_get_buffer <SUBSECTION Standard> GTK_TEXT_MARK GTK_IS_TEXT_MARK @@ -2160,6 +2161,7 @@ gtk_text_tag_event GtkTextAppearance gtk_text_attributes_new gtk_text_attributes_copy +gtk_text_attributes_copy_values gtk_text_attributes_unref gtk_text_attributes_ref <SUBSECTION Standard> @@ -2202,15 +2204,10 @@ gtk_text_view_new_with_buffer gtk_text_view_set_buffer gtk_text_view_get_buffer gtk_text_view_scroll_to_mark +gtk_text_view_scroll_mark_onscreen gtk_text_view_move_mark_onscreen gtk_text_view_place_cursor_onscreen gtk_text_view_get_visible_rect -gtk_text_view_set_wrap_mode -gtk_text_view_get_wrap_mode -gtk_text_view_set_editable -gtk_text_view_get_editable -gtk_text_view_set_cursor_visible -gtk_text_view_get_cursor_visible gtk_text_view_get_iter_location gtk_text_view_get_line_at_y gtk_text_view_get_line_yrange @@ -2221,9 +2218,37 @@ gtk_text_view_get_window gtk_text_view_get_window_type gtk_text_view_set_border_window_size gtk_text_view_set_text_window_size +gtk_text_view_forward_display_line +gtk_text_view_backward_display_line +gtk_text_view_forward_display_line_end +gtk_text_view_backward_display_line_start +gtk_text_view_starts_display_line +gtk_text_view_move_visually gtk_text_view_add_child_at_anchor gtk_text_view_add_child_in_window gtk_text_view_move_child +gtk_text_view_set_wrap_mode +gtk_text_view_get_wrap_mode +gtk_text_view_set_editable +gtk_text_view_get_editable +gtk_text_view_set_cursor_visible +gtk_text_view_get_cursor_visible +gtk_text_view_set_pixels_above_lines +gtk_text_view_get_pixels_above_lines +gtk_text_view_set_pixels_below_lines +gtk_text_view_get_pixels_below_lines +gtk_text_view_set_pixels_inside_wrap +gtk_text_view_get_pixels_inside_wrap +gtk_text_view_set_justification +gtk_text_view_get_justification +gtk_text_view_set_left_margin +gtk_text_view_get_left_margin +gtk_text_view_set_right_margin +gtk_text_view_get_right_margin +gtk_text_view_set_indent +gtk_text_view_get_indent +gtk_text_view_set_tabs +gtk_text_view_get_tabs <SUBSECTION Standard> GTK_TEXT_VIEW GTK_IS_TEXT_VIEW @@ -2449,10 +2474,10 @@ GValueCompareFunc gtk_tree_model_sort_new gtk_tree_model_sort_new_with_model gtk_tree_model_sort_set_model -gtk_tree_model_sort_set_sort_col +gtk_tree_model_sort_set_sort_column gtk_tree_model_sort_set_compare -gtk_tree_model_sort_resort gtk_tree_model_sort_convert_path +gtk_tree_model_sort_convert_iter <SUBSECTION Standard> GTK_TREE_MODEL_SORT GTK_IS_TREE_MODEL_SORT @@ -2464,14 +2489,14 @@ GTK_IS_TREE_MODEL_SORT_CLASS <SECTION> <FILE>gtktreeselection</FILE> -GtkTreeSelectionType +GtkTreeSelectionMode GtkTreeSelectionFunc GtkTreeSelectionForeachFunc <TITLE>GtkTreeSelection</TITLE> -gtk_tree_selection_new -gtk_tree_selection_set_type +gtk_tree_selection_set_mode gtk_tree_selection_set_select_function gtk_tree_selection_get_user_data +gtk_tree_selection_get_tree_view gtk_tree_selection_get_selected gtk_tree_selection_selected_foreach gtk_tree_selection_select_path @@ -2481,8 +2506,6 @@ gtk_tree_selection_unselect_iter gtk_tree_selection_select_all gtk_tree_selection_unselect_all gtk_tree_selection_select_range -gtk_tree_selection_new_with_tree_view -gtk_tree_selection_set_tree_view <SUBSECTION Standard> GTK_TREE_SELECTION GTK_IS_TREE_SELECTION @@ -2527,7 +2550,7 @@ GTK_IS_TREE_STORE_CLASS <FILE>gtktreeviewcolumn</FILE> GTK_TYPE_TREE_COLUMN GtkTreeViewColumn -GtkTreeViewColumnType +GtkTreeViewColumnSizing GtkTreeViewColumnFunc <TITLE>GtkTreeViewColumn</TITLE> gtk_tree_view_column_new @@ -2538,21 +2561,22 @@ gtk_tree_view_column_set_attributes gtk_tree_view_column_set_cell_data gtk_tree_view_column_set_visible gtk_tree_view_column_get_visible -gtk_tree_view_column_set_col_type +gtk_tree_view_column_set_sizing gtk_tree_view_column_get_col_type gtk_tree_view_column_get_size -gtk_tree_view_column_set_size +gtk_tree_view_column_set_width gtk_tree_view_column_set_min_width gtk_tree_view_column_get_min_width gtk_tree_view_column_set_max_width gtk_tree_view_column_get_max_width gtk_tree_view_column_set_title gtk_tree_view_column_get_title -gtk_tree_view_column_set_header_active +gtk_tree_view_column_set_header_clickable gtk_tree_view_column_set_widget gtk_tree_view_column_get_widget gtk_tree_view_column_set_justification gtk_tree_view_column_get_justification +gtk_tree_view_column_clicked <SUBSECTION Standard> GTK_TREE_VIEW_COLUMN GTK_IS_TREE_VIEW_COLUMN @@ -2579,7 +2603,7 @@ gtk_tree_view_set_vadjustment gtk_tree_view_get_headers_visible gtk_tree_view_set_headers_visible gtk_tree_view_columns_autosize -gtk_tree_view_set_headers_active +gtk_tree_view_set_headers_clickable gtk_tree_view_append_column gtk_tree_view_remove_column gtk_tree_view_insert_column @@ -2602,26 +2626,26 @@ GtkTreeViewPrivate </SECTION> <SECTION> -<FILE>gtkmodelsimple</FILE> -<TITLE>GtkModelSimple</TITLE> -GtkModelSimple -gtk_model_simple_new -gtk_model_simple_node_changed -gtk_model_simple_node_inserted -gtk_model_simple_node_child_toggled -gtk_model_simple_node_deleted +<FILE>gtktreemodelsimple</FILE> +<TITLE>GtkTreeModelSimple</TITLE> +GtkTreeModelSimple +gtk_tree_model_simple_new +gtk_tree_model_simple_changed +gtk_tree_model_simple_inserted +gtk_tree_model_simple_child_toggled +gtk_tree_model_simple_deleted <SUBSECTION Standard> -GTK_MODEL_SIMPLE -GTK_IS_MODEL_SIMPLE +GTK_TREE_MODEL_SIMPLE +GTK_IS_TREE_MODEL_SIMPLE GTK_TYPE_MODEL_SIMPLE -gtk_model_simple_get_type -GTK_MODEL_SIMPLE_CLASS -GTK_IS_MODEL_SIMPLE_CLASS +gtk_tree_model_simple_get_type +GTK_TREE_MODEL_SIMPLE_CLASS +GTK_IS_TREE_MODEL_SIMPLE_CLASS </SECTION> <SECTION> <FILE>gtkcellrenderer</FILE> -GtkCellRendererType +GtkCellRendererState <TITLE>GtkCellRenderer</TITLE> GtkCellRenderer gtk_cell_renderer_get_size @@ -2685,6 +2709,8 @@ GTK_IS_CELL_RENDERER_TEXT_PIXBUF_CLASS GtkCellRendererToggle gtk_cell_renderer_toggle_new gtk_cell_renderer_toggle_set_radio +gtk_cell_renderer_toggle_get_active +gtk_cell_renderer_toggle_set_active <SUBSECTION Standard> GTK_CELL_RENDERER_TOGGLE GTK_IS_CELL_RENDERER_TOGGLE @@ -2884,15 +2910,11 @@ GtkSelectionData GtkWidgetAuxInfo GtkWidgetShapeInfo gtk_widget_new -gtk_widget_newv gtk_widget_ref gtk_widget_unref gtk_widget_destroy gtk_widget_destroyed -gtk_widget_get -gtk_widget_getv gtk_widget_set -gtk_widget_setv gtk_widget_unparent gtk_widget_show gtk_widget_show_now @@ -2920,6 +2942,7 @@ gtk_widget_activate gtk_widget_reparent gtk_widget_popup gtk_widget_intersect +gtk_widget_is_focus gtk_widget_grab_focus gtk_widget_grab_default gtk_widget_set_name @@ -3108,6 +3131,7 @@ gtk_key_snooper_remove <SUBSECTION> gtk_get_current_event gtk_get_current_event_time +gtk_get_current_event_state gtk_get_event_widget gtk_propagate_event @@ -3187,26 +3211,24 @@ gtk_draw_shadow gtk_draw_polygon gtk_draw_arrow gtk_draw_diamond -gtk_draw_oval gtk_draw_string gtk_draw_box gtk_draw_box_gap gtk_draw_check -gtk_draw_cross gtk_draw_extension gtk_draw_flat_box gtk_draw_focus gtk_draw_handle gtk_draw_option -gtk_draw_ramp gtk_draw_shadow_gap gtk_draw_slider gtk_draw_tab +gtk_draw_expander +gtk_draw_layout gtk_paint_arrow gtk_paint_box gtk_paint_box_gap gtk_paint_check -gtk_paint_cross gtk_paint_diamond gtk_paint_extension gtk_paint_flat_box @@ -3214,15 +3236,15 @@ gtk_paint_focus gtk_paint_handle gtk_paint_hline gtk_paint_option -gtk_paint_oval gtk_paint_polygon -gtk_paint_ramp gtk_paint_shadow gtk_paint_shadow_gap gtk_paint_slider gtk_paint_string gtk_paint_tab gtk_paint_vline +gtk_paint_expander +gtk_paint_layout <SUBSECTION Standard> GTK_STYLE diff --git a/docs/reference/gtk/gtk.hierarchy b/docs/reference/gtk/gtk.hierarchy index 411ccae3c..be020e251 100644 --- a/docs/reference/gtk/gtk.hierarchy +++ b/docs/reference/gtk/gtk.hierarchy @@ -95,6 +95,3 @@ GtkObject GtkIMContext GtkIMMulticontext GtkItemFactory - GtkTextBuffer - GtkTextTag - GtkTextTagTable diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index 0f3279409..28e71fdec 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -21,6 +21,33 @@ the widget. </para> +<!-- ##### FUNCTION gtk_model_simple_node_inserted ##### --> +<para> + +</para> + +@simple: +@path: +@iter: + +<!-- ##### FUNCTION gtk_widget_newv ##### --> +<para> + +</para> + +@type: +@nargs: +@args: +@Returns: + +<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### --> +<para> +A macro to check whether a child widget of the CList +has the focus. +</para> + +@clist: The #GtkCList widget to check. + <!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### --> <refsect2> <title>What are Signal Marshallers?</title> @@ -91,6 +118,16 @@ void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, +<!-- ##### FUNCTION gtk_object_class_add_signals ##### --> +<para> +Add an array of signals to a #GtkObjectClass. +Usually this is called when registering a new type of object. +</para> + +@klass: the object class to append signals to. +@signals: the signals to append. +@nsignals: the number of signals being appended. + <!-- ##### MACRO gtk_marshal_NONE__UINT_STRING ##### --> <para> @@ -119,6 +156,12 @@ void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, @Returns: +<!-- ##### ARG GtkTextTag:offset-set ##### --> +<para> + +</para> + + <!-- ##### FUNCTION gtk_theme_engine_create_rc_style ##### --> <para> @@ -127,6 +170,14 @@ void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, @engine: @Returns: +<!-- ##### FUNCTION gtk_tree_selection_set_type ##### --> +<para> + +</para> + +@selection: +@type: + <!-- ##### MACRO gtk_marshal_NONE__ENUM_FLOAT ##### --> <para> @@ -172,11 +223,13 @@ void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, </para> -<!-- ##### ARG GtkTextTag:font_set ##### --> +<!-- ##### FUNCTION gtk_widget_get ##### --> <para> </para> +@widget: +@arg: <!-- ##### MACRO gtk_marshal_NONE__POINTER_UINT_ENUM ##### --> <para> @@ -249,20 +302,20 @@ A structure used to return values from @gtk_type_query. @object_size: @class_size: -<!-- ##### FUNCTION gtk_text_buffer_get_clipboard_contents ##### --> +<!-- ##### MACRO gtk_widget_pop_visual ##### --> <para> </para> -@buffer: -@Returns: +@v: -<!-- ##### MACRO gtk_widget_pop_visual ##### --> +<!-- ##### FUNCTION gtk_text_buffer_get_clipboard_contents ##### --> <para> </para> -@v: +@buffer: +@Returns: <!-- ##### FUNCTION gtk_marshal_NONE__C_CALLBACK ##### --> <para> @@ -328,6 +381,24 @@ to gtk_signal_remove_emission_hook()). @func_data: @args: +<!-- ##### FUNCTION gtk_model_simple_node_changed ##### --> +<para> + +</para> + +@simple: +@path: +@iter: + +<!-- ##### FUNCTION gtk_tree_view_column_set_size ##### --> +<para> + +</para> + +@tree_column: +@size: +@width: + <!-- ##### SIGNAL GtkTextView::copy-text ##### --> <para> @@ -345,6 +416,15 @@ to gtk_signal_remove_emission_hook()). @x: @y: +<!-- ##### FUNCTION gtk_object_getv ##### --> +<para> +Gets an array of argument values from an object. +</para> + +@object: the object to get arguments from. +@n_args: the number of arguments to query. +@args: the arguments to fill in. + <!-- ##### STRUCT GtkThemeEngine ##### --> <para> @@ -379,12 +459,29 @@ Get the type of GtkIdentifier. @name: @Returns: +<!-- ##### STRUCT GtkModelSimple ##### --> +<para> + +</para> + +@parent: +@stamp: + <!-- ##### MACRO gtk_marshal_BOOL__POINTER_INT_INT_UINT ##### --> <para> </para> +<!-- ##### FUNCTION gtk_model_simple_node_child_toggled ##### --> +<para> + +</para> + +@simple: +@path: +@iter: + <!-- ##### FUNCTION gtk_marshal_NONE__POINTER_POINTER ##### --> <para> @@ -412,6 +509,15 @@ Get the type of GtkIdentifier. @func_data: @args: +<!-- ##### ENUM GtkCellRendererType ##### --> +<para> + +</para> + +@GTK_CELL_RENDERER_SELECTED: +@GTK_CELL_RENDERER_PRELIT: +@GTK_CELL_RENDERER_INSENSITIVE: + <!-- ##### FUNCTION gtk_marshal_NONE__NONE ##### --> <para> @@ -448,6 +554,15 @@ applications. @is_editable: %TRUE if the user is allowed to edit the text in the widget. +<!-- ##### FUNCTION gtk_model_simple_node_deleted ##### --> +<para> + +</para> + +@simple: +@path: +@iter: + <!-- ##### SIGNAL GtkEditable::delete-text ##### --> <para> This signal is emitted when text is deleted from @@ -519,6 +634,15 @@ Menu Factory @widget: @visual: +<!-- ##### FUNCTION gtk_widget_setv ##### --> +<para> + +</para> + +@widget: +@nargs: +@args: + <!-- ##### MACRO gtk_marshal_NONE__UINT_POINTER_UINT_ENUM_ENUM_POINTER ##### --> <para> @@ -572,6 +696,14 @@ Convert a gtk type into its sequence number </para> +<!-- ##### FUNCTION gtk_text_iter_prev_char ##### --> +<para> + +</para> + +@iter: +@Returns: + <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Short_Description ##### --> @@ -590,6 +722,12 @@ Convert a gtk type into its sequence number @engine: +<!-- ##### ARG GtkTextTag:left-wrapped-line-margin-set ##### --> +<para> + +</para> + + <!-- ##### STRUCT GtkDialogButton ##### --> <para> Deprecated. @@ -606,12 +744,6 @@ Deprecated. @func_data: @args: -<!-- ##### ARG GtkTextTag:overstrike_set ##### --> -<para> - -</para> - - <!-- ##### FUNCTION gtk_text_buffer_cut ##### --> <para> @@ -656,12 +788,36 @@ Control-Return for #GtkText.) @func_data: @args: +<!-- ##### ARG GtkTextTag:left-wrapped-line-margin ##### --> +<para> +Pixel width of the left margin of the text for lines after the first +line in a wrapped paragraph. +</para> + + <!-- ##### SECTION ./tmpl/gtkdebug.sgml:See_Also ##### --> <para> </para> +<!-- ##### FUNCTION gtk_paint_oval ##### --> +<para> + +</para> + +@style: +@window: +@state_type: +@shadow_type: +@area: +@widget: +@detail: +@x: +@y: +@width: +@height: + <!-- ##### MACRO GTK_CONTAINER_RESIZE_PENDING ##### --> <para> @@ -677,6 +833,18 @@ be copied to the clipboard. @editable: the object which received the signal. +<!-- ##### FUNCTION gtk_clist_construct ##### --> +<para> +Initializes a previously allocated #GtkCList widget for use. This should not +normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. +</para> + +@clist: A pointer to an uninitialized #GtkCList widget. +@columns: The number of columns the #GtkCList should have. +@titles: An array of strings that should be used as the titles i +of the columns. There should be enough strings in the array for +the number of columns specified. + <!-- ##### FUNCTION gtk_menu_factory_remove_entries ##### --> <para> @@ -769,6 +937,20 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK </para> +<!-- ##### FUNCTION gtk_object_args_collect ##### --> +<para> +Private: Gets an array of #GtkArgs from a va_list C structure. +</para> + +@object_type: the type of object to collect arguments for. +@arg_list_p: pointer to be filled in with a list of parsed arguments. +@info_list_p: optional pointer for a returned list #GtkArgInfos. +@first_arg_name: name of first argument. +@var_args: value of first argument, followed by more key/value pairs, +terminated by NULL. +@Returns: an error message, or NULL on success. +It is the caller's responsibility to call g_free() in the event of error. + <!-- ##### ENUM GtkFontType ##### --> <para> A set of bit flags used to specify the type of fonts shown @@ -794,6 +976,15 @@ Get the number of signals defined by this object. @obj: the object to query. +<!-- ##### FUNCTION gtk_object_arg_get ##### --> +<para> +Private function to get an argument and argument info from an object. +</para> + +@object: the object whose argument should be retrieved. +@arg: the argument, for the name on input, the rest is filled on output. +@info: a #GtkArgInfo structure to optionally fill in. + <!-- ##### FUNCTION gtk_menu_factory_remove_subfactory ##### --> <para> @@ -860,6 +1051,20 @@ Set the mem_chunk size so it will hold @n_chunks of the objects of that @type. @type: There must be an unlocked TypeNode associated with this type otherwise nothing happens. @n_chunks: +<!-- ##### FUNCTION gtk_draw_oval ##### --> +<para> + +</para> + +@style: +@window: +@state_type: +@shadow_type: +@x: +@y: +@width: +@height: + <!-- ##### MACRO GTK_TYPE_STRUCTURED_FIRST ##### --> <para> The first structured enumerated type value. @@ -977,6 +1182,13 @@ An action signal. Delete a single word. </para> +<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### --> +<para> +Test whether a GtkObject's arguments have been prepared. +</para> + +@obj: the object to examine. + <!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### --> <para> Sets one of the two font filters, to limit the fonts shown. @@ -1018,12 +1230,6 @@ will be shown, or NULL to show all charsets. @Returns: -<!-- ##### ARG GtkTextTag:offset_set ##### --> -<para> - -</para> - - <!-- ##### MACRO GTK_TYPE_NUM_BUILTINS ##### --> <para> No idea. @@ -1048,6 +1254,14 @@ The last "flat" (no struct) enumerated type value. </para> +<!-- ##### FUNCTION gtk_tree_selection_set_tree_view ##### --> +<para> + +</para> + +@selection: +@tree_view: + <!-- ##### FUNCTION gtk_text_mark_unref ##### --> <para> @@ -1086,13 +1300,6 @@ This function is labeled private. @object: the object whose signal handlers should be destroyed. -<!-- ##### ARG GtkTextTag:left_wrapped_line_margin ##### --> -<para> -Pixel width of the left margin of the text for lines after the first -line in a wrapped paragraph. -</para> - - <!-- ##### FUNCTION gtk_text_iter_in_region ##### --> <para> @@ -1146,6 +1353,29 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN @a: +<!-- ##### FUNCTION gtk_object_class_user_signal_new ##### --> +<para> +Define a signal-handler for a new signal on an already defined +object. +</para> +<para> +See the signal documentation for more general information. +</para> + +@klass: the object class to define the signal for. +@name: the name of the signal. +@signal_flags: the default emission behavior for the signal. +See gtk_signal_new(). +@marshaller: a function that will take an array of GtkArgs +and invoke the appropriate handler with the normal calling +conventions. +@return_val: specify the return-value type for the signal +(or GTK_TYPE_NONE for no return-value). +@nparams: specify the number of parameters the signal +receives from the caller of gtk_signal_emit(). +@Varargs: list of nparams #GtkTypes to pass to the signal handlers. +@Returns: the signal id. (See #GtkSignals) + <!-- ##### SIGNAL GtkTextView::paste-text ##### --> <para> @@ -1168,6 +1398,16 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN @ruler: the gtkruler +<!-- ##### FUNCTION gtk_object_newv ##### --> +<para> +Construct an object with an array of arguments. +</para> + +@object_type: the type of the object to create. +@n_args: the number of arguments to set. +@args: an array of n_args arguments (which are name and value pairs). +@Returns: the new GtkObject. + <!-- ##### MACRO GTK_WIDGET_USER_STYLE ##### --> <para> @@ -1175,6 +1415,14 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN @obj: +<!-- ##### FUNCTION gtk_text_iter_forward_to_newline ##### --> +<para> + +</para> + +@iter: +@Returns: + <!-- ##### ENUM GtkDebugFlag ##### --> <para> @@ -1203,6 +1451,15 @@ Given a type, return various interesting parameters of the type. @type: GtkType @Returns: GtkTypeQuery* +<!-- ##### ENUM GtkTreeViewColumnType ##### --> +<para> + +</para> + +@GTK_TREE_VIEW_COLUMN_RESIZEABLE: +@GTK_TREE_VIEW_COLUMN_AUTOSIZE: +@GTK_TREE_VIEW_COLUMN_FIXED: + <!-- ##### SECTION ./tmpl/gtkprivate.sgml:Long_Description ##### --> <para> @@ -1231,6 +1488,30 @@ Hide the name of gtk_identifier_get_type </para> +<!-- ##### FUNCTION gtk_ctree_construct ##### --> +<para> +This function is not usually used by users. +</para> + +@ctree: +@columns: +@tree_column: +@titles: + +<!-- ##### FUNCTION gtk_draw_cross ##### --> +<para> + +</para> + +@style: +@window: +@state_type: +@shadow_type: +@x: +@y: +@width: +@height: + <!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### --> <para> Returns whether a connection id is valid (and optionally not blocked). @@ -1243,6 +1524,13 @@ handler. @Returns: TRUE if the signal exists and wasn't blocked, unless #may_be_blocked was specified. FALSE otherwise. +<!-- ##### FUNCTION gtk_tree_selection_new ##### --> +<para> + +</para> + +@Returns: + <!-- ##### MACRO GTK_PRIVATE_FLAGS ##### --> <para> @@ -1250,6 +1538,13 @@ unless #may_be_blocked was specified. FALSE otherwise. @wid: +<!-- ##### FUNCTION gtk_model_simple_new ##### --> +<para> + +</para> + +@Returns: + <!-- ##### FUNCTION gtk_marshal_BOOL__NONE ##### --> <para> @@ -1300,6 +1595,12 @@ Given the type of an object and a pointer to it, the object is freed. Private Information +<!-- ##### ARG GtkEditable:text-position ##### --> +<para> +The position of the cursor. +</para> + + <!-- ##### FUNCTION gtk_theme_engine_register_type ##### --> <para> @@ -1348,6 +1649,36 @@ position. @window: @xid: +<!-- ##### FUNCTION gtk_tree_view_column_set_header_active ##### --> +<para> + +</para> + +@tree_column: +@active: + +<!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### --> +<para> +Define a signal-handler for a new signal on an already defined +object. +</para> + +@klass: the object class to define the signal for. +@name: the name of the signal. +@signal_flags: the default emission behavior for the signal. +See gtk_signal_new(). +@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array +of arguments, and invokes the function using the appropriate +calling conventions. Usually just select a function +out of gtkmarshal.h. +@return_val: specify the return-value type for the signal (possibly +#GTK_TYPE_NONE). +@nparams: specify the number of parameters the signal +receives from the caller of gtk_signal_emit(). +@params: array of #GtkTypes the signal handlers for this signal +should have in their prototype (of length nparams). +@Returns: the signal id. (See #GtkSignals) + <!-- ##### FUNCTION gtk_marshal_NONE__BOOL ##### --> <para> @@ -1451,6 +1782,15 @@ cursor. (Can be negative). @type: @action: +<!-- ##### FUNCTION gtk_object_arg_set ##### --> +<para> +Private function to set an argument and argument info to an object. +</para> + +@object: the object whose argument should be set. +@arg: the argument. +@info: infomation about this type of argument in general. + <!-- ##### ENUM GtkTextViewDeleteType ##### --> <para> @@ -1483,6 +1823,22 @@ The first "flat" (no struct) enumerated type value. </para> +<!-- ##### FUNCTION gtk_widget_getv ##### --> +<para> + +</para> + +@widget: +@nargs: +@args: + +<!-- ##### FUNCTION gtk_tree_model_sort_resort ##### --> +<para> + +</para> + +@tree_model_sort: + <!-- ##### FUNCTION gtk_menu_factory_new ##### --> <para> @@ -1491,6 +1847,45 @@ The first "flat" (no struct) enumerated type value. @type: @Returns: +<!-- ##### FUNCTION gtk_object_constructed ##### --> +<para> +Mark an allocated object as constructed. +This is used for situations +that require precise control of the construction process. +</para> +<para> +This is done when gtk_object_default_construct() is inadequate. +In #GtkCList the need arises because #GtkCList does construction work that +must happen <emphasis>after</emphasis> its derivers. This work +cannot be done in an initializer function, so an alternate +constructor is mandatory. It calls gtk_object_constructed() to +indicate it has done its job, so that no other constructor will +be invoked. +</para> +<para> +Normally this function is just automatically run from +gtk_object_default_construct(). +</para> + +@object: object which has been constructed. This is usually +done automatically by gtk_object_new() and gtk_object_newv(). + +<!-- ##### FUNCTION gtk_object_default_construct ##### --> +<para> +This function is called to construct arguments that haven't been initialized +but have the #GTK_ARG_CONSTRUCT flag set. +</para> +<para> +All number arguments are set to 0. All pointers and strings +are set to NULL. +</para> +<para> +Normally invoked by gtk_object_new() automatically; gtk_type_new() can +be used to bypass it. +</para> + +@object: the object to initialize. + <!-- ##### MACRO gtk_marshal_NONE__UINT_POINTER_UINT_UINT_ENUM ##### --> <para> @@ -1504,6 +1899,39 @@ The first "flat" (no struct) enumerated type value. @buffer: +<!-- ##### ARG GtkTextTag:font-set ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gtk_object_arg_get_info ##### --> +<para> +Query information about an argument type. +</para> + +@object_type: type of object to query about. +@arg_name: name of the argument. +@info_p: pointer to be filled in with a pointer to the GtkArgInfo. +@Returns: an error message, or NULL on success. +It is the caller's responsibility to call g_free() in the event of error. + +<!-- ##### ENUM GtkTreeSelectionType ##### --> +<para> + +</para> + +@GTK_TREE_SELECTION_SINGLE: +@GTK_TREE_SELECTION_MULTI: + +<!-- ##### ARG GtkObject:signal-after ##### --> +<para> +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the signal is always run +after other user handlers and the default handler. +</para> + + <!-- ##### STRUCT GtkTextTabArray ##### --> <para> @@ -1530,6 +1958,16 @@ Causes the "changed" signal to be emitted. @editable: a #GtkEditable widget. +<!-- ##### FUNCTION gtk_object_setv ##### --> +<para> +Set an array of arguments. +</para> + +@object: the object whose arguments should be set. +@n_args: the number of arguments to set. +@args: the desired values, as an array of #GtkArgs (which contain +the names, types, and values of the arguments). + <!-- ##### SIGNAL GtkTextView::move ##### --> <para> @@ -1615,6 +2053,24 @@ Get the array of signals defined for this object. @obj: the object to fetch the signals from. +<!-- ##### FUNCTION gtk_object_query_args ##### --> +<para> +Get all the arguments that may be used for a given type. +</para> +<para> +In Java, this type of mechanism is called +<wordasword>introspection</wordasword>. It is used by applications +like Glade, that have to determine what can be done to an object +at run-time. +</para> + +@class_type: the GtkType of the ObjectClass +(returned from GTK_OBJECT_CLASS(class)->type for example). +@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to +each argument. You must g_free() this if you request it. +@n_args: the number of arguments is returned in this field. +@Returns: an array of arguments, that you must deallocate with g_free(). + <!-- ##### SIGNAL GtkEditable::move-to-column ##### --> <para> An action signal. Move the cursor to the given column. @@ -1656,6 +2112,14 @@ make sure that it's okay to cast @type_object into a @cast_type. @cast_type: GtkType @Returns: the same GtkTypeObject* as @type_object +<!-- ##### FUNCTION gtk_tree_model_sort_set_sort_col ##### --> +<para> + +</para> + +@tree_model_sort: +@sort_col: + <!-- ##### FUNCTION gtk_themes_exit ##### --> <para> @@ -1673,12 +2137,6 @@ make sure that it's okay to cast @type_object into a @cast_type. @func_data: @args: -<!-- ##### ARG GtkEditable:text_position ##### --> -<para> -The position of the cursor. -</para> - - <!-- ##### MACRO gtk_marshal_NONE__OBJECT ##### --> <para> @@ -1710,6 +2168,18 @@ sure that it's okay to cast something of that @klass into a @cast_type. @cast_type: GtkType @Returns: Always return @klass. +<!-- ##### ARG GtkObject:object-signal-after ##### --> +<para> +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the user data and objects +and swapped when the signal handler is invoked, +and so that the handler is invoked after all others. +</para> +<para> +See gtk_signal_connect_object_after() for more details. +</para> + + <!-- ##### FUNCTION gtk_menu_factory_destroy ##### --> <para> @@ -1717,6 +2187,24 @@ sure that it's okay to cast something of that @klass into a @cast_type. @factory: +<!-- ##### FUNCTION gtk_paint_ramp ##### --> +<para> + +</para> + +@style: +@window: +@state_type: +@shadow_type: +@area: +@widget: +@detail: +@arrow_type: +@x: +@y: +@width: +@height: + <!-- ##### FUNCTION gtk_signal_n_emissions ##### --> <para> Find out the recursion depth of emissions for a particular type @@ -1813,6 +2301,30 @@ May be NULL. @Returns: +<!-- ##### FUNCTION gtk_paint_cross ##### --> +<para> + +</para> + +@style: +@window: +@state_type: +@shadow_type: +@area: +@widget: +@detail: +@x: +@y: +@width: +@height: + +<!-- ##### ARG GtkObject:signal ##### --> +<para> +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object. +</para> + + <!-- ##### FUNCTION gtk_type_describe_heritage ##### --> <para> Print the types @type inherits from. @@ -1883,6 +2395,24 @@ destroyed. @window: @defaultw: +<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### --> +<para> + +</para> + +@textbuffer: the object which received the signal. +@arg1: +@arg2: +@arg3: + +<!-- ##### FUNCTION gtk_tree_selection_new_with_tree_view ##### --> +<para> + +</para> + +@tree_view: +@Returns: + <!-- ##### FUNCTION gtk_marshal_NONE__INT ##### --> <para> @@ -1893,6 +2423,35 @@ destroyed. @func_data: @args: +<!-- ##### ARG GtkObject:object-signal ##### --> +<para> +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the user data and objects +and swapped when the signal handler is invoked. +</para> +<para> +This is useful for handlers that are primarily notifying +other objects and could just invoke an already existing function +if the parameters were swapped. +See gtk_signal_connect_object() for more details. +</para> + + +<!-- ##### FUNCTION gtk_draw_ramp ##### --> +<para> + +</para> + +@style: +@window: +@state_type: +@shadow_type: +@arrow_type: +@x: +@y: +@width: +@height: + <!-- ##### MACRO GTK_WIDGET_LEAVE_PENDING ##### --> <para> @@ -1923,6 +2482,20 @@ destroyed. @func_data: @args: +<!-- ##### FUNCTION gtk_tree_view_column_set_col_type ##### --> +<para> + +</para> + +@tree_column: +@type: + +<!-- ##### ARG GtkTextTag:overstrike-set ##### --> +<para> + +</para> + + <!-- ##### FUNCTION gtk_marshal_INT__POINTER_CHAR_CHAR ##### --> <para> @@ -1953,6 +2526,14 @@ destroyed. @func_data: @args: +<!-- ##### SIGNAL GtkWidget::draw ##### --> +<para> + +</para> + +@widget: the object which received the signal. +@area: + <!-- ##### MACRO gtk_marshal_NONE__STRING_INT_POINTER ##### --> <para> @@ -2012,12 +2593,11 @@ object. @arg1: @arg2: -<!-- ##### FUNCTION gtk_container_register_toplevel ##### --> +<!-- ##### MACRO gtk_marshal_ENUM__ENUM ##### --> <para> </para> -@container: <!-- ##### MACRO gtk_widget_push_visual ##### --> <para> @@ -2027,11 +2607,12 @@ object. @v: @visual: -<!-- ##### MACRO gtk_marshal_ENUM__ENUM ##### --> +<!-- ##### FUNCTION gtk_container_register_toplevel ##### --> <para> </para> +@container: <!-- ##### SECTION ./tmpl/gtkimcontextsimple.sgml:Title ##### --> GtkIMContextSimple @@ -2043,12 +2624,6 @@ GtkIMContextSimple </para> -<!-- ##### ARG GtkTextTag:left_wrapped_line_margin_set ##### --> -<para> - -</para> - - <!-- ##### MACRO GTK_VALUE_C_CALLBACK ##### --> <para> Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK @@ -2082,6 +2657,14 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK </para> +<!-- ##### FUNCTION gtk_tree_view_set_headers_active ##### --> +<para> + +</para> + +@tree_view: +@active: + <!-- ##### FUNCTION gtk_text_buffer_find_regexp ##### --> <para> @@ -2112,6 +2695,14 @@ Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK @GTK_TEXT_SCROLL_PAGE_DOWN: @GTK_TEXT_SCROLL_PAGE_UP: +<!-- ##### FUNCTION gtk_text_iter_next_char ##### --> +<para> + +</para> + +@iter: +@Returns: + <!-- ##### STRUCT GtkTextBTree ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtkaccellabel.sgml b/docs/reference/gtk/tmpl/gtkaccellabel.sgml index 7676b5c70..07710fe4d 100644 --- a/docs/reference/gtk/tmpl/gtkaccellabel.sgml +++ b/docs/reference/gtk/tmpl/gtkaccellabel.sgml @@ -125,7 +125,7 @@ accelerators are added or removed from the associated widget. @Returns: always returns FALSE. -<!-- ##### ARG GtkAccelLabel:accel_widget ##### --> +<!-- ##### ARG GtkAccelLabel:accel-widget ##### --> <para> The widget whose accelerators are to be shown by the #GtkAccelLabel. </para> diff --git a/docs/reference/gtk/tmpl/gtkarrow.sgml b/docs/reference/gtk/tmpl/gtkarrow.sgml index dd3eaf25b..fc40e3dcc 100644 --- a/docs/reference/gtk/tmpl/gtkarrow.sgml +++ b/docs/reference/gtk/tmpl/gtkarrow.sgml @@ -77,12 +77,12 @@ Sets the direction and style of the #GtkArrow, @arrow. @shadow_type: a valid #GtkShadowType. -<!-- ##### ARG GtkArrow:arrow_type ##### --> +<!-- ##### ARG GtkArrow:arrow-type ##### --> <para>
the arrow direction, one of #GtkArrowType.
</para> -<!-- ##### ARG GtkArrow:shadow_type ##### --> +<!-- ##### ARG GtkArrow:shadow-type ##### --> <para>
the arrow style, one of #GtkShadowType.
</para> diff --git a/docs/reference/gtk/tmpl/gtkaspectframe.sgml b/docs/reference/gtk/tmpl/gtkaspectframe.sgml index bac6976d5..4f01f1aed 100644 --- a/docs/reference/gtk/tmpl/gtkaspectframe.sgml +++ b/docs/reference/gtk/tmpl/gtkaspectframe.sgml @@ -78,7 +78,7 @@ to 1.0 (right aligned) </para> -<!-- ##### ARG GtkAspectFrame:obey_child ##### --> +<!-- ##### ARG GtkAspectFrame:obey-child ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml index b94a57489..cafd4fb01 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml @@ -14,7 +14,7 @@ GtkCellRenderer </para> -<!-- ##### ENUM GtkCellRendererType ##### --> +<!-- ##### ENUM GtkCellRendererState ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml b/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml index 96dc1bb05..ae99e4d4a 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml @@ -38,3 +38,21 @@ GtkCellRendererToggle @radio: +<!-- ##### FUNCTION gtk_cell_renderer_toggle_get_active ##### --> +<para> + +</para> + +@toggle: +@Returns: + + +<!-- ##### FUNCTION gtk_cell_renderer_toggle_set_active ##### --> +<para> + +</para> + +@toggle: +@setting: + + diff --git a/docs/reference/gtk/tmpl/gtkclist.sgml b/docs/reference/gtk/tmpl/gtkclist.sgml index 76cdb5b4f..ae1485a7d 100644 --- a/docs/reference/gtk/tmpl/gtkclist.sgml +++ b/docs/reference/gtk/tmpl/gtkclist.sgml @@ -97,15 +97,6 @@ widget's column titles is set. @clist: The #GtkCList widget to check. -<!-- ##### MACRO GTK_CLIST_CHILD_HAS_FOCUS ##### --> -<para> -A macro to check whether a child widget of the CList -has the focus. -</para> - -@clist: The #GtkCList widget to check. - - <!-- ##### MACRO GTK_CLIST_ADD_MODE ##### --> <para> A macro to test whether the CList is in "add mode." @@ -345,19 +336,6 @@ An enumeration for drag operations. @GTK_CLIST_DRAG_INTO: @GTK_CLIST_DRAG_AFTER: -<!-- ##### FUNCTION gtk_clist_construct ##### --> -<para> -Initializes a previously allocated #GtkCList widget for use. This should not -normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. -</para> - -@clist: A pointer to an uninitialized #GtkCList widget. -@columns: The number of columns the #GtkCList should have. -@titles: An array of strings that should be used as the titles i -of the columns. There should be enough strings in the array for -the number of columns specified. - - <!-- ##### FUNCTION gtk_clist_new ##### --> <para> Creates a new #GtkCList widget for use. @@ -1279,22 +1257,22 @@ previously selected row in a "single" or "browse" mode CList. @column: The column where the selection occured. @event: -<!-- ##### ARG GtkCList:n_columns ##### --> +<!-- ##### ARG GtkCList:n-columns ##### --> <para> An integer value for a column. </para> -<!-- ##### ARG GtkCList:shadow_type ##### --> +<!-- ##### ARG GtkCList:shadow-type ##### --> <para> Sets the shadowing for the CList. </para> -<!-- ##### ARG GtkCList:selection_mode ##### --> +<!-- ##### ARG GtkCList:selection-mode ##### --> <para> Sets the type of selection mode for the CList. </para> -<!-- ##### ARG GtkCList:row_height ##### --> +<!-- ##### ARG GtkCList:row-height ##### --> <para> An integer value representing the height of a row in pixels. </para> @@ -1305,19 +1283,19 @@ A boolean value for determining if the user can re-order the CList's columns. </para> -<!-- ##### ARG GtkCList:titles_active ##### --> +<!-- ##### ARG GtkCList:titles-active ##### --> <para> A boolean value for setting whether the column titles can be clicked. </para> -<!-- ##### ARG GtkCList:use_drag_icons ##### --> +<!-- ##### ARG GtkCList:use-drag-icons ##### --> <para> A boolean value for setting whether to use icons during drag operations. </para> -<!-- ##### ARG GtkCList:sort_type ##### --> +<!-- ##### ARG GtkCList:sort-type ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml index dfcf2a992..ec674dea8 100644 --- a/docs/reference/gtk/tmpl/gtkcontainer.sgml +++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml @@ -380,12 +380,12 @@ GtkContainer @container: the object which received the signal. @widget: -<!-- ##### ARG GtkContainer:border_width ##### --> +<!-- ##### ARG GtkContainer:border-width ##### --> <para> </para> -<!-- ##### ARG GtkContainer:resize_mode ##### --> +<!-- ##### ARG GtkContainer:resize-mode ##### --> <para> </para> @@ -395,7 +395,7 @@ GtkContainer </para> -<!-- ##### ARG GtkContainer:reallocate_redraws ##### --> +<!-- ##### ARG GtkContainer:reallocate-redraws ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkctree.sgml b/docs/reference/gtk/tmpl/gtkctree.sgml index 88f4e8650..c9716105f 100644 --- a/docs/reference/gtk/tmpl/gtkctree.sgml +++ b/docs/reference/gtk/tmpl/gtkctree.sgml @@ -406,17 +406,6 @@ as the functions below to access it. @list: -<!-- ##### FUNCTION gtk_ctree_construct ##### --> -<para> -This function is not usually used by users. -</para> - -@ctree: -@columns: -@tree_column: -@titles: - - <!-- ##### FUNCTION gtk_ctree_new_with_titles ##### --> <para> Create a new #GtkCTree widget with the given titles for the columns. @@ -1220,12 +1209,12 @@ Emitted when a node is unselected. @node: The node corresponding to the selected row. @column: -<!-- ##### ARG GtkCTree:n_columns ##### --> +<!-- ##### ARG GtkCTree:n-columns ##### --> <para> The number of columns in the tree. </para> -<!-- ##### ARG GtkCTree:tree_column ##### --> +<!-- ##### ARG GtkCTree:tree-column ##### --> <para> The column in which the actual tree graphic appears. </para> @@ -1240,17 +1229,17 @@ The number of pixels to indent the tree levels. The number of pixels between the tree and the columns. </para> -<!-- ##### ARG GtkCTree:show_stub ##### --> +<!-- ##### ARG GtkCTree:show-stub ##### --> <para> FIXME </para> -<!-- ##### ARG GtkCTree:line_style ##### --> +<!-- ##### ARG GtkCTree:line-style ##### --> <para> The style of the lines in the tree graphic. </para> -<!-- ##### ARG GtkCTree:expander_style ##### --> +<!-- ##### ARG GtkCTree:expander-style ##### --> <para> The style of the expander buttons. </para> diff --git a/docs/reference/gtk/tmpl/gtkcurve.sgml b/docs/reference/gtk/tmpl/gtkcurve.sgml index 2c3b78e01..919f6295f 100644 --- a/docs/reference/gtk/tmpl/gtkcurve.sgml +++ b/docs/reference/gtk/tmpl/gtkcurve.sgml @@ -123,27 +123,27 @@ calling gtk_curve_reset() or gtk_curve_set_gamma(). @curve: the object which received the signal. -<!-- ##### ARG GtkCurve:curve_type ##### --> +<!-- ##### ARG GtkCurve:curve-type ##### --> <para> </para> -<!-- ##### ARG GtkCurve:min_x ##### --> +<!-- ##### ARG GtkCurve:min-x ##### --> <para> </para> -<!-- ##### ARG GtkCurve:max_x ##### --> +<!-- ##### ARG GtkCurve:max-x ##### --> <para> </para> -<!-- ##### ARG GtkCurve:min_y ##### --> +<!-- ##### ARG GtkCurve:min-y ##### --> <para> </para> -<!-- ##### ARG GtkCurve:max_y ##### --> +<!-- ##### ARG GtkCurve:max-y ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkentry.sgml b/docs/reference/gtk/tmpl/gtkentry.sgml index 6c95fceab..7e5111e1d 100644 --- a/docs/reference/gtk/tmpl/gtkentry.sgml +++ b/docs/reference/gtk/tmpl/gtkentry.sgml @@ -268,7 +268,7 @@ to fit. @entry: the object which received the signal. -<!-- ##### ARG GtkEntry:text_position ##### --> +<!-- ##### ARG GtkEntry:text-position ##### --> <para> </para> @@ -278,7 +278,7 @@ to fit. </para> -<!-- ##### ARG GtkEntry:max_length ##### --> +<!-- ##### ARG GtkEntry:max-length ##### --> <para> Determines the maximum allowed length of the contents of the widget. See gtk_entry_set_max_length(). @@ -290,7 +290,7 @@ Determines whether the contents of the entry widget are visible or not. See gtk_entry_set_visibility(). </para> -<!-- ##### ARG GtkEntry:invisible_char ##### --> +<!-- ##### ARG GtkEntry:invisible-char ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkenums.sgml b/docs/reference/gtk/tmpl/gtkenums.sgml index 33beb4c95..162f9300b 100644 --- a/docs/reference/gtk/tmpl/gtkenums.sgml +++ b/docs/reference/gtk/tmpl/gtkenums.sgml @@ -147,8 +147,8 @@ Used for justifying the text inside a #GtkLabel widget. (See also </para> -@GTK_MOVEMENT_CHARS: -@GTK_MOVEMENT_POSITIONS: +@GTK_MOVEMENT_LOGICAL_POSITIONS: +@GTK_MOVEMENT_VISUAL_POSITIONS: @GTK_MOVEMENT_WORDS: @GTK_MOVEMENT_DISPLAY_LINES: @GTK_MOVEMENT_DISPLAY_LINE_ENDS: diff --git a/docs/reference/gtk/tmpl/gtkframe.sgml b/docs/reference/gtk/tmpl/gtkframe.sgml index 0547a0ee1..077699e7d 100644 --- a/docs/reference/gtk/tmpl/gtkframe.sgml +++ b/docs/reference/gtk/tmpl/gtkframe.sgml @@ -83,12 +83,12 @@ Set the shadow type for the Frame widget. </para> -<!-- ##### ARG GtkFrame:label_xalign ##### --> +<!-- ##### ARG GtkFrame:label-xalign ##### --> <para> </para> -<!-- ##### ARG GtkFrame:label_yalign ##### --> +<!-- ##### ARG GtkFrame:label-yalign ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkhandlebox.sgml b/docs/reference/gtk/tmpl/gtkhandlebox.sgml index f4f15b7ce..c5a38131d 100644 --- a/docs/reference/gtk/tmpl/gtkhandlebox.sgml +++ b/docs/reference/gtk/tmpl/gtkhandlebox.sgml @@ -155,12 +155,12 @@ handlebox are detached from the main window. Determines the shadow type for the handlebox. </para> -<!-- ##### ARG GtkHandleBox:handle_position ##### --> +<!-- ##### ARG GtkHandleBox:handle-position ##### --> <para> Determines the side of the handlebox where the handle is drawn. </para> -<!-- ##### ARG GtkHandleBox:snap_edge ##### --> +<!-- ##### ARG GtkHandleBox:snap-edge ##### --> <para> Determines the snap edge of a handlebox. The snap edge is the edge of the detached child that must be aligned diff --git a/docs/reference/gtk/tmpl/gtklist.sgml b/docs/reference/gtk/tmpl/gtklist.sgml index eb528cfea..4eaf3e468 100644 --- a/docs/reference/gtk/tmpl/gtklist.sgml +++ b/docs/reference/gtk/tmpl/gtklist.sgml @@ -355,7 +355,7 @@ The child @widget has just been unselected. @list: the object which received the signal. @widget: the newly unselected child. -<!-- ##### ARG GtkList:selection_mode ##### --> +<!-- ##### ARG GtkList:selection-mode ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkmain.sgml b/docs/reference/gtk/tmpl/gtkmain.sgml index b4e8506f8..1c7a5e215 100644 --- a/docs/reference/gtk/tmpl/gtkmain.sgml +++ b/docs/reference/gtk/tmpl/gtkmain.sgml @@ -643,6 +643,15 @@ This macro is deprecated. You should use G_PRIORITY_LOW instead. @Returns: +<!-- ##### FUNCTION gtk_get_current_event_state ##### --> +<para> + +</para> + +@state: +@Returns: + + <!-- ##### FUNCTION gtk_get_event_widget ##### --> <para> diff --git a/docs/reference/gtk/tmpl/gtknotebook.sgml b/docs/reference/gtk/tmpl/gtknotebook.sgml index a51536f49..9e22ef178 100644 --- a/docs/reference/gtk/tmpl/gtknotebook.sgml +++ b/docs/reference/gtk/tmpl/gtknotebook.sgml @@ -41,6 +41,7 @@ will be a popup menu allowing the users to switch pages. The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook. </para> + <!-- ##### FUNCTION gtk_notebook_new ##### --> <para> </para> @@ -52,28 +53,28 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook. <para> </para> -@notebook: -@child: -@tab_label: +@notebook: +@child: +@tab_label: <!-- ##### FUNCTION gtk_notebook_append_page_menu ##### --> <para> </para> -@notebook: -@child: -@tab_label: -@menu_label: +@notebook: +@child: +@tab_label: +@menu_label: <!-- ##### FUNCTION gtk_notebook_prepend_page ##### --> <para> </para> -@notebook: -@child: the -@tab_label: +@notebook: +@child: the +@tab_label: <!-- ##### FUNCTION gtk_notebook_prepend_page_menu ##### --> @@ -82,29 +83,29 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook. @notebook: @child: -@tab_label: -@menu_label: +@tab_label: +@menu_label: <!-- ##### FUNCTION gtk_notebook_insert_page ##### --> <para> </para> -@notebook: -@child: -@tab_label: -@position: +@notebook: +@child: +@tab_label: +@position: <!-- ##### FUNCTION gtk_notebook_insert_page_menu ##### --> <para> </para> -@notebook: -@child: -@tab_label: +@notebook: +@child: +@tab_label: @menu_label: -@position: +@position: <!-- ##### FUNCTION gtk_notebook_remove_page ##### --> @@ -112,7 +113,7 @@ The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook. </para> @notebook: -@page_num: +@page_num: <!-- ##### MACRO gtk_notebook_current_page ##### --> @@ -126,31 +127,31 @@ Compatibility macro; in gtkcompat.h. <para> </para> -@notebook: -@child: -@Returns: +@notebook: +@child: +@Returns: <!-- ##### FUNCTION gtk_notebook_set_page ##### --> <para> </para> -@notebook: -@page_num: +@notebook: +@page_num: <!-- ##### FUNCTION gtk_notebook_next_page ##### --> <para> </para> -@notebook: +@notebook: <!-- ##### FUNCTION gtk_notebook_prev_page ##### --> <para> </para> -@notebook: +@notebook: <!-- ##### FUNCTION gtk_notebook_reorder_child ##### --> @@ -158,8 +159,11 @@ Compatibility macro; in gtkcompat.h. </para> @notebook -@child: -@position: + +@notebook: +@child: +@position: + <!-- ##### FUNCTION gtk_notebook_set_tab_pos ##### --> <para> @@ -173,46 +177,47 @@ Compatibility macro; in gtkcompat.h. <para> </para> -@notebook: -@show_tabs: +@notebook: +@show_tabs: <!-- ##### FUNCTION gtk_notebook_set_show_border ##### --> <para> </para> -@notebook: -@show_border: +@notebook: +@show_border: <!-- ##### FUNCTION gtk_notebook_set_scrollable ##### --> <para> </para> -@notebook: -@scrollable: +@notebook: +@scrollable: <!-- ##### FUNCTION gtk_notebook_set_tab_border ##### --> <para> </para> -@notebook: -@border_width: +@notebook: +@border_width: <!-- ##### FUNCTION gtk_notebook_popup_enable ##### --> <para> </para> -@notebook: +@notebook: <!-- ##### FUNCTION gtk_notebook_popup_disable ##### --> <para> </para> -@notebook: +@notebook: + <!-- ##### FUNCTION gtk_notebook_get_current_page ##### --> <para> @@ -235,37 +240,37 @@ Compatibility macro; in gtkcompat.h. <para> </para> -@notebook: -@page_num: -@Returns: +@notebook: +@page_num: +@Returns: <!-- ##### FUNCTION gtk_notebook_get_tab_label ##### --> <para> </para> -@notebook: -@child: -@Returns: +@notebook: +@child: +@Returns: <!-- ##### FUNCTION gtk_notebook_query_tab_label_packing ##### --> <para> </para> -@notebook: -@child: -@expand: -@fill: -@pack_type: +@notebook: +@child: +@expand: +@fill: +@pack_type: <!-- ##### FUNCTION gtk_notebook_set_homogeneous_tabs ##### --> <para> </para> -@notebook: -@homogeneous: +@notebook: +@homogeneous: <!-- ##### FUNCTION gtk_notebook_set_menu_label ##### --> @@ -281,14 +286,17 @@ Compatibility macro; in gtkcompat.h. <para> </para> +@notebook: +@child: +@menu_text: <!-- ##### FUNCTION gtk_notebook_set_tab_hborder ##### --> <para> </para> -@notebook: -@tab_hborder: +@notebook: +@tab_hborder: <!-- ##### FUNCTION gtk_notebook_set_tab_label ##### --> @@ -296,8 +304,8 @@ Compatibility macro; in gtkcompat.h. </para> @notebook: -@child: -@tab_label: +@child: +@tab_label: <!-- ##### FUNCTION gtk_notebook_set_tab_label_packing ##### --> @@ -306,9 +314,9 @@ Compatibility macro; in gtkcompat.h. @notebook: @child: -@expand: +@expand: @fill: -@pack_type: +@pack_type: <!-- ##### FUNCTION gtk_notebook_set_tab_label_text ##### --> @@ -324,8 +332,8 @@ Compatibility macro; in gtkcompat.h. <para> </para> -@notebook: -@tab_vborder: +@notebook: +@tab_vborder: <!-- ##### SIGNAL GtkNotebook::switch-page ##### --> @@ -342,32 +350,32 @@ Emitted when the user or a function changes the current page. The current page </para> -<!-- ##### ARG GtkNotebook:tab_pos ##### --> +<!-- ##### ARG GtkNotebook:tab-pos ##### --> <para> The edge at which the tabs for switching pages are drawn. </para> -<!-- ##### ARG GtkNotebook:tab_border ##### --> +<!-- ##### ARG GtkNotebook:tab-border ##### --> <para> Whether the tab labels have a border on all sides. </para> -<!-- ##### ARG GtkNotebook:tab_hborder ##### --> +<!-- ##### ARG GtkNotebook:tab-hborder ##### --> <para> Whether the tab labels have a horizontal border. </para> -<!-- ##### ARG GtkNotebook:tab_vborder ##### --> +<!-- ##### ARG GtkNotebook:tab-vborder ##### --> <para> Whether the tab labels have a vertical border. </para> -<!-- ##### ARG GtkNotebook:show_tabs ##### --> +<!-- ##### ARG GtkNotebook:show-tabs ##### --> <para> Whether to show tabs for the notebook pages. </para> -<!-- ##### ARG GtkNotebook:show_border ##### --> +<!-- ##### ARG GtkNotebook:show-border ##### --> <para> Whether to draw a bevel around the noteobook. </para> @@ -378,7 +386,7 @@ Whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area. </para> -<!-- ##### ARG GtkNotebook:enable_popup ##### --> +<!-- ##### ARG GtkNotebook:enable-popup ##### --> <para> Whether the popup menu for switching pages is enabled. </para> diff --git a/docs/reference/gtk/tmpl/gtkobject.sgml b/docs/reference/gtk/tmpl/gtkobject.sgml index 9857e288c..18a7eace9 100644 --- a/docs/reference/gtk/tmpl/gtkobject.sgml +++ b/docs/reference/gtk/tmpl/gtkobject.sgml @@ -210,9 +210,8 @@ there own references, if they believe they are nearly primary ownership of the object. GTK_CONNECTED: refers to whether are signals are connected to this object. -@GTK_RESERVED: -@GTK_CONSTRUCTED: refers to whether the arguments for this object are -ready. +@GTK_RESERVED_1: +@GTK_RESERVED_2: <!-- ##### MACRO GTK_OBJECT_FLAGS ##### --> <para> @@ -249,14 +248,6 @@ Test whether a GtkObject has had a signal connected to it. @obj: the object to examine. -<!-- ##### MACRO GTK_OBJECT_CONSTRUCTED ##### --> -<para> -Test whether a GtkObject's arguments have been prepared. -</para> - -@obj: the object to examine. - - <!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### --> <para> Turn on certain object flags. (Private) @@ -289,55 +280,6 @@ set. Hence this flag is not allowed with #GTK_ARG_WRITABLE, and is redundant with #GTK_ARG_CONSTRUCT. @GTK_ARG_CHILD_ARG: an argument type that applies to (and may be different for) each child. Used by #GtkContainer. -@GTK_ARG_MASK: the bitwise-OR of all the flags. -@GTK_ARG_READWRITE: the argument is readable and writable. - -<!-- ##### FUNCTION gtk_object_class_user_signal_new ##### --> -<para> -Define a signal-handler for a new signal on an already defined -object. -</para> -<para> -See the signal documentation for more general information. -</para> - -@klass: the object class to define the signal for. -@name: the name of the signal. -@signal_flags: the default emission behavior for the signal. -See gtk_signal_new(). -@marshaller: a function that will take an array of GtkArgs -and invoke the appropriate handler with the normal calling -conventions. -@return_val: specify the return-value type for the signal -(or GTK_TYPE_NONE for no return-value). -@nparams: specify the number of parameters the signal -receives from the caller of gtk_signal_emit(). -@Varargs: list of nparams #GtkTypes to pass to the signal handlers. -@Returns: the signal id. (See #GtkSignals) - - -<!-- ##### FUNCTION gtk_object_class_user_signal_newv ##### --> -<para> -Define a signal-handler for a new signal on an already defined -object. -</para> - -@klass: the object class to define the signal for. -@name: the name of the signal. -@signal_flags: the default emission behavior for the signal. -See gtk_signal_new(). -@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array -of arguments, and invokes the function using the appropriate -calling conventions. Usually just select a function -out of gtkmarshal.h. -@return_val: specify the return-value type for the signal (possibly -#GTK_TYPE_NONE). -@nparams: specify the number of parameters the signal -receives from the caller of gtk_signal_emit(). -@params: array of #GtkTypes the signal handlers for this signal -should have in their prototype (of length nparams). -@Returns: the signal id. (See #GtkSignals) - <!-- ##### FUNCTION gtk_object_new ##### --> <para> @@ -348,63 +290,13 @@ function. @type: the type identifying this object. Returned by gtk_type_unique() although (for a properly-written object it should be accessible through #GTK_TYPE_FOO.) -@first_arg_name: name of the first argument to set when constructing -the object. +@first_property_name: @Varargs: the first argument's value, followed by any number of name/argument-value pairs, terminated with NULL. @Returns: the new GtkObject. - - -<!-- ##### FUNCTION gtk_object_newv ##### --> -<para> -Construct an object with an array of arguments. -</para> - -@object_type: the type of the object to create. -@n_args: the number of arguments to set. -@args: an array of n_args arguments (which are name and value pairs). -@Returns: the new GtkObject. - - -<!-- ##### FUNCTION gtk_object_constructed ##### --> -<para> -Mark an allocated object as constructed. -This is used for situations -that require precise control of the construction process. -</para> -<para> -This is done when gtk_object_default_construct() is inadequate. -In #GtkCList the need arises because #GtkCList does construction work that -must happen <emphasis>after</emphasis> its derivers. This work -cannot be done in an initializer function, so an alternate -constructor is mandatory. It calls gtk_object_constructed() to -indicate it has done its job, so that no other constructor will -be invoked. -</para> -<para> -Normally this function is just automatically run from -gtk_object_default_construct(). -</para> - -@object: object which has been constructed. This is usually -done automatically by gtk_object_new() and gtk_object_newv(). - - -<!-- ##### FUNCTION gtk_object_default_construct ##### --> -<para> -This function is called to construct arguments that haven't been initialized -but have the #GTK_ARG_CONSTRUCT flag set. -</para> -<para> -All number arguments are set to 0. All pointers and strings -are set to NULL. -</para> -<para> -Normally invoked by gtk_object_new() automatically; gtk_type_new() can -be used to bypass it. -</para> - -@object: the object to initialize. +<!-- # Unused Parameters # --> +@first_arg_name: name of the first argument to set when constructing +the object. <!-- ##### FUNCTION gtk_object_sink ##### --> @@ -501,18 +393,10 @@ See gtk_object_unref(). </para> @object: -@first_arg_name: +@first_property_name: @Varargs: - - -<!-- ##### FUNCTION gtk_object_getv ##### --> -<para> -Gets an array of argument values from an object. -</para> - -@object: the object to get arguments from. -@n_args: the number of arguments to query. -@args: the arguments to fill in. +<!-- # Unused Parameters # --> +@first_arg_name: <!-- ##### FUNCTION gtk_object_set ##### --> @@ -537,39 +421,11 @@ void set_box_properties(GtkBox* box) </para> @object: the object whose arguments should be set. -@first_arg_name: the name of the first argument to set. +@first_property_name: @Varargs: the value of the first argument, followed optionally by more name/value pairs, followed by NULL. - - -<!-- ##### FUNCTION gtk_object_setv ##### --> -<para> -Set an array of arguments. -</para> - -@object: the object whose arguments should be set. -@n_args: the number of arguments to set. -@args: the desired values, as an array of #GtkArgs (which contain -the names, types, and values of the arguments). - - -<!-- ##### FUNCTION gtk_object_query_args ##### --> -<para> -Get all the arguments that may be used for a given type. -</para> -<para> -In Java, this type of mechanism is called -<wordasword>introspection</wordasword>. It is used by applications -like Glade, that have to determine what can be done to an object -at run-time. -</para> - -@class_type: the GtkType of the ObjectClass -(returned from GTK_OBJECT_CLASS(class)->type for example). -@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to -each argument. You must g_free() this if you request it. -@n_args: the number of arguments is returned in this field. -@Returns: an array of arguments, that you must deallocate with g_free(). +<!-- # Unused Parameters # --> +@first_arg_name: the name of the first argument to set. <!-- ##### FUNCTION gtk_object_set_data ##### --> @@ -670,17 +526,6 @@ writing applications. @Returns: the user data field for object. -<!-- ##### FUNCTION gtk_object_class_add_signals ##### --> -<para> -Add an array of signals to a #GtkObjectClass. -Usually this is called when registering a new type of object. -</para> - -@klass: the object class to append signals to. -@signals: the signals to append. -@nsignals: the number of signals being appended. - - <!-- ##### FUNCTION gtk_object_add_arg_type ##### --> <para> Add a new type of argument to an object class. @@ -802,53 +647,6 @@ so it is good to use this macro. -<!-- ##### FUNCTION gtk_object_arg_set ##### --> -<para> -Private function to set an argument and argument info to an object. -</para> - -@object: the object whose argument should be set. -@arg: the argument. -@info: infomation about this type of argument in general. - - -<!-- ##### FUNCTION gtk_object_arg_get ##### --> -<para> -Private function to get an argument and argument info from an object. -</para> - -@object: the object whose argument should be retrieved. -@arg: the argument, for the name on input, the rest is filled on output. -@info: a #GtkArgInfo structure to optionally fill in. - - -<!-- ##### FUNCTION gtk_object_args_collect ##### --> -<para> -Private: Gets an array of #GtkArgs from a va_list C structure. -</para> - -@object_type: the type of object to collect arguments for. -@arg_list_p: pointer to be filled in with a list of parsed arguments. -@info_list_p: optional pointer for a returned list #GtkArgInfos. -@first_arg_name: name of first argument. -@var_args: value of first argument, followed by more key/value pairs, -terminated by NULL. -@Returns: an error message, or NULL on success. -It is the caller's responsibility to call g_free() in the event of error. - - -<!-- ##### FUNCTION gtk_object_arg_get_info ##### --> -<para> -Query information about an argument type. -</para> - -@object_type: type of object to query about. -@arg_name: name of the argument. -@info_p: pointer to be filled in with a pointer to the GtkArgInfo. -@Returns: an error message, or NULL on success. -It is the caller's responsibility to call g_free() in the event of error. - - <!-- ##### SIGNAL GtkObject::destroy ##### --> <para> Indicates that an object is being destroyed. @@ -856,45 +654,8 @@ Indicates that an object is being destroyed. @object: the object which received the signal. -<!-- ##### ARG GtkObject:user_data ##### --> +<!-- ##### ARG GtkObject:user-data ##### --> <para> A pointer for convenience when programming applications. </para> -<!-- ##### ARG GtkObject:signal ##### --> -<para> -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object. -</para> - -<!-- ##### ARG GtkObject:signal_after ##### --> -<para> -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the signal is always run -after other user handlers and the default handler. -</para> - -<!-- ##### ARG GtkObject:object_signal ##### --> -<para> -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the user data and objects -and swapped when the signal handler is invoked. -</para> -<para> -This is useful for handlers that are primarily notifying -other objects and could just invoke an already existing function -if the parameters were swapped. -See gtk_signal_connect_object() for more details. -</para> - -<!-- ##### ARG GtkObject:object_signal_after ##### --> -<para> -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the user data and objects -and swapped when the signal handler is invoked, -and so that the handler is invoked after all others. -</para> -<para> -See gtk_signal_connect_object_after() for more details. -</para> - diff --git a/docs/reference/gtk/tmpl/gtkoldeditable.sgml b/docs/reference/gtk/tmpl/gtkoldeditable.sgml index b7fc2edbb..c59280ccf 100644 --- a/docs/reference/gtk/tmpl/gtkoldeditable.sgml +++ b/docs/reference/gtk/tmpl/gtkoldeditable.sgml @@ -179,7 +179,7 @@ GtkOldEditable @oldeditable: the object which received the signal. @arg1: -<!-- ##### ARG GtkOldEditable:text_position ##### --> +<!-- ##### ARG GtkOldEditable:text-position ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkoptionmenu.sgml b/docs/reference/gtk/tmpl/gtkoptionmenu.sgml index c65944894..2e15eeb0c 100644 --- a/docs/reference/gtk/tmpl/gtkoptionmenu.sgml +++ b/docs/reference/gtk/tmpl/gtkoptionmenu.sgml @@ -78,3 +78,10 @@ selected value for the option menu. @Returns: +<!-- ##### SIGNAL GtkOptionMenu::changed ##### --> +<para> + +</para> + +@optionmenu: the object which received the signal. + diff --git a/docs/reference/gtk/tmpl/gtkpacker.sgml b/docs/reference/gtk/tmpl/gtkpacker.sgml index 3302b5d06..c2bdafecc 100644 --- a/docs/reference/gtk/tmpl/gtkpacker.sgml +++ b/docs/reference/gtk/tmpl/gtkpacker.sgml @@ -192,27 +192,27 @@ GtkPacker </para> -<!-- ##### ARG GtkPacker:default_border_width ##### --> +<!-- ##### ARG GtkPacker:default-border-width ##### --> <para> </para> -<!-- ##### ARG GtkPacker:default_pad_x ##### --> +<!-- ##### ARG GtkPacker:default-pad-x ##### --> <para> </para> -<!-- ##### ARG GtkPacker:default_pad_y ##### --> +<!-- ##### ARG GtkPacker:default-pad-y ##### --> <para> </para> -<!-- ##### ARG GtkPacker:default_ipad_x ##### --> +<!-- ##### ARG GtkPacker:default-ipad-x ##### --> <para> </para> -<!-- ##### ARG GtkPacker:default_ipad_y ##### --> +<!-- ##### ARG GtkPacker:default-ipad-y ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkpaned.sgml b/docs/reference/gtk/tmpl/gtkpaned.sgml index 59a5511b7..96672e06a 100644 --- a/docs/reference/gtk/tmpl/gtkpaned.sgml +++ b/docs/reference/gtk/tmpl/gtkpaned.sgml @@ -178,7 +178,7 @@ Set the the handle size to @size x @size pixels. @Returns: -<!-- ##### ARG GtkPaned:handle_size ##### --> +<!-- ##### ARG GtkPaned:handle-size ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkprogress.sgml b/docs/reference/gtk/tmpl/gtkprogress.sgml index f67d36e6e..e9faae556 100644 --- a/docs/reference/gtk/tmpl/gtkprogress.sgml +++ b/docs/reference/gtk/tmpl/gtkprogress.sgml @@ -186,22 +186,22 @@ the #GtkProgress. @max: the maximum progress value. -<!-- ##### ARG GtkProgress:activity_mode ##### --> +<!-- ##### ARG GtkProgress:activity-mode ##### --> <para> A boolean indicating whether activity mode is enabled. </para> -<!-- ##### ARG GtkProgress:show_text ##### --> +<!-- ##### ARG GtkProgress:show-text ##### --> <para> A boolean indicating whether the progress is shown as text. </para> -<!-- ##### ARG GtkProgress:text_xalign ##### --> +<!-- ##### ARG GtkProgress:text-xalign ##### --> <para> A number between 0.0 and 1.0 specifying the horizontal alignment. </para> -<!-- ##### ARG GtkProgress:text_yalign ##### --> +<!-- ##### ARG GtkProgress:text-yalign ##### --> <para> A number between 0.0 and 1.0 specifying the vertical alignment. </para> diff --git a/docs/reference/gtk/tmpl/gtkprogressbar.sgml b/docs/reference/gtk/tmpl/gtkprogressbar.sgml index 3e44bb019..4492a98be 100644 --- a/docs/reference/gtk/tmpl/gtkprogressbar.sgml +++ b/docs/reference/gtk/tmpl/gtkprogressbar.sgml @@ -236,24 +236,24 @@ a #GtkProgressBarOrientation value which specifies the orientation and growth direction of the bar. </para> -<!-- ##### ARG GtkProgressBar:bar_style ##### --> +<!-- ##### ARG GtkProgressBar:bar-style ##### --> <para> a #GtkProgressBarStyle value which specifies the visual style of the bar in percentage mode. </para> -<!-- ##### ARG GtkProgressBar:activity_step ##### --> +<!-- ##### ARG GtkProgressBar:activity-step ##### --> <para> The increment used for each iteration in activity mode. </para> -<!-- ##### ARG GtkProgressBar:activity_blocks ##### --> +<!-- ##### ARG GtkProgressBar:activity-blocks ##### --> <para> The number of blocks which can fit in the progress bar area in activity mode. </para> -<!-- ##### ARG GtkProgressBar:discrete_blocks ##### --> +<!-- ##### ARG GtkProgressBar:discrete-blocks ##### --> <para> The number of blocks which which make up progress bar when it is shown in %GTK_PROGRESS_DISCRETE style. @@ -264,7 +264,7 @@ when it is shown in %GTK_PROGRESS_DISCRETE style. </para> -<!-- ##### ARG GtkProgressBar:pulse_step ##### --> +<!-- ##### ARG GtkProgressBar:pulse-step ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkrange.sgml b/docs/reference/gtk/tmpl/gtkrange.sgml index fcf22cdc6..4445609d5 100644 --- a/docs/reference/gtk/tmpl/gtkrange.sgml +++ b/docs/reference/gtk/tmpl/gtkrange.sgml @@ -175,7 +175,7 @@ GtkRange @range: -<!-- ##### ARG GtkRange:update_policy ##### --> +<!-- ##### ARG GtkRange:update-policy ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkruler.sgml b/docs/reference/gtk/tmpl/gtkruler.sgml index 1e73d3956..679d28430 100644 --- a/docs/reference/gtk/tmpl/gtkruler.sgml +++ b/docs/reference/gtk/tmpl/gtkruler.sgml @@ -75,7 +75,7 @@ This sets the range of the ruler using gfloat lower, gfloat upper, gfloat positi </para> -<!-- ##### ARG GtkRuler:max_size ##### --> +<!-- ##### ARG GtkRuler:max-size ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkscale.sgml b/docs/reference/gtk/tmpl/gtkscale.sgml index e34f3e25e..877a40d09 100644 --- a/docs/reference/gtk/tmpl/gtkscale.sgml +++ b/docs/reference/gtk/tmpl/gtkscale.sgml @@ -85,12 +85,12 @@ string. The number of decimal places that are displayed in the value. </para> -<!-- ##### ARG GtkScale:draw_value ##### --> +<!-- ##### ARG GtkScale:draw-value ##### --> <para> If the current value is displayed as a string next to the slider. </para> -<!-- ##### ARG GtkScale:value_pos ##### --> +<!-- ##### ARG GtkScale:value-pos ##### --> <para> The position in which the current value is displayed. </para> diff --git a/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml b/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml index 5a0e96b4f..52cf2e8c1 100644 --- a/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml +++ b/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml @@ -182,17 +182,17 @@ Horizontal adjustment. See gtk_scrolled_window_set_hadjustment(), gtk_scrolled_w Vertical adjustment. See gtk_scrolled_window_set_vadjustment(), gtk_scrolled_window_get_vadjustment().
</para> -<!-- ##### ARG GtkScrolledWindow:hscrollbar_policy ##### --> +<!-- ##### ARG GtkScrolledWindow:hscrollbar-policy ##### --> <para>
Horizontal scrollbar policy (show scrollbar always, never, or "when appropriate").
</para> -<!-- ##### ARG GtkScrolledWindow:vscrollbar_policy ##### --> +<!-- ##### ARG GtkScrolledWindow:vscrollbar-policy ##### --> <para>
Vertical scrollbar policy (show scrollbar always, never, or "when appropriate").
</para> -<!-- ##### ARG GtkScrolledWindow:window_placement ##### --> +<!-- ##### ARG GtkScrolledWindow:window-placement ##### --> <para>
Position of child window with respect to scrollbars; top left, top
right, bottom left, bottom right.
diff --git a/docs/reference/gtk/tmpl/gtkspinbutton.sgml b/docs/reference/gtk/tmpl/gtkspinbutton.sgml index 916372fbc..7b28651e4 100644 --- a/docs/reference/gtk/tmpl/gtkspinbutton.sgml +++ b/docs/reference/gtk/tmpl/gtkspinbutton.sgml @@ -349,7 +349,7 @@ Refreshes a spin button. The behaviour of the update is determined by gtk_spin_b the #GtkAdjustment that defines a spin button's main properties. </para> -<!-- ##### ARG GtkSpinButton:climb_rate ##### --> +<!-- ##### ARG GtkSpinButton:climb-rate ##### --> <para> the amount a spin button changes when an arrow is clicked. </para> @@ -359,7 +359,7 @@ the amount a spin button changes when an arrow is clicked. the number of decimal places to display. </para> -<!-- ##### ARG GtkSpinButton:snap_to_ticks ##### --> +<!-- ##### ARG GtkSpinButton:snap-to-ticks ##### --> <para> whether erroneous values are automatically changed to a spin button's nearest step increment. </para> @@ -374,12 +374,12 @@ whether non-numeric characters should be ignored. whether a spin button should wrap upon reaching its limits. </para> -<!-- ##### ARG GtkSpinButton:update_policy ##### --> +<!-- ##### ARG GtkSpinButton:update-policy ##### --> <para> how a spin button should be updated. </para> -<!-- ##### ARG GtkSpinButton:shadow_type ##### --> +<!-- ##### ARG GtkSpinButton:shadow-type ##### --> <para> the type of border that surrounds the arrows of a spin button. </para> diff --git a/docs/reference/gtk/tmpl/gtkstyle.sgml b/docs/reference/gtk/tmpl/gtkstyle.sgml index da03752f9..adf0c1ebd 100644 --- a/docs/reference/gtk/tmpl/gtkstyle.sgml +++ b/docs/reference/gtk/tmpl/gtkstyle.sgml @@ -78,14 +78,11 @@ Styles @draw_polygon: @draw_arrow: @draw_diamond: -@draw_oval: @draw_string: @draw_box: @draw_flat_box: @draw_check: @draw_option: -@draw_cross: -@draw_ramp: @draw_tab: @draw_shadow_gap: @draw_box_gap: @@ -93,6 +90,8 @@ Styles @draw_focus: @draw_slider: @draw_handle: +@draw_expander: +@draw_layout: <!-- ##### FUNCTION gtk_style_new ##### --> <para> @@ -299,21 +298,6 @@ Styles @height: -<!-- ##### FUNCTION gtk_draw_oval ##### --> -<para> - -</para> - -@style: -@window: -@state_type: -@shadow_type: -@x: -@y: -@width: -@height: - - <!-- ##### FUNCTION gtk_draw_string ##### --> <para> @@ -375,21 +359,6 @@ Styles @height: -<!-- ##### FUNCTION gtk_draw_cross ##### --> -<para> - -</para> - -@style: -@window: -@state_type: -@shadow_type: -@x: -@y: -@width: -@height: - - <!-- ##### FUNCTION gtk_draw_extension ##### --> <para> @@ -465,7 +434,7 @@ Styles @height: -<!-- ##### FUNCTION gtk_draw_ramp ##### --> +<!-- ##### FUNCTION gtk_draw_shadow_gap ##### --> <para> </para> @@ -474,14 +443,16 @@ Styles @window: @state_type: @shadow_type: -@arrow_type: @x: @y: @width: @height: +@gap_side: +@gap_x: +@gap_width: -<!-- ##### FUNCTION gtk_draw_shadow_gap ##### --> +<!-- ##### FUNCTION gtk_draw_slider ##### --> <para> </para> @@ -494,12 +465,10 @@ Styles @y: @width: @height: -@gap_side: -@gap_x: -@gap_width: +@orientation: -<!-- ##### FUNCTION gtk_draw_slider ##### --> +<!-- ##### FUNCTION gtk_draw_tab ##### --> <para> </para> @@ -512,10 +481,9 @@ Styles @y: @width: @height: -@orientation: -<!-- ##### FUNCTION gtk_draw_tab ##### --> +<!-- ##### FUNCTION gtk_draw_expander ##### --> <para> </para> @@ -523,14 +491,12 @@ Styles @style: @window: @state_type: -@shadow_type: @x: @y: -@width: -@height: +@is_open: -<!-- ##### FUNCTION gtk_paint_arrow ##### --> +<!-- ##### FUNCTION gtk_draw_layout ##### --> <para> </para> @@ -538,19 +504,12 @@ Styles @style: @window: @state_type: -@shadow_type: -@area: -@widget: -@detail: -@arrow_type: -@fill: @x: @y: -@width: -@height: +@layout: -<!-- ##### FUNCTION gtk_paint_box ##### --> +<!-- ##### FUNCTION gtk_paint_arrow ##### --> <para> </para> @@ -562,13 +521,15 @@ Styles @area: @widget: @detail: +@arrow_type: +@fill: @x: @y: @width: @height: -<!-- ##### FUNCTION gtk_paint_box_gap ##### --> +<!-- ##### FUNCTION gtk_paint_box ##### --> <para> </para> @@ -584,12 +545,9 @@ Styles @y: @width: @height: -@gap_side: -@gap_x: -@gap_width: -<!-- ##### FUNCTION gtk_paint_check ##### --> +<!-- ##### FUNCTION gtk_paint_box_gap ##### --> <para> </para> @@ -605,9 +563,12 @@ Styles @y: @width: @height: +@gap_side: +@gap_x: +@gap_width: -<!-- ##### FUNCTION gtk_paint_cross ##### --> +<!-- ##### FUNCTION gtk_paint_check ##### --> <para> </para> @@ -749,7 +710,7 @@ Styles @height: -<!-- ##### FUNCTION gtk_paint_oval ##### --> +<!-- ##### FUNCTION gtk_paint_polygon ##### --> <para> </para> @@ -761,13 +722,12 @@ Styles @area: @widget: @detail: -@x: -@y: -@width: -@height: +@points: +@npoints: +@fill: -<!-- ##### FUNCTION gtk_paint_polygon ##### --> +<!-- ##### FUNCTION gtk_paint_shadow ##### --> <para> </para> @@ -779,12 +739,13 @@ Styles @area: @widget: @detail: -@points: -@npoints: -@fill: +@x: +@y: +@width: +@height: -<!-- ##### FUNCTION gtk_paint_ramp ##### --> +<!-- ##### FUNCTION gtk_paint_shadow_gap ##### --> <para> </para> @@ -796,14 +757,16 @@ Styles @area: @widget: @detail: -@arrow_type: @x: @y: @width: @height: +@gap_side: +@gap_x: +@gap_width: -<!-- ##### FUNCTION gtk_paint_shadow ##### --> +<!-- ##### FUNCTION gtk_paint_slider ##### --> <para> </para> @@ -819,9 +782,10 @@ Styles @y: @width: @height: +@orientation: -<!-- ##### FUNCTION gtk_paint_shadow_gap ##### --> +<!-- ##### FUNCTION gtk_paint_string ##### --> <para> </para> @@ -829,20 +793,15 @@ Styles @style: @window: @state_type: -@shadow_type: @area: @widget: @detail: @x: @y: -@width: -@height: -@gap_side: -@gap_x: -@gap_width: +@string: -<!-- ##### FUNCTION gtk_paint_slider ##### --> +<!-- ##### FUNCTION gtk_paint_tab ##### --> <para> </para> @@ -858,10 +817,9 @@ Styles @y: @width: @height: -@orientation: -<!-- ##### FUNCTION gtk_paint_string ##### --> +<!-- ##### FUNCTION gtk_paint_vline ##### --> <para> </para> @@ -872,12 +830,12 @@ Styles @area: @widget: @detail: +@y1: +@y2: @x: -@y: -@string: -<!-- ##### FUNCTION gtk_paint_tab ##### --> +<!-- ##### FUNCTION gtk_paint_expander ##### --> <para> </para> @@ -885,17 +843,15 @@ Styles @style: @window: @state_type: -@shadow_type: @area: @widget: @detail: @x: @y: -@width: -@height: +@is_open: -<!-- ##### FUNCTION gtk_paint_vline ##### --> +<!-- ##### FUNCTION gtk_paint_layout ##### --> <para> </para> @@ -906,8 +862,8 @@ Styles @area: @widget: @detail: -@y1: -@y2: @x: +@y: +@layout: diff --git a/docs/reference/gtk/tmpl/gtktable.sgml b/docs/reference/gtk/tmpl/gtktable.sgml index 74fe50b42..3ca973b37 100644 --- a/docs/reference/gtk/tmpl/gtktable.sgml +++ b/docs/reference/gtk/tmpl/gtktable.sgml @@ -201,22 +201,22 @@ changes the homogenous property of table cells. Ie. whether all cells are an equ to FALSE if this is not your desired behaviour. -<!-- ##### ARG GtkTable:n_rows ##### --> +<!-- ##### ARG GtkTable:n-rows ##### --> <para> set or retrieve the number of rows in a table. </para> -<!-- ##### ARG GtkTable:n_columns ##### --> +<!-- ##### ARG GtkTable:n-columns ##### --> <para> set or retrieve the number of columnsin a table. </para> -<!-- ##### ARG GtkTable:row_spacing ##### --> +<!-- ##### ARG GtkTable:row-spacing ##### --> <para> set or retrieve the number of pixels of space between each row. </para> -<!-- ##### ARG GtkTable:column_spacing ##### --> +<!-- ##### ARG GtkTable:column-spacing ##### --> <para> set or retrieve the number of pixels of space between each column. </para> diff --git a/docs/reference/gtk/tmpl/gtktext.sgml b/docs/reference/gtk/tmpl/gtktext.sgml index 04a52b5f9..e71f07a83 100644 --- a/docs/reference/gtk/tmpl/gtktext.sgml +++ b/docs/reference/gtk/tmpl/gtktext.sgml @@ -236,12 +236,12 @@ Used by the #GtkText widget to keep track of the size of it's vertical text.
</para> -<!-- ##### ARG GtkText:line_wrap ##### --> +<!-- ##### ARG GtkText:line-wrap ##### --> <para>
Boolean value indicating whether line wrap is enabled or not.
</para> -<!-- ##### ARG GtkText:word_wrap ##### --> +<!-- ##### ARG GtkText:word-wrap ##### --> <para>
Boolean value indicated whether word wrap is enabled or not.
</para> diff --git a/docs/reference/gtk/tmpl/gtktextbuffer.sgml b/docs/reference/gtk/tmpl/gtktextbuffer.sgml index c8f072322..64ad8b400 100644 --- a/docs/reference/gtk/tmpl/gtktextbuffer.sgml +++ b/docs/reference/gtk/tmpl/gtktextbuffer.sgml @@ -541,6 +541,22 @@ types related to the text widget and how they work together. @Returns: +<!-- ##### FUNCTION gtk_text_buffer_begin_user_action ##### --> +<para> + +</para> + +@buffer: + + +<!-- ##### FUNCTION gtk_text_buffer_end_user_action ##### --> +<para> + +</para> + +@buffer: + + <!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### --> <para> @@ -551,6 +567,13 @@ types related to the text widget and how they work together. @arg2: @arg3: +<!-- ##### SIGNAL GtkTextBuffer::begin-user-action ##### --> +<para> + +</para> + +@textbuffer: the object which received the signal. + <!-- ##### SIGNAL GtkTextBuffer::changed ##### --> <para> @@ -558,7 +581,23 @@ types related to the text widget and how they work together. @textbuffer: the object which received the signal. -<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### --> +<!-- ##### SIGNAL GtkTextBuffer::delete-range ##### --> +<para> + +</para> + +@textbuffer: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL GtkTextBuffer::end-user-action ##### --> +<para> + +</para> + +@textbuffer: the object which received the signal. + +<!-- ##### SIGNAL GtkTextBuffer::insert-pixbuf ##### --> <para> </para> @@ -566,7 +605,6 @@ types related to the text widget and how they work together. @textbuffer: the object which received the signal. @arg1: @arg2: -@arg3: <!-- ##### SIGNAL GtkTextBuffer::insert-text ##### --> <para> @@ -577,6 +615,7 @@ types related to the text widget and how they work together. @arg1: @arg2: @arg3: +<!-- # Unused Parameters # --> @arg4: <!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### --> diff --git a/docs/reference/gtk/tmpl/gtktextiter.sgml b/docs/reference/gtk/tmpl/gtktextiter.sgml index 4fd0e08ca..522ea9fda 100644 --- a/docs/reference/gtk/tmpl/gtktextiter.sgml +++ b/docs/reference/gtk/tmpl/gtktextiter.sgml @@ -25,6 +25,13 @@ types related to the text widget and how they work together. </para> +@parent_instance: +@tag_table: +@btree: +@clipboard_contents: +@log_attr_cache: +@user_action_count: +@modified: <!-- ##### STRUCT GtkTextIter ##### --> <para> @@ -251,6 +258,33 @@ types related to the text widget and how they work together. @Returns: +<!-- ##### FUNCTION gtk_text_iter_starts_word ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION gtk_text_iter_ends_word ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION gtk_text_iter_inside_word ##### --> +<para> + +</para> + +@iter: +@Returns: + + <!-- ##### FUNCTION gtk_text_iter_starts_line ##### --> <para> @@ -269,6 +303,15 @@ types related to the text widget and how they work together. @Returns: +<!-- ##### FUNCTION gtk_text_iter_is_cursor_position ##### --> +<para> + +</para> + +@iter: +@Returns: + + <!-- ##### FUNCTION gtk_text_iter_get_chars_in_line ##### --> <para> @@ -278,6 +321,15 @@ types related to the text widget and how they work together. @Returns: +<!-- ##### FUNCTION gtk_text_iter_get_bytes_in_line ##### --> +<para> + +</para> + +@iter: +@Returns: + + <!-- ##### FUNCTION gtk_text_iter_get_attributes ##### --> <para> @@ -288,6 +340,15 @@ types related to the text widget and how they work together. @Returns: +<!-- ##### FUNCTION gtk_text_iter_get_language ##### --> +<para> + +</para> + +@iter: +@Returns: + + <!-- ##### FUNCTION gtk_text_iter_is_last ##### --> <para> @@ -306,7 +367,7 @@ types related to the text widget and how they work together. @Returns: -<!-- ##### FUNCTION gtk_text_iter_next_char ##### --> +<!-- ##### FUNCTION gtk_text_iter_forward_char ##### --> <para> </para> @@ -315,7 +376,7 @@ types related to the text widget and how they work together. @Returns: -<!-- ##### FUNCTION gtk_text_iter_prev_char ##### --> +<!-- ##### FUNCTION gtk_text_iter_backward_char ##### --> <para> </para> @@ -420,6 +481,44 @@ types related to the text widget and how they work together. @Returns: +<!-- ##### FUNCTION gtk_text_iter_forward_cursor_position ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION gtk_text_iter_backward_cursor_position ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION gtk_text_iter_forward_cursor_positions ##### --> +<para> + +</para> + +@iter: +@count: +@Returns: + + +<!-- ##### FUNCTION gtk_text_iter_backward_cursor_positions ##### --> +<para> + +</para> + +@iter: +@count: +@Returns: + + <!-- ##### FUNCTION gtk_text_iter_set_offset ##### --> <para> @@ -464,7 +563,7 @@ types related to the text widget and how they work together. @iter: -<!-- ##### FUNCTION gtk_text_iter_forward_to_newline ##### --> +<!-- ##### FUNCTION gtk_text_iter_forward_to_line_end ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktextmark.sgml b/docs/reference/gtk/tmpl/gtktextmark.sgml index d9a996418..204b00be5 100644 --- a/docs/reference/gtk/tmpl/gtktextmark.sgml +++ b/docs/reference/gtk/tmpl/gtktextmark.sgml @@ -97,3 +97,12 @@ Marks are typically created using the gtk_text_buffer_create_mark() function. @Returns: +<!-- ##### FUNCTION gtk_text_mark_get_buffer ##### --> +<para> + +</para> + +@mark: +@Returns: + + diff --git a/docs/reference/gtk/tmpl/gtktexttag.sgml b/docs/reference/gtk/tmpl/gtktexttag.sgml index 52a9945a4..8858fd780 100644 --- a/docs/reference/gtk/tmpl/gtktexttag.sgml +++ b/docs/reference/gtk/tmpl/gtktexttag.sgml @@ -26,6 +26,40 @@ types related to the text widget and how they work together. </para> +@parent_instance: +@table: +@name: +@priority: +@values: +@bg_color_set: +@bg_stipple_set: +@fg_color_set: +@family_set: +@style_set: +@variant_set: +@weight_set: +@stretch_set: +@size_set: +@fg_stipple_set: +@justify_set: +@left_margin_set: +@indent_set: +@rise_set: +@strikethrough_set: +@right_margin_set: +@pixels_above_lines_set: +@pixels_below_lines_set: +@pixels_inside_wrap_set: +@tabs_set: +@underline_set: +@wrap_mode_set: +@bg_full_height_set: +@invisible_set: +@editable_set: +@language_set: +@pad1: +@pad2: +@pad3: <!-- ##### STRUCT GtkTextBTreeNode ##### --> <para> @@ -38,6 +72,10 @@ types related to the text widget and how they work together. </para> +@parent_instance: +@hash: +@anonymous: +@anon_count: <!-- ##### ENUM GtkWrapMode ##### --> <para> @@ -145,6 +183,17 @@ Describes a type of line wrapping. </para> @src: +@Returns: +<!-- # Unused Parameters # --> +@dest: + + +<!-- ##### FUNCTION gtk_text_attributes_copy_values ##### --> +<para> + +</para> + +@src: @dest: @@ -186,23 +235,38 @@ when the tag is created. Background color, as a string such as "red" or "#FFFFFF" </para> -<!-- ##### ARG GtkTextTag:background_gdk ##### --> +<!-- ##### ARG GtkTextTag:background-gdk ##### --> <para> Background color, as a #GdkColor. </para> -<!-- ##### ARG GtkTextTag:background_full_height ##### --> +<!-- ##### ARG GtkTextTag:background-full-height ##### --> <para> Whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character. </para> -<!-- ##### ARG GtkTextTag:background_stipple ##### --> +<!-- ##### ARG GtkTextTag:background-stipple ##### --> <para> A #GdkBitmap to use for stippling the background color. </para> +<!-- ##### ARG GtkTextTag:foreground ##### --> +<para> +Foreground color as a string such as "red" or "#FFFFFF". +</para> + +<!-- ##### ARG GtkTextTag:foreground-gdk ##### --> +<para> +Foreground color as a #GdkColor. +</para> + +<!-- ##### ARG GtkTextTag:foreground-stipple ##### --> +<para> +A #GdkBitmap to use as a stipple pattern for the foreground. +</para> + <!-- ##### ARG GtkTextTag:direction ##### --> <para> The #GtkTextDirection for the tagged text. @@ -218,7 +282,7 @@ Whether the user can modify the tagged text. Font as a Pango font name, e.g. "Sans Italic 12" </para> -<!-- ##### ARG GtkTextTag:font_desc ##### --> +<!-- ##### ARG GtkTextTag:font-desc ##### --> <para> Font as a #PangoFontDescription. </para> @@ -253,24 +317,9 @@ Font as a #PangoFontDescription. </para> -<!-- ##### ARG GtkTextTag:size_points ##### --> -<para> - -</para> - -<!-- ##### ARG GtkTextTag:foreground ##### --> -<para> -Foreground color as a string such as "red" or "#FFFFFF". -</para> - -<!-- ##### ARG GtkTextTag:foreground_gdk ##### --> +<!-- ##### ARG GtkTextTag:size-points ##### --> <para> -Foreground color as a #GdkColor. -</para> -<!-- ##### ARG GtkTextTag:foreground_stipple ##### --> -<para> -A #GdkBitmap to use as a stipple pattern for the foreground. </para> <!-- ##### ARG GtkTextTag:justify ##### --> @@ -286,11 +335,16 @@ hint when rendering the text. If you don't understand this argument, you probably don't need it. </para> -<!-- ##### ARG GtkTextTag:left_margin ##### --> +<!-- ##### ARG GtkTextTag:left-margin ##### --> <para> Pixel width of left margin of the text. </para> +<!-- ##### ARG GtkTextTag:right-margin ##### --> +<para> +Pixel width of right margin. +</para> + <!-- ##### ARG GtkTextTag:indent ##### --> <para> @@ -301,27 +355,22 @@ Pixel width of left margin of the text. </para> -<!-- ##### ARG GtkTextTag:pixels_above_lines ##### --> +<!-- ##### ARG GtkTextTag:pixels-above-lines ##### --> <para> Pixels of blank space to leave above each newline-terminated line. </para> -<!-- ##### ARG GtkTextTag:pixels_below_lines ##### --> +<!-- ##### ARG GtkTextTag:pixels-below-lines ##### --> <para> Pixels of blank space to leave below each newline-terminated line. </para> -<!-- ##### ARG GtkTextTag:pixels_inside_wrap ##### --> +<!-- ##### ARG GtkTextTag:pixels-inside-wrap ##### --> <para> Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph). </para> -<!-- ##### ARG GtkTextTag:right_margin ##### --> -<para> -Pixel width of right margin. -</para> - <!-- ##### ARG GtkTextTag:strikethrough ##### --> <para> %TRUE to draw a line through the text. @@ -332,7 +381,7 @@ Pixel width of right margin. A #PangoUnderline value. </para> -<!-- ##### ARG GtkTextTag:wrap_mode ##### --> +<!-- ##### ARG GtkTextTag:wrap-mode ##### --> <para> A #GtkWrapMode value. Only used if the tag applies to the first character in a paragraph. @@ -349,142 +398,142 @@ applies to the first character in a paragraph. </para> -<!-- ##### ARG GtkTextTag:background_set ##### --> +<!-- ##### ARG GtkTextTag:background-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:background_full_height_set ##### --> +<!-- ##### ARG GtkTextTag:background-full-height-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:background_gdk_set ##### --> +<!-- ##### ARG GtkTextTag:background-gdk-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:background_stipple_set ##### --> +<!-- ##### ARG GtkTextTag:background-stipple-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:editable_set ##### --> +<!-- ##### ARG GtkTextTag:foreground-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:family_set ##### --> +<!-- ##### ARG GtkTextTag:foreground-gdk-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:style_set ##### --> +<!-- ##### ARG GtkTextTag:foreground-stipple-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:variant_set ##### --> +<!-- ##### ARG GtkTextTag:editable-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:weight_set ##### --> +<!-- ##### ARG GtkTextTag:family-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:stretch_set ##### --> +<!-- ##### ARG GtkTextTag:style-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:size_set ##### --> +<!-- ##### ARG GtkTextTag:variant-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:foreground_set ##### --> +<!-- ##### ARG GtkTextTag:weight-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:foreground_gdk_set ##### --> +<!-- ##### ARG GtkTextTag:stretch-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:foreground_stipple_set ##### --> +<!-- ##### ARG GtkTextTag:size-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:justify_set ##### --> +<!-- ##### ARG GtkTextTag:justify-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:language_set ##### --> +<!-- ##### ARG GtkTextTag:language-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:left_margin_set ##### --> +<!-- ##### ARG GtkTextTag:left-margin-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:indent_set ##### --> +<!-- ##### ARG GtkTextTag:indent-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:rise_set ##### --> +<!-- ##### ARG GtkTextTag:rise-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels_above_lines_set ##### --> +<!-- ##### ARG GtkTextTag:pixels-above-lines-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels_below_lines_set ##### --> +<!-- ##### ARG GtkTextTag:pixels-below-lines-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:pixels_inside_wrap_set ##### --> +<!-- ##### ARG GtkTextTag:pixels-inside-wrap-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:strikethrough_set ##### --> +<!-- ##### ARG GtkTextTag:strikethrough-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:right_margin_set ##### --> +<!-- ##### ARG GtkTextTag:right-margin-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:underline_set ##### --> +<!-- ##### ARG GtkTextTag:underline-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:wrap_mode_set ##### --> +<!-- ##### ARG GtkTextTag:wrap-mode-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:tabs_set ##### --> +<!-- ##### ARG GtkTextTag:tabs-set ##### --> <para> </para> -<!-- ##### ARG GtkTextTag:invisible_set ##### --> +<!-- ##### ARG GtkTextTag:invisible-set ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktextview.sgml b/docs/reference/gtk/tmpl/gtktextview.sgml index 808e424b4..d2621b8ed 100644 --- a/docs/reference/gtk/tmpl/gtktextview.sgml +++ b/docs/reference/gtk/tmpl/gtktextview.sgml @@ -81,7 +81,22 @@ types related to the text widget and how they work together. @text_view: @mark: +@within_margin: +@use_align: +@xalign: +@yalign: +@Returns: +<!-- # Unused Parameters # --> @mark_within_margin: + + +<!-- ##### FUNCTION gtk_text_view_scroll_mark_onscreen ##### --> +<para> + +</para> + +@text_view: +@mark: @Returns: @@ -113,167 +128,174 @@ types related to the text widget and how they work together. @visible_rect: -<!-- ##### FUNCTION gtk_text_view_set_wrap_mode ##### --> +<!-- ##### FUNCTION gtk_text_view_get_iter_location ##### --> <para> </para> @text_view: -@wrap_mode: +@iter: +@location: -<!-- ##### FUNCTION gtk_text_view_get_wrap_mode ##### --> +<!-- ##### FUNCTION gtk_text_view_get_line_at_y ##### --> <para> </para> @text_view: -@Returns: +@target_iter: +@y: +@line_top: -<!-- ##### FUNCTION gtk_text_view_set_editable ##### --> +<!-- ##### FUNCTION gtk_text_view_get_line_yrange ##### --> <para> </para> @text_view: -@setting: +@iter: +@y: +@height: -<!-- ##### FUNCTION gtk_text_view_get_editable ##### --> +<!-- ##### FUNCTION gtk_text_view_get_iter_at_location ##### --> <para> </para> @text_view: -@Returns: +@iter: +@x: +@y: -<!-- ##### FUNCTION gtk_text_view_set_cursor_visible ##### --> +<!-- ##### FUNCTION gtk_text_view_buffer_to_window_coords ##### --> <para> </para> @text_view: -@setting: +@win: +@buffer_x: +@buffer_y: +@window_x: +@window_y: -<!-- ##### FUNCTION gtk_text_view_get_cursor_visible ##### --> +<!-- ##### FUNCTION gtk_text_view_window_to_buffer_coords ##### --> <para> </para> @text_view: -@Returns: +@win: +@window_x: +@window_y: +@buffer_x: +@buffer_y: -<!-- ##### FUNCTION gtk_text_view_get_iter_location ##### --> +<!-- ##### FUNCTION gtk_text_view_get_window ##### --> <para> </para> @text_view: -@iter: -@location: +@win: +@Returns: -<!-- ##### FUNCTION gtk_text_view_get_line_at_y ##### --> +<!-- ##### FUNCTION gtk_text_view_get_window_type ##### --> <para> </para> @text_view: -@target_iter: -@y: -@line_top: +@window: +@Returns: -<!-- ##### FUNCTION gtk_text_view_get_line_yrange ##### --> +<!-- ##### FUNCTION gtk_text_view_set_border_window_size ##### --> <para> </para> @text_view: -@iter: -@y: -@height: +@type: +@size: -<!-- ##### FUNCTION gtk_text_view_get_iter_at_location ##### --> +<!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### --> <para> </para> @text_view: -@iter: -@x: -@y: +@width: +@height: -<!-- ##### FUNCTION gtk_text_view_buffer_to_window_coords ##### --> +<!-- ##### FUNCTION gtk_text_view_forward_display_line ##### --> <para> </para> @text_view: -@win: -@buffer_x: -@buffer_y: -@window_x: -@window_y: +@iter: +@Returns: -<!-- ##### FUNCTION gtk_text_view_window_to_buffer_coords ##### --> +<!-- ##### FUNCTION gtk_text_view_backward_display_line ##### --> <para> </para> @text_view: -@win: -@window_x: -@window_y: -@buffer_x: -@buffer_y: +@iter: +@Returns: -<!-- ##### FUNCTION gtk_text_view_get_window ##### --> +<!-- ##### FUNCTION gtk_text_view_forward_display_line_end ##### --> <para> </para> @text_view: -@win: +@iter: @Returns: -<!-- ##### FUNCTION gtk_text_view_get_window_type ##### --> +<!-- ##### FUNCTION gtk_text_view_backward_display_line_start ##### --> <para> </para> @text_view: -@window: +@iter: @Returns: -<!-- ##### FUNCTION gtk_text_view_set_border_window_size ##### --> +<!-- ##### FUNCTION gtk_text_view_starts_display_line ##### --> <para> </para> @text_view: -@type: -@size: +@iter: +@Returns: -<!-- ##### FUNCTION gtk_text_view_set_text_window_size ##### --> +<!-- ##### FUNCTION gtk_text_view_move_visually ##### --> <para> </para> @text_view: -@width: -@height: +@iter: +@count: +@Returns: <!-- ##### FUNCTION gtk_text_view_add_child_at_anchor ##### --> @@ -309,6 +331,204 @@ types related to the text widget and how they work together. @ypos: +<!-- ##### FUNCTION gtk_text_view_set_wrap_mode ##### --> +<para> + +</para> + +@text_view: +@wrap_mode: + + +<!-- ##### FUNCTION gtk_text_view_get_wrap_mode ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_editable ##### --> +<para> + +</para> + +@text_view: +@setting: + + +<!-- ##### FUNCTION gtk_text_view_get_editable ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_cursor_visible ##### --> +<para> + +</para> + +@text_view: +@setting: + + +<!-- ##### FUNCTION gtk_text_view_get_cursor_visible ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_pixels_above_lines ##### --> +<para> + +</para> + +@text_view: +@pixels_above_lines: + + +<!-- ##### FUNCTION gtk_text_view_get_pixels_above_lines ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_pixels_below_lines ##### --> +<para> + +</para> + +@text_view: +@pixels_below_lines: + + +<!-- ##### FUNCTION gtk_text_view_get_pixels_below_lines ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_pixels_inside_wrap ##### --> +<para> + +</para> + +@text_view: +@pixels_inside_wrap: + + +<!-- ##### FUNCTION gtk_text_view_get_pixels_inside_wrap ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_justification ##### --> +<para> + +</para> + +@text_view: +@justification: + + +<!-- ##### FUNCTION gtk_text_view_get_justification ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_left_margin ##### --> +<para> + +</para> + +@text_view: +@left_margin: + + +<!-- ##### FUNCTION gtk_text_view_get_left_margin ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_right_margin ##### --> +<para> + +</para> + +@text_view: +@right_margin: + + +<!-- ##### FUNCTION gtk_text_view_get_right_margin ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_indent ##### --> +<para> + +</para> + +@text_view: +@indent: + + +<!-- ##### FUNCTION gtk_text_view_get_indent ##### --> +<para> + +</para> + +@text_view: +@Returns: + + +<!-- ##### FUNCTION gtk_text_view_set_tabs ##### --> +<para> + +</para> + +@text_view: +@tabs: + + +<!-- ##### FUNCTION gtk_text_view_get_tabs ##### --> +<para> + +</para> + +@text_view: +@Returns: + + <!-- ##### SIGNAL GtkTextView::copy-clipboard ##### --> <para> @@ -380,27 +600,27 @@ types related to the text widget and how they work together. @textview: the object which received the signal. -<!-- ##### ARG GtkTextView:height_lines ##### --> +<!-- ##### ARG GtkTextView:height-lines ##### --> <para> </para> -<!-- ##### ARG GtkTextView:width_columns ##### --> +<!-- ##### ARG GtkTextView:width-columns ##### --> <para> </para> -<!-- ##### ARG GtkTextView:pixels_above_lines ##### --> +<!-- ##### ARG GtkTextView:pixels-above-lines ##### --> <para> </para> -<!-- ##### ARG GtkTextView:pixels_below_lines ##### --> +<!-- ##### ARG GtkTextView:pixels-below-lines ##### --> <para> </para> -<!-- ##### ARG GtkTextView:pixels_inside_wrap ##### --> +<!-- ##### ARG GtkTextView:pixels-inside-wrap ##### --> <para> </para> @@ -410,7 +630,7 @@ types related to the text widget and how they work together. </para> -<!-- ##### ARG GtkTextView:wrap_mode ##### --> +<!-- ##### ARG GtkTextView:wrap-mode ##### --> <para> </para> @@ -420,12 +640,12 @@ types related to the text widget and how they work together. </para> -<!-- ##### ARG GtkTextView:left_margin ##### --> +<!-- ##### ARG GtkTextView:left-margin ##### --> <para> </para> -<!-- ##### ARG GtkTextView:right_margin ##### --> +<!-- ##### ARG GtkTextView:right-margin ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktipsquery.sgml b/docs/reference/gtk/tmpl/gtktipsquery.sgml index 820526f24..eb2467af9 100644 --- a/docs/reference/gtk/tmpl/gtktipsquery.sgml +++ b/docs/reference/gtk/tmpl/gtktipsquery.sgml @@ -188,7 +188,7 @@ Emitted when a widget is selected during a query. @event: the button press or button release event. @Returns: TRUE if the query should be stopped. -<!-- ##### ARG GtkTipsQuery:emit_always ##### --> +<!-- ##### ARG GtkTipsQuery:emit-always ##### --> <para> TRUE if the widget-entered and widget-selected signals are emitted even when the widget has no tooltip set. @@ -201,13 +201,13 @@ If it is selected while the query is in effect the query is automatically stopped. </para> -<!-- ##### ARG GtkTipsQuery:label_inactive ##### --> +<!-- ##### ARG GtkTipsQuery:label-inactive ##### --> <para> The text to display in the #GtkTipsQuery widget when the query is not in effect. </para> -<!-- ##### ARG GtkTipsQuery:label_no_tip ##### --> +<!-- ##### ARG GtkTipsQuery:label-no-tip ##### --> <para> The text to display in the #GtkTipsQuery widget when the query is running and the widget that the pointer is over has no tooltip. diff --git a/docs/reference/gtk/tmpl/gtktogglebutton.sgml b/docs/reference/gtk/tmpl/gtktogglebutton.sgml index 65f98af29..5a7fe1cf8 100644 --- a/docs/reference/gtk/tmpl/gtktogglebutton.sgml +++ b/docs/reference/gtk/tmpl/gtktogglebutton.sgml @@ -156,7 +156,7 @@ Should be connected if you wish to perform an action whenever the Sets whether the toggle button should be pressed in or not. </para> -<!-- ##### ARG GtkToggleButton:draw_indicator ##### --> +<!-- ##### ARG GtkToggleButton:draw-indicator ##### --> <para> A value of TRUE causes the toggle button to be invisible. FALSE displays it again. diff --git a/docs/reference/gtk/tmpl/gtktoolbar.sgml b/docs/reference/gtk/tmpl/gtktoolbar.sgml index 3fe21b821..921154df5 100644 --- a/docs/reference/gtk/tmpl/gtktoolbar.sgml +++ b/docs/reference/gtk/tmpl/gtktoolbar.sgml @@ -324,17 +324,17 @@ should be used if you wish to perform an action when ever the style of a toolbar </para> -<!-- ##### ARG GtkToolbar:toolbar_style ##### --> +<!-- ##### ARG GtkToolbar:toolbar-style ##### --> <para> </para> -<!-- ##### ARG GtkToolbar:space_size ##### --> +<!-- ##### ARG GtkToolbar:space-size ##### --> <para> </para> -<!-- ##### ARG GtkToolbar:space_style ##### --> +<!-- ##### ARG GtkToolbar:space-style ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktreemodel.sgml b/docs/reference/gtk/tmpl/gtktreemodel.sgml index 52a372fc3..f188e9b48 100644 --- a/docs/reference/gtk/tmpl/gtktreemodel.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodel.sgml @@ -28,9 +28,9 @@ gtktreemodel </para> @stamp: -@tree_node: -@tree_node2: -@tree_node3: +@user_data: +@user_data2: +@user_data3: <!-- ##### STRUCT GtkTreePath ##### --> <para> @@ -54,6 +54,7 @@ gtktreemodel @inserted: @child_toggled: @deleted: +@reordered: @get_flags: @get_n_columns: @get_column_type: diff --git a/docs/reference/gtk/tmpl/gtkmodelsimple.sgml b/docs/reference/gtk/tmpl/gtktreemodelsimple.sgml index 85479fed2..a3ae2da10 100644 --- a/docs/reference/gtk/tmpl/gtkmodelsimple.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodelsimple.sgml @@ -14,7 +14,7 @@ GtkModelSimple </para> -<!-- ##### STRUCT GtkModelSimple ##### --> +<!-- ##### STRUCT GtkTreeModelSimple ##### --> <para> </para> @@ -22,7 +22,7 @@ GtkModelSimple @parent: @stamp: -<!-- ##### FUNCTION gtk_model_simple_new ##### --> +<!-- ##### FUNCTION gtk_tree_model_simple_new ##### --> <para> </para> @@ -30,7 +30,7 @@ GtkModelSimple @Returns: -<!-- ##### FUNCTION gtk_model_simple_node_changed ##### --> +<!-- ##### FUNCTION gtk_tree_model_simple_changed ##### --> <para> </para> @@ -40,7 +40,7 @@ GtkModelSimple @iter: -<!-- ##### FUNCTION gtk_model_simple_node_inserted ##### --> +<!-- ##### FUNCTION gtk_tree_model_simple_inserted ##### --> <para> </para> @@ -50,7 +50,7 @@ GtkModelSimple @iter: -<!-- ##### FUNCTION gtk_model_simple_node_child_toggled ##### --> +<!-- ##### FUNCTION gtk_tree_model_simple_child_toggled ##### --> <para> </para> @@ -60,7 +60,7 @@ GtkModelSimple @iter: -<!-- ##### FUNCTION gtk_model_simple_node_deleted ##### --> +<!-- ##### FUNCTION gtk_tree_model_simple_deleted ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktreemodelsort.sgml b/docs/reference/gtk/tmpl/gtktreemodelsort.sgml index 6eddb40c1..9fa7048ef 100644 --- a/docs/reference/gtk/tmpl/gtktreemodelsort.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodelsort.sgml @@ -44,10 +44,12 @@ GtkTreeModelSort </para> -@model: +@child_model: @func: @sort_col: @Returns: +<!-- # Unused Parameters # --> +@model: <!-- ##### FUNCTION gtk_tree_model_sort_set_model ##### --> @@ -56,10 +58,12 @@ GtkTreeModelSort </para> @tree_model_sort: +@child_model: +<!-- # Unused Parameters # --> @model: -<!-- ##### FUNCTION gtk_tree_model_sort_set_sort_col ##### --> +<!-- ##### FUNCTION gtk_tree_model_sort_set_sort_column ##### --> <para> </para> @@ -77,21 +81,25 @@ GtkTreeModelSort @func: -<!-- ##### FUNCTION gtk_tree_model_sort_resort ##### --> +<!-- ##### FUNCTION gtk_tree_model_sort_convert_path ##### --> <para> </para> @tree_model_sort: +@child_path: +@Returns: +<!-- # Unused Parameters # --> +@path: -<!-- ##### FUNCTION gtk_tree_model_sort_convert_path ##### --> +<!-- ##### FUNCTION gtk_tree_model_sort_convert_iter ##### --> <para> </para> @tree_model_sort: -@path: -@Returns: +@sort_iter: +@child_iter: diff --git a/docs/reference/gtk/tmpl/gtktreeselection.sgml b/docs/reference/gtk/tmpl/gtktreeselection.sgml index 21408a18b..eb6d2695c 100644 --- a/docs/reference/gtk/tmpl/gtktreeselection.sgml +++ b/docs/reference/gtk/tmpl/gtktreeselection.sgml @@ -14,7 +14,7 @@ GtkTreeSelection </para> -<!-- ##### ENUM GtkTreeSelectionType ##### --> +<!-- ##### ENUM GtkTreeSelectionMode ##### --> <para> </para> @@ -44,34 +44,35 @@ GtkTreeSelection @data: -<!-- ##### FUNCTION gtk_tree_selection_new ##### --> +<!-- ##### FUNCTION gtk_tree_selection_set_mode ##### --> <para> </para> -@Returns: +@selection: +@type: -<!-- ##### FUNCTION gtk_tree_selection_set_type ##### --> +<!-- ##### FUNCTION gtk_tree_selection_set_select_function ##### --> <para> </para> @selection: -@type: +@func: +@data: -<!-- ##### FUNCTION gtk_tree_selection_set_select_function ##### --> +<!-- ##### FUNCTION gtk_tree_selection_get_user_data ##### --> <para> </para> @selection: -@func: -@data: +@Returns: -<!-- ##### FUNCTION gtk_tree_selection_get_user_data ##### --> +<!-- ##### FUNCTION gtk_tree_selection_get_tree_view ##### --> <para> </para> @@ -163,21 +164,3 @@ GtkTreeSelection @end_path: -<!-- ##### FUNCTION gtk_tree_selection_new_with_tree_view ##### --> -<para> - -</para> - -@tree_view: -@Returns: - - -<!-- ##### FUNCTION gtk_tree_selection_set_tree_view ##### --> -<para> - -</para> - -@selection: -@tree_view: - - diff --git a/docs/reference/gtk/tmpl/gtktreeview.sgml b/docs/reference/gtk/tmpl/gtktreeview.sgml index bff0f90aa..92e290fc4 100644 --- a/docs/reference/gtk/tmpl/gtktreeview.sgml +++ b/docs/reference/gtk/tmpl/gtktreeview.sgml @@ -28,10 +28,6 @@ GtkTreeView </para> @parent: -@tree_view: -@type: -@user_func: -@user_data: <!-- ##### STRUCT GtkTreeSelectionClass ##### --> <para> @@ -155,7 +151,7 @@ GtkTreeView @tree_view: -<!-- ##### FUNCTION gtk_tree_view_set_headers_active ##### --> +<!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml index 67a0f6280..b266434db 100644 --- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml +++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml @@ -32,7 +32,7 @@ GtkTreeViewColumn @window: @justification: @id: -@size: +@width: @min_width: @max_width: @func: @@ -45,7 +45,7 @@ GtkTreeViewColumn @button_active: @dirty: -<!-- ##### ENUM GtkTreeViewColumnType ##### --> +<!-- ##### ENUM GtkTreeViewColumnSizing ##### --> <para> </para> @@ -141,7 +141,7 @@ GtkTreeViewColumn @Returns: -<!-- ##### FUNCTION gtk_tree_view_column_set_col_type ##### --> +<!-- ##### FUNCTION gtk_tree_view_column_set_sizing ##### --> <para> </para> @@ -168,15 +168,13 @@ GtkTreeViewColumn @Returns: -<!-- ##### FUNCTION gtk_tree_view_column_set_size ##### --> +<!-- ##### FUNCTION gtk_tree_view_column_set_width ##### --> <para> </para> @tree_column: @size: -<!-- # Unused Parameters # --> -@width: <!-- ##### FUNCTION gtk_tree_view_column_set_min_width ##### --> @@ -233,7 +231,7 @@ GtkTreeViewColumn @Returns: -<!-- ##### FUNCTION gtk_tree_view_column_set_header_active ##### --> +<!-- ##### FUNCTION gtk_tree_view_column_set_header_clickable ##### --> <para> </para> @@ -278,3 +276,11 @@ GtkTreeViewColumn @Returns: +<!-- ##### FUNCTION gtk_tree_view_column_clicked ##### --> +<para> + +</para> + +@tree_column: + + diff --git a/docs/reference/gtk/tmpl/gtkviewport.sgml b/docs/reference/gtk/tmpl/gtkviewport.sgml index 473d50166..a97686810 100644 --- a/docs/reference/gtk/tmpl/gtkviewport.sgml +++ b/docs/reference/gtk/tmpl/gtkviewport.sgml @@ -94,7 +94,7 @@ GtkViewport </para> -<!-- ##### ARG GtkViewport:shadow_type ##### --> +<!-- ##### ARG GtkViewport:shadow-type ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkwidget.sgml b/docs/reference/gtk/tmpl/gtkwidget.sgml index 5b05c5e57..2790ec369 100644 --- a/docs/reference/gtk/tmpl/gtkwidget.sgml +++ b/docs/reference/gtk/tmpl/gtkwidget.sgml @@ -310,20 +310,11 @@ GtkWidget </para> @type: -@first_arg_name: +@first_property_name: @Varargs: @Returns: - - -<!-- ##### FUNCTION gtk_widget_newv ##### --> -<para> - -</para> - -@type: -@nargs: -@args: -@Returns: +<!-- # Unused Parameters # --> +@first_arg_name: <!-- ##### FUNCTION gtk_widget_ref ##### --> @@ -360,43 +351,16 @@ GtkWidget @widget_pointer: -<!-- ##### FUNCTION gtk_widget_get ##### --> -<para> - -</para> - -@widget: -@arg: - - -<!-- ##### FUNCTION gtk_widget_getv ##### --> -<para> - -</para> - -@widget: -@nargs: -@args: - - <!-- ##### FUNCTION gtk_widget_set ##### --> <para> </para> @widget: -@first_arg_name: +@first_property_name: @Varargs: - - -<!-- ##### FUNCTION gtk_widget_setv ##### --> -<para> - -</para> - -@widget: -@nargs: -@args: +<!-- # Unused Parameters # --> +@first_arg_name: <!-- ##### FUNCTION gtk_widget_unparent ##### --> @@ -642,6 +606,15 @@ GtkWidget @Returns: +<!-- ##### FUNCTION gtk_widget_is_focus ##### --> +<para> + +</para> + +@widget: +@Returns: + + <!-- ##### FUNCTION gtk_widget_grab_focus ##### --> <para> @@ -1453,14 +1426,6 @@ GtkWidget @time: @Returns: -<!-- ##### SIGNAL GtkWidget::draw ##### --> -<para> - -</para> - -@widget: the object which received the signal. -@area: - <!-- ##### SIGNAL GtkWidget::draw-default ##### --> <para> @@ -1813,37 +1778,37 @@ GtkWidget </para> -<!-- ##### ARG GtkWidget:app_paintable ##### --> +<!-- ##### ARG GtkWidget:app-paintable ##### --> <para> </para> -<!-- ##### ARG GtkWidget:can_focus ##### --> +<!-- ##### ARG GtkWidget:can-focus ##### --> <para> </para> -<!-- ##### ARG GtkWidget:has_focus ##### --> +<!-- ##### ARG GtkWidget:has-focus ##### --> <para> </para> -<!-- ##### ARG GtkWidget:can_default ##### --> +<!-- ##### ARG GtkWidget:can-default ##### --> <para> </para> -<!-- ##### ARG GtkWidget:has_default ##### --> +<!-- ##### ARG GtkWidget:has-default ##### --> <para> </para> -<!-- ##### ARG GtkWidget:receives_default ##### --> +<!-- ##### ARG GtkWidget:receives-default ##### --> <para> </para> -<!-- ##### ARG GtkWidget:composite_child ##### --> +<!-- ##### ARG GtkWidget:composite-child ##### --> <para> </para> @@ -1858,7 +1823,7 @@ GtkWidget </para> -<!-- ##### ARG GtkWidget:extension_events ##### --> +<!-- ##### ARG GtkWidget:extension-events ##### --> <para> </para> diff --git a/docs/reference/gtk/tmpl/gtkwindow.sgml b/docs/reference/gtk/tmpl/gtkwindow.sgml index b46bcd7b8..0793f19c8 100644 --- a/docs/reference/gtk/tmpl/gtkwindow.sgml +++ b/docs/reference/gtk/tmpl/gtkwindow.sgml @@ -263,17 +263,17 @@ The type of the window. The title of the window. </para> -<!-- ##### ARG GtkWindow:auto_shrink ##### --> +<!-- ##### ARG GtkWindow:auto-shrink ##### --> <para> If the window shrinks automatically when widgets within it shrink. </para> -<!-- ##### ARG GtkWindow:allow_shrink ##### --> +<!-- ##### ARG GtkWindow:allow-shrink ##### --> <para> If the window can be resized to a smaller size by the user. </para> -<!-- ##### ARG GtkWindow:allow_grow ##### --> +<!-- ##### ARG GtkWindow:allow-grow ##### --> <para> If the window can be resized to a larger size by the user. </para> @@ -283,22 +283,22 @@ If the window can be resized to a larger size by the user. If the window is modal, i.e. it grabs all GTK+ events. </para> -<!-- ##### ARG GtkWindow:window_position ##### --> +<!-- ##### ARG GtkWindow:window-position ##### --> <para> The position of the window. </para> -<!-- ##### ARG GtkWindow:default_width ##### --> +<!-- ##### ARG GtkWindow:default-width ##### --> <para> </para> -<!-- ##### ARG GtkWindow:default_height ##### --> +<!-- ##### ARG GtkWindow:default-height ##### --> <para> </para> -<!-- ##### ARG GtkWindow:destroy_with_parent ##### --> +<!-- ##### ARG GtkWindow:destroy-with-parent ##### --> <para> </para> |