Detailed Description

template<ObjectDescriptionType type>
class Phonon::ObjectDescriptionModel< type >

The ObjectDescriptionModel class provides a model from a list of ObjectDescription objects.

ObjectDescriptionModel is a readonly model that supplies a list using ObjectDescription::name() for the text and ObjectDescription::description() for the tooltip. If set the properties "icon" and "available" are used to set the decoration and disable the item (disabled only visually, you can still select and drag it).

It also provides the methods moveUp() and moveDown() to order the list. Additionally drag and drop is possible so that QAbstractItemView::InternalMove can be used. The resulting order of the ObjectDescription::index() values can then be retrieved using tupleIndexOrder().

An example use case would be to give the user a QComboBox to select the output device:

 QComboBox *cb = new QComboBox(parentWidget);
 ObjectDescriptionModel *model = new ObjectDescriptionModel(cb);
 model->setModelData(BackendCapabilities::availableAudioOutputDevices());
 cb->setModel(model);
 cb->setCurrentIndex(0); // select first entry

And to retrieve the selected AudioOutputDevice:

 int cbIndex = cb->currentIndex();
 AudioOutputDevice selectedDevice = model->modelData(cbIndex);

Author:: Matthias Kretz <kretz@kde.org>

Definition at line 193 of file objectdescriptionmodel.h.

#include <Phonon/ObjectDescriptionModel>

Inheritance diagram for ObjectDescriptionModel< type >:

[legend]

List of all members.

Public Member Functions
PHONON_TEMPLATE_CLASS_MEMBER_EXPORT const QMetaObject *	metaObject () const
PHONON_TEMPLATE_CLASS_MEMBER_EXPORT void *	qt_metacast (const char *_clname)
int	rowCount (const QModelIndex &parent=QModelIndex()) const
	Returns the number of rows in the model.
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
	Returns data from the item with the given `index` for the specified `role`.
Qt::ItemFlags	flags (const QModelIndex &index) const
	Reimplemented to show unavailable devices as disabled (but still selectable).
QList< int >	tupleIndexOrder () const
	Returns a list of indexes in the same order as they are in the model.
int	tupleIndexAtPositionIndex (int positionIndex) const
	Returns the ObjectDescription::index for the tuple at the given position `positionIndex`.
QMimeData *	mimeData (const QModelIndexList &indexes) const
	Returns the MIME data that dropMimeData() can use to create new items.
void	moveUp (const QModelIndex &index)
	Moves the item at the given `index` up.
void	moveDown (const QModelIndex &index)
	Moves the item at the given `index` down.
	ObjectDescriptionModel (QObject *parent=0)
	Constructs a ObjectDescription model with the given `parent`.
	ObjectDescriptionModel (const QList< ObjectDescription< type > > &data, QObject *parent=0)
	Constructs a ObjectDescription model with the given `parent` and the given `data`.
void	setModelData (const QList< ObjectDescription< type > > &data)
	Sets the model data using the list provided by `data`.
QList< ObjectDescription< type > >	modelData () const
	Returns the model data.
ObjectDescription< type >	modelData (const QModelIndex &index) const
	Returns one ObjectDescription of the model data for the given `index`.
Qt::DropActions	supportedDropActions () const
	This model supports drag and drop to copy or move items.
bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
	Accept drops from other models of the same ObjectDescriptionType.
bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
	Removes count rows starting with the given row.
QStringList	mimeTypes () const
	Returns a list of supported drag and drop MIME types.
Static Public Attributes
static Q_OBJECT_CHECK PHONON_TEMPLATE_CLASS_MEMBER_EXPORT const QMetaObject	staticMetaObject
Protected Attributes
ObjectDescriptionModelData *const	d

Constructor & Destructor Documentation

ObjectDescriptionModel ( QObject * parent = 0 ) [inline, explicit]

Constructs a ObjectDescription model with the given parent.

Definition at line 286 of file objectdescriptionmodel.h.

: QAbstractListModel(parent), d(new ObjectDescriptionModelData(this)) {} //krazy:exclude=inline

ObjectDescriptionModel	(	const QList< ObjectDescription< type > > &	data,
		QObject *	parent = `0`
	)		`[inline, explicit]`

Constructs a ObjectDescription model with the given parent and the given data.

Definition at line 292 of file objectdescriptionmodel.h.

                : QAbstractListModel(parent), d(new ObjectDescriptionModelData(this)) { setModelData(data); }

Member Function Documentation

PHONON_TEMPLATE_CLASS_MEMBER_EXPORT const QMetaObject* metaObject ( ) const

QVariant data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const `[inline, virtual]`

bool dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)		`[inline, virtual]`

bool removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)		`[inline, virtual]`

ObjectDescriptionModel< type > Class Template Reference

Detailed Description

template<ObjectDescriptionType type> class Phonon::ObjectDescriptionModel< type >

Public Member Functions

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<ObjectDescriptionType type>
class Phonon::ObjectDescriptionModel< type >