[cairo-commit] goocanvas/src goocanvasellipseview.c, 1.5,
1.6 goocanvasellipseview.h, 1.1.1.1, 1.2 goocanvasgroupview.c,
1.5, 1.6 goocanvasgroupview.h, 1.1.1.1,
1.2 goocanvasimageview.c, 1.5, 1.6 goocanvasimageview.h,
1.1.1.1, 1.2 goocanvaspathview.c, 1.3, 1.4 goocanvaspathview.h,
1.1, 1.2 goocanvaspolylineview.c, 1.6,
1.7 goocanvaspolylineview.h, 1.2, 1.3 goocanvasrectview.c, 1.5,
1.6 goocanvasrectview.h, 1.1.1.1, 1.2 goocanvastextview.c, 1.6,
1.7 goocanvastextview.h, 1.2, 1.3
Damon Chaplin
commit at pdx.freedesktop.org
Thu Apr 13 10:07:46 PDT 2006
Committed by: damon
Update of /cvs/cairo/goocanvas/src
In directory kemper:/tmp/cvs-serv14526/src
Modified Files:
goocanvasellipseview.c goocanvasellipseview.h
goocanvasgroupview.c goocanvasgroupview.h goocanvasimageview.c
goocanvasimageview.h goocanvaspathview.c goocanvaspathview.h
goocanvaspolylineview.c goocanvaspolylineview.h
goocanvasrectview.c goocanvasrectview.h goocanvastextview.c
goocanvastextview.h
Log Message:
2006-04-13 Damon Chaplin <damon at gnome.org>
* src/*.[hc]: documented views for standard items.
Index: goocanvasellipseview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasellipseview.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- goocanvasellipseview.c 8 Apr 2006 13:14:17 -0000 1.5
+++ goocanvasellipseview.c 13 Apr 2006 17:07:44 -0000 1.6
@@ -2,7 +2,27 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasellipseview.c -
+ * goocanvasellipseview.c - view for ellipse item.
+ */
+
+/**
+ * SECTION:goocanvasellipseview
+ * @Title: GooCanvasEllipseView
+ * @Short_Description: a view for a #GooCanvasEllipse item.
+ *
+ * #GooCanvasEllipseView represents a view of a #GooCanvasEllipse item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the ellipse view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
*/
#include <config.h>
#include <math.h>
@@ -42,6 +62,18 @@
}
+/**
+ * goo_canvas_ellipse_view_new:
+ * @parent_view: the parent view.
+ * @ellipse: the ellipse item.
+ *
+ * Creates a new #GooCanvasEllipseView for the given #GooCanvasEllipse item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasEllipseView.
+ **/
GooCanvasItemView*
goo_canvas_ellipse_view_new (GooCanvasItemView *parent_view,
GooCanvasEllipse *ellipse)
Index: goocanvasellipseview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasellipseview.h,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- goocanvasellipseview.h 15 Dec 2005 15:32:01 -0000 1.1.1.1
+++ goocanvasellipseview.h 13 Apr 2006 17:07:44 -0000 1.2
@@ -2,7 +2,7 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasellipseview.h -
+ * goocanvasellipseview.h - view for ellipse item.
*/
#ifndef __GOO_CANVAS_ELLIPSE_VIEW_H__
#define __GOO_CANVAS_ELLIPSE_VIEW_H__
@@ -25,6 +25,11 @@
typedef struct _GooCanvasEllipseView GooCanvasEllipseView;
typedef struct _GooCanvasEllipseViewClass GooCanvasEllipseViewClass;
+/**
+ * GooCanvasEllipseView
+ *
+ * The #GooCanvasEllipseView-struct struct contains private data only.
+ */
struct _GooCanvasEllipseView
{
GObject parent_object;
Index: goocanvasgroupview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasgroupview.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- goocanvasgroupview.c 8 Apr 2006 13:14:17 -0000 1.5
+++ goocanvasgroupview.c 13 Apr 2006 17:07:44 -0000 1.6
@@ -2,7 +2,27 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasgroupview.c -
+ * goocanvasgroupview.c - view for group item.
+ */
+
+/**
+ * SECTION:goocanvasgroupview
+ * @Title: GooCanvasGroupView
+ * @Short_Description: a view for a #GooCanvasGroup item.
+ *
+ * #GooCanvasGroupView represents a view of a #GooCanvasGroup item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the group view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
*/
#include <config.h>
#include <gtk/gtk.h>
@@ -41,6 +61,18 @@
}
+/**
+ * goo_canvas_group_view_new:
+ * @parent_view: the parent view.
+ * @group: the group item.
+ *
+ * Creates a new #GooCanvasGroupView for the given #GooCanvasGroup item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasGroupView.
+ **/
GooCanvasItemView*
goo_canvas_group_view_new (GooCanvasView *canvas_view,
GooCanvasItemView *parent_view,
Index: goocanvasgroupview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasgroupview.h,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- goocanvasgroupview.h 15 Dec 2005 15:32:02 -0000 1.1.1.1
+++ goocanvasgroupview.h 13 Apr 2006 17:07:44 -0000 1.2
@@ -2,7 +2,7 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasgroupview.h -
+ * goocanvasgroupview.h - view for group item.
*/
#ifndef __GOO_CANVAS_GROUP_VIEW_H__
#define __GOO_CANVAS_GROUP_VIEW_H__
@@ -25,6 +25,11 @@
typedef struct _GooCanvasGroupView GooCanvasGroupView;
typedef struct _GooCanvasGroupViewClass GooCanvasGroupViewClass;
+/**
+ * GooCanvasGroupView
+ *
+ * The #GooCanvasGroupView-struct struct contains private data only.
+ */
struct _GooCanvasGroupView
{
GObject parent;
Index: goocanvasimageview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasimageview.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- goocanvasimageview.c 8 Apr 2006 13:14:17 -0000 1.5
+++ goocanvasimageview.c 13 Apr 2006 17:07:44 -0000 1.6
@@ -2,7 +2,27 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasimageview.c -
+ * goocanvasimageview.c - view for image item.
+ */
+
+/**
+ * SECTION:goocanvasimageview
+ * @Title: GooCanvasImageView
+ * @Short_Description: a view for a #GooCanvasImage item.
+ *
+ * #GooCanvasImageView represents a view of a #GooCanvasImage item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the image view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
*/
#include <config.h>
#include <gtk/gtk.h>
@@ -41,6 +61,18 @@
}
+/**
+ * goo_canvas_image_view_new:
+ * @parent_view: the parent view.
+ * @image: the image item.
+ *
+ * Creates a new #GooCanvasImageView for the given #GooCanvasImage item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasImageView.
+ **/
GooCanvasItemView*
goo_canvas_image_view_new (GooCanvasItemView *parent_view,
GooCanvasImage *image)
Index: goocanvasimageview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasimageview.h,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- goocanvasimageview.h 15 Dec 2005 15:32:01 -0000 1.1.1.1
+++ goocanvasimageview.h 13 Apr 2006 17:07:44 -0000 1.2
@@ -2,7 +2,7 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasimageview.h -
+ * goocanvasimageview.h - view for image item.
*/
#ifndef __GOO_CANVAS_IMAGE_VIEW_H__
#define __GOO_CANVAS_IMAGE_VIEW_H__
@@ -25,6 +25,11 @@
typedef struct _GooCanvasImageView GooCanvasImageView;
typedef struct _GooCanvasImageViewClass GooCanvasImageViewClass;
+/**
+ * GooCanvasImageView
+ *
+ * The #GooCanvasImageView-struct struct contains private data only.
+ */
struct _GooCanvasImageView
{
GObject parent;
Index: goocanvaspathview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvaspathview.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- goocanvaspathview.c 11 Apr 2006 13:42:16 -0000 1.3
+++ goocanvaspathview.c 13 Apr 2006 17:07:44 -0000 1.4
@@ -4,6 +4,26 @@
*
* goocanvaspathview.c - view for path item.
*/
+
+/**
+ * SECTION:goocanvaspathview
+ * @Title: GooCanvasPathView
+ * @Short_Description: a view for a #GooCanvasPath item.
+ *
+ * #GooCanvasPathView represents a view of a #GooCanvasPath item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the path view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
+ */
#include <config.h>
#include <math.h>
#include <gtk/gtk.h>
@@ -41,6 +61,18 @@
}
+/**
+ * goo_canvas_path_view_new:
+ * @parent_view: the parent view.
+ * @path: the path item.
+ *
+ * Creates a new #GooCanvasPathView for the given #GooCanvasPath item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasPathView.
+ **/
GooCanvasItemView*
goo_canvas_path_view_new (GooCanvasItemView *parent_view,
GooCanvasPath *path)
Index: goocanvaspathview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvaspathview.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- goocanvaspathview.h 10 Apr 2006 20:30:24 -0000 1.1
+++ goocanvaspathview.h 13 Apr 2006 17:07:44 -0000 1.2
@@ -25,6 +25,11 @@
typedef struct _GooCanvasPathView GooCanvasPathView;
typedef struct _GooCanvasPathViewClass GooCanvasPathViewClass;
+/**
+ * GooCanvasPathView
+ *
+ * The #GooCanvasPathView-struct struct contains private data only.
+ */
struct _GooCanvasPathView
{
GObject parent;
Index: goocanvaspolylineview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvaspolylineview.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- goocanvaspolylineview.c 10 Apr 2006 20:30:24 -0000 1.6
+++ goocanvaspolylineview.c 13 Apr 2006 17:07:44 -0000 1.7
@@ -4,6 +4,26 @@
*
* goocanvaspolylineview.c - view for polyline item.
*/
+
+/**
+ * SECTION:goocanvaspolylineview
+ * @Title: GooCanvasPolylineView
+ * @Short_Description: a view for a #GooCanvasPolyline item.
+ *
+ * #GooCanvasPolylineView represents a view of a #GooCanvasPolyline item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the polyline view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
+ */
#include <config.h>
#include <gtk/gtk.h>
#include "goocanvasview.h"
@@ -42,6 +62,18 @@
}
+/**
+ * goo_canvas_polyline_view_new:
+ * @parent_view: the parent view.
+ * @polyline: the polyline item.
+ *
+ * Creates a new #GooCanvasPolylineView for the given #GooCanvasPolyline item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasPolylineView.
+ **/
GooCanvasItemView*
goo_canvas_polyline_view_new (GooCanvasItemView *parent_view,
GooCanvasPolyline *polyline)
Index: goocanvaspolylineview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvaspolylineview.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- goocanvaspolylineview.h 10 Apr 2006 20:30:24 -0000 1.2
+++ goocanvaspolylineview.h 13 Apr 2006 17:07:44 -0000 1.3
@@ -25,6 +25,11 @@
typedef struct _GooCanvasPolylineView GooCanvasPolylineView;
typedef struct _GooCanvasPolylineViewClass GooCanvasPolylineViewClass;
+/**
+ * GooCanvasPolylineView
+ *
+ * The #GooCanvasPolylineView-struct struct contains private data only.
+ */
struct _GooCanvasPolylineView
{
GObject parent;
Index: goocanvasrectview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasrectview.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- goocanvasrectview.c 8 Apr 2006 13:14:17 -0000 1.5
+++ goocanvasrectview.c 13 Apr 2006 17:07:44 -0000 1.6
@@ -2,7 +2,27 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasrectview.c -
+ * goocanvasrectview.c - view for rect item.
+ */
+
+/**
+ * SECTION:goocanvasrectview
+ * @Title: GooCanvasRectView
+ * @Short_Description: a view for a #GooCanvasRect item.
+ *
+ * #GooCanvasRectView represents a view of a #GooCanvasRect item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the rect view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
*/
#include <config.h>
#include <math.h>
@@ -43,6 +63,18 @@
}
+/**
+ * goo_canvas_rect_view_new:
+ * @parent_view: the parent view.
+ * @rect: the rect item.
+ *
+ * Creates a new #GooCanvasRectView for the given #GooCanvasRect item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasRectView.
+ **/
GooCanvasItemView*
goo_canvas_rect_view_new (GooCanvasItemView *parent_view,
GooCanvasRect *rect)
Index: goocanvasrectview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvasrectview.h,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- goocanvasrectview.h 15 Dec 2005 15:32:01 -0000 1.1.1.1
+++ goocanvasrectview.h 13 Apr 2006 17:07:44 -0000 1.2
@@ -2,7 +2,7 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvasrectview.h -
+ * goocanvasrectview.h - view for rect item.
*/
#ifndef __GOO_CANVAS_RECT_VIEW_H__
#define __GOO_CANVAS_RECT_VIEW_H__
@@ -25,6 +25,11 @@
typedef struct _GooCanvasRectView GooCanvasRectView;
typedef struct _GooCanvasRectViewClass GooCanvasRectViewClass;
+/**
+ * GooCanvasRectView
+ *
+ * The #GooCanvasRectView-struct struct contains private data only.
+ */
struct _GooCanvasRectView
{
GObject parent;
Index: goocanvastextview.c
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvastextview.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- goocanvastextview.c 8 Apr 2006 13:14:17 -0000 1.6
+++ goocanvastextview.c 13 Apr 2006 17:07:44 -0000 1.7
@@ -2,7 +2,27 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvastextview.c -
+ * goocanvastextview.c - view for text item.
+ */
+
+/**
+ * SECTION:goocanvastextview
+ * @Title: GooCanvasTextView
+ * @Short_Description: a view for a #GooCanvasText item.
+ *
+ * #GooCanvasTextView represents a view of a #GooCanvasText item.
+ *
+ * It implements the #GooCanvasItemView interface, so you can use the
+ * #GooCanvasItemView functions such as goo_canvas_item_view_get_item()
+ * and goo_canvas_item_view_get_bounds().
+ *
+ * Applications do not normally need to create item views themselves, as
+ * they are created automatically by #GooCanvasView when needed.
+ *
+ * To respond to events such as mouse clicks in the text view you can
+ * connect to one of the #GooCanvasItemView signals such as
+ * #GooCanvasItemView::button_press_event. You can connect to these signals
+ * when the view is created. (See #GooCanvasView::item-view-created.)
*/
#include <config.h>
#include <string.h>
@@ -49,6 +69,18 @@
}
+/**
+ * goo_canvas_text_view_new:
+ * @parent_view: the parent view.
+ * @text: the text item.
+ *
+ * Creates a new #GooCanvasTextView for the given #GooCanvasText item.
+ *
+ * This is not normally used by application code, as the views are created
+ * automatically by #GooCanvasView.
+ *
+ * Returns: a new #GooCanvasTextView.
+ **/
GooCanvasItemView*
goo_canvas_text_view_new (GooCanvasItemView *parent_view,
GooCanvasText *text)
Index: goocanvastextview.h
===================================================================
RCS file: /cvs/cairo/goocanvas/src/goocanvastextview.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- goocanvastextview.h 22 Mar 2006 23:49:44 -0000 1.2
+++ goocanvastextview.h 13 Apr 2006 17:07:44 -0000 1.3
@@ -2,7 +2,7 @@
* GooCanvas. Copyright (C) 2005 Damon Chaplin.
* Released under the GNU LGPL license. See COPYING for details.
*
- * goocanvastextview.h -
+ * goocanvastextview.h - view for text item.
*/
#ifndef __GOO_CANVAS_TEXT_VIEW_H__
#define __GOO_CANVAS_TEXT_VIEW_H__
@@ -25,6 +25,11 @@
typedef struct _GooCanvasTextView GooCanvasTextView;
typedef struct _GooCanvasTextViewClass GooCanvasTextViewClass;
+/**
+ * GooCanvasTextView
+ *
+ * The #GooCanvasTextView-struct struct contains private data only.
+ */
struct _GooCanvasTextView
{
GObject parent;
More information about the cairo-commit
mailing list