Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

MP3FileInfos Class Reference

#include <MP3FileInfos.h>

List of all members.


Detailed Description

An MP3FileInfos object stores all information about an MP3, except for the data itself.

Author:
Thomas Jacob

Definition at line 20 of file MP3FileInfos.h.

Public Member Functions

char * GetArtist ()
 Returns the artist name.

char * GetSong ()
 Returns the song name.

 MP3FileInfos ()
 Creates a new MP3 file information.

void Normalize ()
 Capitalizes and trims the song and artist names.

void ReadFrom (const char *path)
 Sets the MP3 file information's attributes from a given file.

void SetArtist (char *artist)
 Sets the artist name.

void SetSong (char *song)
 Sets the song name.

 ~MP3FileInfos ()
 Destroys the MP3 file information.


Static Private Member Functions

void Capitalize (char *string)
 Capitalizes a given string.

void Trim (char *string)
 Trims a given string.


Private Attributes

char * Artist
 The artist name.

char * Song
 The song name.


Constructor & Destructor Documentation

MP3FileInfos  ) 
 

Creates a new MP3 file information.

~MP3FileInfos  ) 
 

Destroys the MP3 file information.


Member Function Documentation

void Capitalize char *  string  )  [static, private]
 

Capitalizes a given string.

This method can be used to capitalize the artist and song names after they are retrieved through the getter methods.

Parameters:
string The string to capitalize.

char* GetArtist  )  [inline]
 

Returns the artist name.

Returns:
The artist name.

char* GetSong  )  [inline]
 

Returns the song name.

Returns:
The song name.

void Normalize  ) 
 

Capitalizes and trims the song and artist names.

void ReadFrom const char *  path  ) 
 

Sets the MP3 file information's attributes from a given file.

Parameters:
path The path to the file.

void SetArtist char *  artist  ) 
 

Sets the artist name.

Parameters:
artist The new artist name. The string will be copied by the method, so the memory is still yours.

void SetSong char *  song  ) 
 

Sets the song name.

Parameters:
song The new song name. The string will be copied by the method, so the memory is still yours.

void Trim char *  string  )  [static, private]
 

Trims a given string.

This method can be used to trim the artist and song names after they are retrieved through the getter methods.

Parameters:
string The string to be trimmed.


Member Data Documentation

char* Artist [private]
 

The artist name.

Definition at line 27 of file MP3FileInfos.h.

char* Song [private]
 

The song name.

Definition at line 32 of file MP3FileInfos.h.


The documentation for this class was generated from the following file:
Generated on Tue Oct 3 00:23:40 2006 for ToolBox by doxygen 1.3.6