ifile::IFileNameParam Class Reference

Common interface for any file system item name (e.g directory, file or URL path) More...

#include <IFileNameParam.h>

Inheritance diagram for ifile::IFileNameParam:

Collaboration diagram for ifile::IFileNameParam:

Public Types
enum	PathType { PT_UNKNOWN , PT_FILE , PT_DIRECTORY , PT_URL }
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 int	GetPathType () const =0
	Get intended type of the path.
virtual const QString &	GetPath () const =0
	Get path.
virtual void	SetPath (const QString &path)=0
	Set path.
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< IChangeable >	CloneMe (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 ChangeSet &	GetNoChanges ()
	Get empty set of changes.
static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.
static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.
static const ChangeSet &	GetDelegatedChanges ()
	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

Common interface for any file system item name (e.g directory, file or URL path)

Definition at line 24 of file IFileNameParam.h.

Member Enumeration Documentation

PathType

enum ifile::IFileNameParam::PathType

Enumerator
PT_UNKNOWN
PT_FILE
PT_DIRECTORY
PT_URL

Definition at line 27 of file IFileNameParam.h.

Member Function Documentation

GetPath()

virtual const QString & ifile::IFileNameParam::GetPath ( ) const

pure virtual

Get path.

Implemented in ifile::CApplicationInfoBasedFileNameComp, ifile::CFileNameParam, ifile::CRelativeFileNameParamComp, ifile::CSystemLocationComp, and ifile::CTimeStampFileNameParamComp.

GetPathType()

virtual int ifile::IFileNameParam::GetPathType ( ) const

pure virtual

Get intended type of the path.

See also

PathType

Implemented in ifile::CFileNameParam, ifile::CFileNameParamComp, and ifile::CSystemLocationComp.

SetPath()

virtual void ifile::IFileNameParam::SetPath ( const QString & path )

pure virtual

Set path.

Implemented in ifile::CFileNameParam, ifile::CGeneratedFileNameParamComp, ifile::CRelativeFileNameParamComp, and ifile::CSystemLocationComp.

---

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

• ifile/IFileNameParam.h