From e9cebcd36a6c63591232c9d962278cdfb291d487 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Thu, 4 Nov 1999 07:30:04 +0000 Subject: [PATCH] Finished integrating the documentation framework. 1999-11-04 Federico Mena Quintero * doc/: Finished integrating the documentation framework. --- docs/reference/gdk-pixbuf/.cvsignore | 4 + docs/reference/gdk-pixbuf/Makefile.am | 2 +- docs/reference/gdk-pixbuf/gdk-pixbuf-decl.txt | 288 ++++++++++++++++++ .../gdk-pixbuf/gdk-pixbuf-sections.txt | 81 +++++ .../reference/gdk-pixbuf/gdk-pixbuf.hierarchy | 4 + docs/reference/gdk-pixbuf/gdk-pixbuf.sgml | 54 ++++ docs/reference/gdk-pixbuf/gdk-pixbuf.types | 7 + docs/reference/gdk-pixbuf/tmpl/creating.sgml | 65 ++++ .../gdk-pixbuf/tmpl/file-loading.sgml | 27 ++ .../gdk-pixbuf/tmpl/gdk-pixbuf-io.sgml | 59 ++++ .../gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml | 87 ++++++ .../gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml | 0 .../reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml | 98 ++++++ .../gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml | 61 ++++ .../gdk-pixbuf/tmpl/refcounting.sgml | 34 +++ docs/reference/gdk-pixbuf/tmpl/rendering.sgml | 81 +++++ gdk-pixbuf/ChangeLog | 4 + 17 files changed, 955 insertions(+), 1 deletion(-) create mode 100644 docs/reference/gdk-pixbuf/.cvsignore create mode 100644 docs/reference/gdk-pixbuf/gdk-pixbuf-decl.txt create mode 100644 docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt create mode 100644 docs/reference/gdk-pixbuf/gdk-pixbuf.hierarchy create mode 100644 docs/reference/gdk-pixbuf/gdk-pixbuf.sgml create mode 100644 docs/reference/gdk-pixbuf/gdk-pixbuf.types create mode 100644 docs/reference/gdk-pixbuf/tmpl/creating.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/file-loading.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-io.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/refcounting.sgml create mode 100644 docs/reference/gdk-pixbuf/tmpl/rendering.sgml diff --git a/docs/reference/gdk-pixbuf/.cvsignore b/docs/reference/gdk-pixbuf/.cvsignore new file mode 100644 index 0000000000..67428d2f60 --- /dev/null +++ b/docs/reference/gdk-pixbuf/.cvsignore @@ -0,0 +1,4 @@ +Makefile +Makefile.in +html +sgml diff --git a/docs/reference/gdk-pixbuf/Makefile.am b/docs/reference/gdk-pixbuf/Makefile.am index 3ec965aa6a..cf2e90cf70 100644 --- a/docs/reference/gdk-pixbuf/Makefile.am +++ b/docs/reference/gdk-pixbuf/Makefile.am @@ -4,7 +4,7 @@ DOC_MODULE=gdk-pixbuf # The top-level SGML file. -DOC_MAIN_SGML_FILE=gdk-pixbuf-docs.sgml +DOC_MAIN_SGML_FILE=gdk-pixbuf.sgml # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=$(GDK_PIXBUF_DIR)/src diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-decl.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-decl.txt new file mode 100644 index 0000000000..f74dcff19b --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-decl.txt @@ -0,0 +1,288 @@ + +GdkPixbufCache +typedef struct { + int dummy; +} GdkPixbufCache; + + +gdk_pixbuf_cache_new +GdkPixbufCache * +long image_cache_limit,long pixmap_bitmap_cache_limit + + +gdk_pixbuf_cache_destroy +void +GdkPixbufCache *cache + + +gdk_pixbuf_cache_load_image +GdkPixbuf * +GdkPixbufCache *cache,const char *file + + +ModulePreparedNotifyFunc +void +GdkPixbuf *pixbuf, gpointer user_data + + +GdkPixbufModule + + +GdkPixbufModule +struct GdkPixbufModule { + char *module_name; + gboolean (* format_check) (guchar *buffer, int size); + GModule *module; + GdkPixbuf *(* load) (FILE *f); + GdkPixbuf *(* load_xpm_data) (const gchar **data); + + /* Incremental loading */ + gpointer (* begin_load) (ModulePreparedNotifyFunc func, gpointer user_data); + void (* stop_load) (gpointer context); + gboolean (* load_increment)(gpointer context, const gchar *buf, guint size); +}; + + +gdk_pixbuf_get_module +GdkPixbufModule * +gchar *buffer, gint size + + +gdk_pixbuf_load_module +void +GdkPixbufModule *image_module + + +GdkPixbuf + + +GdkPixbuf +struct GdkPixbuf { + /* Reference count */ + int ref_count; + + /* Libart pixbuf */ + ArtPixBuf *art_pixbuf; +}; + + +gdk_pixbuf_get_format +ArtPixFormat +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_n_channels +int +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_has_alpha +int +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_bits_per_sample +int +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_pixels +guchar * +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_width +int +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_height +int +GdkPixbuf *pixbuf + + +gdk_pixbuf_get_rowstride +int +GdkPixbuf *pixbuf + + +gdk_pixbuf_ref +void +GdkPixbuf *pixbuf + + +gdk_pixbuf_unref +void +GdkPixbuf *pixbuf + + +gdk_pixbuf_new_from_art_pixbuf +GdkPixbuf * +ArtPixBuf *art_pixbuf + + +gdk_pixbuf_new +GdkPixbuf * +ArtPixFormat format, gboolean has_alpha, int bits_per_sample,int width, int height + + +gdk_pixbuf_new_from_file +GdkPixbuf * +const char *filename + + +gdk_pixbuf_new_from_data +GdkPixbuf * +guchar *data, ArtPixFormat format, gboolean has_alpha,int width, int height, int rowstride,ArtDestroyNotify dfunc, gpointer dfunc_data + + +gdk_pixbuf_new_from_xpm_data +GdkPixbuf * +const gchar **data + + +GdkPixbufAlphaMode +typedef enum { + GDK_PIXBUF_ALPHA_BILEVEL, + GDK_PIXBUF_ALPHA_FULL +} GdkPixbufAlphaMode; + + +gdk_pixbuf_render_threshold_alpha +void +GdkPixbuf *pixbuf, GdkBitmap *bitmap,int src_x, int src_y,int dest_x, int dest_y,int width, int height,int alpha_threshold + + +gdk_pixbuf_render_to_drawable +void +GdkPixbuf *pixbuf,GdkDrawable *drawable, GdkGC *gc,int src_x, int src_y,int dest_x, int dest_y,int width, int height,GdkRgbDither dither,int x_dither, int y_dither + + +gdk_pixbuf_render_to_drawable_alpha +void +GdkPixbuf *pixbuf, GdkDrawable *drawable,int src_x, int src_y,int dest_x, int dest_y,int width, int height,GdkPixbufAlphaMode alpha_mode,int alpha_threshold,GdkRgbDither dither,int x_dither, int y_dither + + +gdk_pixbuf_scale +GdkPixbuf * +const GdkPixbuf *pixbuf, gint w, gint h + + +gdk_pixbuf_rotate +GdkPixbuf * +GdkPixbuf *pixbuf, gdouble angle + + +gdk_pixbuf_rgb_from_drawable +GdkPixbuf * +GdkWindow *window, gint x, gint y, gint width, gint height + + +gdk_pixbuf_rgba_from_drawable +GdkPixbuf * +GdkWindow *window, gint x, gint y, gint width, gint height + + +GNOME_TYPE_CANVAS_PIXBUF +#define GNOME_TYPE_CANVAS_PIXBUF (gnome_canvas_pixbuf_get_type ()) + + +GNOME_CANVAS_PIXBUF +#define GNOME_CANVAS_PIXBUF(obj) (GTK_CHECK_CAST ((obj), \ + GNOME_TYPE_CANVAS_PIXBUF, GnomeCanvasPixbuf)) + + +GNOME_CANVAS_PIXBUF_CLASS +#define GNOME_CANVAS_PIXBUF_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), \ + GNOME_TYPE_CANVAS_PIXBUF, GnomeCanvasPixbufClass)) + + +GNOME_IS_CANVAS_PIXBUF +#define GNOME_IS_CANVAS_PIXBUF(obj) (GTK_CHECK_TYPE ((obj), GNOME_TYPE_CANVAS_PIXBUF)) + + +GNOME_IS_CANVAS_PIXBUF_CLASS +#define GNOME_IS_CANVAS_PIXBUF_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), \ + GNOME_TYPE_CANVAS_PIXBUF)) + + +GnomeCanvasPixbuf + + +GnomeCanvasPixbufClass + + +GnomeCanvasPixbuf +struct GnomeCanvasPixbuf { + GnomeCanvasItem item; + + /* Private data */ + gpointer priv; +}; + + +gnome_canvas_pixbuf_get_type +GtkType +void + + +GDK_TYPE_PIXBUF_LOADER +#define GDK_TYPE_PIXBUF_LOADER (gdk_pixbuf_loader_get_type ()) + + +GDK_PIXBUF_LOADER +#define GDK_PIXBUF_LOADER(obj) (GTK_CHECK_CAST ((obj), GDK_TYPE_PIXBUF_LOADER, GdkPixbufLoader)) + + +GDK_PIXBUF_LOADER_CLASS +#define GDK_PIXBUF_LOADER_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GDK_TYPE_PIXBUF_LOADER, GdkPixbufLoaderClass)) + + +GDK_IS_PIXBUF_LOADER +#define GDK_IS_PIXBUF_LOADER(obj) (GTK_CHECK_TYPE ((obj), GDK_TYPE_PIXBUF_LOADER)) + + +GDK_IS_PIXBUF_LOADER_CLASS +#define GDK_IS_PIXBUF_LOADER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GDK_TYPE_PIXBUF_LOADER)) + + +GdkPixbufLoader + + +GdkPixbufLoader +struct GdkPixbufLoader +{ + GtkObject object; + + /* < Private > */ + gpointer private; +}; + + +GdkPixbufLoaderClass + + +gdk_pixbuf_loader_get_type +GtkType +void + + +gdk_pixbuf_loader_new +GdkPixbufLoader * +void + + +gdk_pixbuf_loader_write +gboolean +GdkPixbufLoader *loader, const gchar *buf, size_t count + + +gdk_pixbuf_loader_get_pixbuf +GdkPixbuf * +GdkPixbufLoader *loader + + +gdk_pixbuf_loader_close +void +GdkPixbufLoader *loader + diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt new file mode 100644 index 0000000000..5763e649d1 --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt @@ -0,0 +1,81 @@ +gdk-pixbuf/gdk-pixbuf.h + +
+gdk-pixbuf +GdkPixbuf +gdk_pixbuf_get_format +gdk_pixbuf_get_n_channels +gdk_pixbuf_get_has_alpha +gdk_pixbuf_get_bits_per_sample +gdk_pixbuf_get_pixels +gdk_pixbuf_get_width +gdk_pixbuf_get_height +gdk_pixbuf_get_rowstride +
+ +
+refcounting +gdk_pixbuf_ref +gdk_pixbuf_unref +
+ +
+file-loading +gdk_pixbuf_new_from_file +
+ +
+creating +gdk_pixbuf_new_from_art_pixbuf +gdk_pixbuf_new +gdk_pixbuf_new_from_data +gdk_pixbuf_new_from_xpm_data +
+ +
+rendering +GdkPixbufAlphaMode +gdk_pixbuf_render_to_drawable_alpha +gdk_pixbuf_render_to_drawable +gdk_pixbuf_render_threshold_alpha +
+ +
+gnome-canvas-pixbuf +GNOME_CANVAS_PIXBUF +GnomeCanvasPixbuf + +GNOME_TYPE_CANVAS_PIXBUF +GNOME_IS_CANVAS_PIXBUF +gnome_canvas_pixbuf_get_type +GNOME_CANVAS_PIXBUF_CLASS +GNOME_IS_CANVAS_PIXBUF_CLASS + +GnomeCanvasPixbuf +
+ +
+gdk-pixbuf-loader +GDK_PIXBUF_LOADER +GdkPixbufLoader +gdk_pixbuf_loader_new +gdk_pixbuf_loader_write +gdk_pixbuf_loader_get_pixbuf +gdk_pixbuf_loader_close + +GDK_TYPE_PIXBUF_LOADER +GDK_IS_PIXBUF_LOADER +gdk_pixbuf_loader_get_type +GDK_PIXBUF_LOADER_CLASS +GDK_IS_PIXBUF_LOADER_CLASS + +GdkPixbufLoader +
+ +
+gdk-pixbuf-io +ModulePreparedNotifyFunc +GdkPixbufModule +gdk_pixbuf_get_module +gdk_pixbuf_load_module +
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.hierarchy b/docs/reference/gdk-pixbuf/gdk-pixbuf.hierarchy new file mode 100644 index 0000000000..1c379f26d4 --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.hierarchy @@ -0,0 +1,4 @@ +GtkObject + GdkPixbufLoader + GnomeCanvasItem + GnomeCanvasPixbuf diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml new file mode 100644 index 0000000000..3efd4f9b83 --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.sgml @@ -0,0 +1,54 @@ + + + + + + + + +]> + + + + The GdkPixbuf Library + + + + Federico + Mena Quintero + +
+ federico@gimp.org +
+ + + + + + 1999 + The Free Software Foundation + + + + + API Reference + + + + This part presents the class and function reference for the + GdkPixbuf library. Classes are described together with their + methods; individual functions are grouped by functional group. + + + + &gdk-pixbuf-gdk-pixbuf; + &gdk-pixbuf-refcounting; + &gdk-pixbuf-file-loading; + &gdk-pixbuf-creating; + &gdk-pixbuf-rendering; + &GnomeCanvasPixbuf; + &GdkPixbufLoader; + &gdk-pixbuf-gdk-pixbuf-io; + + diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.types b/docs/reference/gdk-pixbuf/gdk-pixbuf.types new file mode 100644 index 0000000000..b583e41377 --- /dev/null +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.types @@ -0,0 +1,7 @@ +#include +#include +#include +#include + +gdk_pixbuf_loader_get_type +gnome_canvas_pixbuf_get_type diff --git a/docs/reference/gdk-pixbuf/tmpl/creating.sgml b/docs/reference/gdk-pixbuf/tmpl/creating.sgml new file mode 100644 index 0000000000..fa110239ab --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/creating.sgml @@ -0,0 +1,65 @@ + +creating + + + + + + + + + + + + + + + + + + + + + +@art_pixbuf: +@Returns: + + + + + + + +@format: +@has_alpha: +@bits_per_sample: +@width: +@height: +@Returns: + + + + + + + +@data: +@format: +@has_alpha: +@width: +@height: +@rowstride: +@dfunc: +@dfunc_data: +@Returns: + + + + + + + +@data: +@Returns: + + diff --git a/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml b/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml new file mode 100644 index 0000000000..d26f875855 --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/file-loading.sgml @@ -0,0 +1,27 @@ + +file-loading + + + + + + + + + + + + + + + + + + + + + +@filename: +@Returns: + + diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-io.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-io.sgml new file mode 100644 index 0000000000..4a2aa5478e --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-io.sgml @@ -0,0 +1,59 @@ + +gdk-pixbuf-io + + + + + + + + + + + + + + + + + + + + + +@pixbuf: +@user_data: + + + + + + + +@module_name: +@format_check: +@module: +@load: +@load_xpm_data: +@begin_load: +@stop_load: +@load_increment: + + + + + + +@buffer: +@size: +@Returns: + + + + + + + +@image_module: + + diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml new file mode 100644 index 0000000000..3dc9606b2f --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml @@ -0,0 +1,87 @@ + +GdkPixbufLoader + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@Returns: + + + + + + + +@loader: +@buf: +@count: +@Returns: + + + + + + + +@loader: +@Returns: + + + + + + + +@loader: + + + + + + + +@gdkpixbufloader: the object which received the signal. +@arg1: +@arg2: +@arg3: +@arg4: + + + + + + +@gdkpixbufloader: the object which received the signal. + + + + + + +@gdkpixbufloader: the object which received the signal. + diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml new file mode 100644 index 0000000000..8f95817ea0 --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml @@ -0,0 +1,98 @@ + +gdk-pixbuf + + + + + + + + + + + + + + + + + + + + + +@ref_count: +@art_pixbuf: + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + + + + + + +@pixbuf: +@Returns: + + diff --git a/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml b/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml new file mode 100644 index 0000000000..a615cc27ba --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml @@ -0,0 +1,61 @@ + +GnomeCanvasPixbuf + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml new file mode 100644 index 0000000000..ec2b62d0b8 --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml @@ -0,0 +1,34 @@ + +refcounting + + + + + + + + + + + + + + + + + + + + + +@pixbuf: + + + + + + + +@pixbuf: + + diff --git a/docs/reference/gdk-pixbuf/tmpl/rendering.sgml b/docs/reference/gdk-pixbuf/tmpl/rendering.sgml new file mode 100644 index 0000000000..0576a730b9 --- /dev/null +++ b/docs/reference/gdk-pixbuf/tmpl/rendering.sgml @@ -0,0 +1,81 @@ + +rendering + + + + + + + + + + + + + + + + + + + + + +@GDK_PIXBUF_ALPHA_BILEVEL: +@GDK_PIXBUF_ALPHA_FULL: + + + + + + +@pixbuf: +@drawable: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: +@alpha_mode: +@alpha_threshold: +@dither: +@x_dither: +@y_dither: + + + + + + + +@pixbuf: +@drawable: +@gc: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: +@dither: +@x_dither: +@y_dither: + + + + + + + +@pixbuf: +@bitmap: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: +@alpha_threshold: + + diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog index 2fcafd8938..d1bc556de3 100644 --- a/gdk-pixbuf/ChangeLog +++ b/gdk-pixbuf/ChangeLog @@ -1,3 +1,7 @@ +1999-11-04 Federico Mena Quintero + + * doc/: Finished integrating the documentation framework. + 1999-11-03 Federico Mena Quintero * configure.in: Removed libgif stuff now that we do not depend on it.