Public Member Functions | List of all members
idoc::CStandardDocumentMetaInfo Class Reference

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

#include <CStandardDocumentMetaInfo.h>

Inheritance diagram for idoc::CStandardDocumentMetaInfo:
idoc::IDocumentMetaInfo iser::ISerializable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic idoc::TMultiPageDocumentWrap< Base > idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument > iimg::CMultiPageBitmapBase iimg::CMultiPageBitmapSequenceComp iimg::CMultiPageBitmapComp iimg::TMultiPageBitmap< BitmapImpl >

Public Member Functions

virtual MetaInfoTypes GetMetaInfoTypes (bool allowReadOnly=true) const
 Get list of contained meta info types. More...
 
virtual QVariant GetMetaInfo (int metaInfoType) const
 Get document's meta info. More...
 
virtual bool SetMetaInfo (int metaInfoType, const QVariant &metaInfo)
 Set new document's meta information for a given meta type. More...
 
virtual QString GetMetaInfoName (int metaInfoType) const
 Get a human readable name for a given meta information type. More...
 
virtual QString GetMetaInfoDescription (int metaInfoType) const
 Get a human readable description for a given meta information type. More...
 
virtual bool IsMetaInfoWritable (int metaInfoType) const
 Check if meta information can be changed. More...
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
virtual bool IsEqual (const IChangeable &object) const
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 
virtual istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 

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_USER = 1024
}
 Type of the meta information. More...
 
typedef QSet< int > MetaInfoTypes
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_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
}
 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 ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Implementation of the basic document's meta information.

Definition at line 20 of file CStandardDocumentMetaInfo.h.

Member Function Documentation

virtual istd::IChangeable* idoc::CStandardDocumentMetaInfo::CloneMe ( CompatibilityMode  mode = CM_WITHOUT_REFS) const
virtual

Make a copy of this object.

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

Reimplemented from istd::IChangeable.

Reimplemented in iimg::TMultiPageBitmap< BitmapImpl >.

virtual bool idoc::CStandardDocumentMetaInfo::CopyFrom ( const IChangeable &  object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
virtual
virtual QVariant idoc::CStandardDocumentMetaInfo::GetMetaInfo ( int  metaInfoType) const
virtual

Get document's meta info.

Implements idoc::IDocumentMetaInfo.

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

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

Implements idoc::IDocumentMetaInfo.

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

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

Implements idoc::IDocumentMetaInfo.

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

Get list of contained meta info types.

Parameters
allowReadOnlyif 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.

virtual bool idoc::CStandardDocumentMetaInfo::IsEqual ( const IChangeable &  object) const
virtual
virtual bool idoc::CStandardDocumentMetaInfo::IsMetaInfoWritable ( int  metaInfoType) const
virtual

Check if meta information can be changed.

Implements idoc::IDocumentMetaInfo.

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

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().

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

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:

© 2007-2017 Witold Gantzke and Kirill Lepskiy