diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index fcc260c1f7..f4ecd53bdd 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Thu Dec 11 01:57:55 2003 Matthias Clasen + + * gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Signal documentation + moved inline. + Thu Dec 11 00:04:10 2003 Matthias Clasen * gtk/gtk-sections.txt: Add gtk_window_[sg]et_accept_focus(). diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml index 1845a2573e..7fd47cac2a 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml @@ -78,65 +78,33 @@ fields. - This signal is emitted when the pixbuf loader has allocated the pixbuf - in the desired size. After this signal is emitted, applications can - call gdk_pixbuf_loader_get_pixbuf() to fetch the partially-loaded pixbuf. -@gdkpixbufloader: the object which received the signal. +@gdkpixbufloader: - This signal is emitted when a significant area of the image being - loaded has been updated. Normally it means that a complete - scanline has been read in, but it could be a different area as - well. Applications can use this signal to know when to repaint - areas of an image that is being loaded. -@gdkpixbufloader: Loader which emitted the signal. +@gdkpixbufloader: @arg1: @arg2: @arg3: @arg4: - -@x: X offset of upper-left corner of the updated area. -@y: Y offset of upper-left corner of the updated area. -@width: Width of updated area. -@height: Height of updated area. - This signal is emitted when gdk_pixbuf_loader_close() is called. - It can be used by different parts of an application to receive - notification when an image loader is closed by the code that - drives it. -@gdkpixbufloader: the object which received the signal. - - +@gdkpixbufloader: - This signal is emitted when the pixbuf loader has been fed the - initial amount of data that is required to figure out the size - of the image that it will create. Applications can call - gdk_pixbuf_loader_set_size() in response to this signal to set - the desired size to which the image should be scaled. -@gdkpixbufloader: the object which received the signal. +@gdkpixbufloader: @arg1: @arg2: - -@width: the original width of the image -@height: the original height of the image @@ -224,4 +192,11 @@ End: @error: @Returns: + + diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog index e1286f7441..f9ff08314e 100644 --- a/gdk-pixbuf/ChangeLog +++ b/gdk-pixbuf/ChangeLog @@ -1,3 +1,9 @@ +Thu Dec 11 01:57:05 2003 Matthias Clasen + + * gdk-pixbuf-loader.c (gdk_pixbuf_loader_class_init): Move + the documentation for signals inline, to get proper parameter + documentation. (#128977) + Sat Nov 15 00:26:19 2003 Matthias Clasen * queryloaders.c (loader_sanity_check): Check that the mask diff --git a/gdk-pixbuf/gdk-pixbuf-loader.c b/gdk-pixbuf/gdk-pixbuf-loader.c index 90635ed62a..b4c135252e 100644 --- a/gdk-pixbuf/gdk-pixbuf-loader.c +++ b/gdk-pixbuf/gdk-pixbuf-loader.c @@ -70,7 +70,6 @@ typedef struct /** * gdk_pixbuf_loader_get_type: - * @void: * * Registers the #GdkPixbufLoader class if necessary, and returns the type ID * associated to it. @@ -116,6 +115,18 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class) object_class->finalize = gdk_pixbuf_loader_finalize; + /** + * GdkPixbufLoader::size-prepared: + * @loader: the object which received the signal. + * @width: the original width of the image + * @height: the original height of the image + * + * This signal is emitted when the pixbuf loader has been fed the + * initial amount of data that is required to figure out the size + * of the image that it will create. Applications can call + * gdk_pixbuf_loader_set_size() in response to this signal to set + * the desired size to which the image should be scaled. + */ pixbuf_loader_signals[SIZE_PREPARED] = g_signal_new ("size_prepared", G_TYPE_FROM_CLASS (object_class), @@ -127,6 +138,15 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class) G_TYPE_INT, G_TYPE_INT); + /** + * GdkPixbufLoader::area-prepared: + * @loader: the object which received the signal. + * + * This signal is emitted when the pixbuf loader has allocated the + * pixbuf in the desired size. After this signal is emitted, + * applications can call gdk_pixbuf_loader_get_pixbuf() to fetch + * the partially-loaded pixbuf. + */ pixbuf_loader_signals[AREA_PREPARED] = g_signal_new ("area_prepared", G_TYPE_FROM_CLASS (object_class), @@ -135,7 +155,21 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class) NULL, NULL, gdk_pixbuf_marshal_VOID__VOID, G_TYPE_NONE, 0); - + + /** + * GdkPixbufLoader::area-updated: + * @loader: the object which received the signal. + * @x: X offset of upper-left corner of the updated area. + * @y: Y offset of upper-left corner of the updated area. + * @width: Width of updated area. + * @height: Height of updated area. + * + * This signal is emitted when a significant area of the image being + * loaded has been updated. Normally it means that a complete + * scanline has been read in, but it could be a different area as + * well. Applications can use this signal to know when to repaint + * areas of an image that is being loaded. + */ pixbuf_loader_signals[AREA_UPDATED] = g_signal_new ("area_updated", G_TYPE_FROM_CLASS (object_class), @@ -149,6 +183,15 @@ gdk_pixbuf_loader_class_init (GdkPixbufLoaderClass *class) G_TYPE_INT, G_TYPE_INT); + /** + * GdkPixbufLoader::closed: + * @loader: the object which received the signal. + * + * This signal is emitted when gdk_pixbuf_loader_close() is called. + * It can be used by different parts of an application to receive + * notification when an image loader is closed by the code that + * drives it. + */ pixbuf_loader_signals[CLOSED] = g_signal_new ("closed", G_TYPE_FROM_CLASS (object_class),