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

#include <CSettingsSerializerComp.h>

Inheritance diagram for ifile::CSettingsSerializerComp:

Collaboration diagram for ifile::CSettingsSerializerComp:

Public Types
typedef ilog::CLoggerComponentBase	BaseClass

Public Types inherited from ilog::TLoggerCompWrap< Base >
enum	MessageId { MI_BAD_DEPENDENCY = 0x8a340 }

typedef Base	BaseClass

typedef ilog::CLoggerBase	BaseClass2

Public Types inherited from ifile::IFilePersistence
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=nullptr, int flags=-1, bool beQuiet=true) const override
	Returns `true` if object `dataObject` can be loaded/saved.

virtual iproc::CTaskState	LoadFromFile (istd::IChangeable &data, const QString &filePath=QString(), iproc::IProgressManager *progressManagerPtr=nullptr) const override
	This function loads data `data` from file `filePath`.

virtual iproc::CTaskState	SaveToFile (const istd::IChangeable &data, const QString &filePath=QString(), iproc::IProgressManager *progressManagerPtr=nullptr) const override
	This function saves data `data` to file `filePath`.

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

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

Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()

const QByteArray &	GetVerboseSenderId () const
	Get sender ID for verbose messages.

void	SetVerboseSenderId (const QByteArray &id)
	Set sender ID for verbose messages.

void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Install log.

ilog::IMessageConsumer *	GetLogPtr () const override
	Get log.

Public Member Functions inherited from ilog::ILoggable
Public Member Functions inherited from ifile::IFilePersistence
Public Member Functions inherited from ifile::IFileTypeInfo

Protected Member Functions
void	OnComponentCreated () override

Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message parts before outputting.

void	OnComponentCreated () override

void	OnComponentDestroyed () override

Protected Member Functions inherited from ilog::CLoggerBase
bool	IsVerboseEnabled () const
	Check if verbose messages are enabled.

bool	SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
	Send verbose message.

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.

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

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 Member Functions inherited from istd::ILogger

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

Detailed Description

Store and load parameter as global settings.

Definition at line 27 of file CSettingsSerializerComp.h.

Member Typedef Documentation

◆ BaseClass

ilog::CLoggerComponentBase ifile::CSettingsSerializerComp::BaseClass

Definition at line 32 of file CSettingsSerializerComp.h.

Member Function Documentation

◆ GetFileExtensions()

bool ifile::CSettingsSerializerComp::GetFileExtensions	(	QStringList &	result,
		const istd::IChangeable *	dataObjectPtr = nullptr,
		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 nullptr 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()

QString ifile::CSettingsSerializerComp::GetTypeDescription ( const QString * extensionPtr = nullptr ) const

overridevirtual

Get description of object type associated with single extension.

Implements ifile::IFileTypeInfo.

◆ IsOperationSupported()

virtual bool ifile::CSettingsSerializerComp::IsOperationSupported	(	const istd::IChangeable *	dataObjectPtr,
		const QString *	filePathPtr = nullptr,
		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 nullptr if any object is meant.
filePathPtr	optional pointer to file should be loaded/stored. It can be nullptr 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 iproc::CTaskState ifile::CSettingsSerializerComp::LoadFromFile	(	istd::IChangeable &	data,
		const QString &	filePath = QString(),
		iproc::IProgressManager *	progressManagerPtr = nullptr ) const

overridevirtual

This function loads data data from file filePath.

Returns: File loading state.

See also: Status

Implements ifile::IFilePersistence.

◆ OnComponentCreated()

void ifile::CSettingsSerializerComp::OnComponentCreated ( )

overrideprotected

◆ SaveToFile()

virtual iproc::CTaskState ifile::CSettingsSerializerComp::SaveToFile	(	const istd::IChangeable &	data,
		const QString &	filePath = QString(),
		iproc::IProgressManager *	progressManagerPtr = nullptr ) const

overridevirtual

This function saves data data to file filePath.

Returns: File saving state.

See also: Status

Implements ifile::IFilePersistence.

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

ifile/CSettingsSerializerComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetFileExtensions()

◆ GetTypeDescription()

◆ IsOperationSupported()

◆ LoadFromFile()

◆ OnComponentCreated()

◆ SaveToFile()