tagunion.h

Go to the documentation of this file.
00001 /***************************************************************************
00002     copyright            : (C) 2002 - 2008 by Scott Wheeler
00003     email                : wheeler@kde.org
00004  ***************************************************************************/
00005 
00006 /***************************************************************************
00007  *   This library is free software; you can redistribute it and/or modify  *
00008  *   it under the terms of the GNU Lesser General Public License version   *
00009  *   2.1 as published by the Free Software Foundation.                     *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful, but   *
00012  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the Free Software   *
00018  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
00019  *   02110-1301  USA                                                       *
00020  *                                                                         *
00021  *   Alternatively, this file is available under the Mozilla Public        *
00022  *   License Version 1.1.  You may obtain a copy of the License at         *
00023  *   http://www.mozilla.org/MPL/                                           *
00024  ***************************************************************************/
00025 
00026 #ifndef TAGLIB_TAGUNION_H
00027 #define TAGLIB_TAGUNION_H
00028 
00029 #include "tag.h"
00030 
00031 #ifndef DO_NOT_DOCUMENT
00032 
00033 namespace TagLib {
00034 
00039   class TagUnion : public Tag
00040   {
00041   public:
00042 
00043     enum AccessType { Read, Write };
00044 
00050     TagUnion(Tag *first = 0, Tag *second = 0, Tag *third = 0);
00051 
00052     virtual ~TagUnion();
00053 
00054     Tag *operator[](int index) const;
00055     Tag *tag(int index) const;
00056 
00057     void set(int index, Tag *tag);
00058 
00059     PropertyMap properties() const;
00060     void removeUnsupportedProperties(const StringList &unsupported);
00061 
00062     virtual String title() const;
00063     virtual String artist() const;
00064     virtual String album() const;
00065     virtual String comment() const;
00066     virtual String genre() const;
00067     virtual unsigned int year() const;
00068     virtual unsigned int track() const;
00069 
00070     virtual void setTitle(const String &s);
00071     virtual void setArtist(const String &s);
00072     virtual void setAlbum(const String &s);
00073     virtual void setComment(const String &s);
00074     virtual void setGenre(const String &s);
00075     virtual void setYear(unsigned int i);
00076     virtual void setTrack(unsigned int i);
00077     virtual bool isEmpty() const;
00078 
00079     template <class T> T *access(int index, bool create)
00080     {
00081       if(!create || tag(index))
00082         return static_cast<T *>(tag(index));
00083 
00084       set(index, new T);
00085       return static_cast<T *>(tag(index));
00086     }
00087 
00088   private:
00089     TagUnion(const Tag &);
00090     TagUnion &operator=(const Tag &);
00091 
00092     class TagUnionPrivate;
00093     TagUnionPrivate *d;
00094   };
00095 }
00096 
00097 #endif
00098 #endif