Public Types | Public Member Functions | List of all members
idoc::IDocumentMetaInfo Class Referenceabstract

Interface for document meta-information. More...

#include <IDocumentMetaInfo.h>

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

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_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...
 

Public Member Functions

virtual MetaInfoTypes GetMetaInfoTypes (bool allowReadOnly=true) const =0
 Get list of contained meta info types. More...
 
virtual QVariant GetMetaInfo (int metaInfoType) const =0
 Get document's meta info. More...
 
virtual bool SetMetaInfo (int metaInfoType, const QVariant &metaInfo)=0
 Set new document's meta information for a given meta type. More...
 
virtual QString GetMetaInfoName (int metaInfoType) const =0
 Get a human readable name for a given meta information type. More...
 
virtual QString GetMetaInfoDescription (int metaInfoType) const =0
 Get a human readable description for a given meta information type. More...
 
virtual bool IsMetaInfoWritable (int metaInfoType) const =0
 Check if meta information can be changed. 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 IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this 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 ()
 

Additional Inherited Members

- 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

Interface for document meta-information.

Definition at line 19 of file IDocumentMetaInfo.h.

Member Typedef Documentation

Definition at line 75 of file IDocumentMetaInfo.h.

Member Enumeration Documentation

Data model change notification flags.

Enumerator
CF_METAINFO 

Meta information has been changed.

Definition at line 26 of file IDocumentMetaInfo.h.

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_USER 

Starting of user defined meta info types.

Definition at line 37 of file IDocumentMetaInfo.h.

Member Function Documentation

virtual QVariant idoc::IDocumentMetaInfo::GetMetaInfo ( int  metaInfoType) const
pure virtual

Get document's meta info.

Implemented in idoc::CStandardDocumentMetaInfo.

virtual QString idoc::IDocumentMetaInfo::GetMetaInfoDescription ( int  metaInfoType) const
pure virtual

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

Implemented in idoc::CStandardDocumentMetaInfo.

virtual QString idoc::IDocumentMetaInfo::GetMetaInfoName ( int  metaInfoType) const
pure virtual

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

Implemented in idoc::CStandardDocumentMetaInfo.

virtual MetaInfoTypes idoc::IDocumentMetaInfo::GetMetaInfoTypes ( bool  allowReadOnly = true) const
pure 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.

Implemented in idoc::CStandardDocumentMetaInfo.

virtual bool idoc::IDocumentMetaInfo::IsMetaInfoWritable ( int  metaInfoType) const
pure virtual

Check if meta information can be changed.

Implemented in idoc::CStandardDocumentMetaInfo.

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

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

Implemented in idoc::CStandardDocumentMetaInfo.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy