Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

CascadeFSObject::Selector Class Reference

abstract base class for selectors passed into CascadeDirectory enumration functions. CascadeFSObject::Selector is an abstract base class used to define objects which select the desired files when using the directory enumeration functions in CascadeDirectory. More...

#include <cascade/util/CascadeFSObject.h>

Inheritance diagram for CascadeFSObject::Selector:

CascadeFSObject::PermissionsSelector CascadeFSObject::RegexpSelector CascadeFSObject::TypeSelector List of all members.

Public Types

enum  SelectorTypeFilter { eInvalid = 0, eFiles = 1, eDirectories = 2, eBoth = 3 }

Public Member Functions

 Selector ()
virtual ~Selector ()
 destructor
virtual bool Match (CascadeFSObject &inObject)=0
void SetSelectorTypeFilter (SelectorTypeFilter inFilter)

Protected Attributes

SelectorTypeFilter mFilter

Detailed Description

abstract base class for selectors passed into CascadeDirectory enumration functions. CascadeFSObject::Selector is an abstract base class used to define objects which select the desired files when using the directory enumeration functions in CascadeDirectory.

See also:
CascadeFSObject::RegexpSelector CascadeFSObject::PermissionsSelector


Member Enumeration Documentation

enum CascadeFSObject::Selector::SelectorTypeFilter
 

Enumeration values:
eInvalid 
eFiles 
eDirectories 
eBoth 


Constructor & Destructor Documentation

CascadeFSObject::Selector::Selector  )  [inline]
 

default constructor

The default constructor assumes that you wish to find both files and directories. Use SetSelectorTypeFilter() to change this value.

virtual CascadeFSObject::Selector::~Selector  )  [inline, virtual]
 

destructor


Member Function Documentation

virtual bool CascadeFSObject::Selector::Match CascadeFSObject inObject  )  [pure virtual]
 

pure virtual definition of the Match function

Subclasses must override the Match function, which takes a CascadeFSObject as an argument (by reference) and returns true if the object is a match, or false if not.

Returns:
true if the object is a match, or false if not

Implemented in CascadeFSObject::RegexpSelector, CascadeFSObject::PermissionsSelector, and CascadeFSObject::TypeSelector.

void CascadeFSObject::Selector::SetSelectorTypeFilter SelectorTypeFilter  inFilter  )  [inline]
 

accessor to set selector type

Use this accessor to set the selector type. eFiles indicates that only files should be passed to the filter, while directories never match. eDirectories is the opposite. eBoth indicates that both files and directories should be tested.


Member Data Documentation

SelectorTypeFilter CascadeFSObject::Selector::mFilter [protected]
 


The documentation for this class was generated from the following file:
Generated on Sun Jul 24 14:27:19 2005 for Cascade Library by  doxygen 1.4.1