IlvDvNodeValue Class Reference

Application Framework node value. More...

#include <ilviews/appframe/nodeval.h>

Inheritance diagram for IlvDvNodeValue:

Public Member Functions
	IlvDvNodeValue ()
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const IlvDvNodeValue &src)
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const char *name, IlInt n)
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const char *name, IlBoolean b)
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const char *name, IlFloat f)
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const char *name, IlDouble d)
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const char *name, const char *s)
	Constructs an IlvDvNodeValue object. More...
	IlvDvNodeValue (const char *name, IlAny p)
	Constructs an IlvDvNodeValue object. More...
void	addChildValue (IlvDvNodeValue *child)
	Adds a child node value into the object. More...
virtual IlvDvNodeValue *	copy () const
	Copies the object. More...
IlvDvNodeValue *	getChild (const char *childName) const
	Retrieves a child node value with the given name. More...
IlvDvNodeValue *	getChild (const IlSymbol *childName) const
	Retrieves a child node value with the given name. More...
IlvDvNodeValue *	getChild (IlUInt index) const
	Returns a child node value at a given index. More...
IlBoolean	getChildPoint (const char *name, IlvPoint &pt) const
	Gets the point value of a child node of the object. More...
IlBoolean	getChildRect (const char *name, IlvRect &rect) const
	Gets the IlvRect value of a child node of the object. More...
IlUInt	getChildsCount () const
	Returns the number of child nodes of the object. More...
const IlvValue &	getChildValue (const char *childName) const
	Gets the value of a child node of the object. More...
const IlvValue &	getChildValue (const IlSymbol *fieldName) const
	Gets the value of a child node of the object. More...
void	insertChildValue (IlUInt index, IlvDvNodeValue *child)
	Inserts a child node value into the object. More...
void	removeChild (const char *childName, IlBoolean deleteIt=IlTrue)
	Removes a child node value from the object. More...
void	removeChild (IlUInt index, IlBoolean deleteIt=IlTrue)
	Removes a child node value from the object. More...
void	removeChild (IlvDvNodeValue *child, IlBoolean deleteIt=IlTrue)
	Removes a child node value from the object. More...
void	removeChilds ()
	Removes all the child node values of the object. More...
void	setChildPoint (const char *name, const IlvPoint &pt)
	Sets the point value to a child node of the object. More...
void	setChildRect (const char *name, const IlvRect &rect)
	Sets the IlvRect value to a child node of the object. More...
void	setChildValue (const char *name, const IlvDvValue &value)
	Sets a value to a child node of the object. More...
void	setChildValue (const IlSymbol *name, const IlvDvValue &value)
	Sets a value to a child node of the object. More...

Detailed Description

Application Framework node value.

Library: ilvappframe

The IlvDvNodeValue class is a node value used to store and access all the data read from the option files. The options data is provided by the IlvDvApplication class. Changes to the node values are internally marked so that the modified values are saved in the user option files when the application exits.

Constructor & Destructor Documentation

IlvDvNodeValue::IlvDvNodeValue

(

)

Constructs an IlvDvNodeValue object.

This constructor creates an empty instance of IlvDvNodeValue.

IlvDvNodeValue::IlvDvNodeValue

(

const IlvDvNodeValue &

src

)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue by copying all the attributes of the src object given as the parameter.

IlvDvNodeValue::IlvDvNodeValue	(	const char *	name,
		IlInt	n
	)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue with the accessor name name and with the integer n.

IlvDvNodeValue::IlvDvNodeValue	(	const char *	name,
		IlBoolean	b
	)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue with the accessor name name and with the Boolean b.

IlvDvNodeValue::IlvDvNodeValue	(	const char *	name,
		IlFloat	f
	)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue with the accessor name name and with the float f.

IlvDvNodeValue::IlvDvNodeValue	(	const char *	name,
		IlDouble	d
	)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue with the accessor name name and with the double f.

IlvDvNodeValue::IlvDvNodeValue	(	const char *	name,
		const char *	s
	)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue with the accessor name name and with the string s.

IlvDvNodeValue::IlvDvNodeValue	(	const char *	name,
		IlAny	p
	)

Constructs an IlvDvNodeValue object.

This constructor creates an instance of IlvDvNodeValue with the accessor name name and with the pointer p.

Member Function Documentation

void IlvDvNodeValue::addChildValue

(

IlvDvNodeValue *

child

)

Adds a child node value into the object.

Adds the node value child at the end of the child nodes list. The child object will be deleted by the object when it deletes itself.

virtual IlvDvNodeValue* IlvDvNodeValue::copy ( ) const

virtual

Copies the object.

Returns

A copy of the object.

IlvDvNodeValue* IlvDvNodeValue::getChild

(

const char *

childName

)

const

Retrieves a child node value with the given name.

Retrieves a child node value whose name is equivalent to the name childName.

Returns

The node value with the given name.

IlvDvNodeValue* IlvDvNodeValue::getChild

(

const IlSymbol *

childName

)

const

Retrieves a child node value with the given name.

Retrieves a child node value whose name is equivalent to the name childName.

Returns

The node value with the given name.

IlvDvNodeValue* IlvDvNodeValue::getChild

(

IlUInt

index

)

const

Returns a child node value at a given index.

Returns

Returns the node value that is at the index index inside the child node list.

IlBoolean IlvDvNodeValue::getChildPoint	(	const char *	name,
		IlvPoint &	pt
	)		const

Gets the point value of a child node of the object.

Gets the point value of the object child node whose name equals the name name.

Parameters

name	Specifies the name of the object child node.
pt	Receives the retrieved point value.

Returns

IlTrue if a child node with the given name was found.

IlBoolean IlvDvNodeValue::getChildRect	(	const char *	name,
		IlvRect &	rect
	)		const

Gets the IlvRect value of a child node of the object.

Gets the IlvRect value of the object child node whose name is equivalent to the name name.

Parameters

name	Specifies the name of the object child node.
rect	Receives the retrieved IlvRect value.

Returns

IlTrue if a child node with the given name was found.

IlUInt IlvDvNodeValue::getChildsCount

(

)

const

Returns the number of child nodes of the object.

Returns

The number of child nodes of the object.

const IlvValue& IlvDvNodeValue::getChildValue

(

const char *

childName

)

const

Gets the value of a child node of the object.

Gets the value of the object child node whose name equals the name name.

Returns

Returns the value of the child node of name childName.

const IlvValue& IlvDvNodeValue::getChildValue

(

const IlSymbol *

fieldName

)

const

Gets the value of a child node of the object.

Gets the value of the object child node whose name equals the name name.

Returns

The value of the child node of name childName.

void IlvDvNodeValue::insertChildValue	(	IlUInt	index,
		IlvDvNodeValue *	child
	)

Inserts a child node value into the object.

Inserts the node value child into the child nodes list at the position given by the index parameter. The child object will be deleted by the object when it deletes itself.

void IlvDvNodeValue::removeChild	(	const char *	childName,
		IlBoolean	deleteIt = IlTrue
	)

Removes a child node value from the object.

Removes the node value with the name childName from the list of the child node values.

Parameters

childName	The name of the child node to remove.
deleteIt	If IlTrue, the retrieved child node is deleted.

void IlvDvNodeValue::removeChild	(	IlUInt	index,
		IlBoolean	deleteIt = IlTrue
	)

Removes a child node value from the object.

Removes the node value at the position index from the list of child node values.

Parameters

index	Specifies the node position in the child node values.
deleteIt	If IlTrue, the retrieved child node is deleted.

void IlvDvNodeValue::removeChild	(	IlvDvNodeValue *	child,
		IlBoolean	deleteIt = IlTrue
	)

Removes a child node value from the object.

Removes the node value child from the list of child node values.

Parameters

child	The child node to remove.
deleteIt	If IlTrue, the given child node is deleted.

void IlvDvNodeValue::removeChilds

(

)

Removes all the child node values of the object.

Removes all the node values from the list of child node values. All the child node values are deleted.

void IlvDvNodeValue::setChildPoint	(	const char *	name,
		const IlvPoint &	pt
	)

Sets the point value to a child node of the object.

Sets the point value given by the parameter pt to the child node whose name equals the name name.

void IlvDvNodeValue::setChildRect	(	const char *	name,
		const IlvRect &	rect
	)

Sets the IlvRect value to a child node of the object.

Sets the IlvRect value given by the parameter rect to the child node whose name equals the name name.

void IlvDvNodeValue::setChildValue	(	const char *	name,
		const IlvDvValue &	value
	)

Sets a value to a child node of the object.

Sets the value value to the child node whose name equals the name name.

void IlvDvNodeValue::setChildValue	(	const IlSymbol *	name,
		const IlvDvValue &	value
	)

Sets a value to a child node of the object.

Sets the value value to the child node whose name equals the name name.