Kwave::TypesMap< IDX, DATA > Class Template Reference

#include <TypesMap.h>

Collaboration diagram for Kwave::TypesMap< IDX, DATA >:

Public Member Functions
	TypesMap ()
virtual	~TypesMap ()
virtual void	fill ()=0
virtual void	append (IDX index, DATA data, const QString &name, const QString &description)
unsigned int	count () const
IDX	findFromData (const DATA &data) const
IDX	findFromName (const QString &name) const
DATA	data (IDX type) const
QString	name (IDX type) const
QString	description (IDX type, bool localized) const
QStringList	allNames () const
QList< IDX >	keys () const

Private Types
typedef QMap< IDX, Kwave::Triple< DATA, QString, QString > >	TripleMap

Private Attributes
TripleMap	m_list

Detailed Description

template<class IDX, class DATA>
class Kwave::TypesMap< IDX, DATA >

Definition at line 37 of file TypesMap.h.

Member Typedef Documentation

TripleMap

template<class IDX, class DATA>

typedef QMap<IDX, Kwave::Triple <DATA, QString, QString> > Kwave::TypesMap< IDX, DATA >::TripleMap

private

Definition at line 40 of file TypesMap.h.

Constructor & Destructor Documentation

TypesMap()

template<class IDX, class DATA>

Kwave::TypesMap< IDX, DATA >::TypesMap ( )

inline

Default constructor. Must be overwritten to initialize the list with useful values.

Definition at line 47 of file TypesMap.h.

            :m_list()
        {
        }

~TypesMap()

template<class IDX, class DATA>

virtual Kwave::TypesMap< IDX, DATA >::~TypesMap ( )

inlinevirtual

Destructor

Definition at line 53 of file TypesMap.h.

        {
            m_list.clear();
        }

Member Function Documentation

allNames()

template<class IDX, class DATA>

QStringList Kwave::TypesMap< IDX, DATA >::allNames ( ) const

inline

Returns a string list with all names,

Definition at line 138 of file TypesMap.h.

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

append()

template<class IDX, class DATA>

virtual void Kwave::TypesMap< IDX, DATA >::append ( IDX  index, DATA  data, const QString &  name, const QString &  description  )

inlinevirtual

Appends a new type into the map.

Parameters

index	unique index within the map
data	the data associated with the entry
name	string representation of the type, for internal usage in Kwave commands.
description	text for the user interface

Definition at line 72 of file TypesMap.h.

        {
            Kwave::Triple<DATA, QString, QString>
                triple(data, name, description);
            m_list.insert(index, triple);
        }

count()

template<class IDX, class DATA>

unsigned int Kwave::TypesMap< IDX, DATA >::count ( ) const

inline

Returns the number of types.

Definition at line 81 of file TypesMap.h.

Referenced by Kwave::Functions::count(), Kwave::Interpolation::descriptions(), Kwave::Functions::function(), Kwave::Functions::name(), Kwave::PlayBackDialog::PlayBackDialog(), and Kwave::RecordDialog::RecordDialog().

                                          {
            return m_list.count();
        }

Here is the caller graph for this function:

data()

template<class IDX, class DATA>

DATA Kwave::TypesMap< IDX, DATA >::data ( IDX  type ) const

inline

Returns the data item of a type.

Definition at line 110 of file TypesMap.h.

Referenced by Kwave::TypesMap< window_function_t, unsigned int >::findFromData(), Kwave::Functions::function(), Kwave::RecordDialog::methodSelected(), Kwave::PlayBackDialog::PlayBackDialog(), and Kwave::FileInfoDialog::setupFileInfoTab().

        {
            Q_ASSERT(m_list.contains(type));
            return m_list[type].first();
        }

Here is the caller graph for this function:

description()

template<class IDX, class DATA>

QString Kwave::TypesMap< IDX, DATA >::description ( IDX  type, bool  localized  ) const

inline

Returns the description of a type.

Parameters

type	index of the type
localized	if true, the returned description is localized

Definition at line 128 of file TypesMap.h.

Referenced by Kwave::RecordPlugin::changeSampleFormat(), Kwave::Interpolation::descriptions(), Kwave::RecordPulseAudio::detectSupportedFormats(), Kwave::RecordALSA::initialize(), Kwave::RecordPulseAudio::initialize(), Kwave::AudiofileDecoder::open(), Kwave::PlayBackDialog::PlayBackDialog(), Kwave::RecordDialog::RecordDialog(), Kwave::RecordDialog::setSupportedSampleFormats(), and Kwave::FileInfoDialog::setupFileInfoTab().

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

Here is the caller graph for this function:

fill()

template<class IDX, class DATA>

virtual void Kwave::TypesMap< IDX, DATA >::fill ( )

pure virtual

This function is abstract and must be overwritten to initially fill the map if it was empty.

Implemented in Kwave::FileInfo::PropertyTypesMap, Kwave::Interpolation::InterpolationMap, Kwave::WindowFunction::InitializedTypesMap, Kwave::SampleFormat::Map, Kwave::Functions::FunctionTypesMap, Kwave::PlayBackTypesMap, and Kwave::RecordTypesMap.

Referenced by Kwave::TypesMap< window_function_t, unsigned int >::~TypesMap().

Here is the caller graph for this function:

findFromData()

template<class IDX, class DATA>

IDX Kwave::TypesMap< IDX, DATA >::findFromData ( const DATA &  data ) const

inline

Try to find the type from the data. If the data item is not found, the return value is the default value of the type (casted from 0).

Definition at line 89 of file TypesMap.h.

Referenced by Kwave::RecordPlugin::changeSampleFormat(), Kwave::PlaybackController::checkMethod(), Kwave::PlayBackPlugin::createDevice(), Kwave::Interpolation::descriptions(), Kwave::RecordPulseAudio::detectSupportedFormats(), Kwave::SampleFormat::fromInt(), Kwave::RecordALSA::initialize(), Kwave::RecordPulseAudio::initialize(), Kwave::PlayBackDialog::methodSelected(), Kwave::PlayBackDialog::setMethod(), Kwave::RecordDialog::setMethod(), and Kwave::RecordDialog::setSupportedSampleFormats().

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

Here is the caller graph for this function:

findFromName()

template<class IDX, class DATA>

IDX Kwave::TypesMap< IDX, DATA >::findFromName ( const QString &  name ) const

inline

Try to find the type from a name. If the name is not found, the return value is the default value of the type (casted from 0).

Definition at line 101 of file TypesMap.h.

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

keys()

template<class IDX, class DATA>

QList<IDX> Kwave::TypesMap< IDX, DATA >::keys ( ) const

inline

Returns a list with all keys

Definition at line 150 of file TypesMap.h.

Referenced by Kwave::FileInfo::contains(), Kwave::FileInfo::dump(), Kwave::FileInfo::FileInfo(), Kwave::FileInfo::get(), Kwave::FileInfo::properties(), Kwave::FileInfo::set(), and Kwave::FileInfoDialog::setupFileInfoTab().

        {
            return m_list.keys();
        }

Here is the caller graph for this function:

name()

template<class IDX, class DATA>

QString Kwave::TypesMap< IDX, DATA >::name ( IDX  type ) const

inline

Returns the name of a type.

Definition at line 117 of file TypesMap.h.

Referenced by Kwave::PlaybackController::checkMethod(), Kwave::FileInfo::contains(), Kwave::PlayBackPlugin::createDevice(), Kwave::FileInfo::dump(), Kwave::FileInfo::FileInfo(), Kwave::TypesMap< window_function_t, unsigned int >::findFromName(), Kwave::FileInfo::get(), Kwave::PlayBackDialog::methodSelected(), Kwave::Functions::name(), Kwave::Interpolation::name(), Kwave::FileInfo::set(), and Kwave::PlayBackDialog::setMethod().

        {
            Q_ASSERT(m_list.contains(type));
            return m_list[type].second();
        }

Here is the caller graph for this function:

Member Data Documentation

m_list

template<class IDX, class DATA>

TripleMap Kwave::TypesMap< IDX, DATA >::m_list

private

map with index and triples of data, name and description

Definition at line 158 of file TypesMap.h.

Referenced by Kwave::TypesMap< window_function_t, unsigned int >::allNames(), Kwave::TypesMap< window_function_t, unsigned int >::append(), Kwave::TypesMap< window_function_t, unsigned int >::count(), Kwave::TypesMap< window_function_t, unsigned int >::data(), Kwave::TypesMap< window_function_t, unsigned int >::description(), Kwave::TypesMap< window_function_t, unsigned int >::findFromData(), Kwave::TypesMap< window_function_t, unsigned int >::findFromName(), Kwave::TypesMap< window_function_t, unsigned int >::keys(), Kwave::TypesMap< window_function_t, unsigned int >::name(), and Kwave::TypesMap< window_function_t, unsigned int >::~TypesMap().

---

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

• libkwave/TypesMap.h