DtEnvList Class Reference

DtEnvList is a list of DtEnvValue pointers. More...

Inheritance diagram for DtEnvList:

Collaboration diagram for DtEnvList:

Public Member Functions
virtual DtEnvValueSP	first () const
	Get the first value in the list.
virtual DtEnvValueSP	last () const
	Get the last value in the list.
virtual DtEnvValueSP	next (DtEnvValueSP) const
	Get the next value after the value passed in.
Public Member Functions inherited from DtEnvValue
	DtEnvValue (const DtString &value)
virtual	~DtEnvValue ()
virtual DtString	value () const
	Get the object's value.
virtual DtString	unmodifiedValue () const
	Get the object's value without environmental expansion.
virtual void	setValue (const DtString &value)
	Sets the object's value.
virtual DtEnvValueSP	parent () const
	Get the parent of the object.
virtual void	setParent (DtEnvValueSP parent)
	Set the parent of the object.
DtEnvValueFormat	format () const
	Get the format of the object.

Static Public Member Functions
static bool	isList (const DtEnvValueSP &)
	Check to see if a value is a list.
static DtEnvList *	castToList (const DtEnvValueSP &value)
	Cast a value to a list.

Protected Member Functions
	DtEnvList (const DtString &value)
	CTOR.
virtual DtEnvValue *	clone () const
	Create a deep copy.
virtual void	cloneChildren (DtEnvList *list) const
	Duplicate children in object.
virtual void	append (DtEnvValueSP)
	Append a child into the list.
virtual void	remove (DtEnvValueSP)
	Remove a child from the list.
Protected Member Functions inherited from DtEnvValue
virtual void	valueChanged ()
virtual void	childChanged (DtEnvValue *)
void	addFormat (DtEnvValueFormat format)
	DtEnvValue (const DtString &value, DtEnvValueFormat format)

Protected Attributes
DtEnvValueList	myValues
	The list of values.
Protected Attributes inherited from DtEnvValue
DtEnvValueFormat	myFormat
DtEnvValueType	myValue
DtEnvValueType	myUnmodifiedValue
DtEnvValueWP	myParent

Friends
class	DtEnvironment

Additional Inherited Members
Public Types inherited from DtEnvValue
enum	DtEnvValueFormat {   Value = 0, Listed = 1, Named = RESERVED_VALUE(1), Typed = RESERVED_VALUE(2),   Native = RESERVED_VALUE(3), NamedListed = Named | Listed, NamedTypedListed = Named | Typed | Listed }

Detailed Description

DtEnvList is a list of DtEnvValue pointers.

Which themselves can be any type.

Constructor & Destructor Documentation

DtEnvList::DtEnvList ( const DtString &  value )

explicitprotected

CTOR.

Member Function Documentation

virtual void DtEnvList::append ( DtEnvValueSP  )

protectedvirtual

Append a child into the list.

Reimplemented in DtEnvObject.

static DtEnvList* DtEnvList::castToList ( const DtEnvValueSP &  value )

static

Cast a value to a list.

Return values

NULL	If object is not a list.

virtual DtEnvValue* DtEnvList::clone ( ) const

protectedvirtual

Create a deep copy.

Reimplemented from DtEnvValue.

Reimplemented in DtEnvObject, and DtEnvNamedList.

virtual void DtEnvList::cloneChildren ( DtEnvList *  list ) const

protectedvirtual

Duplicate children in object.

virtual DtEnvValueSP DtEnvList::first ( ) const

virtual

Get the first value in the list.

Reimplemented in DtEnvNamedList, and DtEnvObject.

static bool DtEnvList::isList ( const DtEnvValueSP &  )

static

Check to see if a value is a list.

virtual DtEnvValueSP DtEnvList::last ( ) const

virtual

Get the last value in the list.

virtual DtEnvValueSP DtEnvList::next ( DtEnvValueSP  ) const

virtual

Get the next value after the value passed in.

Returns null if there is no next child.

for(DtEnvValueSP child = list.first();child;child = child->next(child)) { ... }

virtual void DtEnvList::remove ( DtEnvValueSP  )

protectedvirtual

Remove a child from the list.

Reimplemented in DtEnvObject.

Friends And Related Function Documentation

friend class DtEnvironment

friend

Member Data Documentation

DtEnvValueList DtEnvList::myValues

protected

The list of values.

---

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

• envList.h