ICF 3.0.5.47
Technical documentation of ICF Libraries
ifile::IFileTypeInfo Class Referenceabstract

Provide loading and saving of objects. More...

#include <IFileTypeInfo.h>

Inheritance diagram for ifile::IFileTypeInfo:
Collaboration diagram for ifile::IFileTypeInfo:

Public Types

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 GetFileExtensions (QStringList &result, const istd::IChangeable *dataObjectPtr=nullptr, int flags=-1, bool doAppend=false) const =0
 Get file extensions supported by this loader.
 
virtual QString GetTypeDescription (const QString *extensionPtr=nullptr) const =0
 Get description of object type associated with single extension.
 

Detailed Description

Provide loading and saving of objects.

Definition at line 25 of file IFileTypeInfo.h.

Member Enumeration Documentation

◆ QueryFlags

Describe detailed options of query.

Enumerator
QF_LOAD 

Check for load operation.

QF_SAVE 

Check for save operation.

QF_FILE 

Operations with specified file name should be considered.

QF_DIRECTORY 

Operations with specified directory name should be considered.

QF_ANONYMOUS 

Operations without specified path (anonymous) should be considered.

Definition at line 31 of file IFileTypeInfo.h.

Member Function Documentation

◆ GetFileExtensions()

virtual bool ifile::IFileTypeInfo::GetFileExtensions ( QStringList & result,
const istd::IChangeable * dataObjectPtr = nullptr,
int flags = -1,
bool doAppend = false ) const
pure virtual

Get file extensions supported by this loader.

Parameters
resultlist of extensions, e.g. {"txt", "doc"}.
dataObjectPtroptional pointer to data object for which all possible extensions are requested. It can be nullptr if any object is meant.
flagsset of flags
See also
QueryFlags.
Parameters
doAppendif true, list of extensions should be appended to existing list.

Implemented in icmpstr::CRegistrySerializerComp, idoc::CMultiPageDocumentFilePersistenceComp, idoc::CTextFilePersistenceComp, idocgui::CClipboardSerializerComp, idocgui::CDocPreviewGuiComp, ifile::CComposedFilePersistenceComp, ifile::CFileTypeInfoComp, ifile::CSettingsSerializerComp, ifilegui::CFileDialogPersistenceComp, iimg::CBitmapPersistenceComp, iipr::CRenderedObjectFileLoaderComp, imeas::CWavSamplesSaverComp, and ipackage::CRegistryCodeSaverComp.

◆ GetTypeDescription()


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

© Witold Gantzke and Kirill Lepskiy