MetaDataList.h

Go to the documentation of this file.

/***************************************************************************
         MetaDataList.h  -  list with meta data objects
                             -------------------
    begin                : Sat Mar 06 2010
    copyright            : (C) 2010 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef META_DATA_LIST_H
#define META_DATA_LIST_H

#include "config.h"

#include <QtGlobal>
#include <QList>
#include <QMap>
#include <QMapIterator>
#include <QMutableMapIterator>
#include <QString>
#include <QVariant>

#include "libkwave/MetaData.h"
#include "libkwave/Sample.h"

namespace Kwave
{

    class Q_DECL_EXPORT MetaDataList: public QMap<QString, MetaData>
    {
    public:

        typedef QMapIterator<QString, MetaData> Iterator;

        typedef QMutableMapIterator<QString, MetaData> MutableIterator;

        MetaDataList();

        explicit MetaDataList(const MetaData &meta);

        virtual ~MetaDataList();

        virtual QList<Kwave::MetaData> toSortedList() const;

        virtual MetaDataList selectByType(const QString &type) const;

        virtual MetaDataList selectByScope(MetaData::Scope scope) const;

        virtual MetaDataList selectByTracks(
            const QList<unsigned int> &tracks) const;

        virtual MetaDataList selectByRange(
            sample_index_t first, sample_index_t last) const;

        virtual MetaDataList selectByPosition(sample_index_t pos) const;

        virtual MetaDataList selectByProperty(const QString &property) const;

        virtual MetaDataList selectByValue(
            const QString &property, QVariant value) const;

        virtual bool contains(const MetaData &metadata) const;

        virtual void replace(const MetaDataList &list);

        virtual void add(const MetaData &metadata);

        virtual void add(const MetaDataList &list);

        virtual void remove(const MetaData &metadata);

        virtual void remove(const MetaDataList &list);

        virtual void cropByRange(sample_index_t first, sample_index_t last);

        virtual void cropByTracks(const QList<unsigned int> &tracks);

        virtual MetaDataList copy(
            sample_index_t offset,
            sample_index_t length,
            const QList<unsigned int> &tracks
        ) const;

        void merge(const MetaDataList &meta_data);

        virtual void deleteRange(
            sample_index_t offset,
            sample_index_t length,
            const QList<unsigned int> &tracks
        );

        virtual void shiftLeft(
            sample_index_t offset,
            sample_index_t shift,
            const QList<unsigned int> &tracks
        );

        virtual void shiftRight(
            sample_index_t offset,
            sample_index_t shift,
            const QList<unsigned int> &tracks
        );

        virtual void scalePositions(
            double scale,
            const QList<unsigned int> &tracks
        );

        virtual void insertTrack(unsigned int track);

        virtual void deleteTrack(unsigned int track);

        virtual void dump() const;

    protected:

        void split(sample_index_t offset, const QList<unsigned int> &tracks);

    };

}

#endif /* META_DATA_LIST_H */

//***************************************************************************
//***************************************************************************