GL Studio C++ Runtime API
RSOResourceFilterImpl Class Reference

#include <gls_rso_interface_impl.h>

Inheritance diagram for RSOResourceFilterImpl:
RSOInterface1::ResourceFilter

Public Member Functions

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

Detailed Description

Wraps a GlsResourceFilter so it can be passed to the RSO Interface's GetResources call

Member Function Documentation

int ExcludeCount ( ) const
inlinevirtual

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

Implements RSOInterface1::ResourceFilter.

int GroupLevelsDown ( ) const
inlinevirtual

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

Implements RSOInterface1::ResourceFilter.

int IncludeCount ( ) const
inlinevirtual

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

Implements RSOInterface1::ResourceFilter.

int LevelsUp ( ) const
inlinevirtual

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

Implements RSOInterface1::ResourceFilter.

bool NamesOnly ( ) const
inlinevirtual

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

Implements RSOInterface1::ResourceFilter.

bool PassFilter ( const char *  name) const
inlinevirtual

Check a name against the filters Exclude list takes precedence

Implements RSOInterface1::ResourceFilter.


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