atk.Relation.Relation Class Reference

Inheritance diagram for atk.Relation.Relation:

gobject.ObjectG.ObjectG List of all members.

Public Member Functions

AtkRelationgetRelationStruct ()
 this (AtkRelation *atkRelation)
 Sets our main struct and passes it to the parent class.
 this (AtkObject **targets, int nTargets, AtkRelationType relationship)
 Create a new relation for the specified key and the specified list of targets.
AtkRelationType getRelationType ()
 Gets the type of relation relation: an AtkRelation Returns: the type of relation.
PtrArray getTarget ()
 Gets the target list of relation relation: an AtkRelation Returns: the target list of relation.
void addTarget (AtkObject *target)
 Adds the specified AtkObject to the target for the relation, if it is not already present.

Static Public Member Functions

static AtkRelationType typeRegister (char[] name)
 Associate name with a new AtkRelationType name: a name string Returns: an AtkRelationType associated with name.
static char[] typeGetName (AtkRelationType type)
 Gets the description string describing the AtkRelationType type.
static AtkRelationType typeForName (char[] name)
 Get the AtkRelationType type corresponding to a relation name.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

AtkRelationatkRelation
 the main Gtk struct

Constructor & Destructor Documentation

atk.Relation.Relation.this ( AtkRelation atkRelation  ) 

Sets our main struct and passes it to the parent class.

atk.Relation.Relation.this ( AtkObject **  targets,
int  nTargets,
AtkRelationType  relationship 
)

Create a new relation for the specified key and the specified list of targets.

targets: an array of pointers to AtkObjects n_targets: number of AtkObjects pointed to by targets relationship: an AtkRelationType with which to create the new AtkRelation Returns: a pointer to a new AtkRelation


Member Function Documentation

void atk.Relation.Relation.addTarget ( AtkObject target  ) 

Adds the specified AtkObject to the target for the relation, if it is not already present.

relation: an AtkRelation target: an AtkObject Since ATK 1.9 Property Details The "relation-type" property "relation-type" AtkRelationType : Read / Write The type of the relation. Default value: ATK_RELATION_NULL

AtkRelation* atk.Relation.Relation.getRelationStruct (  ) 

AtkRelationType atk.Relation.Relation.getRelationType (  ) 

Gets the type of relation relation: an AtkRelation Returns: the type of relation.

void* atk.Relation.Relation.getStruct (  )  [protected]

the main Gtk struct as a void*

Reimplemented from gobject.ObjectG.ObjectG.

PtrArray atk.Relation.Relation.getTarget (  ) 

Gets the target list of relation relation: an AtkRelation Returns: the target list of relation.

static AtkRelationType atk.Relation.Relation.typeForName ( char[]  name  )  [static]

Get the AtkRelationType type corresponding to a relation name.

name: a string which is the (non-localized) name of an ATK relation type. Returns: the AtkRelationType enumerated type corresponding to the specified name, or ATK_RELATION_NULL if no matching relation type is found.

static char [] atk.Relation.Relation.typeGetName ( AtkRelationType  type  )  [static]

Gets the description string describing the AtkRelationType type.

type: The AtkRelationType whose name is required Returns: the string describing the AtkRelationType

static AtkRelationType atk.Relation.Relation.typeRegister ( char[]  name  )  [static]

Associate name with a new AtkRelationType name: a name string Returns: an AtkRelationType associated with name.


Member Data Documentation

AtkRelation* atk.Relation.Relation.atkRelation [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo