GL Studio C++ Runtime API
Public Member Functions | List of all members
RSOInterface1::ResourceFilter Class Referenceabstract

#include <rso_interface_1.h>

Inheritance diagram for RSOInterface1::ResourceFilter:
GlsRSO1_ResourceFilterImpl RSOResourceFilterImpl

Public Member Functions

virtual int LevelsUp () const =0
 
virtual int GroupLevelsDown () const =0
 
virtual bool NamesOnly () const =0
 
virtual void AddExclude (const char *str)=0
 Manage the list of excluded attributes.
 
virtual int ExcludeCount () const =0
 
virtual const char * GetExclude (int index) const =0
 Returns NULL if index >= ExcludeCount() or index < -1.
 
virtual void AddInclude (const char *str)=0
 Manage the list of included attributes.
 
virtual int IncludeCount () const =0
 
virtual bool PassFilter (const char *name) const =0
 

Detailed Description

The resource filter is a parameter to the GetResources method

Member Function Documentation

virtual int ExcludeCount ( ) const
pure virtual

Returns the number of entries in the exclude list. Default: 0

Implemented in GlsRSO1_ResourceFilterImpl, and RSOResourceFilterImpl.

virtual int GroupLevelsDown ( ) const
pure virtual

How many levels of children to show. 0 means don't show any children properties -1 means all the way down. Default: -1

Implemented in GlsRSO1_ResourceFilterImpl, and RSOResourceFilterImpl.

virtual int IncludeCount ( ) const
pure virtual

Returns the number of entries in the include list. Default: 0

Implemented in GlsRSO1_ResourceFilterImpl, and RSOResourceFilterImpl.

virtual int LevelsUp ( ) const
pure virtual

How many levels of qualification to show in the name. -1 means full qualification. Default: 0 // TODO: confirm this default

Implemented in RSOResourceFilterImpl, and GlsRSO1_ResourceFilterImpl.

virtual bool NamesOnly ( ) const
pure virtual

If true, only a list of names will be returned. Values will not be returned. The format changes to not include the ":". Default: false

Implemented in GlsRSO1_ResourceFilterImpl, and RSOResourceFilterImpl.

virtual bool PassFilter ( const char *  name) const
pure virtual

Check a name against the filters Exclude list takes precedence

Implemented in GlsRSO1_ResourceFilterImpl, and RSOResourceFilterImpl.

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