AdgProjection

AdgProjection — The standard symbol for specifying the projection scheme

Synopsis

                    AdgProjection;
AdgProjection *     adg_projection_new                  (AdgProjectionScheme scheme);
void                adg_projection_set_symbol_dress     (AdgProjection *projection,
                                                         AdgDress dress);
AdgDress            adg_projection_get_symbol_dress     (AdgProjection *projection);
void                adg_projection_set_axis_dress       (AdgProjection *projection,
                                                         AdgDress dress);
AdgDress            adg_projection_get_axis_dress       (AdgProjection *projection);
void                adg_projection_set_scheme           (AdgProjection *projection,
                                                         AdgProjectionScheme scheme);
AdgProjectionScheme  adg_projection_get_scheme          (AdgProjection *projection);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----AdgEntity
               +----AdgProjection

Properties

  "axis-dress"               AdgDress              : Read / Write
  "scheme"                   AdgProjectionScheme   : Read / Write
  "symbol-dress"             AdgDress              : Read / Write

Description

The AdgProjection is an entity representing the standard symbol of the projection scheme.

Details

AdgProjection

typedef struct _AdgProjection AdgProjection;

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


adg_projection_new ()

AdgProjection *     adg_projection_new                  (AdgProjectionScheme scheme);

Creates a new projection entity representing the selected scheme. If scheme is invalid, a projection symbol without a scheme is returned, that is "scheme" is set to ADG_PROJECTION_UNDEFINED, and a warning is raised.

scheme :

the scheme represented by this projection

Returns :

the newly created projection entity

adg_projection_set_symbol_dress ()

void                adg_projection_set_symbol_dress     (AdgProjection *projection,
                                                         AdgDress dress);

Sets a new line dress for rendering the symbol of projection. The new dress must be a line dress: the check is done by calling adg_dress_are_related() with dress and the old dress as arguments. Check out its documentation for further details.

The default dress is a transparent line dress: the rendering callback will stroke the symbol using the default color with a predefined thickness.

projection :

an AdgProjection

dress :

the new AdgDress to use

adg_projection_get_symbol_dress ()

AdgDress            adg_projection_get_symbol_dress     (AdgProjection *projection);

Gets the line dress to be used in stroking the symbol of projection.

projection :

an AdgProjection

Returns :

the requested line dress

adg_projection_set_axis_dress ()

void                adg_projection_set_axis_dress       (AdgProjection *projection,
                                                         AdgDress dress);

Sets a new line dress for rendering the axis of projection. The new dress must be a line dress: the check is done by calling adg_dress_are_related() with dress and the old dress as arguments. Check out its documentation for further details.

The default dress is a transparent line dress: the rendering callback will stroke the axis using the default line style.

projection :

an AdgProjection

dress :

the new AdgDress to use

adg_projection_get_axis_dress ()

AdgDress            adg_projection_get_axis_dress       (AdgProjection *projection);

Gets the line dress to be used in stroking the axis of projection.

projection :

an AdgProjection

Returns :

the requested line dress

adg_projection_set_scheme ()

void                adg_projection_set_scheme           (AdgProjection *projection,
                                                         AdgProjectionScheme scheme);

Sets a new scheme on projection. If scheme is different from the old one, projection is invalidated.

projection :

an AdgProjection

scheme :

the new projection scheme

adg_projection_get_scheme ()

AdgProjectionScheme  adg_projection_get_scheme          (AdgProjection *projection);

Gets the scheme represented by projection.

projection :

an AdgProjection

Returns :

the scheme of projection

Property Details

The "axis-dress" property

  "axis-dress"               AdgDress              : Read / Write

The line dress to use for rendering the axis of the projection scheme.

Allowed values: [G_MAXINT,G_MININT]

Default value: 0


The "scheme" property

  "scheme"                   AdgProjectionScheme   : Read / Write

The projection scheme to be represented.

Default value: ADG_PROJECTION_UNDEFINED


The "symbol-dress" property

  "symbol-dress"             AdgDress              : Read / Write

The line dress to use for rendering the views of the projection.

Allowed values: [G_MAXINT,G_MININT]

Default value: 0

AdgProjection was last modified by gtk-doc on Sat 24 Jul 2010 09:35:28 AM CEST
Hosted by Get Automatic Drawing Generation at SourceForge.net. Fast, secure and Free Open Source software downloads
Search on this domain