Rhino C++ API  8.7
Classes | Public Member Functions | List of all members
IRhRdkContentList Class Referenceabstract

#include <IRhRdkContentList.h>

Classes

class  Iterator
 

Public Member Functions

virtual ~IRhRdkContentList ()
 
virtual int Count (void) const =0
 
virtual void * EVF (const wchar_t *, void *)=0
 
virtual const CRhRdkContentFindInstance (const UUID &uuidInstance, bool bRecurse) const =0
 
virtual void FindInstanceByName (const wchar_t *wszName, bool bCaseSensitive, bool bRecurse, OUT CRhRdkContentArray &aContent) const =0
 
virtual void GetKinds (CRhRdkContentKindList &kindsOut) const =0
 
virtual IteratorNewIterator (void) const =0
 
virtual const CRhRdkContentNext (Iterator *pIterator) const =0
 
virtual UUID Uuid (void) const =0
 

Detailed Description

This interface is used for accessing lists of content. Any kind of content can coexist in such a list, although some actual lists in RDK allow only a single kind.

Constructor & Destructor Documentation

◆ ~IRhRdkContentList()

virtual IRhRdkContentList::~IRhRdkContentList ( )
inlinevirtual

Member Function Documentation

◆ Count()

virtual int IRhRdkContentList::Count ( void  ) const
pure virtual
Returns
The number of items in the list.

◆ EVF()

virtual void* IRhRdkContentList::EVF ( const wchar_t *  ,
void *   
)
pure virtual

Emergency virtual function for future expansion.

◆ FindInstance()

virtual const CRhRdkContent* IRhRdkContentList::FindInstance ( const UUID &  uuidInstance,
bool  bRecurse 
) const
pure virtual

Find a content by its instance id.

Parameters
uuidInstanceis the instance id of the content to find.
bRecursespecifies if children should be searched as well as top-level content.
Returns
A pointer to the content or NULL if not found.

◆ FindInstanceByName()

virtual void IRhRdkContentList::FindInstanceByName ( const wchar_t *  wszName,
bool  bCaseSensitive,
bool  bRecurse,
OUT CRhRdkContentArray aContent 
) const
pure virtual

Find contents with the specified instance name.

Parameters
wszNameis the name to search for.
bCaseSensitivespecifies if the name check is case-sensitive or not.
bRecursespecifies if the content's children should be searched.
aContentaccepts all the contents that satisfy the search.

◆ GetKinds()

virtual void IRhRdkContentList::GetKinds ( CRhRdkContentKindList kindsOut) const
pure virtual

Get the content kinds that the list contains.

◆ NewIterator()

virtual Iterator* IRhRdkContentList::NewIterator ( void  ) const
pure virtual

Get an iterator to use when calling Next(). The caller shall delete the iterator.

◆ Next()

virtual const CRhRdkContent* IRhRdkContentList::Next ( Iterator pIterator) const
pure virtual
Returns
A pointer to the next content in the list or NULL if no more exist.

◆ Uuid()

virtual UUID IRhRdkContentList::Uuid ( void  ) const
pure virtual
Returns
The list's unique identifier.