#include <configFile.h>

Public Member Functions
	ConfigFile ()

	~ConfigFile ()

void	addRecentFile (const std::string &str)

void	getRecentFiles (std::vector< std::string > &filenames) const

void	removeRecentFile (const std::string &str)

unsigned int	read ()

bool	write ()

bool	configLoadedOK () const

std::string	getErrMessage () const

void	getFilterDefaults (std::vector< Filter * > &defs)

void	setFilterDefaults (const std::vector< Filter * > &defs)

Filter *	getDefaultFilter (unsigned int type) const

bool	getHaveMaxPoints () const

size_t	getMaxPoints () const

void	setMaxPoints (size_t maxP)

bool	getPanelEnabled (unsigned int panelID) const
	Return startup status of UI panels. More...

void	setPanelEnabled (unsigned int panelID, bool enabled, bool permanent=false)
	Return startup status of UI panels. More...

unsigned int	getMouseMoveRate () const
	Get the mouse movement rate (for all but zoom) More...

unsigned int	getMouseZoomRate () const
	Get the mouse movement rate for zoom. More...

void	setMouseZoomRate (unsigned int rate)

void	setMouseMoveRate (unsigned int rate)

unsigned int	getStartupPanelMode () const
	Return the current panelmode. More...

void	setStartupPanelMode (unsigned int panelM)
	Set the mode to use for recalling the startup panel layout. More...

bool	getInitialAppSize (unsigned int &x, unsigned int &y) const
	Returns true if we have a suggested initial window size; with x & y being the suggestion. More...

void	setInitialAppSize (unsigned int x, unsigned int y)
	Set the initial window suggested size. More...

bool	getAllowOnlineVersionCheck () const

void	setAllowOnline (bool v)
	Set if the program is allowed to access network resources. More...

void	setAllowOnlineVersionCheck (bool v)
	Set if the program is allowed to phone home to get latest version #s. More...

void	setLeftRightSashPos (float fraction)
	Set the position for the main window left/right sash. More...

void	setTopBottomSashPos (float fraction)
	Set the position for the top/bottom sash. More...

void	setFilterSashPos (float fraction)
	Set the position for the filter property/tree sash. More...

void	setPlotListSashPos (float fraction)
	Set the position for the plot list panel. More...

float	getLeftRightSashPos () const
	Set the position for the main window left/right sash. More...

float	getTopBottomSashPos () const
	Set the position for the top/bottom sash. More...

float	getFilterSashPos () const
	Set the position for the filter property/tree sash. More...

float	getPlotListSashPos () const
	Set the position for the plot list panel. More...

bool	wantStartupTips () const
	Does the user want startup tips. More...

void	setWantStartupTips (bool want)
	Set if tips are to be shown on startup. More...

bool	getWantStartupOrthoCam () const
	Get if user wants an orhtographic camera on startup. More...

void	setWantStartupOrthoCam (bool want)

Static Public Member Functions
static bool	createConfigDir ()

static std::string	getConfigDir ()

static unsigned int	getMaxHistory ()

Constructor & Destructor Documentation

◆ ConfigFile()

ConfigFile::ConfigFile ( )

◆ ~ConfigFile()

ConfigFile::~ConfigFile ( )

Member Function Documentation

◆ addRecentFile()

void ConfigFile::addRecentFile ( const std::string & str )

References MAX_RECENT.

◆ configLoadedOK()

bool ConfigFile::configLoadedOK ( ) const

inline

References createConfigDir(), and getConfigDir().

◆ createConfigDir()

bool ConfigFile::createConfigDir ( )

static

References getConfigDir().

Referenced by configLoadedOK(), and write().

Here is the caller graph for this function:

◆ getAllowOnlineVersionCheck()

bool ConfigFile::getAllowOnlineVersionCheck ( ) const

Referenced by MainWindowFrame::MainWindowFrame(), and setMouseMoveRate().

Here is the caller graph for this function:

◆ getConfigDir()

std::string ConfigFile::getConfigDir ( )

static

References PROGRAM_NAME, and stlStr().

Referenced by configLoadedOK(), createConfigDir(), read(), and write().

Here is the caller graph for this function:

◆ getDefaultFilter()

Filter * ConfigFile::getDefaultFilter ( unsigned int type ) const

References ASSERT, and makeFilter().

Referenced by filterCloneTests(), and getErrMessage().

Here is the caller graph for this function:

◆ getErrMessage()

std::string ConfigFile::getErrMessage ( ) const

inline

References getDefaultFilter(), getFilterDefaults(), getMaxHistory(), and setFilterDefaults().

Referenced by MainWindowFrame::MainWindowFrame().

Here is the caller graph for this function:

◆ getFilterDefaults()

void ConfigFile::getFilterDefaults ( std::vector< Filter * > & defs )

Referenced by getErrMessage().

Here is the caller graph for this function:

◆ getFilterSashPos()

float ConfigFile::getFilterSashPos ( ) const

inline

Set the position for the filter property/tree sash.

◆ getHaveMaxPoints()

bool ConfigFile::getHaveMaxPoints ( ) const

inline

◆ getInitialAppSize()

bool ConfigFile::getInitialAppSize	(	unsigned int &	x,
		unsigned int &	y
	)		const

Returns true if we have a suggested initial window size; with x & y being the suggestion.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ getLeftRightSashPos()

float ConfigFile::getLeftRightSashPos ( ) const

inline

Set the position for the main window left/right sash.

◆ getMaxHistory()

unsigned int ConfigFile::getMaxHistory ( )

static

References MAX_RECENT.

Referenced by getErrMessage(), and MainWindowFrame::MainWindowFrame().

Here is the caller graph for this function:

◆ getMaxPoints()

size_t ConfigFile::getMaxPoints ( ) const

inline

◆ getMouseMoveRate()

unsigned int ConfigFile::getMouseMoveRate ( ) const

inline

Get the mouse movement rate (for all but zoom)

◆ getMouseZoomRate()

unsigned int ConfigFile::getMouseZoomRate ( ) const

inline

Get the mouse movement rate for zoom.

◆ getPanelEnabled()

bool ConfigFile::getPanelEnabled ( unsigned int panelID ) const

Return startup status of UI panels.

References ASSERT, CONFIG_PANELMODE_NONE, CONFIG_PANELMODE_REMEMBER, CONFIG_PANELMODE_SPECIFY, and CONFIG_STARTUPPANEL_END_ENUM.

Referenced by setMaxPoints().

Here is the caller graph for this function:

◆ getPlotListSashPos()

float ConfigFile::getPlotListSashPos ( ) const

inline

Set the position for the plot list panel.

◆ getRecentFiles()

void ConfigFile::getRecentFiles ( std::vector< std::string > & filenames ) const

◆ getStartupPanelMode()

unsigned int ConfigFile::getStartupPanelMode ( ) const

Return the current panelmode.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ getTopBottomSashPos()

float ConfigFile::getTopBottomSashPos ( ) const

inline

Set the position for the top/bottom sash.

◆ getWantStartupOrthoCam()

bool ConfigFile::getWantStartupOrthoCam ( ) const

inline

Get if user wants an orhtographic camera on startup.

◆ read()

unsigned int ConfigFile::read ( )

References boolStrDec(), Filter::canBeHazardous(), CONFIG_ERR_BADFILE, CONFIG_ERR_NOFILE, CONFIG_ERR_NOPARSER, CONFIG_FILENAME, CONFIG_PANELMODE_END_ENUM, CONFIG_PANELMODE_NONE, CONFIG_STARTUPPANEL_CONTROL, CONFIG_STARTUPPANEL_END_ENUM, CONFIG_STARTUPPANEL_PLOTLIST, CONFIG_STARTUPPANEL_RAWDATA, getConfigDir(), makeFilter(), MAX_MOUSE_PERCENT, MAX_RECENT, Filter::readState(), stream_cast(), TRANS, XMLGetAttrib(), XMLGetNextElemAttrib(), XMLHelpFwdToElem(), and XMLHelpNextType().

Referenced by filterCloneTests(), and MainWindowFrame::MainWindowFrame().

Here is the caller graph for this function:

◆ removeRecentFile()

void ConfigFile::removeRecentFile ( const std::string & str )

◆ setAllowOnline()

void ConfigFile::setAllowOnline ( bool v )

Set if the program is allowed to access network resources.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setAllowOnlineVersionCheck()

void ConfigFile::setAllowOnlineVersionCheck ( bool v )

Set if the program is allowed to phone home to get latest version #s.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setFilterDefaults()

void ConfigFile::setFilterDefaults ( const std::vector< Filter * > & defs )

References ASSERT.

Referenced by getErrMessage().

Here is the caller graph for this function:

◆ setFilterSashPos()

void ConfigFile::setFilterSashPos ( float fraction )

Set the position for the filter property/tree sash.

References ASSERT.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setInitialAppSize()

void ConfigFile::setInitialAppSize	(	unsigned int	x,
		unsigned int	y
	)

Set the initial window suggested size.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setLeftRightSashPos()

void ConfigFile::setLeftRightSashPos ( float fraction )

Set the position for the main window left/right sash.

References ASSERT.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setMaxPoints()

void ConfigFile::setMaxPoints ( size_t maxP )

inline

References getPanelEnabled(), and setPanelEnabled().

◆ setMouseMoveRate()

void ConfigFile::setMouseMoveRate ( unsigned int rate )

inline

References getAllowOnlineVersionCheck(), getInitialAppSize(), getStartupPanelMode(), setAllowOnline(), setAllowOnlineVersionCheck(), setFilterSashPos(), setInitialAppSize(), setLeftRightSashPos(), setPlotListSashPos(), setStartupPanelMode(), and setTopBottomSashPos().

◆ setMouseZoomRate()

void ConfigFile::setMouseZoomRate ( unsigned int rate )

inline

◆ setPanelEnabled()

void ConfigFile::setPanelEnabled	(	unsigned int	panelID,
		bool	enabled,
		bool	permanent = `false`
	)

Return startup status of UI panels.

References ASSERT, CONFIG_PANELMODE_SPECIFY, and CONFIG_STARTUPPANEL_END_ENUM.

Referenced by setMaxPoints().

Here is the caller graph for this function:

◆ setPlotListSashPos()

void ConfigFile::setPlotListSashPos ( float fraction )

Set the position for the plot list panel.

References ASSERT.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setStartupPanelMode()

void ConfigFile::setStartupPanelMode ( unsigned int panelM )

Set the mode to use for recalling the startup panel layout.

References ASSERT, and CONFIG_PANELMODE_END_ENUM.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setTopBottomSashPos()

void ConfigFile::setTopBottomSashPos ( float fraction )

Set the position for the top/bottom sash.

References ASSERT.

Referenced by setMouseMoveRate().

Here is the caller graph for this function:

◆ setWantStartupOrthoCam()

void ConfigFile::setWantStartupOrthoCam ( bool want )

inline

◆ setWantStartupTips()

void ConfigFile::setWantStartupTips ( bool want )

inline

Set if tips are to be shown on startup.

◆ wantStartupTips()

bool ConfigFile::wantStartupTips ( ) const

inline

Does the user want startup tips.

◆ write()

bool ConfigFile::write ( )

References ASSERT, boolStrEnc(), CONFIG_FILENAME, CONFIG_STARTUPPANEL_CONTROL, CONFIG_STARTUPPANEL_END_ENUM, CONFIG_STARTUPPANEL_PLOTLIST, CONFIG_STARTUPPANEL_RAWDATA, createConfigDir(), getConfigDir(), PROGRAM_VERSION, STATE_FORMAT_XML, tabs(), and TRANS.

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

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ ConfigFile()

◆ ~ConfigFile()

Member Function Documentation

◆ addRecentFile()

◆ configLoadedOK()

◆ createConfigDir()

◆ getAllowOnlineVersionCheck()

◆ getConfigDir()

◆ getDefaultFilter()

◆ getErrMessage()

◆ getFilterDefaults()

◆ getFilterSashPos()

◆ getHaveMaxPoints()

◆ getInitialAppSize()

◆ getLeftRightSashPos()

◆ getMaxHistory()

◆ getMaxPoints()

◆ getMouseMoveRate()

◆ getMouseZoomRate()

◆ getPanelEnabled()

◆ getPlotListSashPos()

◆ getRecentFiles()

◆ getStartupPanelMode()

◆ getTopBottomSashPos()

◆ getWantStartupOrthoCam()

◆ read()

◆ removeRecentFile()

◆ setAllowOnline()

◆ setAllowOnlineVersionCheck()

◆ setFilterDefaults()

◆ setFilterSashPos()

◆ setInitialAppSize()

◆ setLeftRightSashPos()

◆ setMaxPoints()

◆ setMouseMoveRate()

◆ setMouseZoomRate()

◆ setPanelEnabled()

◆ setPlotListSashPos()

◆ setStartupPanelMode()

◆ setTopBottomSashPos()

◆ setWantStartupOrthoCam()

◆ setWantStartupTips()

◆ wantStartupTips()

◆ write()