CpgLinkAction

CpgLinkAction — Link action equation

Synopsis

#define             CPG_LINK_ACTION_CONST               (obj)
struct              CpgLinkAction;
struct              CpgLinkActionClass;
CpgLinkAction *     cpg_link_action_new                 (const gchar *target,
                                                         CpgExpression *equation);
CpgLinkAction *     cpg_link_action_copy                (CpgLinkAction *action);
const gchar *       cpg_link_action_get_target          (CpgLinkAction *action);
void                cpg_link_action_set_target          (CpgLinkAction *action,
                                                         const gchar *target);
CpgExpression *     cpg_link_action_get_equation        (CpgLinkAction *action);
void                cpg_link_action_set_equation        (CpgLinkAction *action,
                                                         CpgExpression *equation);
gboolean            cpg_link_action_depends             (CpgLinkAction *action,
                                                         CpgProperty *property);
gboolean            cpg_link_action_equal               (CpgLinkAction *action,
                                                         CpgLinkAction *other);
void                cpg_link_action_set_enabled         (CpgLinkAction *action,
                                                         gboolean enabled);
gboolean            cpg_link_action_get_enabled         (CpgLinkAction *action);
CpgProperty *       cpg_link_action_get_target_property (CpgLinkAction *action);
                    CpgLinkActionPrivate;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----CpgLinkAction

Implemented Interfaces

CpgLinkAction implements CpgModifiable, CpgAnnotatable and CpgTaggable.

Properties

  "enabled"                  gboolean              : Read / Write / Construct
  "equation"                 CpgExpression*        : Read / Write / Construct
  "link"                     CpgLink*              : Read
  "target"                   gchar*                : Read / Write / Construct
  "target-property"          CpgProperty*          : Read

Description

A CpgLinkAction is an action inside a link which sets a target CpgProperty to the value of a particular CpgExpression equation.

Details

CPG_LINK_ACTION_CONST()

#define CPG_LINK_ACTION_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CPG_TYPE_LINK_ACTION, CpgLinkAction const))


struct CpgLinkAction

struct CpgLinkAction;


struct CpgLinkActionClass

struct CpgLinkActionClass {
};


cpg_link_action_new ()

CpgLinkAction *     cpg_link_action_new                 (const gchar *target,
                                                         CpgExpression *equation);

Create a new CpgLinkAction.

target :

A CpgProperty

equation :

A CpgExpression

Returns :

A new CpgLinkAction

cpg_link_action_copy ()

CpgLinkAction *     cpg_link_action_copy                (CpgLinkAction *action);

Create a copy of a CpgLinkAction.

action :

A CpgLinkAction

Returns :

A CpgLinkAction. [transfer full]

cpg_link_action_get_target ()

const gchar *       cpg_link_action_get_target          (CpgLinkAction *action);

Get the target of the action.

action :

A CpgLinkAction

Returns :

the action target. [transfer none]

cpg_link_action_set_target ()

void                cpg_link_action_set_target          (CpgLinkAction *action,
                                                         const gchar *target);

Set the target of the action.

action :

A CpgLinkAction

target :

A CpgProperty

cpg_link_action_get_equation ()

CpgExpression *     cpg_link_action_get_equation        (CpgLinkAction *action);

Get the equation of the action.

action :

A CpgLinkAction

Returns :

A CpgExpression. [transfer none]

cpg_link_action_set_equation ()

void                cpg_link_action_set_equation        (CpgLinkAction *action,
                                                         CpgExpression *equation);

Set the equation of the action.

action :

A CpgLinkAction

equation :

A CpgExpression

cpg_link_action_depends ()

gboolean            cpg_link_action_depends             (CpgLinkAction *action,
                                                         CpgProperty *property);

Check whether the action depends on a certain property.

action :

A CpgLinkAction

property :

A CpgProperty

Returns :

TRUE if the action depends on property, FALSE otherwise

cpg_link_action_equal ()

gboolean            cpg_link_action_equal               (CpgLinkAction *action,
                                                         CpgLinkAction *other);


cpg_link_action_set_enabled ()

void                cpg_link_action_set_enabled         (CpgLinkAction *action,
                                                         gboolean enabled);


cpg_link_action_get_enabled ()

gboolean            cpg_link_action_get_enabled         (CpgLinkAction *action);


cpg_link_action_get_target_property ()

CpgProperty *       cpg_link_action_get_target_property (CpgLinkAction *action);

Get the target property of the link action.

action :

A CpgLinkAction

Returns :

A CpgProperty. [transfer none]

CpgLinkActionPrivate

typedef struct _CpgLinkActionPrivate CpgLinkActionPrivate;

Property Details

The "enabled" property

  "enabled"                  gboolean              : Read / Write / Construct

Enabled.

Default value: TRUE


The "equation" property

  "equation"                 CpgExpression*        : Read / Write / Construct

The equation


The "link" property

  "link"                     CpgLink*              : Read

The link


The "target" property

  "target"                   gchar*                : Read / Write / Construct

The target CpgProperty

Default value: NULL


The "target-property" property

  "target-property"          CpgProperty*          : Read

The target property