Kwave::UndoModifyMetaDataAction Class Reference

#include <UndoModifyMetaDataAction.h>

Inheritance diagram for Kwave::UndoModifyMetaDataAction:

Collaboration diagram for Kwave::UndoModifyMetaDataAction:

Public Member Functions
	UndoModifyMetaDataAction (const Kwave::MetaDataList &meta_data)
virtual	~UndoModifyMetaDataAction () 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

Protected Attributes
Kwave::MetaDataList	m_saved_data

Detailed Description

Undo action for modifying meta data

Definition at line 36 of file UndoModifyMetaDataAction.h.

Constructor & Destructor Documentation

UndoModifyMetaDataAction()

Kwave::UndoModifyMetaDataAction::UndoModifyMetaDataAction ( const Kwave::MetaDataList &  meta_data )

explicit

Constructor

Parameters

meta_data

list of meta data that has been changed

Definition at line 27 of file UndoModifyMetaDataAction.cpp.

    :UndoAction(), m_saved_data(meta_data)
{
}

~UndoModifyMetaDataAction()

Kwave::UndoModifyMetaDataAction::~UndoModifyMetaDataAction ( )

virtual

Destructor

Definition at line 34 of file UndoModifyMetaDataAction.cpp.

{
}

Member Function Documentation

description()

QString Kwave::UndoModifyMetaDataAction::description ( )

virtual

Returns a verbose short description of the action.

Implements Kwave::UndoAction.

Definition at line 39 of file UndoModifyMetaDataAction.cpp.

References _, Kwave::MetaData::hasProperty(), m_saved_data, name, and Kwave::MetaData::STDPROP_TYPE.

{
    // sanity check: list should not be empty
    Q_ASSERT(!m_saved_data.isEmpty());
    if (m_saved_data.isEmpty()) return _("");

    QString name;
    {
        const Kwave::MetaData &m = m_saved_data.values().first();
        if (m.hasProperty(Kwave::MetaData::STDPROP_TYPE))
            name = m[Kwave::MetaData::STDPROP_TYPE].toString();
    }

    // if the meta data list contains only one object: try to find
    // out the object's name
    if ((m_saved_data.count() == 1) && name.length()) {
        return i18nc(
            "name of the undo action for modifying a meta data object",
            "Modify %1",
            name
        );
    }

    // check if the list contains only objects of the same type
    bool all_same_type = true;
    foreach (const Kwave::MetaData &m, m_saved_data) {
        QString n = m[Kwave::MetaData::STDPROP_TYPE].toString();
        if (!n.length() || (n != name)) {
            all_same_type = false;
            break;
        }
    }
    if (all_same_type) {
        return i18nc(
            "name of the undo action for modifying multiple "
            "meta data objects of the same type: "
            "%1=number of elements, %2=name of one element in singular",
            "Modify %1 %2 objects",
            m_saved_data.count(), name
        );
    }

    return i18n("Modify Meta Data");
}

Here is the call graph for this function:

dump()

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

virtual

dump, for debugging purposes

Reimplemented from Kwave::UndoAction.

Definition at line 142 of file UndoModifyMetaDataAction.cpp.

References _, DBG, Kwave::MetaData::id(), Kwave::MetaData::keys(), and m_saved_data.

{
   foreach (const Kwave::MetaData &m, m_saved_data) {
        qDebug("%sundo modify meta data object '%s'",
               DBG(indent), DBG(m.id()));

        // dump all properties of the object
        foreach (const QString &key, m.keys()) {
            QVariant v = m[key];
            QString value;
            if (v.type() == QVariant::List) {
                foreach (const QVariant &v1, v.toList())
                    value += _("'") + v1.toString() + _("' ");
            } else {
                value = v.toString();
            }
            qDebug("%s    '%s' = '%s",
                   DBG(indent), DBG(key), DBG(value));
        }
    }
}

Here is the call graph for this function:

redoSize()

qint64 Kwave::UndoModifyMetaDataAction::redoSize ( )

virtual

See also

UndoAction::redoSize()

Implements Kwave::UndoAction.

Definition at line 91 of file UndoModifyMetaDataAction.cpp.

References undoSize().

{
    return undoSize();
}

Here is the call graph for this function:

store()

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

virtual

See also

UndoAction::store()

Implements Kwave::UndoAction.

Definition at line 97 of file UndoModifyMetaDataAction.cpp.

{
    // nothing to do, all data has already
    // been stored in the constructor
    return true;
}

undo()

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

virtual

See also

UndoAction::undo()

Implements Kwave::UndoAction.

Definition at line 105 of file UndoModifyMetaDataAction.cpp.

References Kwave::MetaDataList::add(), Kwave::MetaDataList::contains(), Kwave::MetaData::id(), m_saved_data, Kwave::SignalManager::mergeMetaData(), and Kwave::SignalManager::metaData().

{
    if (m_saved_data.isEmpty()) return Q_NULLPTR;

    // store data for redo
    if (with_redo) {
        Kwave::MetaDataList old_data;
        const Kwave::MetaDataList &current_data = manager.metaData();

        foreach (const Kwave::MetaData &meta, m_saved_data) {
            if (current_data.contains(meta)) {
                // add a new entry that will replace the old one
                old_data.add(current_data[meta.id()]);
            } else {
                // add an empty entry that will delete the old one when added
                Kwave::MetaData empty_element(meta);
                old_data.add(empty_element);
                old_data[empty_element.id()].clear();
            }
        }

        // restore the saved meta data
        manager.mergeMetaData(m_saved_data);

        // take the previous values as new undo data
        m_saved_data = old_data;

        return this;
    } else {
        // restore the saved meta data
        manager.mergeMetaData(m_saved_data);
        return Q_NULLPTR;
    }
}

Here is the call graph for this function:

undoSize()

qint64 Kwave::UndoModifyMetaDataAction::undoSize ( )

virtual

See also

UndoAction::undoSize()

Implements Kwave::UndoAction.

Definition at line 85 of file UndoModifyMetaDataAction.cpp.

References m_saved_data.

Referenced by redoSize().

{
    return sizeof(*this) + sizeof(m_saved_data);
}

Here is the caller graph for this function:

Member Data Documentation

m_saved_data

Kwave::MetaDataList Kwave::UndoModifyMetaDataAction::m_saved_data

protected

the unmodified metadata

Definition at line 73 of file UndoModifyMetaDataAction.h.

Referenced by description(), dump(), undo(), and undoSize().

---

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

• libkwave/undo/UndoModifyMetaDataAction.h
• libkwave/undo/UndoModifyMetaDataAction.cpp