AdgCanvas

AdgCanvas

typedef struct _AdgCanvas AdgCanvas;

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

adg_canvas_new ()

AdgCanvas *         adg_canvas_new                      (void);

Creates a new empty canvas object.

adg_canvas_set_size ()

void                adg_canvas_set_size                 (AdgCanvas *canvas,
                                                         const AdgPair *pair);

Sets a specific size on canvas. The x and/or y components of the returned AdgPair could be 0, in which case the size returned by adg_entity_get_extents() on canvas will be used instead.

adg_canvas_set_size_explicit ()

void                adg_canvas_set_size_explicit        (AdgCanvas *canvas,
                                                         gdouble x,
                                                         gdouble y);

A convenient function to set the size of canvas using explicit coordinates. Check adg_canvas_set_size() for further details.

adg_canvas_get_size ()

const AdgPair *     adg_canvas_get_size                 (AdgCanvas *canvas);

Gets the specific size set on canvas. The x and/or y components of the returned AdgPair could be 0, in which case the size returned by adg_entity_get_extents() on canvas will be used instead.

adg_canvas_set_background_dress ()

void                adg_canvas_set_background_dress     (AdgCanvas *canvas,
                                                         AdgDress dress);

Sets a new background dress for rendering canvas: the new dress must be a color dress.

adg_canvas_get_background_dress ()

AdgDress            adg_canvas_get_background_dress     (AdgCanvas *canvas);

Gets the background dress to be used in rendering canvas.

adg_canvas_set_frame_dress ()

void                adg_canvas_set_frame_dress          (AdgCanvas *canvas,
                                                         AdgDress dress);

Sets the "frame-dress" property of canvas to dress: the new dress must be a line dress.

adg_canvas_get_frame_dress ()

AdgDress            adg_canvas_get_frame_dress          (AdgCanvas *canvas);

Gets the frame dress to be used in rendering the border of canvas.

adg_canvas_set_title_block ()

void                adg_canvas_set_title_block          (AdgCanvas *canvas,
                                                         AdgTitleBlock *title_block);

Sets the "title-block" property of canvas to title_block.

Although a title block entity could be added to canvas in the usual way, that is using the adg_container_add() method, assigning a title block with adg_canvas_set_title_block() is somewhat different:

- title_block will be automatically attached to the bottom right corner of to the canvas frame (this could be accomplished in the usual way too, by resetting the right and bottom paddings); - the title_block boundary box is not taken into account while computing the extents of canvas.

adg_canvas_get_title_block ()

AdgTitleBlock *     adg_canvas_get_title_block          (AdgCanvas *canvas);

Gets the AdgTitleBlock object of canvas: check adg_canvas_set_title_block() for details.

adg_canvas_set_top_margin ()

void                adg_canvas_set_top_margin           (AdgCanvas *canvas,
                                                         gdouble value);

Changes the top margin of canvas by setting "top-margin" to value. Negative values are allowed.

adg_canvas_get_top_margin ()

gdouble             adg_canvas_get_top_margin           (AdgCanvas *canvas);

Gets the top margin (in global space) of canvas.

adg_canvas_set_right_margin ()

void                adg_canvas_set_right_margin         (AdgCanvas *canvas,
                                                         gdouble value);

Changes the right margin of canvas by setting "right-margin" to value. Negative values are allowed.

adg_canvas_get_right_margin ()

gdouble             adg_canvas_get_right_margin         (AdgCanvas *canvas);

Gets the right margin (in global space) of canvas.

adg_canvas_set_bottom_margin ()

void                adg_canvas_set_bottom_margin        (AdgCanvas *canvas,
                                                         gdouble value);

Changes the bottom margin of canvas by setting "bottom-margin" to value. Negative values are allowed.

adg_canvas_get_bottom_margin ()

gdouble             adg_canvas_get_bottom_margin        (AdgCanvas *canvas);

Gets the bottom margin (in global space) of canvas.

adg_canvas_set_left_margin ()

void                adg_canvas_set_left_margin          (AdgCanvas *canvas,
                                                         gdouble value);

Changes the left margin of canvas by setting "left-margin" to value. Negative values are allowed.

adg_canvas_get_left_margin ()

gdouble             adg_canvas_get_left_margin          (AdgCanvas *canvas);

Gets the left margin (in global space) of canvas.

adg_canvas_set_margins ()

void                adg_canvas_set_margins              (AdgCanvas *canvas,
                                                         gdouble top,
                                                         gdouble right,
                                                         gdouble bottom,
                                                         gdouble left);

Convenient function to set all the margins at once.

adg_canvas_apply_margins ()

void                adg_canvas_apply_margins            (AdgCanvas *canvas,
                                                         CpmlExtents *extents);

A convenient function to apply the margins of canvas to the arbitrary CpmlExtents struct extents.

adg_canvas_switch_frame ()

void                adg_canvas_switch_frame             (AdgCanvas *canvas,
                                                         gboolean new_state);

Sets a new status on the "has-frame" property: TRUE means a border around the canvas extents (less the margins) should be rendered.

adg_canvas_has_frame ()

gboolean            adg_canvas_has_frame                (AdgCanvas *canvas);

Gets the current status of the "has-frame" property, that is whether a border around the canvas extents (less the margins) should be rendered (TRUE) or not (FALSE).

adg_canvas_set_top_padding ()

void                adg_canvas_set_top_padding          (AdgCanvas *canvas,
                                                         gdouble value);

Changes the top padding of canvas by setting "top-padding" to value. Negative values are allowed.

adg_canvas_get_top_padding ()

gdouble             adg_canvas_get_top_padding          (AdgCanvas *canvas);

Gets the top padding (in global space) of canvas.

adg_canvas_set_right_padding ()

void                adg_canvas_set_right_padding        (AdgCanvas *canvas,
                                                         gdouble value);

Changes the right padding of canvas by setting "right-padding" to value. Negative values are allowed.

adg_canvas_get_right_padding ()

gdouble             adg_canvas_get_right_padding        (AdgCanvas *canvas);

Gets the right padding (in global space) of canvas.

adg_canvas_set_bottom_padding ()

void                adg_canvas_set_bottom_padding       (AdgCanvas *canvas,
                                                         gdouble value);

Changes the bottom padding of canvas by setting "bottom-padding" to value. Negative values are allowed.

adg_canvas_get_bottom_padding ()

gdouble             adg_canvas_get_bottom_padding       (AdgCanvas *canvas);

Gets the bottom padding (in global space) of canvas.

adg_canvas_set_left_padding ()

void                adg_canvas_set_left_padding         (AdgCanvas *canvas,
                                                         gdouble value);

Changes the left padding of canvas by setting "left-padding" to value. Negative values are allowed.

adg_canvas_get_left_padding ()

gdouble             adg_canvas_get_left_padding         (AdgCanvas *canvas);

Gets the left padding (in global space) of canvas.

adg_canvas_set_paddings ()

void                adg_canvas_set_paddings             (AdgCanvas *canvas,
                                                         gdouble top,
                                                         gdouble right,
                                                         gdouble bottom,
                                                         gdouble left);

Convenient function to set all the paddings at once.

The "background-dress" property

  "background-dress"         AdgDress              : Read / Write

The color dress to use for the canvas background.

Allowed values: [G_MAXINT,G_MININT]

Default value: 0

The "bottom-margin" property

  "bottom-margin"            gdouble               : Read / Write

The margin (in global space) to leave empty below the frame.

Default value: 15

The "bottom-padding" property

  "bottom-padding"           gdouble               : Read / Write

The padding (in global space) to leave empty below between the drawing and the frame.

Default value: 15

The "frame-dress" property

  "frame-dress"              AdgDress              : Read / Write

Line dress to use while drawing the frame around the canvas.

Allowed values: [G_MAXINT,G_MININT]

Default value: 0

The "has-frame" property

  "has-frame"                gboolean              : Read / Write

If enabled, a frame using the frame dress will be drawn around the canvas extents, taking into account the margins.

Default value: TRUE

The "left-margin" property

  "left-margin"              gdouble               : Read / Write

The margin (in global space) to leave empty at the left of the frame.

Default value: 15

The "left-padding" property

  "left-padding"             gdouble               : Read / Write

The padding (in global space) to leave empty at the left between the drawing and the frame.

Default value: 15

The "right-margin" property

  "right-margin"             gdouble               : Read / Write

The margin (in global space) to leave empty at the right of the frame.

Default value: 15

The "right-padding" property

  "right-padding"            gdouble               : Read / Write

The padding (in global space) to leave empty at the right between the drawing and the frame.

Default value: 15

The "size" property

  "size"                     AdgPair*              : Read / Write

The size set on this canvas: use 0 to have an automatic dimension based on the canvas extents.

The "title-block" property

  "title-block"              AdgTitleBlock*        : Read / Write

The title block to assign to this canvas.

The "top-margin" property

  "top-margin"               gdouble               : Read / Write

The margin (in global space) to leave above the frame.

Default value: 15

The "top-padding" property

  "top-padding"              gdouble               : Read / Write

The padding (in global space) to leave empty above between the drawing and the frame.

Default value: 15