TagLib API Documentation

fileref.h

Go to the documentation of this file.
00001 /***************************************************************************
00002     copyright            : (C) 2003 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
00019  *   USA                                                                   *
00020  ***************************************************************************/
00021 
00022 #ifndef TAGLIB_FILEREF_H
00023 #define TAGLIB_FILEREF_H
00024 
00025 #include "audioproperties.h"
00026 
00027 namespace TagLib {
00028 
00029   class String;
00030   class File;
00031   class Tag;
00032 
00034 
00068   class FileRef
00069   {
00070   public:
00071 
00081     explicit FileRef(const char *fileName,
00082                      bool readAudioProperties = true,
00083                      AudioProperties::ReadStyle
00084                      audioPropertiesStyle = AudioProperties::Average);
00085 
00090     explicit FileRef(File *file);
00091 
00095     FileRef(const FileRef &ref);
00096 
00100     virtual ~FileRef();
00101 
00110     Tag *tag() const;
00111 
00116     AudioProperties *audioProperties() const;
00117 
00133     File *file() const;
00134 
00138     void save();
00139 
00143     bool isNull() const;
00144 
00148     FileRef &operator=(const FileRef &ref);
00149 
00153     bool operator==(const FileRef &ref) const;
00154 
00159     bool operator!=(const FileRef &ref) const;
00160 
00170     static File *create(const char *fileName,
00171                         bool readAudioProperties = true,
00172                         AudioProperties::ReadStyle audioPropertiesStyle = AudioProperties::Average);
00173 
00174   private:
00175     class FileRefPrivate;
00176     FileRefPrivate *d;
00177   };
00178 
00179 } // namespace TagLib
00180 
00181 #endif
KDE Logo
This file is part of the documentation for TagLib Version 1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Jan 22 05:44:21 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2003