Message container displaying messages as log list. More...

#include <CTextFileLogStreamerComp.h>

Inheritance diagram for ifile::CTextFileLogStreamerComp:

Public Types
typedef ilog::CStreamLogCompBase	BaseClass

Public Types inherited from ilog::CStreamLogCompBase
typedef ilog::CLogCompBase	BaseClass
	Base class typedef.

Public Types inherited from ilog::CLogCompBase
typedef ilog::TMessageDelegatorComp< icomp::CComponentBase >	BaseClass
	Base class typedef for component functionality.

typedef QObject	BaseClass2
	Base class typedef for QObject functionality.

Public Types inherited from ilog::TMessageDelegatorComp< icomp::CComponentBase >
typedef icomp::CComponentBase	BaseClass
	Base class typedef.

Public Types inherited from ilog::IMessageConsumer
typedef istd::TSharedInterfacePtr< istd::IInformationProvider >	MessagePtr
	Shared pointer type for message objects.

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
	CTextFileLogStreamerComp ()

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::CStreamLogCompBase
	CStreamLogCompBase ()

istd::IInformationProvider::InformationCategory	GetWorseCategory () const
	Get worse category (highest code) of all outputed messages.

virtual bool	IsMessageSupported (int messageCategory=-1, int messageId=-1, const istd::IInformationProvider *messagePtr=NULL) const override
	Check if a message is supported.

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

virtual void	AddMessage (const MessagePtr &messagePtr) override
	Add a message to this log component.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.

virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.

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

Protected Member Functions
virtual void	WriteText (const QString &text, istd::IInformationProvider::InformationCategory category) override
	Write a text line to the output stream.

virtual void	OnComponentCreated () override

virtual void	OnComponentDestroyed () override

Protected Member Functions inherited from ilog::CStreamLogCompBase
virtual void	WriteMessageToStream (const istd::IInformationProvider &message)
	Write formatted message to the output stream.

virtual QString	GenerateMessageText (const istd::IInformationProvider &message) const
	Generate formatted message text for the output.

virtual void	WriteMessageToLog (const MessagePtr &messagePtr) override
	Abstract method called to process a message.

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Additional Inherited Members
Signals inherited from ilog::CLogCompBase
void	EmitAddMessage (const MessagePtr &messagePtr)
	Signal emitted when a message is added.

Static Protected Member Functions inherited from icomp::CComponentBase
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Message container displaying messages as log list.

Definition at line 22 of file CTextFileLogStreamerComp.h.

Member Typedef Documentation

◆ BaseClass

typedef ilog::CStreamLogCompBase ifile::CTextFileLogStreamerComp::BaseClass

Definition at line 27 of file CTextFileLogStreamerComp.h.

Constructor & Destructor Documentation

◆ CTextFileLogStreamerComp()

ifile::CTextFileLogStreamerComp::CTextFileLogStreamerComp ( )

Member Function Documentation

◆ GetFileExtensions()

virtual bool ifile::CTextFileLogStreamerComp::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 ifile::CTextFileLogStreamerComp::GetTypeDescription ( const QString * extensionPtr = NULL ) const

overridevirtual

Get description of object type associated with single extension.

Implements ifile::IFileTypeInfo.

◆ IsOperationSupported()

virtual bool ifile::CTextFileLogStreamerComp::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 ifile::CTextFileLogStreamerComp::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.

◆ OnComponentCreated()

virtual void ifile::CTextFileLogStreamerComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

virtual void ifile::CTextFileLogStreamerComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Reimplemented from ilog::CStreamLogCompBase.

◆ SaveToFile()

virtual ifile::IFilePersistence::OperationState ifile::CTextFileLogStreamerComp::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.

◆ WriteText()

virtual void ifile::CTextFileLogStreamerComp::WriteText	(	const QString &	text,
		istd::IInformationProvider::InformationCategory	category
	)

overrideprotectedvirtual

Write a text line to the output stream.

Implements ilog::CStreamLogCompBase.

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

Acf/Include/ifile/CTextFileLogStreamerComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CTextFileLogStreamerComp()

Member Function Documentation

◆ GetFileExtensions()

◆ GetTypeDescription()

◆ IsOperationSupported()

◆ LoadFromFile()

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ SaveToFile()

◆ WriteText()