Qmmp
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
MetaDataModel Class Reference

#include <metadatamodel.h>

Public Types

enum  DialogHint { IsCoverEditable = 0x1 , CompletePropertyList = 0x2 , IsCueEditable = 0x4 }
 

Public Member Functions

 MetaDataModel (bool readOnly, DialogHints hints=DialogHints())
 
virtual ~MetaDataModel ()
 
virtual QList< MetaDataItemextraProperties () const
 
virtual QList< MetaDataItemdescriptions () const
 
virtual QList< TagModel * > tags () const
 
virtual QPixmap cover () const
 
virtual void setCover (const QPixmap &pix)
 
virtual void removeCover ()
 
virtual QString coverPath () const
 
virtual QString cue () const
 
virtual void setCue (const QString &content)
 
virtual void removeCue ()
 
virtual QString lyrics () const
 
bool isReadOnly () const
 
const DialogHints & dialogHints () const
 

Protected Member Functions

void setDialogHints (const DialogHints &hints)
 
void setReadOnly (bool readOnly)
 

Detailed Description

The MetaDataModel is the base interface class of metadata access.

Author
Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Member Enumeration Documentation

◆ DialogHint

enum DialogHint

Details dialog settings.

Enumerator
IsCoverEditable 

Enable cover editor.

CompletePropertyList 

Show properties from extraProperties() only (ignore other sources)

IsCueEditable 

Enable CUE editor.

Constructor & Destructor Documentation

◆ MetaDataModel()

MetaDataModel ( bool readOnly,
DialogHints hints = DialogHints() )

Constructor.

Parameters
readOnlyOpen file in read-only mode (true - enabled, false - disable).
hintsDetails dialog settings.

◆ ~MetaDataModel()

virtual ~MetaDataModel ( )
virtual

Destructor.

Member Function Documentation

◆ cover()

virtual QPixmap cover ( ) const
virtual

Returns cover pixmap. Subclass should reimplement this function. Default implementation returns empty pixmap.

◆ coverPath()

virtual QString coverPath ( ) const
virtual

Returns path to cover pixmap.

◆ cue()

virtual QString cue ( ) const
virtual

Returns CUE file or tag content if necessary. Default implementation returns empty string.

◆ descriptions()

virtual QList< MetaDataItem > descriptions ( ) const
virtual

Returns a list of long descriptions. Default implemetation returns empty array.

◆ dialogHints()

const DialogHints & dialogHints ( ) const

Returns details dialog hints.

◆ extraProperties()

virtual QList< MetaDataItem > extraProperties ( ) const
virtual

Returns extra properties of the media source (in addition to the Qmmp::TrackProperty values). Default implemetation returns empty array.

◆ isReadOnly()

bool isReadOnly ( ) const

Returns true if file is opened in read only mode. Otherwise returns false.

◆ lyrics()

virtual QString lyrics ( ) const
virtual

Returns song lyrics. Default returns empty string.

◆ removeCover()

virtual void removeCover ( )
virtual

Removes cover. Subclass should reimplement this function. Default implementation does nothing.

◆ removeCue()

virtual void removeCue ( )
virtual

Removes CUE file or tag. Default implementation does nothing.

◆ setCover()

virtual void setCover ( const QPixmap & pix)
virtual

Sets cover.

Parameters
pixCover pixmap. Subclass should reimplement this function. Default implementation does nothing.

◆ setCue()

virtual void setCue ( const QString & content)
virtual

Updates CUE file or tag content. Default implementation doesn nothing.

◆ setDialogHints()

void setDialogHints ( const DialogHints & hints)
protected

Changes details dialog hints to hints

◆ setReadOnly()

void setReadOnly ( bool readOnly)
protected

Enables/Disables read only mode (true - enabled, false - disable).

Parameters
readOnlyread only mode (true - enabled, false - disable).

◆ tags()

virtual QList< TagModel * > tags ( ) const
virtual

Returns a list of available tags. Subclass should reimplement this function. Default implementation returns empty array.


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