AdgStroke

AdgStroke — A stroked entity

Synopsis

struct              AdgStroke;
struct              AdgStrokeClass;
AdgDress            adg_stroke_get_line_dress           (AdgStroke *stroke);
AdgTrail *          adg_stroke_get_trail                (AdgStroke *stroke);
AdgStroke *         adg_stroke_new                      (AdgTrail *trail);
void                adg_stroke_set_line_dress           (AdgStroke *stroke,
                                                         AdgDress dress);
void                adg_stroke_set_trail                (AdgStroke *stroke,
                                                         AdgTrail *trail);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----AdgEntity
               +----AdgStroke
                     +----AdgHatch

Properties

  "line-dress"               AdgDress              : Read / Write
  "trail"                    AdgTrail*             : Read / Write / Construct

Description

The AdgStroke object is a stroked representation of an AdgTrail model.

Details

struct AdgStroke

struct AdgStroke;

All fields are private and should not be used directly. Use its public methods instead.

Since 1.0

struct AdgStrokeClass

struct AdgStrokeClass {
};

adg_stroke_get_line_dress ()

AdgDress            adg_stroke_get_line_dress           (AdgStroke *stroke);

Gets the line dress to be used in rendering stroke.

stroke :

an AdgStroke

Returns :

the current line dress. [transfer none]

Since 1.0

adg_stroke_get_trail ()

AdgTrail *          adg_stroke_get_trail                (AdgStroke *stroke);

Gets the AdgTrail bound to this stroke entity. The returned trail is owned by stroke and should not be freed or modified.

stroke :

an AdgStroke

Returns :

the requested AdgTrail or NULL on errors. [transfer none]

Since 1.0

adg_stroke_new ()

AdgStroke *         adg_stroke_new                      (AdgTrail *trail);

Creates a new stroke entity based on the trail model. trail can be NULL, in which case an empty stroke is created.

trail :

the AdgTrail to stroke

Returns :

the newly created stroke entity

Since 1.0

adg_stroke_set_line_dress ()

void                adg_stroke_set_line_dress           (AdgStroke *stroke,
                                                         AdgDress dress);

Sets a new line dress for rendering stroke. The new dress must be related to the original dress for this property: you cannot set a dress used for line styles to a dress managing fonts.

The check is done by calling adg_dress_are_related() with dress and the previous dress as arguments. Check out its documentation for details on what is a related dress.

stroke :

an AdgStroke

dress :

the new AdgDress to use

Since 1.0

adg_stroke_set_trail ()

void                adg_stroke_set_trail                (AdgStroke *stroke,
                                                         AdgTrail *trail);

Sets trail as the new trail to be stroked by stroke.

stroke :

an AdgStroke

trail :

the new AdgTrail to bind

Since 1.0

Property Details

The "line-dress" property

  "line-dress"               AdgDress              : Read / Write

The dress to use for stroking this entity.

Allowed values: [G_MAXINT,G_MININT]

Default value: 0

The "trail" property

  "trail"                    AdgTrail*             : Read / Write / Construct

The trail to be stroked.

Generated by GTK-Doc V1.18