Scribus
Open source desktop publishing at your fingertips
Public Member Functions | List of all members
UndoTransaction Class Reference

#include <undotransaction.h>

Inheritance diagram for UndoTransaction:
Inheritance graph
[legend]
Collaboration diagram for UndoTransaction:
Collaboration graph
[legend]

Public Member Functions

 UndoTransaction (TransactionData *data)
 
virtual bool commit ()
 
virtual bool cancel ()
 
bool commit (const QString &targetName, QPixmap *targetPixmap, const QString &name="", const QString &description="", QPixmap *actionPixmap=0)
 
- Public Member Functions inherited from Transaction
 Transaction (TransactionStateBase *data)
 
virtual ~Transaction ()
 
 operator bool () const
 
virtual void markFailed ()
 
virtual void reset ()
 
int getState () const
 
bool isNull () const
 
bool isStarted () const
 
bool isOpened () const
 

Additional Inherited Members

- Public Types inherited from Transaction
enum  Status { STATE_OPEN, STATE_WILLFAIL, STATE_FAILED, STATE_COMMITTED }
 
- Protected Attributes inherited from Transaction
QExplicitlySharedDataPointer< TransactionStateBase > m_data
 

Detailed Description

Class which handles Undo transactions. No data, just methods.

Member Function Documentation

bool UndoTransaction::cancel ( )
virtual

Cancels this transaction if in STATE_OPEN or STATE_WILLFAIL; otherwise do nothing Returns true iff the transaction was canceled.

Implements Transaction.

bool UndoTransaction::commit ( )
virtual

Commits this transaction if in STATE_OPEN. If in STATE_WILLFAIL, cancel the transaction instead; otherwise do nothing. Returns true iff the transaction was committed or canceled.

Implements Transaction.

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