Persistent settings for the ReportGenerator module, including the path to the NCReport editor and a registry of custom report templates. More...

Inheritance diagram for ReportGeneratorSettings:

Collaboration diagram for ReportGeneratorSettings:

Public Member Functions
	ReportGeneratorSettings ()
	Constructs settings, loading from the report_generator.ini file.
Public Member Functions inherited from INIInterface
	INIInterface ()
	Constructs an INIInterface with no default INI file.
	INIInterface (const File &default_ini)
	Constructs an INIInterface with the specified default INI file.
virtual	~INIInterface ()
	Virtual destructor for safe polymorphic cleanup.
virtual void	finishReadingINI (INIFactory &)
	Called after reading an INI file.
virtual void	getINI (INIFactory &factory)=0
	Populates the given INI factory with the options managed by this interface.
virtual void	prepareForINI (INIFactory &)
	Called before reading or writing an INI file.
virtual bool	readINIOptions ()
	Reads INI options from the default INI file.
virtual bool	readINIOptions (File &ini_file)
	Reads INI options from the specified INI file.
virtual bool	saveINIOptions (bool multithead=false)
	Saves INI options to the default INI file.
virtual bool	saveINIOptions (File &ini_file, bool multithead=false)
	Saves INI options to the specified INI file.
void	setDefaultINIFile (const File &file)
	Sets the default INI file path used for reading and writing options.
virtual void	writeToLog (const StringView &title, LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log with a title.
virtual void	writeToLog (LogPtr log, uint01 log_level=2U)
	Writes the current INI options to the specified log.

Static Public Member Functions
static ReportGeneratorSettings &	DefaultSettings ()
	Returns the global singleton settings instance.

Public Attributes
Dictionary< String, NCCustomReport * >	custom_reports
	Named custom report templates.
Resource< String >	path_to_nc_editor
	File path to the NCReport editor executable.

Additional Inherited Members
Protected Attributes inherited from INIInterface
File	m_default_ini
	The default file path used for reading and writing INI options.

Detailed Description

Persistent settings for the ReportGenerator module, including the path to the NCReport editor and a registry of custom report templates.

Definition at line 12 of file ReportGeneratorSettings.h.

Member Function Documentation

ReportGeneratorSettings & ReportGeneratorSettings::DefaultSettings ( )

inlinestatic

Returns the global singleton settings instance.

Definition at line 32 of file ReportGeneratorSettings.h.

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