diff -r 86af6c333601 -r 0446eb7b28aa smf/inc/common/smfmusic/smflyrics.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/smf/inc/common/smfmusic/smflyrics.h Thu Apr 15 15:35:36 2010 +0530 @@ -0,0 +1,114 @@ +/** + * Copyright (c) 2010 Sasken Communication Technologies Ltd. + * All rights reserved. + * This component and the accompanying materials are made available + * under the terms of the "Eclipse Public License v1.0" + * which accompanies this distribution, and is available + * at the URL "http://www.eclipse.org/legal/epl-v10.html" + * + * Initial Contributors: + * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution + * + * Contributors: + * Manasij Roy, Nalina Hariharan + * + * Description: + * The SmfLyrics class represents an instance of a music track's lyrics + * + */ + +#ifndef SMFLYRICS_H_ +#define SMFLYRICS_H_ + +#include +#include +#include +#include + +class SmfLyricsPrivate; + +/** + * @ingroup smf_common_group + * The lyrics class represents an instance of a music track's lyrics + */ +class SMFCLIENT_EXPORT SmfLyrics : public QObject + { + Q_OBJECT +public: + /** + * Constructor with default argument + * @param aParent The parent object + */ + SmfLyrics( QObject *aParent = 0 ); + + /** + * Copy Constructor + * @param aOther The reference object + */ + SmfLyrics( const SmfLyrics &aOther ); + + /** + * Destructor + */ + ~SmfLyrics( ); + + /** + * Method to get the lyrics + * @return The lyrics data + */ + QByteArray lyrics( ) const; + + /** + * Method to get the language + * @return The language + */ + QString language( ) const; + + /** + * Method to get the release year + * @return The release year + */ + QDateTime releaseYear( ) const; + + /** + * Method to get the id of the lyrics + * @return The ID value + */ + QString id( ) const; + +private: + QSharedDataPointer d; + + friend QDataStream &operator<<( QDataStream &aDataStream, + const SmfLyrics &aLyrics ); + + friend QDataStream &operator>>( QDataStream &aDataStream, + SmfLyrics &aLyrics ); + + }; + + +/** + * Method for Externalization. Writes the SmfLyrics object to + * the stream and returns a reference to the stream. + * @param aDataStream Stream to be written + * @param aLyrics The SmfLyrics object to be externalized + * @return reference to the written stream + */ +QDataStream &operator<<( QDataStream &aDataStream, + const SmfLyrics &aLyrics ); + +/** + * Method for Internalization. Reads a SmfLyrics object from + * the stream and returns a reference to the stream. + * @param aDataStream Stream to be read + * @param aLyrics The SmfLyrics object to be internalized + * @return reference to the stream + */ +QDataStream &operator>>( QDataStream &aDataStream, + SmfLyrics &aLyrics); + +// Make the class SmfLyrics known to QMetaType, so that as to register it. +Q_DECLARE_METATYPE(SmfLyrics) + +#endif /* SMFLYRICS_H_ */