smf/inc/common/smfmusic/smflyrics.h
changeset 5 edb9dc8273d9
parent 3 0446eb7b28aa
equal deleted inserted replaced
4:969092730d34 5:edb9dc8273d9
    29 
    29 
    30 /**
    30 /**
    31  * @ingroup smf_common_group
    31  * @ingroup smf_common_group
    32  * The lyrics class represents an instance of a music track's lyrics
    32  * The lyrics class represents an instance of a music track's lyrics
    33  */
    33  */
    34 class SMFCLIENT_EXPORT SmfLyrics : public QObject
    34 class SMFCLIENT_EXPORT SmfLyrics
    35 	{
    35 	{
    36 	Q_OBJECT
       
    37 public:
    36 public:
    38 	/**
    37 	/**
    39 	 * Constructor with default argument
    38 	 * Constructor with default argument
    40 	 * @param aParent The parent object
       
    41 	 */
    39 	 */
    42 	SmfLyrics( QObject *aParent = 0 );
    40 	SmfLyrics( );
    43 	
    41 	
    44 	/**
    42 	/**
    45 	 * Copy Constructor
    43 	 * Copy Constructor
    46 	 * @param aOther The reference object
    44 	 * @param aOther The reference object
    47 	 */
    45 	 */
    48 	SmfLyrics( const SmfLyrics &aOther );
    46 	SmfLyrics( const SmfLyrics &aOther );
       
    47 	
       
    48 	/**
       
    49 	 * Overloaded = operator
       
    50 	 * @param aOther The reference object
       
    51 	 * @return The current object reference
       
    52 	 */
       
    53 	SmfLyrics& operator=( const SmfLyrics &aOther );
    49 	
    54 	
    50 	/**
    55 	/**
    51 	 * Destructor
    56 	 * Destructor
    52 	 */
    57 	 */
    53 	~SmfLyrics( );
    58 	~SmfLyrics( );
    73 	/**
    78 	/**
    74 	 * Method to get the id of the lyrics
    79 	 * Method to get the id of the lyrics
    75 	 * @return The ID value 
    80 	 * @return The ID value 
    76 	 */
    81 	 */
    77 	QString id( ) const;
    82 	QString id( ) const;
       
    83 	
       
    84 	/**
       
    85 	 * Method to set the lyrics
       
    86 	 * @param aLyrics The lyrics data
       
    87 	 */
       
    88 	void setLyrics( const QByteArray &aLyrics );
       
    89 	
       
    90 	/**
       
    91 	 * Method to set the language
       
    92 	 * @param aLang The language
       
    93 	 */
       
    94 	void setLanguage( const QString &aLang );
       
    95 	
       
    96 	/**
       
    97 	 * Method to set the release year
       
    98 	 * @param aRelYear The release year
       
    99 	 */
       
   100 	void setReleaseYear( const QDateTime &aRelYear );
       
   101 	
       
   102 	/**
       
   103 	 * Method to set the id of the lyrics
       
   104 	 * @param aId The ID value 
       
   105 	 */
       
   106 	void setId( const QString &aId );
    78 	
   107 	
    79 private:
   108 private:
    80 	QSharedDataPointer<SmfLyricsPrivate> d;
   109 	QSharedDataPointer<SmfLyricsPrivate> d;
    81 	
   110 	
    82 	friend QDataStream &operator<<( QDataStream &aDataStream, 
   111 	friend QDataStream &operator<<( QDataStream &aDataStream, 
   106  * @return reference to the stream
   135  * @return reference to the stream
   107  */
   136  */
   108 QDataStream &operator>>( QDataStream &aDataStream, 
   137 QDataStream &operator>>( QDataStream &aDataStream, 
   109 		SmfLyrics &aLyrics);
   138 		SmfLyrics &aLyrics);
   110 
   139 
       
   140 
   111 // Make the class SmfLyrics known to QMetaType, so that as to register it.
   141 // Make the class SmfLyrics known to QMetaType, so that as to register it.
   112 Q_DECLARE_METATYPE(SmfLyrics)
   142 Q_DECLARE_METATYPE(SmfLyrics)
   113 
   143 
       
   144 
   114 #endif /* SMFLYRICS_H_ */
   145 #endif /* SMFLYRICS_H_ */