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)
void	setAdditionalConfDir (const string &dir)
const string &	getAdditionalDataDir ()
const string &	getAdditionalConfDir ()
const string &	getDir ()
const string	getLangPath (const string &file="", bool forceDefault=false)
const string	getThemePath (const string &file="", bool forceDefault=false)
const string	getAdditionalLangDefDir ()
const string	getAdditionalThemeDir ()
const string	getConfDir (bool forceDefault=false)
const string	getI18nDir ()
const string	getExtDir ()
const string	getDocDir ()
Static Public Attributes
static string	LSB_DATA_DIR = "/usr/share/highlight/"
static string	LSB_CFG_DIR = "/etc/highlight/"
static string	LSB_DOC_DIR = "/usr/share/doc/highlight/"

---

Detailed Description

Manages access to installation directories.

Apart from the standard installation directory, one can define additional search paths. If the additonal paths do not exist, the default paths are returned.

---

Member Function Documentation

const string & DataDir::getAdditionalConfDir

(

)

Returns:

data Directory defined by user

const string & DataDir::getAdditionalDataDir

(

)

Returns:

data Directory defined by user

const string DataDir::getAdditionalLangDefDir

(

)

Returns:

User defined location of languafe definitions

Referenced by getLangPath().

const string DataDir::getAdditionalThemeDir

(

)

Returns:

User defined location of themes

Referenced by getThemePath().

const string DataDir::getConfDir

(

bool

forceDefault = false

)

Parameters:

forceDefault

set tue if additional directory should be ignored

Returns:

Location of configuration files

References getDir().

const string & DataDir::getDir

(

)

Returns:

Data installation directory

Referenced by getConfDir(), and getDocDir().

const string DataDir::getDocDir

(

)

Returns:

Location of documentation (README) files (GUI)

References getDir().

const string DataDir::getExtDir

(

)

Returns:

Location of GUI file extension filter files

const string DataDir::getI18nDir

(

)

Returns:

Location of GUI menu translation files

const string DataDir::getLangPath	(	const string &	file = "",
		bool	forceDefault = false
	)

Parameters:

	file	filename
	forceDefault	set tue if additional directory should be ignored

Returns:

Location of languafe definitions

References getAdditionalLangDefDir().

Referenced by HLCmdLineApp::run().

const string DataDir::getThemePath	(	const string &	file = "",
		bool	forceDefault = false
	)

Parameters:

	file	filename
	forceDefault	set tue if additional directory should be ignored

Returns:

Location of themes

References getAdditionalThemeDir().

Referenced by HLCmdLineApp::run().

bool DataDir::searchDataDir

(

const string &

userDefinedDir

)

search for a valid installation directory

Parameters:

userDefinedDir

Directory defined by user

Returns:

True if directory was found

Referenced by HLCmdLineApp::run().

void DataDir::setAdditionalConfDir

(

const string &

dir

)

add another installation directory, which is added to search path

Parameters:

dir

Directory defined by user

Referenced by HLCmdLineApp::run().

void DataDir::setAdditionalDataDir

(

const string &

dir

)

add another installation directory, which is added to search path

Parameters:

dir

Directory defined by user

Referenced by HLCmdLineApp::run().

---

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

• datadir.h
• datadir.cpp