Implementation of the basic document's meta information. More...

#include <CStandardDocumentMetaInfo.h>

Inheritance diagram for idoc::CStandardDocumentMetaInfo:

Collaboration diagram for idoc::CStandardDocumentMetaInfo:

Public Member Functions
MetaInfoTypes	GetMetaInfoTypes (bool allowReadOnly=true) const override
	Get list of contained meta info types.

QVariant	GetMetaInfo (int metaInfoType) const override
	Get document's meta info.

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

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

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

bool	IsMetaInfoWritable (int metaInfoType) const override
	Check if meta information can be changed.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

bool	IsEqual (const IChangeable &object) const override

bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

Public Member Functions inherited from idoc::IDocumentMetaInfo
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 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.

Public Member Functions inherited from iser::ISerializable
virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Additional Inherited Members
Public Types inherited from idoc::IDocumentMetaInfo
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...

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

Implementation of the basic document's meta information.

Definition at line 24 of file CStandardDocumentMetaInfo.h.

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > idoc::CStandardDocumentMetaInfo::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS ) const

overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns: new instance or nullptr, if this operation is not supported.

Reimplemented from istd::IChangeable.

Reimplemented in iimg::TMultiPageBitmap< BitmapImpl >, and iimg::TMultiPageBitmap< iimg::CBitmap >.

◆ CopyFrom()

bool idoc::CStandardDocumentMetaInfo::CopyFrom	(	const IChangeable &	object,
		CompatibilityMode	mode = CM_WITHOUT_REFS )

override

◆ GetMetaInfo()

QVariant idoc::CStandardDocumentMetaInfo::GetMetaInfo ( int metaInfoType ) const

overridevirtual

Get document's meta info.

Implements idoc::IDocumentMetaInfo.

◆ GetMetaInfoDescription()

QString idoc::CStandardDocumentMetaInfo::GetMetaInfoDescription ( int metaInfoType ) const

overridevirtual

Get a human readable description for a given meta information type.

Implements idoc::IDocumentMetaInfo.

◆ GetMetaInfoName()

QString idoc::CStandardDocumentMetaInfo::GetMetaInfoName ( int metaInfoType ) const

overridevirtual

Get a human readable name for a given meta information type.

Implements idoc::IDocumentMetaInfo.

◆ GetMetaInfoTypes()

MetaInfoTypes idoc::CStandardDocumentMetaInfo::GetMetaInfoTypes ( bool allowReadOnly = true ) const

overridevirtual

Get list of contained meta info types.

Parameters

allowReadOnly if enabled, read only types will be also listed out, if this flag is false only the writable types will be returned.

See also: IsMetaInfoWritable.

Implements idoc::IDocumentMetaInfo.

◆ IsEqual()

bool idoc::CStandardDocumentMetaInfo::IsEqual ( const IChangeable & object ) const

override

◆ IsMetaInfoWritable()

bool idoc::CStandardDocumentMetaInfo::IsMetaInfoWritable ( int metaInfoType ) const

overridevirtual

Check if meta information can be changed.

Implements idoc::IDocumentMetaInfo.

◆ ResetData()

bool idoc::CStandardDocumentMetaInfo::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS )

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns: true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

Reimplemented in idoc::TMultiPageDocumentWrap< Base >, and idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

◆ Serialize()

bool idoc::CStandardDocumentMetaInfo::Serialize ( iser::IArchive & archive )

overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also: iser::IArchive

Implements iser::ISerializable.

Reimplemented in idoc::TMultiPageDocumentWrap< Base >, and idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >.

Referenced by idoc::TMultiPageDocumentWrap< Base >::SerializePage().

◆ SetMetaInfo()

bool idoc::CStandardDocumentMetaInfo::SetMetaInfo	(	int	metaInfoType,
		const QVariant &	metaInfo )

overridevirtual

Set new document's meta information for a given meta type.

Implements idoc::IDocumentMetaInfo.

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

idoc/CStandardDocumentMetaInfo.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CloneMe()

◆ CopyFrom()

◆ GetMetaInfo()

◆ GetMetaInfoDescription()

◆ GetMetaInfoName()

◆ GetMetaInfoTypes()

◆ IsEqual()

◆ IsMetaInfoWritable()

◆ ResetData()

◆ Serialize()

◆ SetMetaInfo()