diff options
Diffstat (limited to 'libkcddb/cdinfo.h')
| -rw-r--r-- | libkcddb/cdinfo.h | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/libkcddb/cdinfo.h b/libkcddb/cdinfo.h new file mode 100644 index 00000000..554e2ff6 --- /dev/null +++ b/libkcddb/cdinfo.h @@ -0,0 +1,146 @@ +/* + Copyright (C) 2002 Rik Hemsley (rikkus) <rik@kde.org> + Copyright (C) 2002 Benjamin Meyer <ben-devel@meyerhome.net> + Copyright (C) 2002-2004 Nadeem Hasan <nhasan@nadmm.com> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. +*/ + +#ifndef KCDDB_CDINFO_H +#define KCDDB_CDINFO_H + +#include <qstringlist.h> +#include <qvaluelist.h> +#include <kdemacros.h> +#include <qvariant.h> + +namespace KCDDB +{ + /** + * Information about a sepecific track in a cd. + */ + class KDE_EXPORT TrackInfo + { + public: + + TrackInfo(); + ~TrackInfo(); + TrackInfo(const TrackInfo& clone); + TrackInfo& operator=(const TrackInfo& clone); + + /** + * Get data for type that has been assigned to this track. + * @p type is case insensitive. + * For example <code>get("title")</code> + */ + QVariant get(const QString &type) const; +#ifndef KDE_NO_COMPAT + // Use get("title"); + QString title; + // Use get("extt"); + QString extt; +#endif + }; + + typedef QValueList<TrackInfo> TrackInfoList; + + /** + * Information about a CD + * + * Typically CDInfo is obtained from the client such as: + * <code>KCDDB::Client *cddb = new KCDDB::Client(); + * cddb->lookup(discSignature); + * CDInfo info = cddb->bestLookupResponse();</code> + */ + class KDE_EXPORT CDInfo + { + public: + + CDInfo(); + ~CDInfo(); + CDInfo(const CDInfo& clone); + CDInfo& operator=(const CDInfo& clone); + + /** + * Load CDInfo from a string that is CDDB compatible + * @return true if successful + */ + bool load(const QString &); + /** + * Load CDInfo from a stringList that is CDDB compatible + * @return true if successful + */ + bool load(const QStringList &); + + /** + * Clear all information, setting this to invalid + * internal + */ + void clear(); + + /** + * @return true if the cd information is valid + */ + bool isValid() const; + /** + * @param submit If submit is true only returns CDDB compatible information + * @return a string containing all of the CD's information. + */ + QString toString(bool submit=false) const; + + /** + * Get data for type that has been assigned to this disc. + * @p type is case insensitive. + * For example <code>get("title")</code> + */ + QVariant get(const QString &type) const; + // Use get(...) + QString id; + QString artist; + QString title; + QString genre; + QString category; + QString extd; + uint year; + uint length; // in milliseconds + uint revision; + + TrackInfoList trackInfoList; + + protected: + /** + * @returns a valid CDDB line made up of name and value + */ + QString createLine(const QString& name, const QString& value) const; + /** + * Checks to make sure that trackNumber exists + */ + void checkTrack( uint ); + /** + * escape's string for CDDB processing + */ + static QString escape( const QString & ); + /** + * fixes an escaped string that has been CDDB processed + */ + static QString unescape( const QString & ); + }; + + typedef QValueList<CDInfo> CDInfoList; +} + +#endif // KCDDB_CDINFO_H +// vim:tabstop=2:shiftwidth=2:expandtab:cinoptions=(s,U1,m1 |