RSOInterface1::ResourceFilter Class Reference

#include <rso_interface_1.h>

Inheritance diagram for RSOInterface1::ResourceFilter:

Public Member Functions
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
	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 const char *	GetInclude (int index) 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 GlsResourceFilter.

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 GlsResourceFilter.

virtual int IncludeCount ( ) const

pure virtual

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

Implemented in GlsResourceFilter.

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 GlsResourceFilter.

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 GlsResourceFilter.

virtual bool PassFilter ( const char *  name ) const

pure virtual

Check a name against the filters Exclude list takes precedence

Implemented in GlsResourceFilter.

---

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

• rso_interface_1.h