ITags Struct Reference

List of string tags. Provides helpers to get and search the list of tags. More...

Inheritance diagram for ITags:

Collaboration diagram for ITags:

Detailed Description

List of string tags. Provides helpers to get and search the list of tags.

Tags provide a view into an underlying list of tags. The list can be retrieved via getList, and inspected through contains and query.

To manipulate the list of tags, the add/remove tag functions can be used. The Tags object can only be modified if the object is not locked by the owning Component.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getList (IList **value)=0
	Gets the list of all tags in the list. More...
virtual ErrCode INTERFACE_FUNC	contains (IString *name, Bool *value)=0
	Checks whether a tag is present in the list of tags. More...
virtual ErrCode INTERFACE_FUNC	query (IString *query, Bool *value)=0
	Queries the list of tags, creating an EvalValue expression from the query string. Returns true if the list of tags matches the query, false otherwise. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

contains()

virtual ErrCode INTERFACE_FUNC contains ( IString *  name, Bool *  value  )

pure virtual

Checks whether a tag is present in the list of tags.

Parameters

	name	The name of the tag being checked.
[out]	value	True if a tag is found; false otherwise.

getList()

virtual ErrCode INTERFACE_FUNC getList ( IList **  value )

pure virtual

Gets the list of all tags in the list.

Parameters

[out]

value

The list of tag strings.

query()

virtual ErrCode INTERFACE_FUNC query ( IString *  query, Bool *  value  )

pure virtual

Queries the list of tags, creating an EvalValue expression from the query string. Returns true if the list of tags matches the query, false otherwise.

Parameters

	query	The query string. I.e. "tag1 || (tag2 && tag3)"
[out]	value	The result of the query