id3lib 3.8.3
|
#include <field_impl.h>
Public Member Functions | |
~ID3_FieldImpl () | |
void | Clear () |
Clears any data and frees any memory associated with the field. | |
size_t | Size () const |
Returns the size of a field. | |
size_t | BinSize () const |
size_t | GetNumTextItems () const |
Returns the number of items in a text list. | |
ID3_Field & | operator= (uint32 val) |
A shortcut for the Set method. | |
void | Set (uint32) |
Sets the value of the field to the specified integer. | |
uint32 | Get () const |
Returns the value of the integer field. | |
void | SetInteger (uint32) |
uint32 | GetInteger () const |
ID3_Field & | operator= (const char *s) |
Shortcut for the Set operator. | |
size_t | Set (const char *data) |
Copies the supplied string to the field. | |
size_t | Get (char *, size_t) const |
Copies the contents of the field into the supplied buffer, up to the number of characters specified; for fields with multiple entries, the optional third parameter indicates which of the fields to retrieve. | |
size_t | Get (char *, size_t, size_t) const |
const char * | GetRawText () const |
const char * | GetRawTextItem (size_t) const |
size_t | Add (const char *data) |
dami::String | GetText () const |
dami::String | GetTextItem (size_t) const |
size_t | SetText (dami::String) |
size_t | AddText (dami::String) |
ID3_Field & | operator= (const unicode_t *s) |
Shortcut for the Set operator. | |
size_t | Set (const unicode_t *) |
Copies the supplied unicode string to the field. | |
size_t | Get (unicode_t *buffer, size_t) const |
Copies the contents of the field into the supplied buffer, up to the number of characters specified; for fields with multiple entries, the optional third parameter indicates which of the fields to retrieve. | |
size_t | Get (unicode_t *buffer, size_t, size_t) const |
size_t | Add (const unicode_t *) |
const unicode_t * | GetRawUnicodeText () const |
const unicode_t * | GetRawUnicodeTextItem (size_t) const |
size_t | Set (const uchar *buf, size_t size) |
size_t | Set (const char *buf, size_t size) |
size_t | Get (uchar *, size_t) const |
Copies the field's internal string to the buffer. | |
const uchar * | GetRawBinary () const |
void | FromFile (const char *) |
Copies binary data from the file specified to the field. | |
void | ToFile (const char *sInfo) const |
Copies binary data from the field to the specified file. | |
size_t | SetBinary (dami::BString) |
Copies the supplied unicode string to the field. | |
dami::BString | GetBinary () const |
ID3_Field & | operator= (const ID3_Field &) |
bool | InScope (ID3_V2Spec spec) const |
ID3_FieldID | GetID () const |
ID3_FieldType | GetType () const |
bool | SetEncoding (ID3_TextEnc enc) |
ID3_TextEnc | GetEncoding () const |
bool | IsEncodable () const |
void | Render (ID3_Writer &) const |
bool | Parse (ID3_Reader &) |
bool | HasChanged () const |
Protected Member Functions | |
void | RenderInteger (ID3_Writer &) const |
void | RenderText (ID3_Writer &) const |
void | RenderBinary (ID3_Writer &) const |
bool | ParseInteger (ID3_Reader &) |
bool | ParseText (ID3_Reader &) |
bool | ParseBinary (ID3_Reader &) |
![]() | |
virtual | ~ID3_Field () |
ID3_Field () | |
Friends | |
class | ID3_FrameImpl |
Definition at line 40 of file field_impl.h.
|
virtual |
Implements ID3_Field.
Definition at line 250 of file field_string_ascii.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 61 of file field_string_unicode.cpp.
size_t ID3_FieldImpl::AddText | ( | dami::String | ) |
Definition at line 240 of file field_string_ascii.cpp.
|
virtual |
|
virtual |
Clears any data and frees any memory associated with the field.
Implements ID3_Field.
|
virtual |
Copies binary data from the file specified to the field.
Implements ID3_Field.
Definition at line 136 of file field_binary.cpp.
|
virtual |
Returns the value of the integer field.
Implements ID3_Field.
Definition at line 72 of file field_integer.cpp.
|
virtual |
Copies the contents of the field into the supplied buffer, up to the number of characters specified; for fields with multiple entries, the optional third parameter indicates which of the fields to retrieve.
The third parameter is useful when using text lists (see Add(const char*) for more details). The default value for this third parameter is 1, which returns the entire string if the field contains only one item.
It returns the number of characters (not bytes necessarily, and not including any NULL terminator) of the supplied buffer that are now used.
It fills the buffer with as much data from the field as is present in the field, or as large as the buffer, whichever is smaller.
This fills the buffer with up to the first 1024 characters from the third element of the text list.
Implements ID3_Field.
Definition at line 87 of file field_string_ascii.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 106 of file field_string_ascii.cpp.
|
virtual |
Copies the field's internal string to the buffer.
It copies the data in the field into the buffer, for as many bytes as the field contains, or the size of buffer, whichever is smaller.
Implements ID3_Field.
Definition at line 113 of file field_binary.cpp.
|
virtual |
Copies the contents of the field into the supplied buffer, up to the number of characters specified; for fields with multiple entries, the optional third parameter indicates which of the fields to retrieve.
Performs similarly as the ASCII Get(char *, size_t, size_t) method, taking a unicode_t string as a parameter rather than an ascii string. The maxChars parameter still represents the maximum number of characters, not bytes.
buffer | Where the field's data is copied to |
maxChars | The maximum number of characters to copy to the buffer. |
itemNum | For fields with multiple items (such as the involved people frame, the item number to retrieve. |
Implements ID3_Field.
Definition at line 93 of file field_string_unicode.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 139 of file field_string_unicode.cpp.
BString ID3_FieldImpl::GetBinary | ( | ) | const |
Definition at line 81 of file field_binary.cpp.
|
inlinevirtual |
Implements ID3_Field.
Definition at line 105 of file field_impl.h.
|
inlinevirtual |
Implements ID3_Field.
Definition at line 102 of file field_impl.h.
uint32 ID3_FieldImpl::GetInteger | ( | ) | const |
Definition at line 77 of file field_integer.cpp.
|
virtual |
Returns the number of items in a text list.
Implements ID3_Field.
Definition at line 399 of file field_string_ascii.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 92 of file field_binary.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 261 of file field_string_ascii.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 272 of file field_string_ascii.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 111 of file field_string_unicode.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 122 of file field_string_unicode.cpp.
String ID3_FieldImpl::GetText | ( | ) | const |
Definition at line 124 of file field_string_ascii.cpp.
String ID3_FieldImpl::GetTextItem | ( | size_t | index | ) | const |
Definition at line 134 of file field_string_ascii.cpp.
|
inlinevirtual |
Implements ID3_Field.
Definition at line 103 of file field_impl.h.
|
virtual |
|
inlinevirtual |
Implements ID3_Field.
Definition at line 99 of file field_impl.h.
|
inlinevirtual |
Implements ID3_Field.
Definition at line 106 of file field_impl.h.
|
inlinevirtual |
Shortcut for the Set operator.
data | The string to assign to this field |
Implements ID3_Field.
Definition at line 61 of file field_impl.h.
Shortcut for the Set operator.
Performs similarly as operator=(const char*), taking a unicode_t string as a parameter rather than an ascii string.
string | The string to assign to the field |
Implements ID3_Field.
Definition at line 75 of file field_impl.h.
|
inlinevirtual |
A shortcut for the Set method.
val | The data to assign to this field |
Implements ID3_Field.
Definition at line 53 of file field_impl.h.
|
virtual |
|
protected |
Definition at line 195 of file field_binary.cpp.
|
protected |
Definition at line 87 of file field_integer.cpp.
|
protected |
Definition at line 327 of file field_string_ascii.cpp.
|
virtual |
|
protected |
Definition at line 203 of file field_binary.cpp.
|
protected |
Definition at line 105 of file field_integer.cpp.
|
protected |
Definition at line 376 of file field_string_ascii.cpp.
|
inline |
Definition at line 85 of file field_impl.h.
|
virtual |
Copies the supplied string to the field.
You may dispose of the source string after a call to this method.
Implements ID3_Field.
Definition at line 45 of file field_string_ascii.cpp.
|
virtual |
Implements ID3_Field.
Definition at line 39 of file field_binary.cpp.
|
virtual |
Copies the supplied unicode string to the field.
Performs similarly as the ASCII Set() method, taking a unicode_t string as a parameter rather than an ascii string.
string | The unicode string to set this field to. |
Implements ID3_Field.
Definition at line 49 of file field_string_unicode.cpp.
|
virtual |
Sets the value of the field to the specified integer.
data | The data to assign to this field |
Implements ID3_Field.
Definition at line 47 of file field_integer.cpp.
size_t ID3_FieldImpl::SetBinary | ( | dami::BString | ) |
Copies the supplied unicode string to the field.
Again, like the string types, the binary Set() function copies the data so you may dispose of the source data after a call to this method.
Definition at line 55 of file field_binary.cpp.
|
virtual |
void ID3_FieldImpl::SetInteger | ( | uint32 | val | ) |
Definition at line 52 of file field_integer.cpp.
size_t ID3_FieldImpl::SetText | ( | dami::String | ) |
Definition at line 189 of file field_string_ascii.cpp.
|
virtual |
Returns the size of a field.
The value returned is dependent on the type of the field. For ASCII strings, this returns the number of characters in the field, not including any NULL-terminator. The same holds true for Unicode—it returns the number of characters in the field, not bytes, and this does not include the Unicode BOM, which isn't put in a Unicode string obtained by the Get(unicode_t*, size_t, size_t) method anyway. For binary and integer fields, this returns the number of bytes in the field.
Implements ID3_Field.
|
virtual |
Copies binary data from the field to the specified file.
Implements ID3_Field.
Definition at line 172 of file field_binary.cpp.
|
friend |
Definition at line 42 of file field_impl.h.