PrevUpHomeGNOME Canvas Library Reference ManualNext

GnomeCanvasShape

GnomeCanvasShape — Base class for canvas item shapes

Synopsis


#include <libgnomecanvas/libgnomecanvas.h>


struct      GnomeCanvasShape;
void        gnome_canvas_shape_set_path_def (GnomeCanvasShape *shape,
                                             GnomeCanvasPathDef *def);
GnomeCanvasPathDef* gnome_canvas_shape_get_path_def
                                            (GnomeCanvasShape *shape);

Object Hierarchy


  GObject
   +----GtkObject
         +----GnomeCanvasItem
               +----GnomeCanvasShape
                     +----GnomeCanvasBpath
                     +----GnomeCanvasRE
                     +----GnomeCanvasPolygon

Properties


  "cap-style"            GdkCapStyle           : Read / Write
  "dash"                 gpointer              : Read / Write
  "fill-color"           gchararray            : Write
  "fill-color-gdk"       GdkColor              : Read / Write
  "fill-color-rgba"      guint                 : Read / Write
  "fill-stipple"         GdkDrawable           : Read / Write
  "join-style"           GdkJoinStyle          : Read / Write
  "miterlimit"           gdouble               : Read / Write
  "outline-color"        gchararray            : Write
  "outline-color-gdk"    GdkColor              : Read / Write
  "outline-color-rgba"   guint                 : Read / Write
  "outline-stipple"      GdkDrawable           : Read / Write
  "width-pixels"         guint                 : Read / Write
  "width-units"          gdouble               : Write
  "wind"                 guint                 : Read / Write

Description

Provides a base class for canvas item shapes, including: GnomeCanvasBpath, GnomeCanvasEllipse, GnomeCanvasRect, and GnomeCanvasPolygon.

Details

struct GnomeCanvasShape

struct GnomeCanvasShape;

This structure should not be accessed directly. Use the object's properties and functions for querying or changing its parameters.

gnome_canvas_shape_set_path_def ()

void        gnome_canvas_shape_set_path_def (GnomeCanvasShape *shape,
                                             GnomeCanvasPathDef *def);

This function sets the the GnomeCanvasPathDef used by the GnomeCanvasShape. Notice, that it does not request updates, as it is meant to be used from item implementations, from inside update queue.

shape : a GnomeCanvasShape
def : a GnomeCanvasPathDef

gnome_canvas_shape_get_path_def ()

GnomeCanvasPathDef* gnome_canvas_shape_get_path_def
                                            (GnomeCanvasShape *shape);

This function returns the GnomeCanvasPathDef that the shape currently uses. It adds a reference to the GnomeCanvasPathDef and returns it, if there is not a GnomeCanvasPathDef set for the shape it returns NULL.

shape : a GnomeCanvasShape
Returns : a GnomeCanvasPathDef or NULL if none is set for the shape.

Properties

The "cap-style" property

  "cap-style"            GdkCapStyle           : Read / Write

Cap (end point) style for the bpath.

Default value: GDK_CAP_BUTT

The "dash" property

  "dash"                 gpointer              : Read / Write

Dashing pattern.

The "fill-color" property

  "fill-color"           gchararray            : Write

X color specification for fill color, or NULL pointer for no color (transparent).

Default value: NULL

The "fill-color-gdk" property

  "fill-color-gdk"       GdkColor              : Read / Write

Allocated GdkColor for fill.

The "fill-color-rgba" property

  "fill-color-rgba"      guint                 : Read / Write

Fill color with an alpha component (in the format 0xRRGGBBAA).

Default value: 0

The "fill-stipple" property

  "fill-stipple"         GdkDrawable           : Read / Write

Stipple pattern for fill.

The "join-style" property

  "join-style"           GdkJoinStyle          : Read / Write

Vertex join style for the bpath.

Default value: GDK_JOIN_MITER

The "miterlimit" property

  "miterlimit"           gdouble               : Read / Write

Minimum angle between segments, where miter join rule is applied.

Allowed values: >= 0

Default value: 0

The "outline-color" property

  "outline-color"        gchararray            : Write

X color specification for outline color, or NULL pointer for no color (transparent).

Default value: NULL

The "outline-color-gdk" property

  "outline-color-gdk"    GdkColor              : Read / Write

Allocated GdkColor for outline.

The "outline-color-rgba" property

  "outline-color-rgba"   guint                 : Read / Write

Outline color with an alpha component (in the format 0xRRGGBBAA).

Default value: 0

The "outline-stipple" property

  "outline-stipple"      GdkDrawable           : Read / Write

Stipple pattern for outline.

The "width-pixels" property

  "width-pixels"         guint                 : Read / Write

Width of the outline in pixels. The outline will not be scaled when the canvas zoom factor is changed.

Default value: 0

The "width-units" property

  "width-units"          gdouble               : Write

Width of the outline in canvas units. The outline will be scaled when the canvas zoom factor is changed.

Allowed values: >= 0

Default value: 0

The "wind" property

  "wind"                 guint                 : Read / Write

Winding rule for the bpath (ArtWindRule).

Default value: 0

<< GnomeCanvasRichTextGnomeCanvasText >>