[cairo-commit] gtkcairo README,1.4,1.5 ChangeLog,1.23,1.24

[Oeyvind Kolaas]

Committed by: pippin

Update of /cvs/cairo/gtkcairo
In directory gabe:/tmp/cvs-serv16538

Modified Files:
	README ChangeLog 
Log Message:
updated README

Index: README
===================================================================
RCS file: /cvs/cairo/gtkcairo/README,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- README	29 Jun 2004 08:20:48 -0000	1.4
+++ README	11 Dec 2004 16:43:55 -0000	1.5
@@ -1,24 +1,34 @@
-/* gtkcairo - GTK+ widget for displaying a Cairo surface.
- *
- * Hacked up by Evan Martin <martine at danga.com>.
- * further modified by OEyvind Kolaas <oeyvindk at hig.no>
- */
+GtkCairo
+========
 
+GtkCairo is an extension of GtkWidget that can paint itself using the
+cairo api using a few backends (xlib w/Render acceleration, and glitz
+w/open gl acceleration).
 
-GtkCairo is a library that provides a new widget to be used in your
-GTK+ program: a Cairo surface.
+Synopsis
+========
 
+GtkWidget *gtk_cairo_new (void);
+cairo_t   *gtk_cairo_get_cairo (GtkCairo *gtkcairo);
 
-Dependencies
-------------
+Signal prototypes
+=================
 
-GtkCairo depends on the obvious two:
- - GTK 2: http://www.gtk.org
- - Cairo: http://www.cairographics.org
+"paint"
+     void user_function (GtkWidget *widget,
+                         cairo_t   *cr,
+                         gpointer   user_data)
 
+Object Hierarchy
+================
+
+GObject
++---GtkObject
+    +----GtkWidget
+         +----GtkCairo
 
 Usage
------
+=====
 
 Hook up to the widgets "paint" signal with your custom drawing code,
 queue redraw of the widget using gtk_widget_queue_draw (widget);
@@ -29,9 +39,8 @@
 To use GtkCairo in your code, add the package "gtkcairo" to the list
 of packages you pull in via pkg-config.
 
-
 Backend selection
------------------
+=================
 
 GtkCairo should choose a reasonable cairo backend by default, at the
 moment this means the xlib backend since it provides AA at all times,
@@ -39,16 +48,22 @@
 
 export GTKCAIRO_BACKEND = gl
 export GTKCAIRO_BACKEND = xlib
-export GTKCAIRO_BACKEND = image
+export GTKCAIRO_BACKEND = image (not implemented yet)
 
 before starting an application.
 
+Todo
+====
 
-Acknowledgement
----------------
+* Make it possible to switch backend on the fly using a property,
+* Implement the image backend, probably using gdkpixbuf.
 
-The majority of GtkCairo was a cut'n'paste job from from grrobot, by
-Carl Worth.
+Dependencies
+============
+
+GtkCairo depends on the obvious two:
+ - GTK 2: http://www.gtk.org
+ - Cairo: http://www.cairographics.org
 
 
 vim: tw=70

Index: ChangeLog
===================================================================
RCS file: /cvs/cairo/gtkcairo/ChangeLog,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -r1.23 -r1.24
--- ChangeLog	11 Dec 2004 16:04:42 -0000	1.23
+++ ChangeLog	11 Dec 2004 16:43:55 -0000	1.24
@@ -1,4 +1,9 @@
-2004-12-11  Øyvind Kolås>  <oeyvindk at hig.no>
+2004-12-11  Øyvind Kolås  <oeyvindk at hig.no>
+
+	* README: rewrote, removed authors, since almost all that information
+	is available in AUTHORS.
+
+2004-12-11  Øyvind Kolås  <oeyvindk at hig.no>
 
 	* */*.[ch]: transformed to GNU coding style.