ID3_FrameHeader Class Reference

#include <header_frame.h>

Inheritance diagram for ID3_FrameHeader:

ID3_Header List of all members.

Public Types

enum  {
  TAGALTER = 1 << 15, FILEALTER = 1 << 14, READONLY = 1 << 13, COMPRESSION = 1 << 7,
  ENCRYPTION = 1 << 6, GROUPING = 1 << 5
}

Public Member Functions

 ID3_FrameHeader ()
virtual ~ID3_FrameHeader ()
size_t Size () const
bool Parse (ID3_Reader &)
void Render (ID3_Writer &) const
bool SetFrameID (ID3_FrameID id)
ID3_FrameID GetFrameID () const
const char * GetTextID () const
const ID3_FrameDefGetFrameDef () const
bool Clear ()
ID3_FrameHeaderoperator= (const ID3_FrameHeader &)
bool SetCompression (bool b)
bool SetEncryption (bool b)
bool SetGrouping (bool b)
bool GetCompression () const
bool GetEncryption () const
bool GetGrouping () const
bool GetReadOnly () const
void SetUnknownFrame (const char *)

Protected Member Functions

bool SetFlags (uint16 f, bool b)

Detailed Description

Definition at line 36 of file header_frame.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
TAGALTER 
FILEALTER 
READONLY 
COMPRESSION 
ENCRYPTION 
GROUPING 

Definition at line 40 of file header_frame.h.


Constructor & Destructor Documentation

ID3_FrameHeader::ID3_FrameHeader (  )  [inline]

Definition at line 50 of file header_frame.h.

virtual ID3_FrameHeader::~ID3_FrameHeader (  )  [inline, virtual]

Definition at line 51 of file header_frame.h.

References Clear().


Member Function Documentation

size_t ID3_FrameHeader::Size (  )  const [virtual]

Implements ID3_Header.

Definition at line 79 of file header_frame.cpp.

References ID3_Header::_info, ID3_Header::Info::frame_bytes_flags, ID3_Header::Info::frame_bytes_id, and ID3_Header::Info::frame_bytes_size.

Referenced by ID3_FrameImpl::Render(), and ID3_FrameImpl::Size().

bool ID3_FrameHeader::Parse ( ID3_Reader  )  [virtual]

Implements ID3_Header.

Definition at line 91 of file header_frame.cpp.

References ID3_Header::_flags, ID3_Header::_info, ID3_Flags::add(), ID3_Header::Info::frame_bytes_flags, ID3_Header::Info::frame_bytes_id, ID3_Header::Info::frame_bytes_size, ID3_Reader::getCur(), ID3_Reader::getEnd(), ID3_FindFrameID(), ID3FID_NOFRAME, ID3_Header::SetDataSize(), SetFrameID(), and SetUnknownFrame().

Referenced by ID3_FrameImpl::Parse().

void ID3_FrameHeader::Render ( ID3_Writer  )  const [virtual]

Implements ID3_Header.

Definition at line 135 of file header_frame.cpp.

References ID3_Header::_data_size, ID3_Header::_flags, ID3_Header::_info, ID3_Header::Info::frame_bytes_flags, ID3_Header::Info::frame_bytes_id, ID3_Header::Info::frame_bytes_size, ID3_Flags::get(), NULL, ID3_FrameDef::sLongTextID, ID3_FrameDef::sShortTextID, and ID3_Writer::writeChars().

Referenced by ID3_FrameImpl::Render().

bool ID3_FrameHeader::SetFrameID ( ID3_FrameID  id  ) 

Definition at line 65 of file header_frame.cpp.

References ID3_Header::_changed, ID3_Header::_flags, ID3_FrameDef::bFileDiscard, ID3_FrameDef::bTagDiscard, FILEALTER, ID3_FindFrameDef(), ID3FID_NOFRAME, ID3_Flags::set(), and TAGALTER.

Referenced by ID3_FrameImpl::_SetID(), Parse(), and ID3_FrameImpl::Render().

ID3_FrameID ID3_FrameHeader::GetFrameID (  )  const

Definition at line 209 of file header_frame.cpp.

References ID3_FrameDef::eID, ID3FID_NOFRAME, and NULL.

Referenced by ID3_FrameImpl::GetID().

const char * ID3_FrameHeader::GetTextID (  )  const

Definition at line 163 of file header_frame.cpp.

References ID3_Header::_info, ID3_Header::Info::frame_bytes_id, ID3_FrameDef::sLongTextID, and ID3_FrameDef::sShortTextID.

Referenced by ID3_FrameImpl::GetTextID(), and ID3_FrameImpl::Parse().

const ID3_FrameDef * ID3_FrameHeader::GetFrameDef (  )  const

Definition at line 220 of file header_frame.cpp.

Referenced by ID3_FrameImpl::_InitFields(), and ID3_FrameImpl::GetDescription().

bool ID3_FrameHeader::Clear (  )  [virtual]

Reimplemented from ID3_Header.

Definition at line 225 of file header_frame.cpp.

References ID3_Header::Clear(), and NULL.

Referenced by ID3_FrameImpl::Clear(), operator=(), SetUnknownFrame(), and ~ID3_FrameHeader().

ID3_FrameHeader & ID3_FrameHeader::operator= ( const ID3_FrameHeader  ) 

Definition at line 180 of file header_frame.cpp.

References _dyn_frame_def, _frame_def, ID3_FrameDef::aeFieldDefs, ID3_FrameDef::bFileDiscard, ID3_FrameDef::bTagDiscard, Clear(), ID3_FrameDef::eID, NULL, ID3_Header::operator=(), ID3_FrameDef::sLongTextID, and ID3_FrameDef::sShortTextID.

bool ID3_FrameHeader::SetCompression ( bool  b  )  [inline]

Definition at line 63 of file header_frame.h.

References COMPRESSION, and SetFlags().

Referenced by ID3_FrameImpl::Render(), and ID3_FrameImpl::SetCompression().

bool ID3_FrameHeader::SetEncryption ( bool  b  )  [inline]

Definition at line 64 of file header_frame.h.

References ENCRYPTION, and SetFlags().

Referenced by ID3_FrameImpl::Render(), and ID3_FrameImpl::SetEncryptionID().

bool ID3_FrameHeader::SetGrouping ( bool  b  )  [inline]

Definition at line 65 of file header_frame.h.

References GROUPING, and SetFlags().

Referenced by ID3_FrameImpl::Render(), and ID3_FrameImpl::SetGroupingID().

bool ID3_FrameHeader::GetCompression (  )  const [inline]

Definition at line 67 of file header_frame.h.

References ID3_Header::_flags, COMPRESSION, and ID3_Flags::test().

Referenced by ID3_FrameImpl::GetCompression(), ID3_FrameImpl::Parse(), and ID3_FrameImpl::Render().

bool ID3_FrameHeader::GetEncryption (  )  const [inline]

Definition at line 68 of file header_frame.h.

References ID3_Header::_flags, ENCRYPTION, and ID3_Flags::test().

Referenced by ID3_FrameImpl::Parse(), and ID3_FrameImpl::Render().

bool ID3_FrameHeader::GetGrouping (  )  const [inline]

Definition at line 69 of file header_frame.h.

References ID3_Header::_flags, GROUPING, and ID3_Flags::test().

Referenced by ID3_FrameImpl::Parse(), and ID3_FrameImpl::Render().

bool ID3_FrameHeader::GetReadOnly (  )  const [inline]

Definition at line 70 of file header_frame.h.

References ID3_Header::_flags, READONLY, and ID3_Flags::test().

void ID3_FrameHeader::SetUnknownFrame ( const char *   ) 

Definition at line 38 of file header_frame.cpp.

References ID3_FrameDef::aeFieldDefs, ID3_FrameDef::bFileDiscard, ID3_FrameDef::bTagDiscard, Clear(), ID3_FieldDef::DEFAULT, ID3_FrameDef::eID, ID3FID_NOFRAME, NULL, ID3_FrameDef::sDescription, ID3_FrameDef::sLongTextID, and ID3_FrameDef::sShortTextID.

Referenced by Parse(), and ID3_FrameImpl::Render().

bool ID3_FrameHeader::SetFlags ( uint16  f,
bool  b 
) [inline, protected]

Definition at line 74 of file header_frame.h.

References ID3_Header::_changed, ID3_Header::_flags, and ID3_Flags::set().

Referenced by SetCompression(), SetEncryption(), and SetGrouping().


The documentation for this class was generated from the following files:
Generated on Mon Aug 20 17:48:46 2007 for id3lib by  doxygen 1.5.2