Kwave::UndoDeleteAction Class Reference

#include <UndoDeleteAction.h>

Inheritance diagram for Kwave::UndoDeleteAction:

Collaboration diagram for Kwave::UndoDeleteAction:

Public Member Functions
	UndoDeleteAction (QWidget *parent_widget, const QList< unsigned int > &track_list, sample_index_t offset, sample_index_t length)
virtual	~UndoDeleteAction () Q_DECL_OVERRIDE
virtual QString	description () Q_DECL_OVERRIDE
virtual qint64	undoSize () Q_DECL_OVERRIDE
virtual qint64	redoSize () Q_DECL_OVERRIDE
virtual bool	store (Kwave::SignalManager &manager) Q_DECL_OVERRIDE
virtual Kwave::UndoAction *	undo (Kwave::SignalManager &manager, bool with_redo) Q_DECL_OVERRIDE
virtual void	dump (const QString &indent) Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::UndoAction
virtual	~UndoAction ()
virtual bool	containsModification () const

Private Attributes
QWidget *	m_parent_widget
QList< Kwave::Stripe::List >	m_stripes
Kwave::MetaDataList	m_meta_data
QList< unsigned int >	m_track_list
sample_index_t	m_offset
sample_index_t	m_length
unsigned int	m_undo_size

Detailed Description

Definition at line 38 of file UndoDeleteAction.h.

Constructor & Destructor Documentation

UndoDeleteAction()

Kwave::UndoDeleteAction::UndoDeleteAction	(	QWidget *	parent_widget,
		const QList< unsigned int > &	track_list,
		sample_index_t	offset,
		sample_index_t	length
	)

Constructor.

Parameters

parent_widget	the widget used as parent for displaying error messages
track_list	list of affected tracks
offset	index of the first deleted sample
length	number of samples to delete

Definition at line 32 of file UndoDeleteAction.cpp.

References m_length, m_track_list, and m_undo_size.

    :Kwave::UndoAction(),
     m_parent_widget(parent_widget),
     m_stripes(), m_meta_data(),
     m_track_list(track_list),
     m_offset(offset), m_length(length),
     m_undo_size(sizeof(*this))
{
    // undo size needed for samples
    m_undo_size += m_length * sizeof(sample_t) * m_track_list.count();
}

~UndoDeleteAction()

Kwave::UndoDeleteAction::~UndoDeleteAction ( )

virtual

Destructor

Definition at line 48 of file UndoDeleteAction.cpp.

References m_stripes.

{
    m_stripes.clear();
}

Member Function Documentation

description()

QString Kwave::UndoDeleteAction::description ( )

virtual

See also

UndoAction::description()

Implements Kwave::UndoAction.

Definition at line 54 of file UndoDeleteAction.cpp.

{
    return i18n("Delete");
}

dump()

void Kwave::UndoDeleteAction::dump ( const QString &  indent )

virtual

dump, for debugging purposes

Reimplemented from Kwave::UndoAction.

Definition at line 129 of file UndoDeleteAction.cpp.

References DBG, m_length, and m_offset.

{
    qDebug("%sundo delete from [%lu ... %lu] (%lu)", DBG(indent),
           static_cast<unsigned long int>(m_offset),
           static_cast<unsigned long int>(m_offset + ((m_length) ?
               (m_length - 1) : m_length)),
           static_cast<unsigned long int>(m_length));
}

redoSize()

qint64 Kwave::UndoDeleteAction::redoSize ( )

virtual

See also

UndoAction::redoSize()

Implements Kwave::UndoAction.

Definition at line 66 of file UndoDeleteAction.cpp.

{
    return sizeof(Kwave::UndoInsertAction);
}

store()

bool Kwave::UndoDeleteAction::store ( Kwave::SignalManager &  manager )

virtual

Stores the data needed for undo.

Parameters

manager

the SignalManager for modifying the signal

Note

this is the second step, after size() has been called

Returns

true if successful, false if failed (e.g. out of memory)

Implements Kwave::UndoAction.

Definition at line 72 of file UndoDeleteAction.cpp.

References Kwave::MetaDataList::copy(), m_length, m_meta_data, m_offset, m_stripes, m_track_list, Kwave::SignalManager::metaData(), and Kwave::SignalManager::stripes().

{
    if (!m_length) return true; // shortcut: this is an empty action

    // fork off a multi track stripe list for the selected range
    const sample_index_t left  = m_offset;
    const sample_index_t right = m_offset + m_length - 1;
    m_stripes = manager.stripes(m_track_list, left, right);
    if (m_stripes.isEmpty())
        return false; // retrieving the stripes failed

    // save the meta data
    m_meta_data = manager.metaData().copy(m_offset, m_length, m_track_list);

    return true;
}

Here is the call graph for this function:

undo()

Kwave::UndoAction * Kwave::UndoDeleteAction::undo ( Kwave::SignalManager &  manager, bool  with_redo  )

virtual

Copies the samples to be deleted to the internal buffer.

See also

UndoAction::undo()

Implements Kwave::UndoAction.

Definition at line 90 of file UndoDeleteAction.cpp.

References Kwave::SignalManager::insertSpace(), m_length, m_meta_data, m_offset, m_parent_widget, m_stripes, m_track_list, Kwave::MetaDataList::merge(), Kwave::SignalManager::mergeStripes(), Kwave::SignalManager::metaData(), and Kwave::UndoAction::store().

{
    Kwave::UndoAction *redo_action = Q_NULLPTR;

    // store data for redo
    if (with_redo) {
        redo_action = new(std::nothrow) Kwave::UndoInsertAction(
            m_parent_widget, m_track_list,
            m_offset, m_length
        );
        Q_ASSERT(redo_action);
        if (!redo_action) return Q_NULLPTR;
        redo_action->store(manager);
    }

    if (!m_length) return redo_action; // shortcut: this is an empty action

    // insert space for the stripes
    if (!manager.insertSpace(m_offset, m_length, m_track_list)) {
        qWarning("UndoDeleteAction::undo() FAILED [insertSpace]");
        delete redo_action;
        return Q_NULLPTR;
    }

    // merge the stripes back into the signal
    if (!manager.mergeStripes(m_stripes, m_track_list)) {
        qWarning("UndoDeleteAction::undo() FAILED [mergeStripes]");
        delete redo_action;
        return Q_NULLPTR;
    }

    // restore the saved meta data
    manager.metaData().merge(m_meta_data);

    return redo_action;
}

Here is the call graph for this function:

undoSize()

qint64 Kwave::UndoDeleteAction::undoSize ( )

virtual

See also

UndoAction::undoSize()

Implements Kwave::UndoAction.

Definition at line 60 of file UndoDeleteAction.cpp.

References m_undo_size.

{
    return m_undo_size;
}

Member Data Documentation

m_length

sample_index_t Kwave::UndoDeleteAction::m_length

private

number of deleted samples

Definition at line 102 of file UndoDeleteAction.h.

Referenced by dump(), store(), undo(), and UndoDeleteAction().

m_meta_data

Kwave::MetaDataList Kwave::UndoDeleteAction::m_meta_data

private

storage for the affected meta data items

Definition at line 93 of file UndoDeleteAction.h.

Referenced by store(), and undo().

m_offset

sample_index_t Kwave::UndoDeleteAction::m_offset

private

first deleted sample

Definition at line 99 of file UndoDeleteAction.h.

Referenced by dump(), store(), and undo().

m_parent_widget

QWidget* Kwave::UndoDeleteAction::m_parent_widget

private

parent widget for showing error messages

Definition at line 87 of file UndoDeleteAction.h.

Referenced by undo().

m_stripes

QList<Kwave::Stripe::List> Kwave::UndoDeleteAction::m_stripes

private

storage for all deleted stripes

Definition at line 90 of file UndoDeleteAction.h.

Referenced by store(), undo(), and ~UndoDeleteAction().

m_track_list

QList<unsigned int> Kwave::UndoDeleteAction::m_track_list

private

list of affected tracks

Definition at line 96 of file UndoDeleteAction.h.

Referenced by store(), undo(), and UndoDeleteAction().

m_undo_size

unsigned int Kwave::UndoDeleteAction::m_undo_size

private

memory needed for undo

Definition at line 105 of file UndoDeleteAction.h.

Referenced by UndoDeleteAction(), and undoSize().

---

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

• libkwave/undo/UndoDeleteAction.h
• libkwave/undo/UndoDeleteAction.cpp