DataDir Class Reference

Manages access to installation directories. More...

List of all members.

Public Member Functions

bool searchDataDir (const string &userDefinedDir)
void setAdditionalDataDir (const string &dir)
const string & getDir ()
const string getLangDefDir ()
const string getThemeDir ()
const string getIndentSchemesDir ()
const string getAdditionalIndentSchemesDir ()
const string getAdditionalLangDefDir ()
const string getAdditionalThemeDir ()
const string getHelpMsgDir ()
const string getConfDir ()
const string searchForLangDef (const string &langDef)
const string searchForTheme (const string &theme)
const string searchForIndentScheme (const string &scheme)


Detailed Description

Manages access to installation directories.

Apart from the standard installation directory, one can define additional search paths.


Member Function Documentation

bool DataDir::searchDataDir ( const string &  userDefinedDir  ) 

search for a valid installation directory

Parameters:
userDefinedDir Directory defined by user
Returns:
True if directory was found

void DataDir::setAdditionalDataDir ( const string &  dir  ) 

add another installation directory, which is added to search path

Parameters:
dir Directory defined by user

const string & DataDir::getDir (  ) 

Returns:
Data installation directory

const string DataDir::getLangDefDir (  ) 

Returns:
Location of languafe definitions

const string DataDir::getThemeDir (  ) 

Returns:
Location of themes

const string DataDir::getIndentSchemesDir (  ) 

Returns:
Location of indentation schemes

const string DataDir::getAdditionalIndentSchemesDir (  ) 

Returns:
User defined location of indentation schemes

const string DataDir::getAdditionalLangDefDir (  ) 

Returns:
User defined location of languafe definitions

const string DataDir::getAdditionalThemeDir (  ) 

Returns:
User defined location of themes

const string DataDir::getHelpMsgDir (  ) 

Returns:
Location of help files

const string DataDir::getConfDir (  ) 

Returns:
Location of configuration files

const string DataDir::searchForLangDef ( const string &  langDef  ) 

Parameters:
langDef Name of language definition
Returns:
Absolute path of definiton found in a data directory

const string DataDir::searchForTheme ( const string &  theme  ) 

Parameters:
theme Name of colour theme file
Returns:
Absolute path of theme found in a data directory

const string DataDir::searchForIndentScheme ( const string &  scheme  ) 

Parameters:
scheme Name of indent scheme file
Returns:
Absolute path of theme found in a data directory


The documentation for this class was generated from the following files:
Generated on Fri Apr 27 13:12:36 2007 for Highlight Code Converter by  doxygen 1.5.2