Miam-Player  0.8.0
A nice music player
TagLib::Mod::FileBase Class Reference

#include <modfilebase.h>

Inheritance diagram for TagLib::Mod::FileBase:
TagLib::File TagLib::IT::File TagLib::Mod::File TagLib::S3M::File TagLib::XM::File

Protected Member Functions

 FileBase (FileName file)
 
 FileBase (IOStream *stream)
 
void writeString (const String &s, unsigned long size, char padding=0)
 
void writeByte (unsigned char byte)
 
void writeU16L (unsigned short number)
 
void writeU32L (unsigned long number)
 
void writeU16B (unsigned short number)
 
void writeU32B (unsigned long number)
 
bool readString (String &s, unsigned long size)
 
bool readByte (unsigned char &byte)
 
bool readU16L (unsigned short &number)
 
bool readU32L (unsigned long &number)
 
bool readU16B (unsigned short &number)
 
bool readU32B (unsigned long &number)
 
- Protected Member Functions inherited from TagLib::File
 File (FileName file)
 Construct a File object and opens the file. More...
 
 File (IOStream *stream)
 Construct a File object and use the stream instance. More...
 
void setValid (bool valid)
 Marks the file as valid or invalid. More...
 
void truncate (long length)
 Truncates the file to a length. More...
 

Additional Inherited Members

- Public Types inherited from TagLib::File
enum  Position { Beginning, Current, End }
 Position in the file used for seeking. More...
 
- Public Member Functions inherited from TagLib::File
virtual ~File ()
 Destroys this File instance. More...
 
FileName name () const
 Returns the file name in the local file system encoding. More...
 
virtual Tagtag () const =0
 Returns a pointer to this file's tag. More...
 
PropertyMap properties () const
 Exports the tags of the file as dictionary mapping (human readable) tag names (uppercase Strings) to StringLists of tag values. More...
 
void removeUnsupportedProperties (const StringList &properties)
 Removes unsupported properties, or a subset of them, from the file's metadata. More...
 
PropertyMap setProperties (const PropertyMap &properties)
 Sets the tags of this File to those specified in properties. More...
 
virtual AudioPropertiesaudioProperties () const =0
 Returns a pointer to this file's audio properties. More...
 
virtual bool save ()=0
 Save the file and its associated tags. More...
 
ByteVector readBlock (unsigned long length)
 Reads a block of size length at the current get pointer. More...
 
void writeBlock (const ByteVector &data)
 Attempts to write the block data at the current get pointer. More...
 
long find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
 Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...
 
long rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
 Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...
 
void insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
 Insert data at position start in the file overwriting replace bytes of the original content. More...
 
void removeBlock (unsigned long start=0, unsigned long length=0)
 Removes a block of the file starting a start and continuing for length bytes. More...
 
bool readOnly () const
 Returns true if the file is read only (or if the file can not be opened). More...
 
bool isOpen () const
 Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded. More...
 
bool isValid () const
 Returns true if the file is open and readable. More...
 
void seek (long offset, Position p=Beginning)
 Move the I/O pointer to offset in the file from position p. More...
 
void clear ()
 Reset the end-of-file and error flags on the file. More...
 
long tell () const
 Returns the current offset within the file. More...
 
long length ()
 Returns the length of the file. More...
 
- Static Public Member Functions inherited from TagLib::File
static bool isReadable (const char *file)
 Returns true if file can be opened for reading. More...
 
static bool isWritable (const char *name)
 Returns true if file can be opened for writing. More...
 
- Static Protected Member Functions inherited from TagLib::File
static unsigned int bufferSize ()
 Returns the buffer size that is used for internal buffering. More...
 

Constructor & Destructor Documentation

TagLib::Mod::FileBase::FileBase ( FileName  file)
protected
TagLib::Mod::FileBase::FileBase ( IOStream stream)
protected

Member Function Documentation

bool TagLib::Mod::FileBase::readByte ( unsigned char &  byte)
protected
bool TagLib::Mod::FileBase::readString ( String s,
unsigned long  size 
)
protected
bool TagLib::Mod::FileBase::readU16B ( unsigned short &  number)
protected
bool TagLib::Mod::FileBase::readU16L ( unsigned short &  number)
protected
bool TagLib::Mod::FileBase::readU32B ( unsigned long &  number)
protected
bool TagLib::Mod::FileBase::readU32L ( unsigned long &  number)
protected
void TagLib::Mod::FileBase::writeByte ( unsigned char  byte)
protected
void TagLib::Mod::FileBase::writeString ( const String s,
unsigned long  size,
char  padding = 0 
)
protected
void TagLib::Mod::FileBase::writeU16B ( unsigned short  number)
protected
void TagLib::Mod::FileBase::writeU16L ( unsigned short  number)
protected
void TagLib::Mod::FileBase::writeU32B ( unsigned long  number)
protected
void TagLib::Mod::FileBase::writeU32L ( unsigned long  number)
protected

The documentation for this class was generated from the following file: