mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2025-07-18 13:04:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

comments++

Browse Source
This commit is contained in:
Mathias Panzenböck
2011-06-18 04:28:48 +02:00
parent a31b0bcf8c
commit 0143c3ee63
1 changed files with 113 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
taglib/mod/modtag.h
View File

@ -26,35 +26,123 @@
namespace TagLib {
namespace Mod {
class TAGLIB_EXPORT Tag : public TagLib::Tag {
public:
Tag();
virtual ~Tag();
/*!
* Tags for module files (mod, s3m, it, xm).
*
* Note that only the \a title is supported as such by most
* module file formats. Except for xm files the \a trackerName
* is derived from the file format or the flavour of the file
* format. For xm files it is stored in the file.
*
* The \a comment tag is not strictly supported by module files,
* but it is common practice to abuse instrument/sample/pattern
* names as multiline comments. TagLib does so as well, but
* currently does not support writing them.
*/
class TAGLIB_EXPORT Tag : public TagLib::Tag
{
public:
Tag();
virtual ~Tag();
String title() const;
String artist() const;
String album() const;
String comment() const;
String genre() const;
uint year() const;
uint track() const;
String trackerName() const;
/*!
* Returns the track name; if no track name is present in the tag
* String::null will be returned.
*/
String title() const;
void setTitle (const String &title);
void setArtist (const String &artist);
void setAlbum (const String &album);
void setComment(const String &comment);
void setGenre (const String &genre);
void setYear (uint year);
void setTrack(uint track);
void setTrackerName(const String &trackerName);
/*!
* Not supported by module files. Therefore always returns String::null.
*/
String artist() const;
private:
Tag(const Tag &);
Tag &operator=(const Tag &);
/*!
* Not supported by module files. Therefore always returns String::null.
*/
String album() const;
class TagPrivate;
TagPrivate *d;
/*!
* Returns the track comment derived from the instrument/sample/pattern
* names; if no comment is present in the tag String::null will be
* returned.
*/
String comment() const;
/*!
* Not supported by module files. Therefore always returns String::null.
*/
String genre() const;
/*!
* Not supported by module files. Therefore always returns 0.
*/
uint year() const;
/*!
* Not supported by module files. Therefore always returns 0.
*/
uint track() const;
/*!
* Returns the name of the tracker used to create/edit the module file.
* Only xm files store this tag to the file as such, for other formats
* (mod, s3m, it) this is derived from the file type or the flavour of
* the file type. Therefore only xm file might have an empty
* (String::null) tracker name.
*/
String trackerName() const;
/*!
* Sets the title to \a title. If \a title is String::null then this
* value will be cleared.
*/
void setTitle(const String &title);
/*!
* Not supported by module files and therefore ignored.
*/
void setArtist(const String &artist);
/*!
* Not supported by module files and therefore ignored.
*/
void setAlbum(const String &album);
/*!
* Not yet supported.
*/
void setComment(const String &comment);
/*!
* Not supported by module files and therefore ignored.
*/
void setGenre(const String &genre);
/*!
* Not supported by module files and therefore ignored.
*/
void setYear(uint year);
/*!
* Not supported by module files and therefore ignored.
*/
void setTrack(uint track);
/*!
* Sets the tracker name to \a trackerName. If \a trackerName is
* String::null then this value will be cleared.
*
* Note that only xm files support this tag. Setting the
* tracker name for other module file formats will be ignored.
*/
void setTrackerName(const String &trackerName);
private:
Tag(const Tag &);
Tag &operator=(const Tag &);
class TagPrivate;
TagPrivate *d;
};
}
}