GooCanvas-2.0 Python API Documentation

Implements: Atk.ImplementorIface, Gtk.Buildable, Gtk.Scrollable

Subclass of: Gtk.Container

The #GooCanvas-struct struct contains private data only.

Subclass of: Atk.ObjectFactory

Subclass of: Atk.ObjectFactory

Subclass of: Atk.ObjectFactory

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasEllipse represents an ellipse item. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). To create a #GooCanvasEllipse use goo_canvas_ellipse_new(). To get or set the properties of an existing #GooCanvasEllipse, use g_object_get() and g_object_set(). The ellipse can be specified either with the "center-x", "center-y", "radius-x" and "radius-y" properties, or with the "x", "y", "width" and "height" properties.

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasEllipseModel represents a model for ellipse items. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). To create a #GooCanvasEllipseModel use goo_canvas_ellipse_model_new(). To get or set the properties of an existing #GooCanvasEllipseModel, use g_object_get() and g_object_set(). The ellipse can be specified either with the "center-x", "center-y", "radius-x" and "radius-y" properties, or with the "x", "y", "width" and "height" properties. To respond to events such as mouse clicks on the ellipse you must connect to the signal handlers of the corresponding #GooCanvasEllipse objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasGrid represents a grid item. A grid consists of a number of equally-spaced horizontal and vertical grid lines, plus an optional border. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). To create a #GooCanvasGrid use goo_canvas_grid_new(). To get or set the properties of an existing #GooCanvasGrid, use g_object_get() and g_object_set(). The grid's position and size is specified with the #GooCanvasGrid:x, #GooCanvasGrid:y, #GooCanvasGrid:width and #GooCanvasGrid:height properties. The #GooCanvasGrid:x-step and #GooCanvasGrid:y-step properties specify the distance between grid lines. The #GooCanvasGrid:x-offset and #GooCanvasGrid:y-offset properties specify the distance before the first grid lines. The horizontal or vertical grid lines can be hidden using the #GooCanvasGrid:show-horz-grid-lines and #GooCanvasGrid:show-vert-grid-lines properties. The width of the border can be set using the #GooCanvasGrid:border-width property. The border is drawn outside the area specified with the #GooCanvasGrid:x, #GooCanvasGrid:y, #GooCanvasGrid:width and #GooCanvasGrid:height properties. Other properties allow the colors and widths of the grid lines to be set. The grid line color and width properties override the standard #GooCanvasItemSimple:stroke-color and #GooCanvasItemSimple:line-width properties, enabling different styles for horizontal and vertical grid lines.

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasGridModel represents a model for grid items. A grid consists of a number of equally-spaced horizontal and vertical grid lines, plus an optional border. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). To create a #GooCanvasGridModel use goo_canvas_grid_model_new(). To get or set the properties of an existing #GooCanvasGridModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the grid you must connect to the signal handlers of the corresponding #GooCanvasGrid objects. (See goo_canvas_get_item() and #GooCanvas::item-created.) The grid's position and size is specified with the #GooCanvasGridModel:x, #GooCanvasGridModel:y, #GooCanvasGridModel:width and #GooCanvasGridModel:height properties. The #GooCanvasGridModel:x-step and #GooCanvasGridModel:y-step properties specify the distance between grid lines. The #GooCanvasGridModel:x-offset and #GooCanvasGridModel:y-offset properties specify the distance before the first grid lines. The horizontal or vertical grid lines can be hidden using the #GooCanvasGridModel:show-horz-grid-lines and #GooCanvasGridModel:show-vert-grid-lines properties. The width of the border can be set using the #GooCanvasGridModel:border-width property. The border is drawn outside the area specified with the #GooCanvasGridModel:x, #GooCanvasGridModel:y, #GooCanvasGridModel:width and #GooCanvasGridModel:height properties. Other properties allow the colors and widths of the grid lines to be set. The grid line color and width properties override the standard #GooCanvasItemModelSimple:stroke-color and #GooCanvasItemModelSimple:line-width properties, enabling different styles for horizontal and vertical grid lines.

Implements: GooCanvas.CanvasItem

Known subclasses: GooCanvas.CanvasTable

Subclass of: GooCanvas.CanvasItemSimple

#GooCanvasGroup represents a group of items. Groups can be nested to any depth, to create a hierarchy of items. Items are ordered within each group, with later items being displayed above earlier items. #GooCanvasGroup is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". Setting a style property on a #GooCanvasGroup will affect all children of the #GooCanvasGroup (unless the children override the property setting). #GooCanvasGroup implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(), and the properties such as "visibility" and "pointer-events". If the #GooCanvasGroup:width and #GooCanvasGroup:height properties are set to positive values then the group is clipped to the given size. To create a #GooCanvasGroup use goo_canvas_group_new(). To get or set the properties of an existing #GooCanvasGroup, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Known subclasses: GooCanvas.CanvasTableModel

Subclass of: GooCanvas.CanvasItemModelSimple

#GooCanvasGroupModel represents a group of items. Groups can be nested to any depth, to create a hierarchy of items. Items are ordered within each group, with later items being displayed above earlier items. #GooCanvasGroupModel is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". Setting a style property on a #GooCanvasGroupModel will affect all children of the #GooCanvasGroupModel (unless the children override the property setting). #GooCanvasGroupModel implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(), and the properties such as "visibility" and "pointer-events". To create a #GooCanvasGroupModel use goo_canvas_group_model_new(). To get or set the properties of an existing #GooCanvasGroupModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the group you must connect to the signal handlers of the corresponding #GooCanvasGroup objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasImage represents an image item. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "operator" and "pointer-events". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). To create a #GooCanvasImage use goo_canvas_image_new(). To get or set the properties of an existing #GooCanvasImage, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasImageModel represent a model for image items. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "operator" and "pointer-events". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). To create a #GooCanvasImageModel use goo_canvas_image_model_new(). To get or set the properties of an existing #GooCanvasImageModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the image you must connect to the signal handlers of the corresponding #GooCanvasImage objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Implements: GooCanvas.CanvasItemModel

Known subclasses: GooCanvas.CanvasPathModel, GooCanvas.CanvasTextModel, GooCanvas.CanvasRectModel, GooCanvas.CanvasPolylineModel, GooCanvas.CanvasImageModel, GooCanvas.CanvasGroupModel, GooCanvas.CanvasGridModel, GooCanvas.CanvasEllipseModel

Subclass of: GObject.Object

#GooCanvasItemModelSimple is used as a base class for the standard canvas item models. It can also be used as the base class for new custom canvas item models. <note><para> The Model/View canvas feature may be removed in a future version of GooCanvas. </para></note> It provides default implementations for many of the #GooCanvasItemModel methods. Subclasses of #GooCanvasItemModelSimple only need to implement the create_item() method of the #GooCanvasItemModel interface, to create the default canvas item to view the item model.

Implements: GooCanvas.CanvasItem

Known subclasses: GooCanvas.CanvasEllipse, GooCanvas.CanvasImage, GooCanvas.CanvasText, GooCanvas.CanvasPath, GooCanvas.CanvasGroup, GooCanvas.CanvasPolyline, GooCanvas.CanvasGrid, GooCanvas.CanvasRect, GooCanvas.CanvasWidget

Subclass of: GObject.Object

#GooCanvasItemSimple is used as a base class for all of the standard canvas items. It can also be used as the base class for new custom canvas items. It provides default implementations for many of the #GooCanvasItem methods. For very simple items, all that is needed is to implement the create_path() method. (#GooCanvasEllipse, #GooCanvasRect and #GooCanvasPath do this.) More complicated items need to implement the update(), paint() and is_item_at() methods instead. (#GooCanvasImage, #GooCanvasPolyline, #GooCanvasText and #GooCanvasWidget do this.) They may also need to override some of the other GooCanvasItem methods such as set_canvas(), set_parent() or allocate_area() if special code is needed. (#GooCanvasWidget does this to make sure the #GtkWidget is embedded in the #GooCanvas widget correctly.)

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasPath represents a path item, which is a series of one or more lines, bezier curves, or elliptical arcs. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). #GooCanvasPath uses the same path specification strings as the Scalable Vector Graphics (SVG) path element. For details see the <ulink url="http://www.w3.org/Graphics/SVG/">SVG specification</ulink>. To create a #GooCanvasPath use goo_canvas_path_new(). To get or set the properties of an existing #GooCanvasPath, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasPathModel represents a model for path items, which are a series of one or more lines, bezier curves, or elliptical arcs. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). #GooCanvasPathModel uses the same path specification strings as the Scalable Vector Graphics (SVG) path element. For details see the <ulink url="http://www.w3.org/Graphics/SVG/">SVG specification</ulink>. To create a #GooCanvasPathModel use goo_canvas_path_model_new(). To get or set the properties of an existing #GooCanvasPathModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the path you must connect to the signal handlers of the corresponding #GooCanvasPath objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasPolyline represents a polyline item, which is a series of one or more lines, with optional arrows at either end. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). To create a #GooCanvasPolyline use goo_canvas_polyline_new(), or goo_canvas_polyline_new_line() for a simple line between two points. To get or set the properties of an existing #GooCanvasPolyline, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasPolylineModel represents a model for polyline items, which are a series of one or more lines, with optional arrows at either end. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). To create a #GooCanvasPolylineModel use goo_canvas_polyline_model_new(), or goo_canvas_polyline_model_new_line() for a simple line between two points. To get or set the properties of an existing #GooCanvasPolylineModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the polyline you must connect to the signal handlers of the corresponding #GooCanvasPolyline objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasRect represents a rectangle item. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). To create a #GooCanvasRect use goo_canvas_rect_new(). To get or set the properties of an existing #GooCanvasRect, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasRectModel represents a model for rectangle items. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). To create a #GooCanvasRectModel use goo_canvas_rect_model_new(). To get or set the properties of an existing #GooCanvasRectModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the rectangle you must connect to the signal handlers of the corresponding #GooCanvasRect objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Subclass of: GObject.Object

#GooCanvasStyle provides support for cascading style properties for canvas items. It is intended to be used when implementing new canvas items. <note><para> The cascading styles canvas feature may be removed in a future version of GooCanvas. </para></note> Style properties are identified by a unique #GQuark, and contain arbitrary data stored in a #GValue. #GooCanvasStyle also provides a few convenience functions such as goo_canvas_style_set_stroke_options() and goo_canvas_style_set_fill_options() which efficiently apply an item's standard style properties to the given cairo_t.

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasGroup

#GooCanvasTable is a table container used to lay out other canvas items. It is used in a similar way to how the GtkTable widget is used to lay out GTK+ widgets. Items are added to the table using the normal methods, then goo_canvas_item_set_child_properties() is used to specify how each child item is to be positioned within the table (i.e. which row and column it is in, how much padding it should have and whether it should expand or shrink). #GooCanvasTable is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". Setting a style property on a #GooCanvasTable will affect all children of the #GooCanvasTable (unless the children override the property setting). #GooCanvasTable implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(), and the properties such as "visibility" and "pointer-events". To create a #GooCanvasTable use goo_canvas_table_new(). To get or set the properties of an existing #GooCanvasTable, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasGroupModel

#GooCanvasTableModel is a model for a table container used to lay out other canvas items. It is used in a similar way to how the GtkTable widget is used to lay out GTK+ widgets. Item models are added to the table using the normal methods, then goo_canvas_item_model_set_child_properties() is used to specify how each child item is to be positioned within the table (i.e. which row and column it is in, how much padding it should have and whether it should expand or shrink). #GooCanvasTableModel is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". Setting a style property on a #GooCanvasTableModel will affect all children of the #GooCanvasTableModel (unless the children override the property setting). #GooCanvasTableModel implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_rotate(), and the properties such as "visibility" and "pointer-events". To create a #GooCanvasTableModel use goo_canvas_table_model_new(). To get or set the properties of an existing #GooCanvasTableModel, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasText represents a text item. It is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "fill-color". It also implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(). The #GooCanvasText:width and #GooCanvasText:height properties specify the area of the item. If it exceeds that area because there is too much text, it is clipped. The properties can be set to -1 to disable clipping. To create a #GooCanvasText use goo_canvas_text_new(). To get or set the properties of an existing #GooCanvasText, use g_object_get() and g_object_set().

Implements: GooCanvas.CanvasItemModel

Subclass of: GooCanvas.CanvasItemModelSimple

GooCanvasTextModel represents a model for text items. It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "fill-color". It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate(). To create a #GooCanvasTextModel use goo_canvas_text_model_new(). To get or set the properties of an existing #GooCanvasTextModel, use g_object_get() and g_object_set(). To respond to events such as mouse clicks on the text item you must connect to the signal handlers of the corresponding #GooCanvasText objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

Implements: GooCanvas.CanvasItem

Subclass of: GooCanvas.CanvasItemSimple

GooCanvasWidget provides support for placing any GtkWidget in the canvas. The #GooCanvasWidget:width and #GooCanvasWidget:height properties specify the widget's size. If either of them is -1, then the requested size of the widget is used instead, which is the default for both width and height. Note that there are a number of limitations in the use of #GooCanvasWidget: <itemizedlist><listitem><para> It doesn't support any transformation besides simple translation. This means you can't scale a canvas with a #GooCanvasWidget in it. </para></listitem><listitem><para> It doesn't support layering, so you can't place other items beneath or above the #GooCanvasWidget. </para></listitem><listitem><para> It doesn't support rendering of widgets to a given cairo_t, which means you can't output the widget to a pdf or postscript file. </para></listitem><listitem><para> It doesn't have a model/view variant like the other standard items, so it can only be used in a simple canvas without a model. </para></listitem><listitem><para> It can't be made a static item. </para></listitem></itemizedlist>