FARDirectory Class Reference

#include "FAR.h"

Public Member Functions
	FARDirectory (const QString &_fullPath)
	FARDirectory (const FARDirectory &_parentDirectory, const QString &_directoryName)
	FARDirectory (const FARDirectory &_other)
bool	exists (void) const
bool	scanFiles (const FARFilter &_filter, int &_counter)
	Find all files in this directory. Result is buffered.
bool	readAllFiles (bool _topLevelOnly=true)
	Read all the files found in this directory. Note that scan files must be called first if the files are not set manually. Result is buffered.
bool	scanDirectories (const FARFilter &_filter, int &_counter, bool _topLevelOnly=true)
	Find all the child directories in this directory. Result is buffered.
bool	scanAll (const FARFilter &_filter, int &_fileCounter, int &_directoryCounter, bool _topLevelOnly=true, bool _readFiles=false)
	Find all files and directories in this directory. Result is buffered.
bool	findText (const QString &_text, FARFilter::FilterFlags _textFilter, std::list< FARMatch > &_matches, int &_longestText, int &_longestPath, bool _topLevelOnly=true) const
bool	replaceText (const QString &_text, const QString &_newText, FARFilter::FilterFlags _textFilter, std::list< FARMatch > &_matches, int &_longestText, int &_longestPath, bool _topLevelOnly=true)
void	setFullPath (const QString &_path)
const QString &	fullPath (void) const
void	setNameOnly (const QString &_name)
const QString &	nameOnly (void) const
void	setFiles (const std::list< FARFile > &_files)
const std::list< FARFile > &	files (void) const
void	setDirectories (const std::list< FARDirectory > &_directories)
const std::list< FARDirectory > &	directories (void) const

Constructor & Destructor Documentation

FARDirectory() [1/3]

FARDirectory::FARDirectory

(

const QString &

_fullPath

)

FARDirectory() [2/3]

FARDirectory::FARDirectory	(	const FARDirectory &	_parentDirectory,
		const QString &	_directoryName )

FARDirectory() [3/3]

FARDirectory::FARDirectory

(

const FARDirectory &

_other

)

Member Function Documentation

directories()

const std::list< FARDirectory > & FARDirectory::directories ( void ) const

inline

exists()

bool FARDirectory::exists

(

void

)

const

files()

const std::list< FARFile > & FARDirectory::files ( void ) const

inline

findText()

bool FARDirectory::findText	(	const QString &	_text,
		FARFilter::FilterFlags	_textFilter,
		std::list< FARMatch > &	_matches,
		int &	_longestText,
		int &	_longestPath,
		bool	_topLevelOnly = true ) const

fullPath()

const QString & FARDirectory::fullPath ( void ) const

inline

nameOnly()

const QString & FARDirectory::nameOnly ( void ) const

inline

readAllFiles()

bool FARDirectory::readAllFiles

(

bool

_topLevelOnly = true

)

Read all the files found in this directory. Note that scan files must be called first if the files are not set manually. Result is buffered.

Parameters

_topLevelOnly

If true only the files in this directory will read their contents

replaceText()

bool FARDirectory::replaceText	(	const QString &	_text,
		const QString &	_newText,
		FARFilter::FilterFlags	_textFilter,
		std::list< FARMatch > &	_matches,
		int &	_longestText,
		int &	_longestPath,
		bool	_topLevelOnly = true )

scanAll()

bool FARDirectory::scanAll	(	const FARFilter &	_filter,
		int &	_fileCounter,
		int &	_directoryCounter,
		bool	_topLevelOnly = true,
		bool	_readFiles = false )

Find all files and directories in this directory. Result is buffered.

Parameters

_topLevelOnly	If true only this directory will be scanned
_readFiles	If true the found files will read their text

scanDirectories()

bool FARDirectory::scanDirectories	(	const FARFilter &	_filter,
		int &	_counter,
		bool	_topLevelOnly = true )

Find all the child directories in this directory. Result is buffered.

Parameters

_topLevelOnly

If true only this directory will be scanned

scanFiles()

bool FARDirectory::scanFiles	(	const FARFilter &	_filter,
		int &	_counter )

Find all files in this directory. Result is buffered.

setDirectories()

void FARDirectory::setDirectories ( const std::list< FARDirectory > & _directories )

inline

setFiles()

void FARDirectory::setFiles ( const std::list< FARFile > & _files )

inline

setFullPath()

void FARDirectory::setFullPath ( const QString & _path )

inline

setNameOnly()

void FARDirectory::setNameOnly ( const QString & _name )

inline

---

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

• Tools/OToolkit/include/FAR.h
• Tools/OToolkit/src/FAR.cpp