Store and load parameter as global settings. More...

#include <CSettingsSerializerComp.h>

Inheritance diagram for iqt::CSettingsSerializerComp:

Public Types
typedef ilog::CLoggerComponentBase	BaseClass

Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base	BaseClass
	Base class typedef for component functionality.

typedef ilog::CLoggerBase	BaseClass2
	Base class typedef for logger functionality.

Public Types inherited from ifile::IFilePersistence
enum	OperationState { OS_OK , OS_CANCELED , OS_FAILED }
	Result of operation. More...

enum	ErrorType { ET_NO_WRITE_PERMISSIONS , ET_NO_READ_PERMISSIONS , ET_FILE_NOT_EXIST }
	Possible file I/O errors. More...

enum	MessageId { MI_BAD_OBJECT_TYPE = 0xabf0 , MI_CANNOT_LOAD , MI_CANNOT_SAVE , MI_BAD_EXTENSION , MI_FILE_NOT_EXIST , MI_UNSUPPORTED_VERSION }
	List of possible message IDs used in context of this interface. More...

Public Types inherited from ifile::IFileTypeInfo
enum	QueryFlags { QF_LOAD = 1 << 0 , QF_SAVE = 1 << 1 , QF_FILE = 1 << 2 , QF_DIRECTORY = 1 << 3 , QF_ANONYMOUS = 1 << 4 }
	Describe detailed options of query. More...

Public Member Functions
virtual bool	IsOperationSupported (const istd::IChangeable dataObjectPtr, const QString filePathPtr=NULL, int flags=-1, bool beQuiet=true) const override
	Returns `true` if object `dataObject` can be loaded/saved.

virtual ifile::IFilePersistence::OperationState	LoadFromFile (istd::IChangeable &data, const QString &filePath=QString(), ibase::IProgressManager *progressManagerPtr=NULL) const override
	This function loads data `data` from file `filePath`.

virtual ifile::IFilePersistence::OperationState	SaveToFile (const istd::IChangeable &data, const QString &filePath=QString(), ibase::IProgressManager *progressManagerPtr=NULL) const override
	This function saves data `data` to file `filePath`.

virtual bool	GetFileExtensions (QStringList &result, const istd::IChangeable *dataObjectPtr=NULL, int flags=-1, bool doAppend=false) const override
	Get file extensions supported by this loader.

virtual QString	GetTypeDescription (const QString *extensionPtr=NULL) const override
	Get description of object type associated with single extension.

Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()
	Default constructor.

virtual void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Attach a message consumer for logging.

virtual ilog::IMessageConsumer *	GetLogPtr () const override
	Get the currently attached message consumer.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool	IsVerboseEnabled (int tracingLevel=0) const
	Check if verbose messages are enabled for a given tracing level.

void	SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
	Send a verbose message if enabled.

virtual void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message before sending.

virtual void	OnComponentCreated () override
	Called when component is created.

virtual void	OnComponentDestroyed () override
	Called when component is destroyed.

Protected Member Functions inherited from ilog::CLoggerBase
bool	SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send info message to log.

bool	SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send warning message to log.

bool	SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send error message to log.

bool	SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send critical message to log.

bool	SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once info message to log.

bool	SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once warning message to log.

bool	SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once error message to log.

bool	SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once critical message to log.

bool	SendUserMessage (const istd::IInformationProvider *messagePtr) const
	Send message with user object.

bool	AllowMessageOnceAgain (int id)
	Reset message lock.

virtual bool	IsLogConsumed (const istd::IInformationProvider::InformationCategory categoryPtr=NULL, const int flagsPtr=NULL) const override
	Check if any log message is consumed.

virtual bool	SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
	Send any message to log.

Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Detailed Description

Store and load parameter as global settings.

Definition at line 25 of file CSettingsSerializerComp.h.

Member Typedef Documentation

◆ BaseClass

typedef ilog::CLoggerComponentBase iqt::CSettingsSerializerComp::BaseClass

Definition at line 30 of file CSettingsSerializerComp.h.

Member Function Documentation

◆ GetFileExtensions()

virtual bool iqt::CSettingsSerializerComp::GetFileExtensions	(	QStringList &	result,
		const istd::IChangeable *	dataObjectPtr = `NULL`,
		int	flags = `-1`,
		bool	doAppend = `false`
	)		const

overridevirtual

Get file extensions supported by this loader.

Parameters

result	list of extensions, e.g. {"txt", "doc"}.
dataObjectPtr	optional pointer to data object for which all possible extensions are requested. It can be NULL if any object is meant.
flags	set of flags

See also: QueryFlags.

Parameters

doAppend if true, list of extensions should be appended to existing list.

Implements ifile::IFileTypeInfo.

◆ GetTypeDescription()

virtual QString iqt::CSettingsSerializerComp::GetTypeDescription ( const QString * extensionPtr = NULL ) const

overridevirtual

Get description of object type associated with single extension.

Implements ifile::IFileTypeInfo.

◆ IsOperationSupported()

virtual bool iqt::CSettingsSerializerComp::IsOperationSupported	(	const istd::IChangeable *	dataObjectPtr,
		const QString *	filePathPtr = `NULL`,
		int	flags = `-1`,
		bool	beQuiet = `true`
	)		const

overridevirtual

Returns true if object dataObject can be loaded/saved.

Parameters

dataObjectPtr	optional pointer to data object should be loaded/stored. It can be NULL if any object is meant.
filePathPtr	optional pointer to file should be loaded/stored. It can be NULL if any file is meant. If it points at empty string, anonymous loading is mean.
flags	combination of flags defined in `QueryFlags` and `ifile::IFileTypeInfo::QueryFlags`.
beQuiet	if true, no user message output is allowed.

Implements ifile::IFilePersistence.

◆ LoadFromFile()

virtual ifile::IFilePersistence::OperationState iqt::CSettingsSerializerComp::LoadFromFile	(	istd::IChangeable &	data,
		const QString &	filePath = `QString()`,
		ibase::IProgressManager *	progressManagerPtr = `NULL`
	)		const

overridevirtual

This function loads data data from file filePath.

Returns: File loading state.

See also: OperationState

Implements ifile::IFilePersistence.

◆ SaveToFile()

virtual ifile::IFilePersistence::OperationState iqt::CSettingsSerializerComp::SaveToFile	(	const istd::IChangeable &	data,
		const QString &	filePath = `QString()`,
		ibase::IProgressManager *	progressManagerPtr = `NULL`
	)		const

overridevirtual

This function saves data data to file filePath.

Returns: File saving state.

See also: OperationState

Implements ifile::IFilePersistence.

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

Acf/Include/iqt/CSettingsSerializerComp.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetFileExtensions()

◆ GetTypeDescription()

◆ IsOperationSupported()

◆ LoadFromFile()

◆ SaveToFile()