tag.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2002 - 2008 by Scott Wheeler
    email                : wheeler@kde.org
 ***************************************************************************/

/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/

#ifndef TAGLIB_TAG_H
#define TAGLIB_TAG_H

#include "taglib_export.h"
#include "tstring.h"
#include "tlist.h"
#include "tvariant.h"

namespace TagLib {

  class PropertyMap;


  class TAGLIB_EXPORT Tag
  {
  public:

    virtual ~Tag();

    Tag(const Tag &) = delete;
    Tag &operator=(const Tag &) = delete;

    virtual PropertyMap properties() const;

    virtual void removeUnsupportedProperties(const StringList& properties);

    virtual PropertyMap setProperties(const PropertyMap &origProps);

    virtual StringList complexPropertyKeys() const;

    virtual List<VariantMap> complexProperties(const String &key) const;

    virtual bool setComplexProperties(const String &key, const List<VariantMap> &value);

    virtual String title() const = 0;

    virtual String artist() const = 0;

    virtual String album() const = 0;

    virtual String comment() const = 0;

    virtual String genre() const = 0;

    virtual unsigned int year() const = 0;

    virtual unsigned int track() const = 0;

    virtual void setTitle(const String &s) = 0;

    virtual void setArtist(const String &s) = 0;

    virtual void setAlbum(const String &s) = 0;

    virtual void setComment(const String &s) = 0;

    virtual void setGenre(const String &s) = 0;

    virtual void setYear(unsigned int i) = 0;

    virtual void setTrack(unsigned int i) = 0;

    virtual bool isEmpty() const;

    static void duplicate(const Tag *source, Tag *target, bool overwrite = true);

    static String joinTagValues(const StringList &values);

  protected:
    Tag();

  private:
    class TagPrivate;
    TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
    std::unique_ptr<TagPrivate> d;
  };
}  // namespace TagLib

#endif