TypesMap.h

Go to the documentation of this file.

/***************************************************************************
             TypesMap.h  -  Map with index, data, command, description
                             -------------------
    begin                : Feb 05 2001
    copyright            : (C) 2001 by Thomas Eschenbacher
    email                : Thomas Eschenbacher <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 TYPES_MAP_H
#define TYPES_MAP_H

#include "config.h"

#include <QList>
#include <QMap>
#include <QObject>
#include <QString>
#include <QStringList>

#include <KLocalizedString>

#include "libkwave/String.h"
#include "libkwave/Triple.h"

namespace Kwave
{

    template <class IDX, class DATA> class TypesMap
    {
    private:
        typedef QMap <IDX, Kwave::Triple <DATA, QString, QString> > TripleMap;

    public:
        TypesMap()
            :m_list()
        {
        }

        virtual ~TypesMap()
        {
            m_list.clear();
        }

        virtual void fill() = 0;

        virtual void append(IDX index, DATA data,
            const QString &name, const QString &description)
        {
            Kwave::Triple<DATA, QString, QString>
                triple(data, name, description);
            m_list.insert(index, triple);
        }

        inline unsigned int count() const {
            return m_list.count();
        }

        IDX findFromData(const DATA &data) const
        {
            foreach (const IDX &it, m_list.keys()) {
                if (m_list[it].first() == data) return it;
            }
            return IDX(0);
        }

        IDX findFromName(const QString &name) const
        {
            foreach (const IDX &it, m_list.keys()) {
                if (m_list[it].second() == name) return it;
            }
            return IDX(0);
        }

        DATA data(IDX type) const
        {
            Q_ASSERT(m_list.contains(type));
            return m_list[type].first();
        }

        QString name(IDX type) const
        {
            Q_ASSERT(m_list.contains(type));
            return m_list[type].second();
        }

        QString description(IDX type, bool localized) const
        {
            if (!m_list.contains(type)) return QString();
            QString s(m_list[type].third());
            return (localized) ? i18n(s.toLatin1()) : s;
        }

        QStringList allNames() const
        {
            QStringList names;
            foreach (const IDX &it, m_list.keys()) {
                names.append(m_list[it].second());
            }
            return names;
        }

        QList<IDX> keys() const
        {
            return m_list.keys();
        }

    private:

        TripleMap m_list;

    };
}

#endif /* TYPES_MAP_H */

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