owl::TRegLink Class Reference

A linked structure in which each node points to a list of TRegList objects (or TRegList-derived objects) or TDocTemplate objects. More...

#include <owl/registry.h>

Inheritance diagram for owl::TRegLink:

Public Member Functions
	TRegLink (TRegList &regList, TRegLink *&head)
	Constructs a reglink pointing to a reglist, and adds it to the end of the list.
virtual	~TRegLink ()
	Registration link node destructor.
TRegLink *	GetNext () const
	Returns a pointer to the next link.
void	SetNext (TRegLink *link)
TRegList &	GetRegList () const
	Returns a pointer to the registration parameter table (reglist).

Static Public Member Functions
static void	AddLink (TRegLink **head, TRegLink *newLink)
	Adds a new link to the end of the link list.
static bool	RemoveLink (TRegLink **head, TRegLink *remLink)
	Removes a link from the link list. Returns true if the link is found and removed.

Protected Member Functions
	TRegLink ()
	Derived class must fill in ptrs.

Protected Attributes
TRegLink *	Next
	Next RegLink.
TRegList *	RegList
	Pointer to registration parameter table.

Detailed Description

A linked structure in which each node points to a list of TRegList objects (or TRegList-derived objects) or TDocTemplate objects.

Each object has an item name and a string value associated with the item name. The structure forms a typical linked list as the following diagram illustrates:

A TDocTemplate object uses the following variation of the TRegLink structure:

Definition at line 561 of file registry.h.

Constructor & Destructor Documentation

TRegLink() [1/2]

owl::TRegLink::TRegLink	(	TRegList &	regList,
		TRegLink *&	head )

Constructs a reglink pointing to a reglist, and adds it to the end of the list.

Definition at line 16 of file reglink.cpp.

References AddLink().

~TRegLink()

owl::TRegLink::~TRegLink ( )

inlinevirtual

Registration link node destructor.

Definition at line 1331 of file registry.h.

TRegLink() [2/2]

owl::TRegLink::TRegLink ( )

inlineprotected

Derived class must fill in ptrs.

Protected constructor where the derived class must initialize all pointers.

Definition at line 1358 of file registry.h.

Member Function Documentation

AddLink()

void owl::TRegLink::AddLink ( TRegLink ** head, TRegLink * newLink )

static

Adds a new link to the end of the link list.

Definition at line 27 of file reglink.cpp.

GetNext()

TRegLink * owl::TRegLink::GetNext ( ) const

inline

Returns a pointer to the next link.

Definition at line 1337 of file registry.h.

References Next.

GetRegList()

TRegList & owl::TRegLink::GetRegList ( ) const

inline

Returns a pointer to the registration parameter table (reglist).

Definition at line 1350 of file registry.h.

References RegList.

RemoveLink()

bool owl::TRegLink::RemoveLink ( TRegLink ** head, TRegLink * remLink )

static

Removes a link from the link list. Returns true if the link is found and removed.

Definition at line 50 of file reglink.cpp.

SetNext()

void owl::TRegLink::SetNext ( TRegLink * link )

inline

Definition at line 1342 of file registry.h.

References Next.

Member Data Documentation

Next

TRegLink* owl::TRegLink::Next

protected

Next RegLink.

Definition at line 576 of file registry.h.

RegList

TRegList* owl::TRegLink::RegList

protected

Pointer to registration parameter table.

Definition at line 577 of file registry.h.

---

The documentation for this class was generated from the following files:

• include/owl/registry.h
• source/owlcore/reglink.cpp