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

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

#include <IDocumentStateComparator.h>

Inheritance diagram for idoc::IDocumentStateComparator:
istd::IChangeable istd::IPolymorphic idoc::IUndoManager idoc::CSerializedUndoManagerComp

Public Types

enum  DocumentChangeFlag { DCF_UNKNOWN, DCF_EQUAL, DCF_DIFFERENT }
 
- 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 bool HasStoredDocumentState () const =0
 Check if there is stored document available. More...
 
virtual bool StoreDocumentState ()=0
 Store state of some document. More...
 
virtual bool RestoreDocumentState ()=0
 Restore last stored document state. More...
 
virtual DocumentChangeFlag GetDocumentChangeFlag () const =0
 Check if document state is the same as stored state. 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

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

Definition at line 16 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 19 of file IDocumentStateComparator.h.

Member Function Documentation

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

Check if document state is the same as stored state.

Implemented in idoc::CSerializedUndoManagerComp.

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

Check if there is stored document available.

Implemented in idoc::CSerializedUndoManagerComp.

virtual bool idoc::IDocumentStateComparator::RestoreDocumentState ( )
pure virtual

Restore last stored document state.

Implemented in idoc::CSerializedUndoManagerComp.

virtual bool idoc::IDocumentStateComparator::StoreDocumentState ( )
pure virtual

Store state of some document.

Implemented in idoc::CSerializedUndoManagerComp.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy