GCF LOGO VCL LOGO
GCF::SettingsLoadEvent Class Reference

Contains parameters that describe an settings load event

#include <GCF3/Component>
.

Public Member Functions

bool isPreSettingsLoad () const
 
bool isPostSettingsLoad () const
 
void setSettingsFile (const QString &fileName)
 
QString settingsFile () const
 

Member Function Documentation

bool GCF::SettingsLoadEvent::isPreSettingsLoad ( ) const
Returns
true if this class describes a pre-settings load event, false otherwise.
See Also
GCF::Component::settingsLoadEvent()
bool GCF::SettingsLoadEvent::isPostSettingsLoad ( ) const
Returns
true if this class describes a post-settings load event, false otherwise.
See Also
GCF::Component::settingsLoadEvent()
void GCF::SettingsLoadEvent::setSettingsFile ( const QString &  fileName)

Use this function to set the settings file for loading.

Parameters
fileNamename of the settings file to load.
Note
the fileName is either absolute or relative to the location of the executable. If no name is passed then the settings file is assumed to be a INI file in component's name (GCF::Component::name()) stored in the settings directory (GCF::settingsDirectory())
This function should only be used if isPreSettingsLoad() returns true.
See Also
GCF::Component::settingsLoadEvent()
QString GCF::SettingsLoadEvent::settingsFile ( ) const
Returns
When isPreSettingsLoad() returns true, the function returns name of the settings file set via the setSettingsFile() method. When isPostSettingsLoad() returns true, the function returns name of the settings file that was actually used to load the settings.
See Also
GCF::Component::settingsLoadEvent()