GFC Logo GFC Title Logo
Reference Manual
Main Page  |  Namespace List  |  Alphabetical List  |  Class List  |  File List

GFC::Atk::RelationSet Class Reference

An AtkRelationSet C++ wrapper class. More...

#include <gfc/atk/relation.hh>

Inheritance diagram for GFC::Atk::RelationSet:

GFC::G::Object GFC::G::TypeInstance GFC::Trackable List of all members.

Public Member Functions

Constructors
Accessors
Methods

Protected Member Functions

Constructors

Detailed Description

An AtkRelationSet C++ wrapper class.

RelationSet is a set of Relations, normally the set of Relations which an Atk::Object has.


Constructor & Destructor Documentation

GFC::Atk::RelationSet::RelationSet AtkRelationSet *  set,
bool  owns_reference = true
[explicit, protected]
 

Construct a new RelationSet from an existing AtkRelationSet.

Parameters:
set A pointer to a AtkRelationSet.
owns_reference Set false if the initial reference count is floating, set true if it's not.

The set can be a newly created AtkRelationSet or an existing AtkRelationSet. (see G::Object::Object).


Member Function Documentation

void GFC::Atk::RelationSet::add Relation relation  ) 
 

Add a new relation to the current relation set if it is not already present.

Parameters:
relation A Relation.

bool GFC::Atk::RelationSet::contains RelationType  relationship  )  const
 

Determines whether the relation set contains a relation that matches the specified type.

Parameters:
relationship A RelationType.
Returns:
true if relationship is the relationship type of a relation in the set, false otherwise.

int GFC::Atk::RelationSet::get_n_relations  )  const
 

Determines the number of relations in a relation set.

Returns:
An integer representing the number of relations in the set.

Relation* GFC::Atk::RelationSet::get_relation RelationType  relationship  )  const
 

Finds a relation that matches the specified type.

Parameters:
relationship A RelationType.
Returns:
A Relation, which is a relation matching the specified type.

Relation* GFC::Atk::RelationSet::get_relation int  index  )  const
 

Determines the relation at the specified position in the relation set.

Parameters:
index An integer representing a position in the set, starting from 0.
Returns:
A Relation, which is the relation at position i in the set.

void GFC::Atk::RelationSet::remove Relation relation  ) 
 

Removes a relation from the relation set.

Parameters:
relation A Relation.

This method unreferences the Relation so it will be deleted, unless there is another reference to it.


The documentation for this class was generated from the following file:
Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by doxygen 1.3.8