DiaCanvasLine

DiaCanvasLine — Line object.

Synopsis




#define     DIA_CANVAS_LINE                 (obj)
            DiaCanvasLine;

Object Hierarchy


  GObject
   +----DiaCanvasItem
         +----DiaCanvasLine

Properties


  "add-point"            DiaPoint              : Write
  "add-segment"          guint                 : Write
  "cap"                  DiaCapStyle           : Read / Write
  "color"                gulong                : Read / Write
  "cyclic"               gboolean              : Read / Write
  "dash"                 DiaDashStyle          : Read / Write
  "del-segment"          guint                 : Write
  "has-head"             gboolean              : Read / Write
  "has-tail"             gboolean              : Read / Write
  "head-a"               gdouble               : Read / Write
  "head-b"               gdouble               : Read / Write
  "head-c"               gdouble               : Read / Write
  "head-color"           gulong                : Read / Write
  "head-d"               gdouble               : Read / Write
  "head-fill-color"      gulong                : Read / Write
  "head-pos"             DiaPoint              : Read / Write
  "horizontal"           gboolean              : Read / Write
  "join"                 DiaJoinStyle          : Read / Write
  "line-width"           gdouble               : Read / Write
  "orthogonal"           gboolean              : Read / Write
  "tail-a"               gdouble               : Read / Write
  "tail-b"               gdouble               : Read / Write
  "tail-c"               gdouble               : Read / Write
  "tail-color"           gulong                : Read / Write
  "tail-d"               gdouble               : Read / Write
  "tail-fill-color"      gulong                : Read / Write
  "tail-pos"             DiaPoint              : Read / Write

Description

This object is a multi functional line object (a bit line GnomeCanvasLine).

Figure 1. A line

A line

This line can also have a arrow head (or tail). The head is defined by four properties: head_a, head_b, head_c and head_d, as explained in the image below.

Figure 2. Arrow head

Arrow head

Details

DIA_CANVAS_LINE()

#define DIA_CANVAS_LINE(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), DIA_TYPE_CANVAS_LINE, DiaCanvasLine))

obj :

DiaCanvasLine

typedef struct _DiaCanvasLine DiaCanvasLine;

Properties

The "add-point" property

  "add-point"            DiaPoint              : Write

Add a point to the end of the line.


The "add-segment" property

  "add-segment"          guint                 : Write

Add a segment by splitting the given segment into two.

Default value: 0


The "cap" property

  "cap"                  DiaCapStyle           : Read / Write

Style for the line-end.

Default value: DIA_CAP_BUTT


The "color" property

  "color"                gulong                : Read / Write

Color of the line, as RGBA.


The "cyclic" property

  "cyclic"               gboolean              : Read / Write

Line is cyclic, a polygon.

Default value: FALSE


The "dash" property

  "dash"                 DiaDashStyle          : Read / Write

Set dash style for the line.


The "del-segment" property

  "del-segment"          guint                 : Write

Delete line segment.

Default value: 0


The "has-head" property

  "has-head"             gboolean              : Read / Write

Turn arrow on the head on and off.

Default value: FALSE


The "has-tail" property

  "has-tail"             gboolean              : Read / Write

The line should have an arrow on the end of the line. The arrow is descripbed by 'tail_[abcd]'.

Default value: FALSE


The "head-a" property

  "head-a"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "head-b" property

  "head-b"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "head-c" property

  "head-c"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "head-color" property

  "head-color"           gulong                : Read / Write

Color of the head arrow in RGBA.


The "head-d" property

  "head-d"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "head-fill-color" property

  "head-fill-color"      gulong                : Read / Write

Color of the line in RGBA.


The "head-pos" property

  "head-pos"             DiaPoint              : Read / Write


The "horizontal" property

  "horizontal"           gboolean              : Read / Write

The first segmen of the orthogonal line should be horizontal.

Default value: FALSE


The "join" property

  "join"                 DiaJoinStyle          : Read / Write

Style of the line's corners.

Default value: DIA_JOIN_MITER


The "line-width" property

  "line-width"           gdouble               : Read / Write

Width of the line.

Allowed values: >= 0

Default value: 1


The "orthogonal" property

  "orthogonal"           gboolean              : Read / Write

Set if the line should be an orthogonal line or not.

Default value: FALSE


The "tail-a" property

  "tail-a"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "tail-b" property

  "tail-b"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "tail-c" property

  "tail-c"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "tail-color" property

  "tail-color"           gulong                : Read / Write

Color of the end arrow in RGBA.


The "tail-d" property

  "tail-d"               gdouble               : Read / Write

Allowed values: >= 0

Default value: 0


The "tail-fill-color" property

  "tail-fill-color"      gulong                : Read / Write

Color of the line in RGBA.


The "tail-pos" property

  "tail-pos"             DiaPoint              : Read / Write