ITransactionHandler.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include    "DgnPlatform.h"

struct DropElemFromActive;

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

struct HandlerTxnMonitor;

/*=================================================================================**/
struct     ITransactionHandler
{

protected:

virtual void    _OnUndoRedo                 (ElementHandleP afterUndoRedo, ElementHandleP beforeUndoRedo, ChangeTrackAction action, bool isUndo, ChangeTrackSource source) {}

virtual void    _OnHistoryRestore           (ElementHandleP after, ElementHandleP before, ChangeTrackAction actionStep, BentleyDgnHistoryElementChangeType effectiveChange) {}

virtual void    _OnUndoRedoFinished         (ElementRefP element, bool isUndo) {}

virtual void    _OnDeleted                  (ElementHandleP element) {}

virtual void    _OnAdded                    (ElementHandleP element) {}

virtual void    _OnAddedComplete            (ElementHandleP element) {}

virtual void    _OnModified                 (ElementHandleP newElement, ElementHandleP oldElement, ChangeTrackAction action, bool* cantBeUndoneFlag) {}

virtual void    _OnUndoRedoXAttributeChange (XAttributeHandleCR xAttr, ChangeTrackAction action, bool isUndo, ChangeTrackSource source) {}

virtual void    _OnXAttributeChanged        (XAttributeHandleCR xAttr, ChangeTrackAction action, bool* cantBeUndoneFlag) {}

enum PreActionStatus
    {
    PRE_ACTION_Ok    = 0,
    PRE_ACTION_Block = 1,
    };

virtual PreActionStatus    _OnAdd           (EditElementHandleR) {return PRE_ACTION_Ok;};
virtual PreActionStatus    _OnReplace       (EditElementHandleR, ElementHandleCR) {return PRE_ACTION_Ok;}
virtual PreActionStatus    _OnDelete        (ElementHandleCR) {return PRE_ACTION_Ok;};
virtual PreActionStatus    _OnRemoveHandler (ElementHandleCR) {return PRE_ACTION_Ok;}

public:
    DGNPLATFORM_EXPORT static void CallOnAdded  (ElementHandleR);
    DGNPLATFORM_EXPORT static void CallOnAddedComplete  (ElementHandleR);
};

END_BENTLEY_DGNPLATFORM_NAMESPACE