Kwave::UndoModifyAction Class Reference

#include <UndoModifyAction.h>

Inheritance diagram for Kwave::UndoModifyAction:

Collaboration diagram for Kwave::UndoModifyAction:

Public Member Functions
	UndoModifyAction (unsigned int track, sample_index_t offset, sample_index_t length)
virtual	~UndoModifyAction () 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 UndoAction *	undo (Kwave::SignalManager &manager, bool with_redo) Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::UndoAction
virtual	~UndoAction ()
virtual bool	containsModification () const
virtual void	dump (const QString &indent)

Protected Attributes
unsigned int	m_track
sample_index_t	m_offset
sample_index_t	m_length
QList< Kwave::Stripe::List >	m_stripes

Detailed Description

Definition at line 33 of file UndoModifyAction.h.

Constructor & Destructor Documentation

UndoModifyAction()

Kwave::UndoModifyAction::UndoModifyAction	(	unsigned int	track,
		sample_index_t	offset,
		sample_index_t	length
	)

Constructor.

Parameters

track	index of the track
offset	index of the first modified sample
length	number of samples

Definition at line 29 of file UndoModifyAction.cpp.

    :UndoAction(), m_track(track), m_offset(offset), m_length(length),
     m_stripes()
{
}

~UndoModifyAction()

Kwave::UndoModifyAction::~UndoModifyAction ( )

virtual

Destructor

Definition at line 38 of file UndoModifyAction.cpp.

{
}

Member Function Documentation

description()

QString Kwave::UndoModifyAction::description ( )

virtual

See also

UndoAction::description()

Implements Kwave::UndoAction.

Definition at line 43 of file UndoModifyAction.cpp.

{
    return i18n("Modify Samples");
}

redoSize()

virtual qint64 Kwave::UndoModifyAction::redoSize ( )

inlinevirtual

See also

UndoAction::redoSize()

Implements Kwave::UndoAction.

Definition at line 56 of file UndoModifyAction.h.

References store(), undo(), and undoSize().

{ return undoSize(); }

Here is the call graph for this function:

store()

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

virtual

See also

UndoAction::store()

Implements Kwave::UndoAction.

Definition at line 55 of file UndoModifyAction.cpp.

References m_length, m_offset, m_stripes, m_track, and Kwave::SignalManager::stripes().

Referenced by redoSize().

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

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

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

undo()

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

virtual

Exchange samples from the current signal and the internal undo buffer. So this instance will be re-used for redo and so does not require any extra memory for redo.

See also

UndoAction::undo()

Implements Kwave::UndoAction.

Definition at line 72 of file UndoModifyAction.cpp.

References m_length, m_offset, m_stripes, m_track, Kwave::SignalManager::mergeStripes(), and Kwave::SignalManager::stripes().

Referenced by redoSize().

{
    const sample_index_t left  = m_offset;
    const sample_index_t right = m_offset + m_length - 1;
    QList<Kwave::Stripe::List> redo_data;
    QList<unsigned int> track_list;
    track_list.append(m_track);
    bool ok = true;

    if (m_length && with_redo) {
        // save the current stripes for later redo
        redo_data = manager.stripes(track_list, left, right);
        ok &= !redo_data.isEmpty();
    }

    // merge the stripes back into the signal
    if (m_length && ok) {
        if (!manager.mergeStripes(m_stripes, track_list)) {
            qWarning("UndoModifyAction::undo() FAILED [mergeStripes]");
            return Q_NULLPTR;
        }
    }

    if (ok && with_redo) {
        // now store the redo data in this object
        m_stripes = redo_data;
    }

    return (with_redo && ok) ? this : Q_NULLPTR;
}

Here is the call graph for this function:

Here is the caller graph for this function:

undoSize()

qint64 Kwave::UndoModifyAction::undoSize ( )

virtual

See also

UndoAction::undoSize()

Implements Kwave::UndoAction.

Definition at line 49 of file UndoModifyAction.cpp.

References m_length.

Referenced by redoSize().

{
    return sizeof(*this) + (m_length * sizeof(sample_t));
}

Here is the caller graph for this function:

Member Data Documentation

m_length

sample_index_t Kwave::UndoModifyAction::m_length

protected

number of samples

Definition at line 81 of file UndoModifyAction.h.

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

m_offset

sample_index_t Kwave::UndoModifyAction::m_offset

protected

first sample

Definition at line 78 of file UndoModifyAction.h.

Referenced by store(), and undo().

m_stripes

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

protected

storage for all deleted stripes

Definition at line 84 of file UndoModifyAction.h.

Referenced by store(), and undo().

m_track

unsigned int Kwave::UndoModifyAction::m_track

protected

index of the modified track

Definition at line 75 of file UndoModifyAction.h.

Referenced by store(), and undo().

---

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

• libkwave/undo/UndoModifyAction.h
• libkwave/undo/UndoModifyAction.cpp