KisTransaction Class Reference

#include <kis_transaction.h>

Inheritance diagram for KisTransaction:

Public Types
enum	Flag { None = 0x0 , SuppressUpdates = 0x1 }

Public Member Functions
void	commit (KisPostExecutionUndoAdapter *undoAdapter)
void	commit (KisUndoAdapter *undoAdapter)
void	end ()
KUndo2Command *	endAndTake ()
	KisTransaction (const KUndo2MagicString &name, KisPaintDeviceSP device, KUndo2Command *parent=0, int timedID=-1, KisTransactionWrapperFactory *interstrokeDataFactory=0, Flags flags=None)
	KisTransaction (KisPaintDeviceSP device, KUndo2Command *parent=0, int timedID=-1, KisTransactionWrapperFactory *interstrokeDataFactory=0, Flags flags=None)
void	revert ()
KUndo2MagicString	text () const
KUndo2Command *	undoCommand ()
virtual	~KisTransaction ()

Protected Member Functions
	KisTransaction ()
	Q_DISABLE_COPY (KisTransaction)

Protected Attributes
KisTransactionData *	m_transactionData

Detailed Description

Definition at line 24 of file kis_transaction.h.

Member Enumeration Documentation

Flag

enum KisTransaction::Flag

Enumerator
None
SuppressUpdates

Definition at line 27 of file kis_transaction.h.

              {
        None = 0x0,
        SuppressUpdates = 0x1
    };

Constructor & Destructor Documentation

KisTransaction() [1/3]

KisTransaction::KisTransaction ( const KUndo2MagicString & name, KisPaintDeviceSP device, KUndo2Command * parent = 0, int timedID = -1, KisTransactionWrapperFactory * interstrokeDataFactory = 0, Flags flags = None )

inline

Definition at line 34 of file kis_transaction.h.

                                                                                                                                                                                                     {
        m_transactionData = new KisTransactionData(name, device, true, interstrokeDataFactory, parent, flags & SuppressUpdates);
        m_transactionData->setTimedID(timedID);
    }

References m_transactionData, KUndo2Command::setTimedID(), and SuppressUpdates.

KisTransaction() [2/3]

KisTransaction::KisTransaction ( KisPaintDeviceSP device, KUndo2Command * parent = 0, int timedID = -1, KisTransactionWrapperFactory * interstrokeDataFactory = 0, Flags flags = None )

inline

Definition at line 39 of file kis_transaction.h.

        : KisTransaction(KUndo2MagicString(), device, parent, timedID, interstrokeDataFactory, flags)
    {
    }

~KisTransaction()

virtual KisTransaction::~KisTransaction ( )

inlinevirtual

Definition at line 44 of file kis_transaction.h.

                              {
        delete m_transactionData;
    }

References m_transactionData.

KisTransaction() [3/3]

KisTransaction::KisTransaction ( )

inlineprotected

Definition at line 122 of file kis_transaction.h.

: m_transactionData(0) {}

Member Function Documentation

commit() [1/2]

void KisTransaction::commit ( KisPostExecutionUndoAdapter * undoAdapter )

inline

Definition at line 62 of file kis_transaction.h.

                                                          {
        KIS_ASSERT_X(m_transactionData,
                     "KisTransaction::commit()",
                     "the transaction has been tried to be committed twice");
 
        m_transactionData->endTransaction();
        m_transactionData->redo();
        undoAdapter->addCommand(KUndo2CommandSP(m_transactionData));
        m_transactionData = 0;
    }

References KisPostExecutionUndoAdapter::addCommand(), KisTransactionData::endTransaction(), KIS_ASSERT_X, m_transactionData, and KisTransactionData::redo().

commit() [2/2]

void KisTransaction::commit ( KisUndoAdapter * undoAdapter )

inline

Definition at line 52 of file kis_transaction.h.

                                             {
        KIS_ASSERT_X(m_transactionData,
                     "KisTransaction::commit()",
                     "the transaction has been tried to be committed twice");
 
        m_transactionData->endTransaction();
        undoAdapter->addCommand(m_transactionData);
        m_transactionData = 0;
    }

References KisUndoAdapter::addCommand(), KisTransactionData::endTransaction(), KIS_ASSERT_X, and m_transactionData.

end()

void KisTransaction::end ( )

inline

We will not call endTransaction for m_transactionData, we'll just kill it, and it'll report about it's death to the memento manager, so no commit will be made

Definition at line 85 of file kis_transaction.h.

               {
        KIS_ASSERT_X(m_transactionData, "KisTransaction::end()", "nothing to end!");
        delete m_transactionData;
        m_transactionData = 0;
    }

References KIS_ASSERT_X, and m_transactionData.

endAndTake()

KUndo2Command * KisTransaction::endAndTake ( )

inline

Definition at line 73 of file kis_transaction.h.

                                {
        KIS_ASSERT_X(m_transactionData,
                     "KisTransaction::endAndTake()",
                     "the transaction has been tried to be committed twice");
 
        m_transactionData->endTransaction();
        KisTransactionData *transactionData = m_transactionData;
        m_transactionData = 0;
 
        return transactionData;
    }

References KisTransactionData::endTransaction(), KIS_ASSERT_X, and m_transactionData.

Q_DISABLE_COPY()

KisTransaction::Q_DISABLE_COPY ( KisTransaction )

protected

revert()

void KisTransaction::revert ( )

inline

FIXME: Should we emulate first redo() here?

Definition at line 96 of file kis_transaction.h.

                  {
        KIS_ASSERT_X(m_transactionData,
                     "KisTransaction::reverted()",
                     "the transaction is tried to be reverted()"
                     "after it has already been added to undo adapter");
 
        m_transactionData->endTransaction();
        m_transactionData->undo();
        delete m_transactionData;
        m_transactionData = 0;
    }

References KisTransactionData::endTransaction(), KIS_ASSERT_X, m_transactionData, and KisTransactionData::undo().

text()

KUndo2MagicString KisTransaction::text ( ) const

inline

Definition at line 111 of file kis_transaction.h.

                                   {
        KIS_ASSERT_X(m_transactionData,
                     "KisTransaction::text()",
                     "the name has been requested after the transaction"
                     "has already been ended");
        return m_transactionData->text();
    }

References KIS_ASSERT_X, m_transactionData, and KUndo2Command::text().

undoCommand()

KUndo2Command * KisTransaction::undoCommand ( )

inline

Definition at line 48 of file kis_transaction.h.

                                 {
        return m_transactionData;
    }

References m_transactionData.

Member Data Documentation

m_transactionData

KisTransactionData* KisTransaction::m_transactionData

protected

Definition at line 123 of file kis_transaction.h.

---

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

• libs/image/kis_transaction.h