File dialog component. More...

#include <CFileDialogPersistenceComp.h>

Inheritance diagram for ifilegui::CFileDialogPersistenceComp:

Collaboration diagram for ifilegui::CFileDialogPersistenceComp:

Public Types
enum	MessageId { MI_NONE_SUPPORTS = 0xf8e0 }

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 Types inherited from ifile::IFilePersistenceInfo
enum	OperationType { OT_UNKNOWN , OT_LOAD , OT_SAVE }

enum	PathType { PT_COMPLETE , OT_FILENAME , OT_DIR }

Public Member Functions
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.

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

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.

QString	GetLastFilePath (OperationType operationType=OT_UNKNOWN, PathType pathType=PT_COMPLETE) const override
	Returns the last opened file name.

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
Public Member Functions inherited from ifile::IFilePersistenceInfo

Static Public Member Functions
static void	AppendLoaderFilterList (const ifile::IFileTypeInfo &fileTypeInfo, const istd::IChangeable *dataObjectPtr, int flags, QStringList &allExt, QStringList &result, bool allowCommonDescription=true)
	Append filters extracted from file loader to Qt filter list accepted by `QFileDialog`.

Protected Member Functions
QString	GetPathForType (const QFileInfo &fileInfo, PathType pathType) const

virtual QString	GetFileName (const istd::IChangeable &data, const QString &filePath, bool isSaving, int &selectionIndex) const

ifile::IFilePersistence *	GetLoaderFor (const istd::IChangeable *dataObjectPtr, const QString &filePath, int selectionIndex, int flags, bool beQuiet) const

void	OnComponentCreated () override

Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
virtual 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

File dialog component.

File dialog will be created according to set of the slave file loaders.

Definition at line 32 of file CFileDialogPersistenceComp.h.

Member Typedef Documentation

◆ BaseClass

ilog::CLoggerComponentBase ifilegui::CFileDialogPersistenceComp::BaseClass

Definition at line 39 of file CFileDialogPersistenceComp.h.

Member Enumeration Documentation

◆ MessageId

enum ifilegui::CFileDialogPersistenceComp::MessageId

Enumerator
MI_NONE_SUPPORTS

Definition at line 41 of file CFileDialogPersistenceComp.h.

Member Function Documentation

◆ AppendLoaderFilterList()

static void ifilegui::CFileDialogPersistenceComp::AppendLoaderFilterList	(	const ifile::IFileTypeInfo &	fileTypeInfo,
		const istd::IChangeable *	dataObjectPtr,
		int	flags,
		QStringList &	allExt,
		QStringList &	result,
		bool	allowCommonDescription = true )

static

Append filters extracted from file loader to Qt filter list accepted by QFileDialog.

Parameters

loader	file loader.
allExt	output list of all filters from extensions separated using semicolon (for example '.bmp;.png').
result	input/output list of filters with description separated with next line character.

Returns: number of filters.

Referenced by idocgui::TQtDocumentManagerWrap< Base, Gui >::CreateFileDialogFilters().

◆ GetFileExtensions()

bool ifilegui::CFileDialogPersistenceComp::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.

◆ GetFileName()

virtual QString ifilegui::CFileDialogPersistenceComp::GetFileName	(	const istd::IChangeable &	data,
		const QString &	filePath,
		bool	isSaving,
		int &	selectionIndex ) const

protectedvirtual

◆ GetLastFilePath()

QString ifilegui::CFileDialogPersistenceComp::GetLastFilePath	(	OperationType	operationType = OT_UNKNOWN,
		PathType	pathType = PT_COMPLETE ) const

overridevirtual

Returns the last opened file name.

Implements ifile::IFilePersistenceInfo.

◆ GetLoaderFor()

ifile::IFilePersistence * ifilegui::CFileDialogPersistenceComp::GetLoaderFor	(	const istd::IChangeable *	dataObjectPtr,
		const QString &	filePath,
		int	selectionIndex,
		int	flags,
		bool	beQuiet ) const

protected

◆ GetPathForType()

QString ifilegui::CFileDialogPersistenceComp::GetPathForType	(	const QFileInfo &	fileInfo,
		PathType	pathType ) const

protected

◆ GetTypeDescription()

QString ifilegui::CFileDialogPersistenceComp::GetTypeDescription ( const QString * extensionPtr = nullptr ) const

overridevirtual

Get description of object type associated with single extension.

Implements ifile::IFileTypeInfo.

◆ IsOperationSupported()

bool ifilegui::CFileDialogPersistenceComp::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()

iproc::CTaskState ifilegui::CFileDialogPersistenceComp::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 ifilegui::CFileDialogPersistenceComp::OnComponentCreated ( )

overrideprotected

◆ SaveToFile()

iproc::CTaskState ifilegui::CFileDialogPersistenceComp::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:

ifilegui/CFileDialogPersistenceComp.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ MessageId

Member Function Documentation

◆ AppendLoaderFilterList()

◆ GetFileExtensions()

◆ GetFileName()

◆ GetLastFilePath()

◆ GetLoaderFor()

◆ GetPathForType()

◆ GetTypeDescription()

◆ IsOperationSupported()

◆ LoadFromFile()

◆ OnComponentCreated()

◆ SaveToFile()