Allows to store some document state used as reference for comarision. More...

Inheritance diagram for idoc::IDocumentStateComparator:

Collaboration diagram for idoc::IDocumentStateComparator:

Public Types
enum	DocumentChangeFlag { DCF_UNKNOWN , DCF_EQUAL , DCF_DIFFERENT }

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 bool	HasStoredDocumentState () const =0
	Check if there is stored document available.

virtual bool	StoreDocumentState ()=0
	Store state of some document.

virtual bool	RestoreDocumentState ()=0
	Restore last stored document state.

virtual DocumentChangeFlag	GetDocumentChangeFlag () const =0
	Check if document state is the same as stored state.

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

Allows to store some document state used as reference for comarision.

Definition at line 20 of file IDocumentStateComparator.h.

Member Enumeration Documentation

Enumerator
DCF_UNKNOWN	There is no information about document change.
DCF_EQUAL	Current document state equals the stored one.
DCF_DIFFERENT	Current document state equals the stored one.

Definition at line 23 of file IDocumentStateComparator.h.

virtual DocumentChangeFlag idoc::IDocumentStateComparator::GetDocumentChangeFlag ( ) const

pure virtual

Check if document state is the same as stored state.

virtual bool idoc::IDocumentStateComparator::HasStoredDocumentState ( ) const

pure virtual

Check if there is stored document available.

virtual bool idoc::IDocumentStateComparator::RestoreDocumentState ( )

pure virtual

Restore last stored document state.

virtual bool idoc::IDocumentStateComparator::StoreDocumentState ( )

pure virtual

Store state of some document.

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