GL Studio C++ Runtime API
Public Member Functions | Protected Attributes | List of all members
GlsRSO1_ResourceFilterImpl Class Reference

#include <gls_rso_container_util.h>

Inheritance diagram for GlsRSO1_ResourceFilterImpl:
RSOInterface1::ResourceFilter

Public Member Functions

 GlsRSO1_ResourceFilterImpl (GlsResourceFilter *filter)
 
void Filter (GlsResourceFilter *filter)
 
GlsResourceFilter * Filter ()
 
virtual int LevelsUp () const
 
virtual void LevelsUp (int value)
 
virtual int GroupLevelsDown () const
 
virtual void GroupLevelsDown (int value)
 
virtual bool NamesOnly () const
 
virtual void NamesOnly (bool value)
 
virtual void AddExclude (const char *str)
 
virtual int ExcludeCount () const
 
virtual const char * GetExclude (int index) const
 
virtual void AddInclude (const char *str)
 
virtual int IncludeCount () const
 
virtual const char * GetInclude (int index) const
 
virtual bool PassFilter (const char *name) const
 
virtual int LevelsUp () const =0
 
virtual void LevelsUp (int value)=0
 
virtual int GroupLevelsDown () const =0
 
virtual void GroupLevelsDown (int value)=0
 
virtual bool NamesOnly () const =0
 
virtual void NamesOnly (bool value)=0
 
virtual void AddExclude (const char *str)=0
 
virtual int ExcludeCount () const =0
 
virtual const char * GetExclude (int index) const =0
 
virtual void AddInclude (const char *str)=0
 
virtual int IncludeCount () const =0
 
virtual const char * GetInclude (int index) const =0
 
virtual bool PassFilter (const char *name) const =0
 

Protected Attributes

GlsResourceFilter * _filter
 

Detailed Description

Standard implmentation for the RSO1_ResourceFilter interface This wraps the GlsResourceFilter class

Constructor & Destructor Documentation

◆ GlsRSO1_ResourceFilterImpl()

GlsRSO1_ResourceFilterImpl ( GlsResourceFilter *  filter)
inline

Constructor

Parameters
filterThe filter object to wrap.

Member Function Documentation

◆ AddExclude()

virtual void AddExclude ( const char *  str)
inlinevirtual

Manage the exclude list. Takes precedence over includes.

Parameters
strThe new name to add to the exclude list.

Implements RSOInterface1::ResourceFilter.

◆ AddInclude()

virtual void AddInclude ( const char *  str)
inlinevirtual

Manage the include list.

Parameters
strThe new name to add to the include list.

Implements RSOInterface1::ResourceFilter.

◆ ExcludeCount()

virtual int ExcludeCount ( ) const
inlinevirtual
Returns
The number of items in the exclusion list.

Implements RSOInterface1::ResourceFilter.

◆ Filter() [1/2]

GlsResourceFilter * Filter ( )
inline
Returns
The current filter object.

◆ Filter() [2/2]

void Filter ( GlsResourceFilter *  filter)
inline

Change the filter object that this interface is wrapping.

Parameters
filterThe new filter to set.

◆ GetExclude()

virtual const char * GetExclude ( int  index) const
inlinevirtual
Returns
The name of the exclude item associated with the index.
Parameters
indexThe index whose name is to be returned.

Implements RSOInterface1::ResourceFilter.

◆ GetInclude()

virtual const char * GetInclude ( int  index) const
inlinevirtual
Returns
The name of the include item associated with the index.
Parameters
indexThe index whose name is to be returned.

Implements RSOInterface1::ResourceFilter.

◆ GroupLevelsDown() [1/2]

virtual int GroupLevelsDown ( ) const
inlinevirtual
Returns
The current levels of children to show.

Implements RSOInterface1::ResourceFilter.

◆ GroupLevelsDown() [2/2]

virtual void GroupLevelsDown ( int  value)
inlinevirtual

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

Parameters
valueThe new levels of children to show.

Implements RSOInterface1::ResourceFilter.

◆ IncludeCount()

virtual int IncludeCount ( ) const
inlinevirtual
Returns
The number of items in the inclusion list.

Implements RSOInterface1::ResourceFilter.

◆ LevelsUp() [1/2]

virtual int LevelsUp ( ) const
inlinevirtual
Returns
The current levels of qualification to show in the name. -1 means full qualification.

Implements RSOInterface1::ResourceFilter.

◆ LevelsUp() [2/2]

virtual void LevelsUp ( int  value)
inlinevirtual

How many levels of qualification to show in the name. -1 means full qualification.

Parameters
valuethe new qualification level to set

Implements RSOInterface1::ResourceFilter.

◆ NamesOnly() [1/2]

virtual bool NamesOnly ( ) const
inlinevirtual
Returns
Whether or not to show names, or names and values.

Implements RSOInterface1::ResourceFilter.

◆ NamesOnly() [2/2]

virtual void NamesOnly ( bool  value)
inlinevirtual

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

Parameters
valueThe new name format flag to set.

Implements RSOInterface1::ResourceFilter.

◆ PassFilter()

virtual bool PassFilter ( const char *  name) const
inlinevirtual

Check a name against the filter.

Parameters
nameThe name to check against the filter.
Returns
Whether or not the name passes the filter (to be included in the results).

Implements RSOInterface1::ResourceFilter.

Member Data Documentation

◆ _filter

GlsResourceFilter* _filter
protected

Reference to the GlsResourceFilter object being wrapped. The GlsRSO1_ResourceFilterImpl does not delete this object.

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