Interface for document meta-information. More...

#include <IDocumentMetaInfo.h>

Inheritance diagram for idoc::IDocumentMetaInfo:

Collaboration diagram for idoc::IDocumentMetaInfo:

Public Types
enum	ChangeFlags { CF_METAINFO = 0xd83067d }
	Data model change notification flags. More...

enum	MetaInfoType { MIT_TITLE , MIT_AUTHOR , MIT_CREATOR , MIT_DESCRIPTION , MIT_CREATION_TIME , MIT_MODIFICATION_TIME , MIT_CREATOR_VERSION , MIT_DOCUMENT_VERSION , MIT_CONTENT_CHECKSUM , MIT_USER = 1024 }
	Type of the meta information. More...

typedef QSet< int >	MetaInfoTypes

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 MetaInfoTypes	GetMetaInfoTypes (bool allowReadOnly=true) const =0
	Get list of contained meta info types.

virtual QVariant	GetMetaInfo (int metaInfoType) const =0
	Get document's meta info.

virtual bool	SetMetaInfo (int metaInfoType, const QVariant &metaInfo)=0
	Set new document's meta information for a given meta type.

virtual QString	GetMetaInfoName (int metaInfoType) const =0
	Get a human readable name for a given meta information type.

virtual QString	GetMetaInfoDescription (int metaInfoType) const =0
	Get a human readable description for a given meta information type.

virtual bool	IsMetaInfoWritable (int metaInfoType) const =0
	Check if meta information can be changed.

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

Interface for document meta-information.

Definition at line 23 of file IDocumentMetaInfo.h.

Member Typedef Documentation

◆ MetaInfoTypes

QSet<int> idoc::IDocumentMetaInfo::MetaInfoTypes

Definition at line 94 of file IDocumentMetaInfo.h.

Member Enumeration Documentation

◆ ChangeFlags

enum idoc::IDocumentMetaInfo::ChangeFlags

Data model change notification flags.

Enumerator
CF_METAINFO	Meta information has been changed.

Definition at line 30 of file IDocumentMetaInfo.h.

◆ MetaInfoType

enum idoc::IDocumentMetaInfo::MetaInfoType

Type of the meta information.

Enumerator
MIT_TITLE	Title of the document.
MIT_AUTHOR	Person, who has created the document.
MIT_CREATOR	Tool used for document creation.
MIT_DESCRIPTION	Document description.
MIT_CREATION_TIME	Document creation time.
MIT_MODIFICATION_TIME	Last document modification time.
MIT_CREATOR_VERSION	Version of the creation tool given as a QString.
MIT_DOCUMENT_VERSION	Version of the document given as a QString.
MIT_CONTENT_CHECKSUM	Checksum of the document data.
MIT_USER	Starting of user defined meta info types.