Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QMediaList Class Reference
[QtMediaModule]

The QMediaList class provides a filtered list of media content. More...

    #include <QMediaList>

Inherits QAbstractListModel.

• List of all members, including inherited members

Public Types

• enum Grouping { ShowAll, ShowGrouped }
• enum Properties { ShowEmpty, ShowEmptyAsUnknown, HideEmpty }
• enum Roles { Title, Url, Artist, Album, Genre, MimeType }
• enum SortDirection { Ascending, Descending, Unsorted }

Public Functions

• QMediaList ()
• QMediaList ( const QMediaPlaylist & playlist )
• QMediaList ( const QMediaList & other )
• bool addFilter ( Roles filterType, const QString & text )
• void beginFilter ()
• void clearFilter ()
• Grouping displayGrouping () const
• int displayRole () const
• void endFilter ()
• bool isFiltered () const
• QMediaPlaylist playlist ( const QModelIndex & index = QModelIndex() ) const
• void randomize ()
• bool removeFilter ( Roles filterType )
• void setDisplayRole ( int role, Grouping grouping = ShowGrouped )
• bool setFilter ( Roles filterType, const QString & text )
• void setModel ( const QMediaPlaylist & playlist )
• void setSorting ( SortDirection sortType )
• void setSorting ( QList<int> roles, SortDirection sortType )
• void showEmpty ( Properties role )
• QMediaList & operator= ( const QMediaList & medialist )
• bool operator== ( const QMediaList & other ) const

• 1 public function inherited from QAbstractListModel
• 34 public functions inherited from QAbstractItemModel
• 29 public functions inherited from QObject

Protected Functions

• void refreshData ()

• 14 protected functions inherited from QAbstractItemModel
• 7 protected functions inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 2 public slots inherited from QAbstractItemModel
• 1 public slot inherited from QObject
• 14 signals inherited from QAbstractItemModel
• 1 signal inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QMediaList class provides a filtered list of media content.

The QMediaList class is useful for displaying media content filtered by Artist, Album, Genre etc. For example to display a list of music by artist name containing "Billy".

    mediaPlaylist = QMediaList();
    itemview->setModel( mediaPlaylist );
    mediaPlaylist.clearFilter();
    mediaPlaylist.setDisplayRole(QMediaList::Title);
    mediaPlaylist.beginFilter();
    mediaList.setFilter(QMediaList::MimeType,"audio");
    mediaList.addFilter(QMediaList::Artist, "Billy");
    mediaList.randomize();
    mediaList.endFilter();

Member Type Documentation

enum QMediaList::Grouping

enum QMediaList::Properties

enum QMediaList::Roles

enum QMediaList::SortDirection

Member Function Documentation

QMediaList::QMediaList ()

Constructs a list from the Document System.

QMediaList::QMediaList ( const QMediaPlaylist & playlist )

Constructs a QMediaList from a QMediaPlaylist playlist.

QMediaList::QMediaList ( const QMediaList & other )

Constructs a copy of the other QMediaList.

bool QMediaList::addFilter ( Roles filterType, const QString & text )

Appends new filter on Category filterType containing string text

eg. addFilter(QMediaList::Title,"Billy");

Returns false on error.

void QMediaList::beginFilter ()

Set filter mode to create, filter will not be applied until endFilter() is called.

void QMediaList::clearFilter ()

Resets current filter.

Grouping QMediaList::displayGrouping () const

Returns whether to display all, or to aggregate the data type set by setDisplayRole()

int QMediaList::displayRole () const

Returns the media lists default display role

See also setDisplayRole() and Qt::DisplayRole.

void QMediaList::endFilter ()

Applies current filter to data.

bool QMediaList::isFiltered () const

Returns true if filters are in effect on the model.

QMediaPlaylist QMediaList::playlist ( const QModelIndex & index = QModelIndex() ) const

Constructs a QMediaPlaylist from the selected index, or if index is empty, then from the whole QMediaList.

void QMediaList::randomize ()

Randomizes the filtered list.

void QMediaList::refreshData ()   [protected]

Applies current filters to data and refresh content of list.

bool QMediaList::removeFilter ( Roles filterType )

Removes filter on Category filterType

eg. removeFilter(QMediaList::Album);

Returns false on error.

void QMediaList::setDisplayRole ( int role, Grouping grouping = ShowGrouped )

Set what role is currently begin displayed. Setting the grouping changes the display from unique to all.

Options for role are: QMediaPlaylist::DataRole

eg. setDisplayRole(QMediaPlaylist::Title, QMediaList::ShowAll);

See also displayRole().

bool QMediaList::setFilter ( Roles filterType, const QString & text )

Resets current filter, applying new filter on Category filterType containing string text

eg. setFilter(QMediaList::MimeType,"audio");

Returns false on error.

void QMediaList::setModel ( const QMediaPlaylist & playlist )

Sets the given model to be used as the data provider for the list to playlist

void QMediaList::setSorting ( SortDirection sortType )

Sorts the list by sortType

void QMediaList::setSorting ( QList<int> roles, SortDirection sortType )

This is an overloaded member function, provided for convenience.

Sorts the list by sortType, using sort order roles

void QMediaList::showEmpty ( Properties role )

Set role to handle empty data field.

Options for role are: QMediaList::Properties

eg. showEmpty(QMediaList::HideEmpty);

QMediaList & QMediaList::operator= ( const QMediaList & medialist )

Assigns the specified medialist to this object.

bool QMediaList::operator== ( const QMediaList & other ) const

Returns true if this QMediaList and the other are equal; otherwise returns false.