ITransaction.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Internationalization/Text.h"
#include "Misc/Guid.h"
#include "Internationalization/Text.h"
#include "UObject/UObjectHierarchyFwd.h"
#include "Change.h"
 
// Class for handling undo/redo transactions among objects.
typedef void(*STRUCT_DC)( void* TPtr );                     // default construct
typedef void(*STRUCT_AR)( class FArchive& Ar, void* TPtr ); // serialize
typedef void(*STRUCT_DTOR)( void* TPtr );                   // destruct
 
 
enum class ETransactionStateEventType : uint8
{
    TransactionStarted,
    TransactionCanceled,
    PreTransactionFinalized,
    TransactionFinalized,
    PostTransactionFinalized,
 
    UndoRedoStarted,
    UndoRedoFinalized,
};
 
 
struct FTransactionContext 
{
    FTransactionContext()
        : TransactionId()
        , OperationId()
        , Title()
        , Context()
        , PrimaryObject(nullptr)
    {
    }
 
    FTransactionContext(const FGuid& InTransactionId, const FGuid& InOperationId, const FText& InSessionTitle, const TCHAR* InContext, UObject* InPrimaryObject) 
        : TransactionId(InTransactionId)
        , OperationId(InOperationId)
        , Title(InSessionTitle)
        , Context(InContext)
        , PrimaryObject(InPrimaryObject)
    {
    }
 
    bool IsValid() const
    {
        return TransactionId.IsValid() && OperationId.IsValid();
    }
 
    FGuid TransactionId;
    FGuid OperationId;
    FText Title;
    FString Context;
    UObject* PrimaryObject;
};
 
 
class ITransaction
{
public:
 
    virtual void BeginOperation() = 0;
 
    virtual void EndOperation() = 0;
 
    virtual void Finalize() = 0;
 
    virtual void Apply() = 0;
 
    virtual FTransactionContext GetContext() const = 0;
 
    virtual bool IsTransient() const = 0;
 
    virtual bool ContainsPieObjects() const = 0;
 
    virtual void SaveArray( UObject* Object, class FScriptArray* Array, int32 Index, int32 Count, int32 Oper, int32 ElementSize, uint32 ElementAlignment, STRUCT_DC DefaultConstructor, STRUCT_AR Serializer, STRUCT_DTOR Destructor ) = 0;
 
    virtual void SaveObject( UObject* Object ) = 0;
 
    virtual void StoreUndo( UObject* Object, TUniquePtr<FChange> CustomChange ) = 0;
 
    virtual void SetPrimaryObject( UObject* Object ) = 0;
 
    virtual void SnapshotObject( UObject* Object, TArrayView<const FProperty*> Properties ) = 0;
 
    virtual bool ContainsObject(const UObject* Object) const = 0;
};