ICF 3.0.5.47
Technical documentation of ICF Libraries
ifileproc::IFileNamingParams Class Referenceabstract

Interface for calculation parameters of the new file name for any file item. More...

#include <IFileNamingParams.h>

Inheritance diagram for ifileproc::IFileNamingParams:
Collaboration diagram for ifileproc::IFileNamingParams:

Public Types

enum  OverwriteStrategy { RM_OVERWRITE , RM_NUMBERING }
 Strategy mode. More...
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

virtual OverwriteStrategy GetOverwriteStrategy () const =0
 Get used strategy for possible overwriting of existing files.
 
virtual void SetOverwriteStrategy (OverwriteStrategy overwriteStrategy)=0
 Set renaming mode.
 
virtual QString GetPrefix () const =0
 Get prefix of the file.
 
virtual void SetPrefix (const QString &prefix)=0
 Set prefix of the file.
 
virtual QString GetSuffix () const =0
 Set suffix of the file.
 
virtual void SetSuffix (const QString &suffix)=0
 Get suffix of the file.
 
virtual QStringList GetPatternsToRemove () const =0
 Get list of text patterns, that must be removed from the output file name.
 
virtual void SetPatternsToRemove (const QStringList &patternsToRemove)=0
 Set list of text patterns, that must be removed from the output file name.
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream.
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual std::unique_ptr< IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 

Detailed Description

Interface for calculation parameters of the new file name for any file item.

See also
IFileNaming

Definition at line 22 of file IFileNamingParams.h.

Member Enumeration Documentation

◆ OverwriteStrategy

Strategy mode.

Enumerator
RM_OVERWRITE 

Output file name is equals the input file name.

RM_NUMBERING 

Output file name will be automatic numbered if the file already exists.

Definition at line 28 of file IFileNamingParams.h.

Member Function Documentation

◆ GetOverwriteStrategy()

virtual OverwriteStrategy ifileproc::IFileNamingParams::GetOverwriteStrategy ( ) const
pure virtual

Get used strategy for possible overwriting of existing files.

See also
OverwriteStrategy

Implemented in ifileproc::CFileNamingParams.

◆ GetPatternsToRemove()

virtual QStringList ifileproc::IFileNamingParams::GetPatternsToRemove ( ) const
pure virtual

Get list of text patterns, that must be removed from the output file name.

See also
SetPatternsToRemove

Implemented in ifileproc::CFileNamingParams.

◆ GetPrefix()

virtual QString ifileproc::IFileNamingParams::GetPrefix ( ) const
pure virtual

Get prefix of the file.

Implemented in ifileproc::CFileNamingParams.

◆ GetSuffix()

virtual QString ifileproc::IFileNamingParams::GetSuffix ( ) const
pure virtual

Set suffix of the file.

Implemented in ifileproc::CFileNamingParams.

◆ SetOverwriteStrategy()

virtual void ifileproc::IFileNamingParams::SetOverwriteStrategy ( OverwriteStrategy overwriteStrategy)
pure virtual

Set renaming mode.

See also
OverwriteStrategy

Implemented in ifileproc::CFileNamingParams.

◆ SetPatternsToRemove()

virtual void ifileproc::IFileNamingParams::SetPatternsToRemove ( const QStringList & patternsToRemove)
pure virtual

Set list of text patterns, that must be removed from the output file name.

For example, the file name foo_some.txt will be transformed into foo.txt if _some pattern is set.

See also
GetPatternsToRemove

Implemented in ifileproc::CFileNamingParams.

◆ SetPrefix()

virtual void ifileproc::IFileNamingParams::SetPrefix ( const QString & prefix)
pure virtual

Set prefix of the file.

Implemented in ifileproc::CFileNamingParams.

◆ SetSuffix()

virtual void ifileproc::IFileNamingParams::SetSuffix ( const QString & suffix)
pure virtual

Get suffix of the file.

Implemented in ifileproc::CFileNamingParams.


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

© Witold Gantzke and Kirill Lepskiy