Kwave::UndoManager Class Reference

#include <UndoManager.h>

Collaboration diagram for Kwave::UndoManager:

Public Member Functions
	UndoManager ()
virtual	~UndoManager ()
bool	registerHandler (Kwave::UndoHandler *handler)
bool	unregisterHandler (Kwave::UndoHandler *handler)
bool	startUndoTransaction (Kwave::UndoTransaction *transaction)
bool	closeUndoTransaction (Kwave::UndoTransaction *transaction)

Private Attributes
QList< Kwave::UndoHandler * >	m_handlers

Detailed Description

Definition at line 32 of file UndoManager.h.

Constructor & Destructor Documentation

UndoManager()

Kwave::UndoManager::UndoManager

(

)

Constructor

Definition at line 24 of file UndoManager.cpp.

    :m_handlers()
{
}

~UndoManager()

Kwave::UndoManager::~UndoManager ( )

virtual

Destructor

Definition at line 30 of file UndoManager.cpp.

References m_handlers.

{
    m_handlers.clear();
}

Member Function Documentation

closeUndoTransaction()

bool Kwave::UndoManager::closeUndoTransaction

(

Kwave::UndoTransaction *

transaction

)

Should be called when a undo transaction is completed

Parameters

transaction

the undo transaction that has been closed

Returns

true if successful, false if failed

Definition at line 70 of file UndoManager.cpp.

{
    Q_UNUSED(transaction);
    return true;
}

registerHandler()

bool Kwave::UndoManager::registerHandler

(

Kwave::UndoHandler *

handler

)

Register an instance of an undo handler

Parameters

handler

the undo handler to register

Returns

true if successful, false if failed (e.g. duplicate registration or null pointer)

Definition at line 36 of file UndoManager.cpp.

References m_handlers.

Referenced by Kwave::SelectionTracker::SelectionTracker().

{
    if (!handler) return false;
    if (m_handlers.contains(handler)) return false;
    m_handlers.append(handler);
    return true;
}

Here is the caller graph for this function:

startUndoTransaction()

bool Kwave::UndoManager::startUndoTransaction

(

Kwave::UndoTransaction *

transaction

)

Should be called when a undo transaction has been started, calls saveUndoData of all undo handlers

Parameters

transaction

the newly created undo transaction (still empty)

Returns

true if successful, false if failed (e.g. one undo handler failed saving it's data)

Definition at line 54 of file UndoManager.cpp.

References m_handlers, and Kwave::UndoHandler::saveUndoData().

Referenced by Kwave::SignalManager::startUndoTransaction().

{
    if (!transaction) return false;

    foreach (Kwave::UndoHandler *handler, m_handlers) {
        Q_ASSERT(handler);
        if (!handler) continue;
        if (!(handler->saveUndoData(*transaction)))
            return false;
    }

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterHandler()

bool Kwave::UndoManager::unregisterHandler

(

Kwave::UndoHandler *

handler

)

Unregister an instance of an undo handler previously registered through registerHandler()

Parameters

handler

the undo handler to unregister

Returns

true if successful, false if failed (e.g. if not registered or null pointer)

Definition at line 45 of file UndoManager.cpp.

References m_handlers.

Referenced by Kwave::SelectionTracker::~SelectionTracker().

{
    if (!handler) return false;
    if (!m_handlers.contains(handler)) return false;
    m_handlers.removeAll(handler);
    return true;
}

Here is the caller graph for this function:

Member Data Documentation

m_handlers

QList<Kwave::UndoHandler *> Kwave::UndoManager::m_handlers

private

list of all registered undo handlers

Definition at line 86 of file UndoManager.h.

Referenced by registerHandler(), startUndoTransaction(), unregisterHandler(), and ~UndoManager().

---

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

• libkwave/undo/UndoManager.h
• libkwave/undo/UndoManager.cpp